8.3
general documentation
cs_gwf_param.h File Reference
#include "cs_defs.h"
+ Include dependency graph for cs_gwf_param.h:

Go to the source code of this file.

Macros

Flags specifying the kind of post-processing to perform in

the groundwater flow module

#define CS_GWF_POST_SOIL_CAPACITY   (1 << 0)
 Activate the post-processing of the soil capacity (property in front of the unsteady term in Richards equation) More...
 
#define CS_GWF_POST_LIQUID_SATURATION   (1 << 1)
 Activate the post-processing of the liquid saturation (also nammed "moisture content" in case of single phase flow) More...
 
#define CS_GWF_POST_PERMEABILITY   (1 << 2)
 Activate the post-processing of the permeability field. More...
 
#define CS_GWF_POST_DARCY_FLUX_BALANCE   (1 << 3)
 Compute the overall balance at the different boundaries of the Darcy flux. More...
 
#define CS_GWF_POST_DARCY_FLUX_DIVERGENCE   (1 << 4)
 Compute in each control volume (vertices or cells w.r.t the space scheme) the divergence of the Darcy flux. More...
 
#define CS_GWF_POST_DARCY_FLUX_AT_BOUNDARY   (1 << 5)
 Define a field at boundary faces for the Darcy flux and activate the post-processing. More...
 
#define CS_GWF_POST_COMPONENT_MASS_DENSITY   (1 << 6)
 Compute the mass density of the component which is mainly present in the gaseous phase. This option makes sense only for a miscible or immiscible two-phase flow model. One recalls that one assumes that there is no water in the gas phase and that the mass density is a function of the gas pressure through a perfect gas law. More...
 
#define CS_GWF_POST_SOIL_STATE   (1 << 7)
 State of the soil among "saturated", "unsaturated", "dry". More...
 
#define CS_GWF_POST_SOIL_MINMAX   (1 << 8)
 Output the min./max. of all pressures and the liquid saturation in each soil for each time step. The output file is named 'gwf.log'. More...
 

Enumerations

enum  cs_gwf_model_bit_t {
  CS_GWF_GRAVITATION = 1<< 0 , CS_GWF_GRAVITATION = 1<< 0 , CS_GWF_FORCE_RICHARDS_ITERATIONS = 1<< 6 , CS_GWF_FORCE_RICHARDS_ITERATIONS = 1<< 6 ,
  CS_GWF_RESCALE_HEAD_TO_ZERO_MEAN_VALUE = 1<< 7 , CS_GWF_RESCALE_HEAD_TO_ZERO_MEAN_VALUE = 1<< 7 , CS_GWF_ENFORCE_DIVERGENCE_FREE = 1<< 8 , CS_GWF_ENFORCE_DIVERGENCE_FREE = 1<< 8
}
 Additional modelling options either from the physical viewpoint or the numerical viewpoint. More...
 
Type of unit used for the inventory of radioactive tracers
enum  cs_gwf_tracer_unit_t { CS_GWF_TRACER_UNIT_BECQUEREL , CS_GWF_TRACER_UNIT_MOLE }
 Type of unit for the expression of the radioactive inventory. More...
 
Model definition for the groundwater flow module
enum  cs_gwf_model_type_t {
  CS_GWF_MODEL_SATURATED_SINGLE_PHASE , CS_GWF_MODEL_UNSATURATED_SINGLE_PHASE , CS_GWF_MODEL_MISCIBLE_TWO_PHASE , CS_GWF_MODEL_IMMISCIBLE_TWO_PHASE ,
  CS_GWF_N_MODEL_TYPES
}
 Type of system of equation(s) to consider for the physical modelling. More...
 

Soil modelling

enum  cs_gwf_soil_model_t {
  CS_GWF_SOIL_SATURATED , CS_GWF_SOIL_VGM_SINGLE_PHASE , CS_GWF_SOIL_VGM_TWO_PHASE , CS_GWF_SOIL_USER ,
  CS_GWF_SOIL_N_HYDRAULIC_MODELS
}
 Predefined hydraulic model of soils used in the groundwater flow module. More...
 

Tracer modelling

