8.1
general documentation
cs_ast_coupling.h
Go to the documentation of this file.
1 #ifndef __CS_AST_COUPLING_H__
2 #define __CS_AST_COUPLING_H__
3 
4 /*============================================================================
5  * code_aster coupling
6  *============================================================================*/
7 
8 /*
9  This file is part of code_saturne, a general-purpose CFD tool.
10 
11  Copyright (C) 1998-2023 EDF S.A.
12 
13  This program is free software; you can redistribute it and/or modify it under
14  the terms of the GNU General Public License as published by the Free Software
15  Foundation; either version 2 of the License, or (at your option) any later
16  version.
17 
18  This program is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
20  FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
21  details.
22 
23  You should have received a copy of the GNU General Public License along with
24  this program; if not, write to the Free Software Foundation, Inc., 51 Franklin
25  Street, Fifth Floor, Boston, MA 02110-1301, USA.
26 */
27 
28 /*----------------------------------------------------------------------------*/
29 
30 /*----------------------------------------------------------------------------
31  * Standard C library headers
32  *----------------------------------------------------------------------------*/
33 
34 /*----------------------------------------------------------------------------
35  * Local headers
36  *----------------------------------------------------------------------------*/
37 
38 #include "cs_base.h"
39 
40 /*----------------------------------------------------------------------------*/
41 
42 BEGIN_C_DECLS
43 
44 /*=============================================================================
45  * Local Macro Definitions
46  *============================================================================*/
47 
48 /*============================================================================
49  * Structure definition
50  *============================================================================*/
51 
52 typedef struct _cs_ast_coupling_t cs_ast_coupling_t;
53 
54 /*============================================================================
55  * Global variable definitions
56  *============================================================================*/
57 
58 /*============================================================================
59  * Public function prototypes
60  *============================================================================*/
61 
62 /*----------------------------------------------------------------------------*/
68 /*----------------------------------------------------------------------------*/
69 
70 int
71 cs_ast_coupling_n_couplings(void);
72 
73 /*----------------------------------------------------------------------------*/
81 /*----------------------------------------------------------------------------*/
82 
83 void
84 cs_ast_coupling_add(void);
85 
86 /*----------------------------------------------------------------------------*/
95 /*----------------------------------------------------------------------------*/
96 
97 void
98 cs_ast_coupling_initialize(int nalimx,
99  cs_real_t epalim);
100 
101 /*----------------------------------------------------------------------------*/
105 /*----------------------------------------------------------------------------*/
106 
107 void
108 cs_ast_coupling_finalize(void);
109 
110 /*----------------------------------------------------------------------------*/
119 /*----------------------------------------------------------------------------*/
120 
121 void
122 cs_ast_coupling_geometry(cs_lnum_t n_faces,
123  const cs_lnum_t *face_ids,
124  cs_real_t almax);
125 
126 /*----------------------------------------------------------------------------*/
132 /*----------------------------------------------------------------------------*/
133 
134 void
135 cs_ast_coupling_exchange_time_step(cs_real_t c_dt[]);
136 
137 /*----------------------------------------------------------------------------*/
144 /*----------------------------------------------------------------------------*/
145 
146 cs_real_3_t *
147 cs_ast_coupling_get_fluid_forces_pointer(void);
148 
149 /*----------------------------------------------------------------------------*/
154 /*----------------------------------------------------------------------------*/
155 
156 void
157 cs_ast_coupling_exchange_fields(void);
158 
159 /*----------------------------------------------------------------------------*/
166 /*----------------------------------------------------------------------------*/
167 
168 void
169 cs_ast_coupling_compute_displacement(cs_real_t disp[][3]);
170 
171 /*----------------------------------------------------------------------------*/
178 /*----------------------------------------------------------------------------*/
179 
180 int
181 cs_ast_coupling_get_ext_cvg(void);
182 
183 /*----------------------------------------------------------------------------*/
189 /*----------------------------------------------------------------------------*/
190 
191 void
192 cs_ast_coupling_send_cvg(int icved);
193 
194 /*----------------------------------------------------------------------------*/
200 /*----------------------------------------------------------------------------*/
201 
202 int
203 cs_ast_coupling_get_verbosity(void);
204 
205 /*----------------------------------------------------------------------------*/
211 /*----------------------------------------------------------------------------*/
212 
213 void
214 cs_ast_coupling_set_verbosity(int verbosity);
215 
216 /*----------------------------------------------------------------------------*/
222 /*----------------------------------------------------------------------------*/
223 
224 int
225 cs_ast_coupling_get_visualization(void);
226 
227 /*----------------------------------------------------------------------------*/
233 /*----------------------------------------------------------------------------*/
234 
235 void
236 cs_ast_coupling_set_visualization(int visualization);
237 
238 /*----------------------------------------------------------------------------*/
239 
240 END_C_DECLS
241 
242 #endif /* __CS_AST_COUPLING_H__ */
cs_ast_coupling_compute_displacement
void cs_ast_coupling_compute_displacement(cs_real_t disp[][3])
Compute predicted or exact displacement of the fluid/structure interface.
Definition: cs_ast_coupling.c:1218
cs_ast_coupling_n_couplings
int cs_ast_coupling_n_couplings(void)
Query number of couplings with code_aster.
Definition: cs_ast_coupling.c:582
cs_ast_coupling_exchange_time_step
void cs_ast_coupling_exchange_time_step(cs_real_t c_dt[])
Exchange time-step information with code_aster.
Definition: cs_ast_coupling.c:980
cs_ast_coupling_send_cvg
void cs_ast_coupling_send_cvg(int icved)
Send global convergence value of FSI calculations.
Definition: cs_ast_coupling.c:1329
cs_ast_coupling_add
void cs_ast_coupling_add(void)
Define coupling with code_aster.
Definition: cs_ast_coupling.c:603
cs_ast_coupling_exchange_fields
void cs_ast_coupling_exchange_fields(void)
Send stresses acting on the fluid/structure interface and receive displacements.
Definition: cs_ast_coupling.c:1098
cs_ast_coupling_set_visualization
void cs_ast_coupling_set_visualization(int visualization)
Set visualization level for code_aster coupling.
Definition: cs_ast_coupling.c:1392
cs_ast_coupling_finalize
void cs_ast_coupling_finalize(void)
Finalize exchange with code_aster.
Definition: cs_ast_coupling.c:789
cs_ast_coupling_get_ext_cvg
int cs_ast_coupling_get_ext_cvg(void)
Receive convergence value of code_saturne/code_aster coupling.
Definition: cs_ast_coupling.c:1306
cs_ast_coupling_t
struct _cs_ast_coupling_t cs_ast_coupling_t
Definition: cs_ast_coupling.h:52
cs_ast_coupling_get_verbosity
int cs_ast_coupling_get_verbosity(void)
Get verbosity level for code_aster coupling.
Definition: cs_ast_coupling.c:1345
cs_ast_coupling_get_fluid_forces_pointer
cs_real_3_t * cs_ast_coupling_get_fluid_forces_pointer(void)
Return pointer to array of fluid forces at faces coupled with code_aster.
Definition: cs_ast_coupling.c:1078
cs_ast_coupling_geometry
void cs_ast_coupling_geometry(cs_lnum_t n_faces, const cs_lnum_t *face_ids, cs_real_t almax)
Extract and exchange mesh information for surfaces coupled with code_aster.
Definition: cs_ast_coupling.c:835
cs_ast_coupling_get_visualization
int cs_ast_coupling_get_visualization(void)
Get visualization level for code_aster coupling.
Definition: cs_ast_coupling.c:1379
cs_ast_coupling_initialize
void cs_ast_coupling_initialize(int nalimx, cs_real_t epalim)
Initial exchange with code_aster.
Definition: cs_ast_coupling.c:727
cs_ast_coupling_set_verbosity
void cs_ast_coupling_set_verbosity(int verbosity)
Set verbosity level for code_aster coupling.
Definition: cs_ast_coupling.c:1359
cs_base.h
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:514
cs_real_t
double cs_real_t
Floating-point value.
Definition: cs_defs.h:319
cs_real_3_t
cs_real_t cs_real_3_t[3]
vector of 3 floating-point values
Definition: cs_defs.h:334
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:515
cs_lnum_t
int cs_lnum_t
local mesh entity id
Definition: cs_defs.h:313
albase::nalimx
integer(c_int), save nalimx
maximum number of implicitation iterations of the structure displacement
Definition: albase.f90:49
albase::epalim
real(c_double), save epalim
relative precision of implicitation of the structure displacement
Definition: albase.f90:51
cstphy::almax
real(c_double), pointer, save almax
is a characteristic macroscopic length of the domain, used for the initialization of the turbulence a...
Definition: cstphy.f90:344