7.2
general documentation
cs_gwf_param.h
Go to the documentation of this file.
1 #ifndef __CS_GWF_PARAM_H__
2 #define __CS_GWF_PARAM_H__
3 
4 /*============================================================================
5  * Types related to the groundwater flow module
6  *============================================================================*/
7 
8 /*
9  This file is part of code_saturne, a general-purpose CFD tool.
10 
11  Copyright (C) 1998-2022 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  * Local headers
30  *----------------------------------------------------------------------------*/
31 
32 #include "cs_defs.h"
33 
34 /*----------------------------------------------------------------------------*/
35 
37 
38 /*============================================================================
39  * Macro definitions
40  *============================================================================*/
41 
78 #define CS_GWF_POST_SOIL_CAPACITY (1 << 0)
79 #define CS_GWF_POST_LIQUID_SATURATION (1 << 1)
80 #define CS_GWF_POST_PERMEABILITY (1 << 2)
81 #define CS_GWF_POST_DARCY_FLUX_BALANCE (1 << 3)
82 #define CS_GWF_POST_DARCY_FLUX_DIVERGENCE (1 << 4)
83 #define CS_GWF_POST_DARCY_FLUX_AT_BOUNDARY (1 << 5)
84 #define CS_GWF_POST_GAS_MASS_DENSITY (1 << 6)
85 
90 /*============================================================================
91  * Type definitions
92  *============================================================================*/
93 
102 typedef enum {
103 
114 
128 
140 
153 
157 
158 
166 typedef enum {
167 
176  CS_GWF_GRAVITATION = 1<< 0, /* = 1 */
177 
189 
198 
204  CS_GWF_ENFORCE_DIVERGENCE_FREE = 1<< 8 /* = 256 */
205 
207 
240 typedef enum {
241 
245 
247 
249 
257 
268 typedef enum {
269 
276  CS_GWF_TRACER_USER = 1<< 0, /* = 1 */
277 
278  /* Physical phenomena to consider */
279  /* ------------------------------ */
280 
289 
300 
305  CS_GWF_TRACER_PRECIPITATION = 1<< 4, /* = 16 */
306 
308 
313 /*============================================================================
314  * Public function prototypes
315  *============================================================================*/
316 
317 /*----------------------------------------------------------------------------*/
318 
320 
321 #endif /* __CS_GWF_PARAM_H__ */
cs_gwf_soil_model_t
Predefined hydraulic model of soils used in the groundwater flow module.
Definition: cs_gwf_param.h:240
Definition: cs_gwf_param.h:154
Definition: cs_gwf_param.h:204
Single phase (liquid phase) modelling in a porous media.
Definition: cs_gwf_param.h:113
#define BEGIN_C_DECLS
Definition: cs_defs.h:510
cs_gwf_tracer_model_bit_t
Flags specifying the general behavior of a tracer associated to the groundwater flow module...
Definition: cs_gwf_param.h:268
cs_gwf_model_type_t
Type of system of equation(s) to consider for the physical modelling.
Definition: cs_gwf_param.h:102
User-defined tracer.
Definition: cs_gwf_param.h:276
Immiscible two phase flow modelling (gaseous and liquid phases) in porous media.
Definition: cs_gwf_param.h:152
Definition: cs_gwf_param.h:188
Add the precipitation phenomena to the default tracer equation.
Definition: cs_gwf_param.h:305
Definition: cs_gwf_param.h:243
Definition: cs_gwf_param.h:244
Definition: cs_gwf_param.h:176
Miscible two phase flow modelling (gaseous and liquid phases) in porous media.
Definition: cs_gwf_param.h:139
EK model with 3 parameters.
Definition: cs_gwf_param.h:288
Single phase (liquid phase) modelling in a porous media.
Definition: cs_gwf_param.h:127
#define END_C_DECLS
Definition: cs_defs.h:511
unsigned short int cs_flag_t
Definition: cs_defs.h:324
EK model with 5 parameters.
Definition: cs_gwf_param.h:299
cs_flag_t cs_gwf_tracer_model_t
Definition: cs_gwf_param.h:256
Definition: cs_gwf_param.h:246
cs_gwf_model_bit_t
Additional modelling options either from the physical viewpoint or the numerical viewpoint.
Definition: cs_gwf_param.h:166
Definition: cs_gwf_param.h:242
Definition: cs_gwf_param.h:197