8.3
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-2024 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
42BEGIN_C_DECLS
43
44/*=============================================================================
45 * Local Macro Definitions
46 *============================================================================*/
47
48/*============================================================================
49 * Structure definition
50 *============================================================================*/
51
52typedef 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
70int
71cs_ast_coupling_n_couplings(void);
72
73/*----------------------------------------------------------------------------*/
82/*----------------------------------------------------------------------------*/
83
84void
85cs_ast_coupling_initialize(int nalimx,
86 cs_real_t epalim);
87
88/*----------------------------------------------------------------------------*/
92/*----------------------------------------------------------------------------*/
93
94void
95cs_ast_coupling_finalize(void);
96
97/*----------------------------------------------------------------------------*/
101/*----------------------------------------------------------------------------*/
102
103void
104cs_ast_coupling_set_coefficients(cs_real_t aexxst,
105 cs_real_t bexxst,
106 cs_real_t cfopre);
107
108/*----------------------------------------------------------------------------*/
117/*----------------------------------------------------------------------------*/
118
119void
120cs_ast_coupling_geometry(cs_lnum_t n_faces,
121 const cs_lnum_t *face_ids,
122 cs_real_t almax);
123
124/*----------------------------------------------------------------------------*/
130/*----------------------------------------------------------------------------*/
131
132void
133cs_ast_coupling_exchange_time_step(cs_real_t c_dt[]);
134
135/*----------------------------------------------------------------------------*/
142/*----------------------------------------------------------------------------*/
143
144cs_real_3_t *
145cs_ast_coupling_get_fluid_forces_pointer(void);
146
147/*----------------------------------------------------------------------------*/
151/*----------------------------------------------------------------------------*/
152
153void
154cs_ast_coupling_send_fluid_forces(void);
155
156/*----------------------------------------------------------------------------*/
160/*----------------------------------------------------------------------------*/
161
162void
163cs_ast_coupling_recv_displacement(void);
164
165/*----------------------------------------------------------------------------*/
169/*----------------------------------------------------------------------------*/
170
171void
172cs_ast_coupling_evaluate_cvg(void);
173
174/*----------------------------------------------------------------------------*/
178/*----------------------------------------------------------------------------*/
179
180void
181cs_ast_coupling_save_values(void);
182
183/*----------------------------------------------------------------------------*/
190/*----------------------------------------------------------------------------*/
191
192void
193cs_ast_coupling_compute_displacement(cs_real_t disp[][3]);
194
195/*----------------------------------------------------------------------------*/
202/*----------------------------------------------------------------------------*/
203
204int
205cs_ast_coupling_get_current_cvg(void);
206
207/*----------------------------------------------------------------------------*/
213/*----------------------------------------------------------------------------*/
214
215cs_real_t
216cs_ast_coupling_get_current_residual(void);
217
218/*----------------------------------------------------------------------------*/
224/*----------------------------------------------------------------------------*/
225
226void
227cs_ast_coupling_set_final_cvg(int icved);
228
229/*----------------------------------------------------------------------------*/
235/*----------------------------------------------------------------------------*/
236
237int
238cs_ast_coupling_get_verbosity(void);
239
240/*----------------------------------------------------------------------------*/
246/*----------------------------------------------------------------------------*/
247
248void
249cs_ast_coupling_set_verbosity(int verbosity);
250
251/*----------------------------------------------------------------------------*/
257/*----------------------------------------------------------------------------*/
258
259int
260cs_ast_coupling_get_visualization(void);
261
262/*----------------------------------------------------------------------------*/
268/*----------------------------------------------------------------------------*/
269
270void
271cs_ast_coupling_set_visualization(int visualization);
272
273/*----------------------------------------------------------------------------*/
274
275END_C_DECLS
276
277#endif /* __CS_AST_COUPLING_H__ */
cs_ast_coupling_save_values
void cs_ast_coupling_save_values(void)
Save previous values.
Definition: cs_ast_coupling.cpp:1163
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.cpp:1194
cs_ast_coupling_recv_displacement
void cs_ast_coupling_recv_displacement(void)
Receive displacements of the fluid/structure interface.
Definition: cs_ast_coupling.cpp:1117
cs_ast_coupling_evaluate_cvg
void cs_ast_coupling_evaluate_cvg(void)
Evaluate convergence of the coupling.
Definition: cs_ast_coupling.cpp:1061
cs_ast_coupling_n_couplings
int cs_ast_coupling_n_couplings(void)
Query number of couplings with code_aster.
Definition: cs_ast_coupling.cpp:479
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.cpp:866
cs_ast_coupling_set_visualization
void cs_ast_coupling_set_visualization(int visualization)
Set visualization level for code_aster coupling.
Definition: cs_ast_coupling.cpp:1407
cs_ast_coupling_get_current_residual
cs_real_t cs_ast_coupling_get_current_residual(void)
Receive convergence value of code_saturne/code_aster coupling.
Definition: cs_ast_coupling.cpp:1319
cs_ast_coupling_set_coefficients
void cs_ast_coupling_set_coefficients(cs_real_t aexxst, cs_real_t bexxst, cs_real_t cfopre)
Set coefficient for prediction.
Definition: cs_ast_coupling.cpp:704
cs_ast_coupling_finalize
void cs_ast_coupling_finalize(void)
Finalize exchange with code_aster.
Definition: cs_ast_coupling.cpp:659
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.cpp:972
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.cpp:1360
cs_ast_coupling_send_fluid_forces
void cs_ast_coupling_send_fluid_forces(void)
Send stresses acting on the fluid/structure interface.
Definition: cs_ast_coupling.cpp:991
cs_ast_coupling_set_final_cvg
void cs_ast_coupling_set_final_cvg(int icved)
Send global convergence value of FSI calculations.
Definition: cs_ast_coupling.cpp:1335
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.cpp:730
cs_ast_coupling_get_current_cvg
int cs_ast_coupling_get_current_cvg(void)
Receive convergence value of code_saturne/code_aster coupling.
Definition: cs_ast_coupling.cpp:1303
cs_ast_coupling_get_visualization
int cs_ast_coupling_get_visualization(void)
Get visualization level for code_aster coupling.
Definition: cs_ast_coupling.cpp:1394
cs_ast_coupling_initialize
void cs_ast_coupling_initialize(int nalimx, cs_real_t epalim)
Initial exchange with code_aster.
Definition: cs_ast_coupling.cpp:501
cs_ast_coupling_set_verbosity
void cs_ast_coupling_set_verbosity(int verbosity)
Set verbosity level for code_aster coupling.
Definition: cs_ast_coupling.cpp:1374
cs_base.h
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:542
cs_real_t
double cs_real_t
Floating-point value.
Definition: cs_defs.h:342
cs_real_3_t
cs_real_t cs_real_3_t[3]
vector of 3 floating-point values
Definition: cs_defs.h:359
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:543
cs_lnum_t
int cs_lnum_t
local mesh entity id
Definition: cs_defs.h:335
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