8.1
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 
84 #define CS_GWF_POST_SOIL_CAPACITY (1 << 0)
85 #define CS_GWF_POST_LIQUID_SATURATION (1 << 1)
86 #define CS_GWF_POST_PERMEABILITY (1 << 2)
87 #define CS_GWF_POST_DARCY_FLUX_BALANCE (1 << 3)
88 #define CS_GWF_POST_DARCY_FLUX_DIVERGENCE (1 << 4)
89 #define CS_GWF_POST_DARCY_FLUX_AT_BOUNDARY (1 << 5)
90 #define CS_GWF_POST_GAS_MASS_DENSITY (1 << 6)
91 #define CS_GWF_POST_SOIL_STATE (1 << 7)
92 #define CS_GWF_POST_SOIL_MINMAX (1 << 8)
93 
98 /*============================================================================
99  * Type definitions
100  *============================================================================*/
101 
110 typedef enum {
111 
114 
116 
126 typedef enum {
127 
138 
152 
164 
177 
181 
182 
190 typedef enum {
191 
200  CS_GWF_GRAVITATION = 1<< 0, /* = 1 */
201 
213 
222 
228  CS_GWF_ENFORCE_DIVERGENCE_FREE = 1<< 8 /* = 256 */
229 
231 
279 typedef enum {
280 
285 
287 
289 
297 
308 typedef enum {
309 
316  CS_GWF_TRACER_USER = 1<< 0, /* = 1 */
317 
318  /* Physical phenomena to consider */
319  /* ------------------------------ */
320 
329 
340 
345  CS_GWF_TRACER_PRECIPITATION = 1<< 4, /* = 16 */
346 
348 
353 /*============================================================================
354  * Public function prototypes
355  *============================================================================*/
356 
357 /*----------------------------------------------------------------------------*/
358 
360 
361 #endif /* __CS_GWF_PARAM_H__ */
#define BEGIN_C_DECLS
Definition: cs_defs.h:514
#define END_C_DECLS
Definition: cs_defs.h:515
unsigned short int cs_flag_t
Definition: cs_defs.h:321
cs_flag_t cs_gwf_tracer_model_t
Definition: cs_gwf_param.h:296
cs_gwf_model_bit_t
Additional modelling options either from the physical viewpoint or the numerical viewpoint.
Definition: cs_gwf_param.h:190
@ CS_GWF_ENFORCE_DIVERGENCE_FREE
Definition: cs_gwf_param.h:228
@ CS_GWF_GRAVITATION
Definition: cs_gwf_param.h:200
@ CS_GWF_FORCE_RICHARDS_ITERATIONS
Definition: cs_gwf_param.h:212
@ CS_GWF_RESCALE_HEAD_TO_ZERO_MEAN_VALUE
Definition: cs_gwf_param.h:221
cs_gwf_model_type_t
Type of system of equation(s) to consider for the physical modelling.
Definition: cs_gwf_param.h:126
@ CS_GWF_MODEL_IMMISCIBLE_TWO_PHASE
Immiscible two phase flow modelling (gaseous and liquid phases) in porous media.
Definition: cs_gwf_param.h:176
@ CS_GWF_MODEL_SATURATED_SINGLE_PHASE
Single phase (liquid phase) model in a saturated porous media.
Definition: cs_gwf_param.h:137
@ CS_GWF_N_MODEL_TYPES
Definition: cs_gwf_param.h:178
@ CS_GWF_MODEL_UNSATURATED_SINGLE_PHASE
Single phase (liquid phase) model in an unsaturated porous media.
Definition: cs_gwf_param.h:151
@ CS_GWF_MODEL_MISCIBLE_TWO_PHASE
Miscible two phase flow modelling (gaseous and liquid phases) in porous media.
Definition: cs_gwf_param.h:163
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:308
@ CS_GWF_TRACER_SORPTION_EK_3_PARAMETERS
EK model with 3 parameters.
Definition: cs_gwf_param.h:328
@ CS_GWF_TRACER_PRECIPITATION
Add the precipitation phenomena to the default tracer equation.
Definition: cs_gwf_param.h:345
@ CS_GWF_TRACER_USER
User-defined tracer.
Definition: cs_gwf_param.h:316
@ CS_GWF_TRACER_SORPTION_EK_5_PARAMETERS
EK model with 5 parameters.
Definition: cs_gwf_param.h:339
cs_gwf_soil_model_t
Predefined hydraulic model of soils used in the groundwater flow module.
Definition: cs_gwf_param.h:279
@ CS_GWF_SOIL_VGM_TWO_PHASE
Definition: cs_gwf_param.h:283
@ CS_GWF_SOIL_USER
Definition: cs_gwf_param.h:284
@ CS_GWF_SOIL_VGM_SINGLE_PHASE
Definition: cs_gwf_param.h:282
@ CS_GWF_SOIL_N_HYDRAULIC_MODELS
Definition: cs_gwf_param.h:286
@ CS_GWF_SOIL_SATURATED
Definition: cs_gwf_param.h:281
cs_gwf_tracer_unit_t
Type of unit for the expression of the radioactive inventory.
Definition: cs_gwf_param.h:110
@ CS_GWF_TRACER_UNIT_BECQUEREL
Definition: cs_gwf_param.h:112
@ CS_GWF_TRACER_UNIT_MOLE
Definition: cs_gwf_param.h:113