~ubuntu-branches/ubuntu/precise/code-saturne/precise

« back to all changes in this revision

Viewing changes to include/base/cs_syr3_messages.h

  • Committer: Package Import Robot
  • Author(s): Sylvestre Ledru
  • Date: 2011-11-24 00:00:08 UTC
  • mfrom: (6.1.9 sid)
  • Revision ID: package-import@ubuntu.com-20111124000008-2vo99e38267942q5
Tags: 2.1.0-3
Install a missing file

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
/*============================================================================
2
 
 *
3
 
 *     This file is part of the Code_Saturne Kernel, element of the
4
 
 *     Code_Saturne CFD tool.
5
 
 *
6
 
 *     Copyright (C) 1998-2009 EDF S.A., France
7
 
 *
8
 
 *     contact: saturne-support@edf.fr
9
 
 *
10
 
 *     The Code_Saturne Kernel is free software; you can redistribute it
11
 
 *     and/or modify it under the terms of the GNU General Public License
12
 
 *     as published by the Free Software Foundation; either version 2 of
13
 
 *     the License, or (at your option) any later version.
14
 
 *
15
 
 *     The Code_Saturne Kernel is distributed in the hope that it will be
16
 
 *     useful, but WITHOUT ANY WARRANTY; without even the implied warranty
17
 
 *     of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18
 
 *     GNU General Public License for more details.
19
 
 *
20
 
 *     You should have received a copy of the GNU General Public License
21
 
 *     along with the Code_Saturne Kernel; if not, write to the
22
 
 *     Free Software Foundation, Inc.,
23
 
 *     51 Franklin St, Fifth Floor,
24
 
 *     Boston, MA  02110-1301  USA
25
 
 *
26
 
 *============================================================================*/
27
 
 
28
 
#ifndef __CS_SYR3_MESSAGES_H__
29
 
#define __CS_SYR3_MESSAGES_H__
30
 
 
31
 
/*============================================================================
32
 
 * Manage messages for Syrthes coupling: sending, receiving and interpolation
33
 
 *============================================================================*/
34
 
 
35
 
/*----------------------------------------------------------------------------
36
 
 * Standard C library headers
37
 
 *----------------------------------------------------------------------------*/
38
 
 
39
 
/*----------------------------------------------------------------------------
40
 
 * BFT library headers
41
 
 *----------------------------------------------------------------------------*/
42
 
 
43
 
/*----------------------------------------------------------------------------
44
 
 * FVM library headers
45
 
 *----------------------------------------------------------------------------*/
46
 
 
47
 
/*----------------------------------------------------------------------------
48
 
 * Local headers
49
 
 *----------------------------------------------------------------------------*/
50
 
 
51
 
#include "cs_base.h"
52
 
 
53
 
/*----------------------------------------------------------------------------*/
54
 
 
55
 
BEGIN_C_DECLS
56
 
 
57
 
/*=============================================================================
58
 
 * Local Macro Definitions
59
 
 *============================================================================*/
60
 
 
61
 
/*=============================================================================
62
 
 * Local Structure Definitions
63
 
 *============================================================================*/
64
 
 
65
 
/*============================================================================
66
 
 *  Global variables
67
 
 *============================================================================*/
68
 
 
69
 
/*============================================================================
70
 
 * Public function prototypes
71
 
 *============================================================================*/
72
 
 
73
 
/*----------------------------------------------------------------------------
74
 
 * Check if Syrthes coupling continues or if we must finalize communications.
75
 
 *
76
 
 * parameters:
77
 
 *   nt_cur_abs <-- current iteration number
78
 
 *   nt_max_abs <-> maximum iteration number
79
 
 *----------------------------------------------------------------------------*/
80
 
 
81
 
void
82
 
cs_syr3_messages_test_iter(int   nt_cur_abs,
83
 
                           int  *nt_max_abs);
84
 
 
85
 
/*----------------------------------------------------------------------------
86
 
 * Synchronize new time step
87
 
 *
88
 
 * parameters:
89
 
 *   nt_cur_abs <-- current iteration number
90
 
 *   nt_max_abs --> maximum iteration number
91
 
 *----------------------------------------------------------------------------*/
92
 
 
93
 
void
94
 
cs_syr3_messages_new_time_step(int  nt_cur_abs,
95
 
                               int  nt_max_abs);
96
 
 
97
 
/*----------------------------------------------------------------------------
98
 
 * Receive coupling variables from Syrthes
99
 
 *
100
 
 * parameters:
101
 
 *   syr_num <-- Syrthes 3 coupling number
102
 
 *   twall   --> wall temperature
103
 
 *----------------------------------------------------------------------------*/
104
 
 
105
 
void
106
 
cs_syr3_messages_recv_twall(cs_int_t   syr_num,
107
 
                            cs_real_t  twall[]);
108
 
 
109
 
/*----------------------------------------------------------------------------
110
 
 * Send coupling variables to Syrthes
111
 
 *
112
 
 * parameters:
113
 
 *   syr_num <-- Syrthes 3 coupling number
114
 
 *   tfluid  <-- wall exchange coefficient
115
 
 *   hwall   <-- wall exchange coefficient
116
 
 *----------------------------------------------------------------------------*/
117
 
 
118
 
void
119
 
cs_syr3_messages_send_tf_hwall(cs_int_t   syr_num,
120
 
                               cs_real_t  tfluid[],
121
 
                               cs_real_t  hwall[]);
122
 
 
123
 
/*----------------------------------------------------------------------------*/
124
 
 
125
 
END_C_DECLS
126
 
 
127
 
#endif /* __CS_SYR3_MESSAGES_H__ */