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