programmer's 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-2015 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  int irevmc; /* reconstruction of the velocity field with the
56  updated pressure option
57  - 0: default */
58  int iprco; /* compute the pressure step thanks to the
59  continuity equation
60  - 1: true (default)
61  - 0: false */
62  int irnpnw; /* compute the normed residual for the pressure
63  step in the prediction step
64  - 1: true (default)
65  - 0: false */
66  double rnormp; /* normed residual for the pressure step */
67  double arak; /* Arakawa multiplicator for the Rhie and Chow
68  filter (1 by default) */
69  int ipucou; /* pseudo coupled pressure-velocity solver
70  - 1: true (default)
71  - 0: false */
72  int iccvfg; /* calculation with a fixed velocity field
73  - 1: true (default)
74  - 0: false */
75  int idilat; /* algorithm to take into account the density
76  variation in time
77  - 1: dilatable steady algorithm (default)
78  - 2: dilatable unsteady algorithm
79  - 3: low-Mach algorithm
80  - 4: algorithm for fire
81  - 0: boussinesq algorithm with constant
82  density */
83  double epsdp; /* parameter of diagonal pressure strengthening */
84  int itbrrb; /* accurate treatment of the wall temperature
85  - 1: true
86  - 0: false (default) */
87  int iphydr; /* improve hydrostatic pressure algorithm
88  - 1: impose the equilibrium of the hydrostaic
89  part of the pressure with any external force,
90  even head losses
91  - 2: compute an hydrostatic pressure due to
92  buoyancy forces before the prediction step
93  - 0: no treatment (default) */
94  int igprij; /* improve static pressure algorithm
95  - 1: take -div(rho R) in the static pressure
96  treatment IF iphydr=1
97  - 0: no treatment (default) */
98  int igpust; /* improve static pressure algorithm
99  - 1: take user momemtum source terms in the static pressure
100  treatment IF iphydr=1 (default)
101  - 0: no treatment */
102  int iifren; /* indicates the presence of a Bernoulli boundary
103  face (automatically computed)
104  - 0: no face
105  - 1: at least one face */
106  int icalhy; /* compute the hydrostatic pressure in order to
107  compute the Dirichlet conditions on the
108  pressure at outlets
109  - 1: true
110  - 0: false (default) */
111  int irecmf; /* use interpolated face diffusion coefficient instead of
112  cell diffusion coefficient for the mass flux reconstruction
113  for the non-orthogonalities
114  - 1: true
115  - 0: false (default) */
116 
118 
119 /*============================================================================
120  * Static global variables
121  *============================================================================*/
122 
123 /* Pointer to main Stokes model structure */
124 
126 
127 /*=============================================================================
128  * Public function prototypes
129  *============================================================================*/
130 
131 /*----------------------------------------------------------------------------
132  * Provide acces to cs_glob_stokes_model
133  *
134  * needed to initialize structure with GUI
135  *----------------------------------------------------------------------------*/
136 
139 
140 /*----------------------------------------------------------------------------*/
141 
143 
144 #endif /* __CS_STOKES_MODEL_H__ */
int itbrrb
Definition: cs_stokes_model.h:84
int irnpnw
Definition: cs_stokes_model.h:62
double arak
Definition: cs_stokes_model.h:67
int iccvfg
Definition: cs_stokes_model.h:72
int ivisse
Definition: cs_stokes_model.h:53
#define BEGIN_C_DECLS
Definition: cs_defs.h:429
int irecmf
Definition: cs_stokes_model.h:111
int ipucou
Definition: cs_stokes_model.h:69
int irevmc
Definition: cs_stokes_model.h:55
int iifren
Definition: cs_stokes_model.h:102
double rnormp
Definition: cs_stokes_model.h:66
const cs_stokes_model_t * cs_glob_stokes_model
int igpust
Definition: cs_stokes_model.h:98
int icalhy
Definition: cs_stokes_model.h:106
int idilat
Definition: cs_stokes_model.h:75
int iphydr
Definition: cs_stokes_model.h:87
#define END_C_DECLS
Definition: cs_defs.h:430
int iprco
Definition: cs_stokes_model.h:58
Stokes equation model descriptor.
Definition: cs_stokes_model.h:51
cs_stokes_model_t * cs_get_glob_stokes_model(void)
Definition: cs_stokes_model.c:303
double epsdp
Definition: cs_stokes_model.h:83
int igprij
Definition: cs_stokes_model.h:94