enum  cs_gwf_tracer_model_bit_t { CS_GWF_TRACER_USER = 1<< 0 , CS_GWF_TRACER_SORPTION_EK_3_PARAMETERS = 1<< 2 , CS_GWF_TRACER_SORPTION_EK_5_PARAMETERS = 1<< 3 , CS_GWF_TRACER_PRECIPITATION = 1<< 4 }
 Flags specifying the general behavior of a tracer associated to the groundwater flow module. More...
 
typedef cs_flag_t cs_gwf_tracer_model_t
 Flags specifying the general behavior of a tracer associated to the groundwater flow module. More...
 

Macro Definition Documentation

◆ CS_GWF_POST_COMPONENT_MASS_DENSITY

#define CS_GWF_POST_COMPONENT_MASS_DENSITY   (1 << 6)

Compute the mass density of the component which is mainly present in the gaseous phase. This option makes sense only for a miscible or immiscible two-phase flow model. One recalls that one assumes that there is no water in the gas phase and that the mass density is a function of the gas pressure through a perfect gas law.

◆ CS_GWF_POST_DARCY_FLUX_AT_BOUNDARY

#define CS_GWF_POST_DARCY_FLUX_AT_BOUNDARY   (1 << 5)

Define a field at boundary faces for the Darcy flux and activate the post-processing.

◆ CS_GWF_POST_DARCY_FLUX_BALANCE

#define CS_GWF_POST_DARCY_FLUX_BALANCE   (1 << 3)

Compute the overall balance at the different boundaries of the Darcy flux.

◆ CS_GWF_POST_DARCY_FLUX_DIVERGENCE

#define CS_GWF_POST_DARCY_FLUX_DIVERGENCE   (1 << 4)

Compute in each control volume (vertices or cells w.r.t the space scheme) the divergence of the Darcy flux.

◆ CS_GWF_POST_LIQUID_SATURATION

#define CS_GWF_POST_LIQUID_SATURATION   (1 << 1)

Activate the post-processing of the liquid saturation (also nammed "moisture content" in case of single phase flow)

◆ CS_GWF_POST_PERMEABILITY

#define CS_GWF_POST_PERMEABILITY   (1 << 2)

Activate the post-processing of the permeability field.

◆ CS_GWF_POST_SOIL_CAPACITY

#define CS_GWF_POST_SOIL_CAPACITY   (1 << 0)

Activate the post-processing of the soil capacity (property in front of the unsteady term in Richards equation)

◆ CS_GWF_POST_SOIL_MINMAX

#define CS_GWF_POST_SOIL_MINMAX   (1 << 8)

Output the min./max. of all pressures and the liquid saturation in each soil for each time step. The output file is named 'gwf.log'.

◆ CS_GWF_POST_SOIL_STATE

#define CS_GWF_POST_SOIL_STATE   (1 << 7)

State of the soil among "saturated", "unsaturated", "dry".

Typedef Documentation

◆ cs_gwf_tracer_model_t

Flags specifying the general behavior of a tracer associated to the groundwater flow module.

Elemental modelling choice either from the physical viewpoint or the numerical viewpoint for the transport of a tracer

Enumeration Type Documentation

◆ cs_gwf_model_bit_t

Additional modelling options either from the physical viewpoint or the numerical viewpoint.

Enumerator
CS_GWF_GRAVITATION 
CS_GWF_GRAVITATION 
CS_GWF_FORCE_RICHARDS_ITERATIONS 
CS_GWF_FORCE_RICHARDS_ITERATIONS 
CS_GWF_RESCALE_HEAD_TO_ZERO_MEAN_VALUE 
CS_GWF_RESCALE_HEAD_TO_ZERO_MEAN_VALUE 
CS_GWF_ENFORCE_DIVERGENCE_FREE 
CS_GWF_ENFORCE_DIVERGENCE_FREE 

◆ cs_gwf_model_type_t

Type of system of equation(s) to consider for the physical modelling.

Enumerator
CS_GWF_MODEL_SATURATED_SINGLE_PHASE 

Single phase (liquid phase) model in a saturated porous media.

All soils are assumed to be saturated. This yields several simplifications in the Richards equation governing the water conservation. The Richards equation is steady. The saturation is constant and there is no relative permeability.

CS_GWF_MODEL_UNSATURATED_SINGLE_PHASE 

Single phase (liquid phase) model in an unsaturated porous media.

