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-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  - 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 rnormp; /* normed residual for the pressure step */
65  double arak; /* Arakawa multiplicator for the Rhie and Chow
66  filter (1 by default) */
67  int ipucou; /* pseudo coupled pressure-velocity solver
68  - 1: true (default)
69  - 0: false */
70  int iccvfg; /* calculation with a fixed velocity field
71  - 1: true (default)
72  - 0: false */
73  int idilat; /* algorithm to take into account the density
74  variation in time
75  - 1: dilatable steady algorithm (default)
76  - 2: dilatable unsteady algorithm
77  - 3: low-Mach algorithm
78  - 4: algorithm for fire
79  - 0: boussinesq algorithm with constant
80  density */
81  double epsdp; /* parameter of diagonal pressure strengthening */
82  int itbrrb; /* accurate treatment of the wall temperature
83  - 1: true
84  - 0: false (default) */
85  int iphydr; /* improve hydrostatic pressure algorithm
86  - 1: impose the equilibrium of the hydrostaic
87  part of the pressure with any external force,
88  even head losses
89  - 2: compute an hydrostatic pressure due to
90  buoyancy forces before the prediction step
91  - 0: no treatment (default) */
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 
117 
118 /*============================================================================
119  * Static global variables
120  *============================================================================*/
121 
122 /* Pointer to main Stokes model structure */
123 
125 
126 /*=============================================================================
127  * Public function prototypes
128  *============================================================================*/
129 
130 /*----------------------------------------------------------------------------
131  * Provide acces to cs_glob_stokes_model
132  *
133  * needed to initialize structure with GUI
134  *----------------------------------------------------------------------------*/
135 
138 
139 /*----------------------------------------------------------------------------*/
143 /*----------------------------------------------------------------------------*/
144 
145 void
147 
148 /*----------------------------------------------------------------------------*/
149 
151 
152 #endif /* __CS_STOKES_MODEL_H__ */
int itbrrb
Definition: cs_stokes_model.h:82
double arak
Definition: cs_stokes_model.h:65
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:70
int ivisse
Definition: cs_stokes_model.h:53
#define BEGIN_C_DECLS
Definition: cs_defs.h:461
int irecmf
Definition: cs_stokes_model.h:109
int ipucou
Definition: cs_stokes_model.h:67
int irevmc
Definition: cs_stokes_model.h:57
int iifren
Definition: cs_stokes_model.h:100
double rnormp
Definition: cs_stokes_model.h:64
const cs_stokes_model_t * cs_glob_stokes_model
int igpust
Definition: cs_stokes_model.h:96
int icalhy
Definition: cs_stokes_model.h:104
int idilat
Definition: cs_stokes_model.h:73
int iphydr
Definition: cs_stokes_model.h:85
#define END_C_DECLS
Definition: cs_defs.h:462
int iprco
Definition: cs_stokes_model.h:60
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:81
int igprij
Definition: cs_stokes_model.h:92