7.0
general documentation
cs_ale.h
Go to the documentation of this file.
1 #ifndef __CS_ALE_H__
2 #define __CS_ALE_H__
3 
4 /*============================================================================
5  * Functions associated to ALE formulation
6  *============================================================================*/
7 
8 /*
9  This file is part of Code_Saturne, a general-purpose CFD tool.
10 
11  Copyright (C) 1998-2021 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 #include "cs_domain.h"
40 
41 /*----------------------------------------------------------------------------*/
42 
43 BEGIN_C_DECLS
44 
45 /*============================================================================
46  * Type definitions
47  *============================================================================*/
48 
49 /*----------------------------------------------------------------------------
50  * ALE type
51  *----------------------------------------------------------------------------*/
52 
53 enum {
54 
55  CS_ALE_NONE = 0,
56  CS_ALE_LEGACY = 1,
57  CS_ALE_CDO = 2
58 
59 };
60 
61 /*=============================================================================
62  * Global variables
63  *============================================================================*/
64 
65 extern int cs_glob_ale;
66 
67 /*============================================================================
68  * Fortran wrapper function definitions
69  *============================================================================*/
70 
71 /*----------------------------------------------------------------------------
72  * Get pointer to cs_glob_ale
73  *----------------------------------------------------------------------------*/
74 
75 void
76 cs_f_ale_get_pointers(int **iale);
77 
78 /*============================================================================
79  * Public function prototypes
80  *============================================================================*/
81 
82 /*----------------------------------------------------------------------------*/
91 /*----------------------------------------------------------------------------*/
92 
93 void
94 cs_ale_update_mesh_quantities(cs_real_t *min_vol,
95  cs_real_t *max_vol,
96  cs_real_t *tot_vol);
97 
98 /*----------------------------------------------------------------------------*/
111 /*----------------------------------------------------------------------------*/
112 
113 void
114 cs_ale_project_displacement(const int ale_bc_type[],
115  const cs_real_3_t *meshv,
116  const cs_real_33_t gradm[],
117  const cs_real_3_t *claale,
118  const cs_real_33_t *clbale,
119  const cs_real_t *dt,
120  cs_real_3_t *disp_proj);
121 
122 /*----------------------------------------------------------------------------*/
128 /*----------------------------------------------------------------------------*/
129 
130 void
131 cs_ale_update_mesh(const int itrale);
132 
133 /*----------------------------------------------------------------------------*/
140 /*----------------------------------------------------------------------------*/
141 
142 void
143 cs_ale_update_bcs(int *ale_bc_type,
144  cs_real_3_t *b_fluid_vel);
145 
146 /*----------------------------------------------------------------------------*/
157 /*----------------------------------------------------------------------------*/
158 
159 void
160 cs_ale_solve_mesh_velocity(const int iterns,
161  const int *impale,
162  const int *ale_bc_type);
163 
164 /*----------------------------------------------------------------------------*/
168 /*----------------------------------------------------------------------------*/
169 
170 void
171 cs_ale_activate(void);
172 
173 /*----------------------------------------------------------------------------*/
179 /*----------------------------------------------------------------------------*/
180 
181 bool
182 cs_ale_is_activated(void);
183 
184 /*----------------------------------------------------------------------------*/
190 /*----------------------------------------------------------------------------*/
191 
192 void
193 cs_ale_init_setup(cs_domain_t *domain);
194 
195 /*----------------------------------------------------------------------------*/
201 /*----------------------------------------------------------------------------*/
202 
203 void
204 cs_ale_setup_boundaries(const cs_domain_t *domain);
205 
206 /*----------------------------------------------------------------------------*/
212 /*----------------------------------------------------------------------------*/
213 
214 void
215 cs_ale_finalize_setup(cs_domain_t *domain);
216 
217 /*----------------------------------------------------------------------------*/
221 /*----------------------------------------------------------------------------*/
222 
223 void
224 cs_ale_destroy_all(void);
225 
226 /*----------------------------------------------------------------------------*/
227 
228 END_C_DECLS
229 
230 #endif /* __CS_ALE_H__ */
cs_base.h
CS_ALE_CDO
Definition: cs_ale.h:57
cs_ale_update_mesh
void cs_ale_update_mesh(const int itrale)
Update mesh in the ALE framework.
Definition: cs_ale.c:1399
cs_f_ale_get_pointers
void cs_f_ale_get_pointers(int **iale)
Definition: cs_ale.c:92
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:495
cs_glob_ale
int cs_glob_ale
Definition: cs_ale.c:81
cs_real_t
double cs_real_t
Floating-point value.
Definition: cs_defs.h:307
cs_ale_is_activated
bool cs_ale_is_activated(void)
Test if mesh velocity solving with CDO is activated.
Definition: cs_ale.c:1557
cs_ale_update_mesh_quantities
void cs_ale_update_mesh_quantities(cs_real_t *min_vol, cs_real_t *max_vol, cs_real_t *tot_vol)
Compute cell and face centers of gravity, cell volumes and update bad cells.
Definition: cs_ale.c:1142
CS_ALE_NONE
Definition: cs_ale.h:55
cs_ale_destroy_all
void cs_ale_destroy_all(void)
Free the main structure related to the ALE mesh velocity solving.
Definition: cs_ale.c:1756
cs_ale_solve_mesh_velocity
void cs_ale_solve_mesh_velocity(const int iterns, const int *impale, const int *ale_bc_type)
Solve a Poisson equation on the mesh velocity in ALE framework.
Definition: cs_ale.c:1499
cs_domain.h
albase::iale
integer(c_int), pointer, save iale
Activates (=1 o) or not (=0), activate the ALE module:
Definition: albase.f90:45
dt
Definition: cs_field_pointer.h:65
cs_ale_update_bcs
void cs_ale_update_bcs(int *ale_bc_type, cs_real_3_t *b_fluid_vel)
Update ALE BCs for required for the fluid.
Definition: cs_ale.c:1475
cs_ale_init_setup
void cs_ale_init_setup(cs_domain_t *domain)
Setup the equations related to mesh deformation.
Definition: cs_ale.c:1574
cs_domain_t
Structure storing the main features of the computational domain and pointers to the main geometrical ...
Definition: cs_domain.h:88
cs_ale_finalize_setup
void cs_ale_finalize_setup(cs_domain_t *domain)
Finalize the setup stage for the equation of the mesh velocity.
Definition: cs_ale.c:1733
cs_ale_activate
void cs_ale_activate(void)
Activate the mesh velocity solving with CDO.
Definition: cs_ale.c:1517
cs_real_3_t
cs_real_t cs_real_3_t[3]
vector of 3 floating-point values
Definition: cs_defs.h:320
albase::impale
integer, dimension(:), allocatable impale
indicator of imposed displacement
Definition: albase.f90:56
cs_ale_setup_boundaries
void cs_ale_setup_boundaries(const cs_domain_t *domain)
Setup the equations solving the mesh velocity.
Definition: cs_ale.c:1627
cs_ale_project_displacement
void cs_ale_project_displacement(const int ale_bc_type[], const cs_real_3_t *meshv, const cs_real_33_t gradm[], const cs_real_3_t *claale, const cs_real_33_t *clbale, const cs_real_t *dt, cs_real_3_t *disp_proj)
Project the displacement on mesh vertices (solved on cell center).
Definition: cs_ale.c:1175
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:496
cs_real_33_t
cs_real_t cs_real_33_t[3][3]
3x3 matrix of floating-point values
Definition: cs_defs.h:327
CS_ALE_LEGACY
Definition: cs_ale.h:56