All soils are considered as unsaturated and are described by a more complex modelling such as the Van Genuchten-Mualem model. Simplifications made in the case of CS_GWF_MODEL_SATURATED_SINGLE_PHASE do not hold anymore. Richards equation is unsteady and there can be a non-linearity to handle according to the type of soil model. Soil properties such as permeability, soil capacity and liquid saturation (also called moisture content) are neither uniform nor steady.

CS_GWF_MODEL_MISCIBLE_TWO_PHASE 

Miscible two phase flow modelling (gaseous and liquid phases) in porous media.

A Richards-like equation is considered in each phase to take into account the mass conservation of water and one other component. The component can be disolved in the liquid phase. No water vapour is taken into account. Please refer to cs_gwf_tpf_t for more details.

CS_GWF_MODEL_IMMISCIBLE_TWO_PHASE 

Immiscible two phase flow modelling (gaseous and liquid phases) in porous media.

A Richards-like equation is considered in each phase to take into account the mass conservation of water in the liquid phase and the conservation of the other component in the gaseous phase. The model context is shared with the miscible two-phase flow model. Please refer to cs_gwf_tpf_t for more details.

CS_GWF_N_MODEL_TYPES 

Number of predefined models (not a model)

◆ cs_gwf_soil_model_t

Predefined hydraulic model of soils used in the groundwater flow module.

Enumerator
CS_GWF_SOIL_SATURATED 

Hydraulic model of soild where the soil is considered as saturated. In this model, there no evolution taken into account. The liquid saturation and the permeability are considered as constant.

CS_GWF_SOIL_VGM_SINGLE_PHASE 

Van Genuchten-Mualem laws defining the evolution of the effective liquid saturation (also called dimensionless moisture content) and the relative permeability in the case of (unsaturated) single-phase flow in a porous media

The (effective) liquid saturation (also called moisture content) follows the identity: S_l,eff = (S_l - theta_r)/(theta_s - theta_r) = (1 + |alpha . h|^n)^(-m)

The isotropic relative permeability is defined as: k_r = S_l,eff^L * (1 - (1 - S_l,eff^(1/m))^m))^2 where m = 1 - 1/n

CS_GWF_SOIL_VGM_TWO_PHASE 

Van Genuchten-Mualem laws defining the evolution of the effective liquid saturation, the relative permeabilities in the liquid and gaz in the case of (unsaturated) two-phase flow in a porous media

The (effective) liquid saturation follows the identity sl_eff = (sl - sl_r)/(sl_s - sl_r) = (1 + |Pc/Pr_r|^n)^(-m) where m = 1 - 1/n

The isotropic relative permeability in the liquid and gaz are defined as: krl = sl_eff^(1/2) * (1 - (1 - sl_eff^(1/m))^m))^2 krg = (1 - sl_eff)^(1/2) * (1 - sl_eff^(1/m))^(2m)

CS_GWF_SOIL_USER 

User-defined model of soil

CS_GWF_SOIL_N_HYDRAULIC_MODELS 

◆ cs_gwf_tracer_model_bit_t

Flags specifying the general behavior of a tracer associated to the groundwater flow module.

Elemental modelling choice either from the physical viewpoint or the numerical viewpoint for the transport of a tracer

Enumerator
CS_GWF_TRACER_USER 

User-defined tracer.

All terms can be modified with user functions

CS_GWF_TRACER_SORPTION_EK_3_PARAMETERS 

EK model with 3 parameters.

Add the sorption phenomena to the default tracer equation. Case of the EK model with 3 parameters. Sorption is assumed to be infinite

CS_GWF_TRACER_SORPTION_EK_5_PARAMETERS 

EK model with 5 parameters.

Add the sorption phenomena to the default tracer equation in the case of the EK model with 5 parameters. Sorption is assumed to be finite. An additional equation related to the concentration of sorpted tracer in the second kind of sites.

CS_GWF_TRACER_PRECIPITATION 

Add the precipitation phenomena to the default tracer equation.

◆ cs_gwf_tracer_unit_t

Type of unit for the expression of the radioactive inventory.

Enumerator
CS_GWF_TRACER_UNIT_BECQUEREL 
CS_GWF_TRACER_UNIT_MOLE