9.2
general documentation
cs_aster_coupling.h
Go to the documentation of this file.
1#ifndef CS_ASTER_COUPLING_H
2#define CS_ASTER_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-2026 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 "base/cs_base.h"
39
40/*=============================================================================
41 * Local Macro Definitions
42 *============================================================================*/
43
44/*============================================================================
45 * Structure definition
46 *============================================================================*/
47
48typedef struct _cs_aster_coupling_t cs_aster_coupling_t;
49
50/*============================================================================
51 * Global variable definitions
52 *============================================================================*/
53
54/*============================================================================
55 * Public function prototypes
56 *============================================================================*/
57
58/*----------------------------------------------------------------------------*/
64/*----------------------------------------------------------------------------*/
65
66int
67cs_aster_coupling_n_couplings(void);
68
69/*----------------------------------------------------------------------------*/
78/*----------------------------------------------------------------------------*/
79
80void
81cs_aster_coupling_initialize(int nalimx, cs_real_t epalim);
82
83/*----------------------------------------------------------------------------*/
87/*----------------------------------------------------------------------------*/
88
89void
90cs_aster_coupling_finalize(void);
91
92/*----------------------------------------------------------------------------*/
96/*----------------------------------------------------------------------------*/
97
98void
99cs_aster_coupling_set_coefficients(cs_real_t aexxst,
100 cs_real_t bexxst,
101 cs_real_t cfopre);
102
103/*----------------------------------------------------------------------------*/
112/*----------------------------------------------------------------------------*/
113
114void
115cs_aster_coupling_geometry(cs_lnum_t n_faces,
116 const cs_lnum_t *face_ids,
117 cs_real_t almax);
118
119/*----------------------------------------------------------------------------*/
125/*----------------------------------------------------------------------------*/
126
127void
128cs_aster_coupling_exchange_time_step(cs_real_t c_dt[]);
129
130/*----------------------------------------------------------------------------*/
137/*----------------------------------------------------------------------------*/
138
139cs_real_3_t *
140cs_aster_coupling_get_bstress_pointer(void);
141
142/*----------------------------------------------------------------------------*/
146/*----------------------------------------------------------------------------*/
147
148void
149cs_aster_coupling_send_bstress(void);
150
151/*----------------------------------------------------------------------------*/
155/*----------------------------------------------------------------------------*/
156
157void
158cs_aster_coupling_recv_displacement(void);
159
160/*----------------------------------------------------------------------------*/
164/*----------------------------------------------------------------------------*/
165
166void
167cs_aster_coupling_evaluate_cvg(void);
168
169/*----------------------------------------------------------------------------*/
173/*----------------------------------------------------------------------------*/
174
175void
176cs_aster_coupling_save_values(void);
177
178/*----------------------------------------------------------------------------*/
185/*----------------------------------------------------------------------------*/
186
187void
188cs_aster_coupling_compute_displacement(cs_real_t disp[][3]);
189
190/*----------------------------------------------------------------------------*/
197/*----------------------------------------------------------------------------*/
198
199int
200cs_aster_coupling_get_current_cvg(void);
201
202/*----------------------------------------------------------------------------*/
208/*----------------------------------------------------------------------------*/
209
210cs_real_t
211cs_aster_coupling_get_current_residual(void);
212
213/*----------------------------------------------------------------------------*/
219/*----------------------------------------------------------------------------*/
220
221void
222cs_aster_coupling_set_final_cvg(int icved);
223
224/*----------------------------------------------------------------------------*/
230/*----------------------------------------------------------------------------*/
231
232int
233cs_aster_coupling_get_verbosity(void);
234
235/*----------------------------------------------------------------------------*/
241/*----------------------------------------------------------------------------*/
242
243void
244cs_aster_coupling_set_verbosity(int verbosity);
245
246/*----------------------------------------------------------------------------*/
252/*----------------------------------------------------------------------------*/
253
254int
255cs_aster_coupling_get_visualization(void);
256
257/*----------------------------------------------------------------------------*/
263/*----------------------------------------------------------------------------*/
264
265void
266cs_aster_coupling_set_visualization(int visualization);
267
268/*----------------------------------------------------------------------------*/
269
270#endif /* CS_ASTER_COUPLING_H */
cs_aster_coupling_set_final_cvg
void cs_aster_coupling_set_final_cvg(int icved)
Send global convergence value of FSI calculations.
Definition: cs_aster_coupling.cpp:1559
cs_aster_coupling_get_current_cvg
int cs_aster_coupling_get_current_cvg(void)
Receive convergence value of code_saturne/code_aster coupling.
Definition: cs_aster_coupling.cpp:1527
cs_aster_coupling_set_coefficients
void cs_aster_coupling_set_coefficients(cs_real_t aexxst, cs_real_t bexxst, cs_real_t cfopre)
Set coefficient for prediction.
Definition: cs_aster_coupling.cpp:865
cs_aster_coupling_compute_displacement
void cs_aster_coupling_compute_displacement(cs_real_t disp[][3])
Compute predicted or exact displacement of the fluid/structure interface.
Definition: cs_aster_coupling.cpp:1410
cs_aster_coupling_send_bstress
void cs_aster_coupling_send_bstress(void)
Send boundary stresse acting on the fluid/structure interface.
Definition: cs_aster_coupling.cpp:1168
cs_aster_coupling_finalize
void cs_aster_coupling_finalize(void)
Finalize exchange with code_aster.
Definition: cs_aster_coupling.cpp:815
cs_aster_coupling_t
struct _cs_aster_coupling_t cs_aster_coupling_t
Definition: cs_aster_coupling.h:48
cs_aster_coupling_get_visualization
int cs_aster_coupling_get_visualization(void)
Get visualization level for code_aster coupling.
Definition: cs_aster_coupling.cpp:1616
cs_aster_coupling_set_visualization
void cs_aster_coupling_set_visualization(int visualization)
Set visualization level for code_aster coupling.
Definition: cs_aster_coupling.cpp:1629
cs_aster_coupling_initialize
void cs_aster_coupling_initialize(int nalimx, cs_real_t epalim)
Initial exchange with code_aster.
Definition: cs_aster_coupling.cpp:643
cs_aster_coupling_exchange_time_step
void cs_aster_coupling_exchange_time_step(cs_real_t c_dt[])
Exchange time-step information with code_aster.
Definition: cs_aster_coupling.cpp:1048
cs_aster_coupling_n_couplings
int cs_aster_coupling_n_couplings(void)
Query number of couplings with code_aster.
Definition: cs_aster_coupling.cpp:621
cs_aster_coupling_geometry
void cs_aster_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_aster_coupling.cpp:891
cs_aster_coupling_get_bstress_pointer
cs_real_3_t * cs_aster_coupling_get_bstress_pointer(void)
Return pointer to array of boundary stress at faces coupled with code_aster.
Definition: cs_aster_coupling.cpp:1149
cs_aster_coupling_set_verbosity
void cs_aster_coupling_set_verbosity(int verbosity)
Set verbosity level for code_aster coupling.
Definition: cs_aster_coupling.cpp:1597
cs_aster_coupling_get_verbosity
int cs_aster_coupling_get_verbosity(void)
Get verbosity level for code_aster coupling.
Definition: cs_aster_coupling.cpp:1583
cs_aster_coupling_recv_displacement
void cs_aster_coupling_recv_displacement(void)
Receive displacements of the fluid/structure interface.
Definition: cs_aster_coupling.cpp:1335
cs_aster_coupling_get_current_residual
cs_real_t cs_aster_coupling_get_current_residual(void)
Receive convergence value of code_saturne/code_aster coupling.
Definition: cs_aster_coupling.cpp:1543
cs_aster_coupling_evaluate_cvg
void cs_aster_coupling_evaluate_cvg(void)
Evaluate convergence of the coupling.
Definition: cs_aster_coupling.cpp:1276
cs_aster_coupling_save_values
void cs_aster_coupling_save_values(void)
Save previous values.
Definition: cs_aster_coupling.cpp:1379
cs_base.h
cs_real_t
double cs_real_t
Floating-point value.
Definition: cs_defs.h:332
cs_real_3_t
cs_real_t cs_real_3_t[3]
vector of 3 floating-point values
Definition: cs_defs.h:349
cs_lnum_t
int cs_lnum_t
local mesh entity id
Definition: cs_defs.h:325