6.3
general documentation
cs_stokes_model.h
Go to the documentation of this file.
1 #ifndef __CS_STOKES_MODEL_H__
2 #define __CS_STOKES_MODEL_H__
3 
4 /*============================================================================
5  * Stokes equation model data.
6  *============================================================================*/
7 
8 /*
9  This file is part of Code_Saturne, a general-purpose CFD tool.
10 
11  Copyright (C) 1998-2020 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  * Local headers
32  *----------------------------------------------------------------------------*/
33 
34 #include "cs_defs.h"
35 
36 /*----------------------------------------------------------------------------*/
37 
39 
40 /*=============================================================================
41  * Macro definitions
42  *============================================================================*/
43 
44 /*============================================================================
45  * Type definitions
46  *============================================================================*/
47 
48 /* Stokes equation model descriptor */
49 /*---------------------------*/
50 
51 typedef struct {
52 
53  int ivisse; /* take viscous term of transposed velocity
54  gradient into account in momentum equation
55  - 1: true (default)
56  - 0: false */
57  int irevmc; /* reconstruction of the velocity field with the
58  updated pressure option
59  - 0: default */
60  int iprco; /* compute the pressure step thanks to the
61  continuity equation
62  - 1: true (default)
63  - 0: false */
64  double arak; /* Arakawa multiplicator for the Rhie and Chow
65  filter (1 by default) */
66  int rcfact; /* Indicates the factor of the Rhie and Chow
67  filter
68  - 1: dt (default)
69  - 0: 1/A_u */
70  int ipucou; /* pseudo coupled pressure-velocity solver
71  - 1: true (default)
72  - 0: false */
73  int iccvfg; /* calculation with a fixed velocity field
74  - 1: true (default)
75  - 0: false */
76  int idilat; /* algorithm to take into account the density
77  variation in time
78  - 1: dilatable steady algorithm (default)
79  - 2: dilatable unsteady algorithm
80  - 3: low-Mach algorithm
81  - 4: algorithm for fire
82  - 0: boussinesq algorithm with constant
83  density */
84  double epsdp; /* parameter of diagonal pressure strengthening */
85  int itbrrb; /* accurate treatment of the wall temperature
86  - 1: true
87  - 0: false (default) */
88  int iphydr; /* improve hydrostatic pressure algorithm
89  - 1: impose the equilibrium of the hydrostaic
90  part of the pressure with any external force,
91  even head losses */
92  int igprij; /* improve static pressure algorithm
93  - 1: take -div(rho R) in the static pressure
94  treatment IF iphydr=1
95  - 0: no treatment (default) */
96  int igpust; /* improve static pressure algorithm
97  - 1: take user momemtum source terms in the
98  static pressure treatment IF iphydr=1 (default)
99  - 0: no treatment */
100  int iifren; /* indicates the presence of a Bernoulli boundary
101  face (automatically computed)
102  - 0: no face
103  - 1: at least one face */
104  int icalhy; /* compute the hydrostatic pressure in order to
105  compute the Dirichlet conditions on the
106  pressure at outlets
107  - 1: true
108  - 0: false (default) */
109  int irecmf; /* use interpolated face diffusion coefficient
110  instead of cell diffusion coefficient for the
111  mass flux reconstruction for the
112  non-orthogonalities
113  - 1: true
114  - 0: false (default) */
115  bool fluid_solid; /* Has a solid zone where dynamics must be killed?
116  - false (default)
117  - true */
118 
120 
121 /*============================================================================
122  * Static global variables
123  *============================================================================*/
124 
125 /* Pointer to main Stokes model structure */
126 
128 
129 /*=============================================================================
130  * Public function prototypes
131  *============================================================================*/
132 
133 /*----------------------------------------------------------------------------
134  * Provide access to cs_glob_stokes_model
135  *
136  * needed to initialize structure with GUI
137  *----------------------------------------------------------------------------*/
138 
141 
142 /*----------------------------------------------------------------------------*/
146 /*----------------------------------------------------------------------------*/
147 
148 void
150 
151 /*----------------------------------------------------------------------------*/
152 
154 
155 #endif /* __CS_STOKES_MODEL_H__ */
cs_stokes_model_t::igprij
int igprij
Definition: cs_stokes_model.h:92
cs_defs.h
cs_stokes_model_t::igpust
int igpust
Definition: cs_stokes_model.h:96
cs_stokes_model_t::ivisse
int ivisse
Definition: cs_stokes_model.h:53
cs_stokes_model_t::irevmc
int irevmc
Definition: cs_stokes_model.h:57
cs_stokes_model_t::icalhy
int icalhy
Definition: cs_stokes_model.h:104
cs_stokes_model_t::arak
double arak
Definition: cs_stokes_model.h:64
cs_glob_stokes_model
const cs_stokes_model_t * cs_glob_stokes_model
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:493
cs_stokes_model_log_setup
void cs_stokes_model_log_setup(void)
Print the stokes model parameters to setup.log.
Definition: cs_stokes_model.c:385
cs_get_glob_stokes_model
cs_stokes_model_t * cs_get_glob_stokes_model(void)
Definition: cs_stokes_model.c:373
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:492
cs_stokes_model_t::iifren
int iifren
Definition: cs_stokes_model.h:100
cs_stokes_model_t::itbrrb
int itbrrb
Definition: cs_stokes_model.h:85
cs_stokes_model_t::epsdp
double epsdp
Definition: cs_stokes_model.h:84
cs_stokes_model_t::idilat
int idilat
Definition: cs_stokes_model.h:76
cs_stokes_model_t::iccvfg
int iccvfg
Definition: cs_stokes_model.h:73
cs_stokes_model_t::fluid_solid
bool fluid_solid
Definition: cs_stokes_model.h:115
cs_stokes_model_t
Stokes equation model descriptor.
Definition: cs_stokes_model.h:51
cs_stokes_model_t::iphydr
int iphydr
Definition: cs_stokes_model.h:88
cs_stokes_model_t::ipucou
int ipucou
Definition: cs_stokes_model.h:70
cs_stokes_model_t::iprco
int iprco
Definition: cs_stokes_model.h:60
cs_stokes_model_t::rcfact
int rcfact
Definition: cs_stokes_model.h:66
cs_stokes_model_t::irecmf
int irecmf
Definition: cs_stokes_model.h:109