8.0
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-2023 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 
106 
108 
118 typedef enum {
119 
130 
144 
156 
169 
173 
174 
182 typedef enum {
183 
192  CS_GWF_GRAVITATION = 1<< 0, /* = 1 */
193 
205 
214 
220  CS_GWF_ENFORCE_DIVERGENCE_FREE = 1<< 8 /* = 256 */
221 
223 
256 typedef enum {
257 
261 
263 
265 
273 
284 typedef enum {
285 
292  CS_GWF_TRACER_USER = 1<< 0, /* = 1 */
293 
294  /* Physical phenomena to consider */
295  /* ------------------------------ */
296 
305 
316 
321  CS_GWF_TRACER_PRECIPITATION = 1<< 4, /* = 16 */
322 
324 
329 /*============================================================================
330  * Public function prototypes
331  *============================================================================*/
332 
333 /*----------------------------------------------------------------------------*/
334 
336 
337 #endif /* __CS_GWF_PARAM_H__ */
#define BEGIN_C_DECLS
Definition: cs_defs.h:509
#define END_C_DECLS
Definition: cs_defs.h:510
unsigned short int cs_flag_t
Definition: cs_defs.h:321
cs_flag_t cs_gwf_tracer_model_t
Definition: cs_gwf_param.h:272
cs_gwf_model_bit_t
Additional modelling options either from the physical viewpoint or the numerical viewpoint.
Definition: cs_gwf_param.h:182
@ CS_GWF_ENFORCE_DIVERGENCE_FREE
Definition: cs_gwf_param.h:220
@ CS_GWF_GRAVITATION
Definition: cs_gwf_param.h:192
@ CS_GWF_FORCE_RICHARDS_ITERATIONS
Definition: cs_gwf_param.h:204
@ CS_GWF_RESCALE_HEAD_TO_ZERO_MEAN_VALUE
Definition: cs_gwf_param.h:213
cs_gwf_model_type_t
Type of system of equation(s) to consider for the physical modelling.
Definition: cs_gwf_param.h:118
@ CS_GWF_MODEL_IMMISCIBLE_TWO_PHASE
Immiscible two phase flow modelling (gaseous and liquid phases) in porous media.
Definition: cs_gwf_param.h:168
@ CS_GWF_MODEL_SATURATED_SINGLE_PHASE
Single phase (liquid phase) modelling in a porous media.
Definition: cs_gwf_param.h:129
@ CS_GWF_N_MODEL_TYPES
Definition: cs_gwf_param.h:170
@ CS_GWF_MODEL_UNSATURATED_SINGLE_PHASE
Single phase (liquid phase) modelling in a porous media.
Definition: cs_gwf_param.h:143
@ CS_GWF_MODEL_MISCIBLE_TWO_PHASE
Miscible two phase flow modelling (gaseous and liquid phases) in porous media.
Definition: cs_gwf_param.h:155
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:284
@ CS_GWF_TRACER_SORPTION_EK_3_PARAMETERS
EK model with 3 parameters.
Definition: cs_gwf_param.h:304
@ CS_GWF_TRACER_PRECIPITATION
Add the precipitation phenomena to the default tracer equation.
Definition: cs_gwf_param.h:321
@ CS_GWF_TRACER_USER
User-defined tracer.
Definition: cs_gwf_param.h:292
@ CS_GWF_TRACER_SORPTION_EK_5_PARAMETERS
EK model with 5 parameters.
Definition: cs_gwf_param.h:315
cs_gwf_soil_model_t
Predefined hydraulic model of soils used in the groundwater flow module.
Definition: cs_gwf_param.h:256
@ CS_GWF_SOIL_USER
Definition: cs_gwf_param.h:260
@ CS_GWF_SOIL_N_HYDRAULIC_MODELS
Definition: cs_gwf_param.h:262
@ CS_GWF_SOIL_SATURATED
Definition: cs_gwf_param.h:259
@ CS_GWF_SOIL_GENUCHTEN
Definition: cs_gwf_param.h:258
cs_gwf_tracer_unit_t
Type of unit for the expression of the radioactive inventory.
Definition: cs_gwf_param.h:102
@ CS_GWF_TRACER_UNIT_BECQUEREL
Definition: cs_gwf_param.h:104
@ CS_GWF_TRACER_UNIT_MOLE
Definition: cs_gwf_param.h:105