8.3
general documentation
cs_gwf_soil_t Struct Reference

Main structure to handle a soil in the groundwater flow module: its definition, the way to update its related properties. More...

#include <cs_gwf_soil.h>

+ Collaboration diagram for cs_gwf_soil_t:

Data Fields

Metadata
int id
 
int zone_id
 
cs_gwf_model_type_t hydraulic_model
 
void * hydraulic_context
 
Soil features (whatever is the soil model)
double bulk_density
 
double porosity
 
int abs_permeability_dim
 
double abs_permeability [3][3]
 
Soil modelling
cs_gwf_soil_model_t model
 
void * model_param
 
Function pointers
cs_gwf_soil_update_tupdate_properties
 
cs_gwf_soil_free_param_tfree_model_param
 

Detailed Description

Main structure to handle a soil in the groundwater flow module: its definition, the way to update its related properties.

Store a set of parameters and pointers describing a soil and its related hydraulic model (this hydraulic model is shared with the main structure cs_gwf_t)

Field Documentation

◆ abs_permeability

abs_permeability

Value of the intrisic permeability in the soil when all the porous media is filled with water (= saturated permeability)

◆ abs_permeability_dim

abs_permeability_dim

=1 if isotropic or =3 if orthotropic or =9 if anisotropic

◆ bulk_density

bulk_density

Value of the mass density of the soil

◆ free_model_param

free_model_param

Pointer to a function which free the param structure if needed. May be set to null if there is nothing to free inside the param structure.

◆ hydraulic_context

hydraulic_context

Structure cast on-the-fly. This structure contains parameters, arrays, properties and fields describing the hydraulic state. It depends on the type of hydraulic model which is considered.

◆ hydraulic_model

hydraulic_model

Type of model use in the groundwater flow module to describe the hydraulic (see cs_gwf_model_type_t for more details)

◆ id

id

id associated to a soil. Position in the array of soils.

◆ model

model

Type of model describing the hydraulic behaviour of a soil (cf. cs_gwf_soil_model_t for more details)

◆ model_param

model_param

Pointer to a structure cast on-the-fly (it depends on the type of soil model). This structure contains the set of parameters describing a soil. Can be set to null in the case of a saturated single-phase model.

◆ porosity

porosity

Max. portion of volume in a soil where the liquid (or the gas) can be. In a single-phase saturated model this corresponds to the saturated moisture or the max. liquid saturation.

◆ update_properties

update_properties

Pointer to a function which manages the update of the properties describing the porous media or used in associated equations (diffusion terms for instance). These functions depend on the model of soil and the type of model used in the groundwater flow module. May be set to null if there is no need to update soil properties.

◆ zone_id

zone_id

id related to a volumic cs_zone_t structure (based on cells)


The documentation for this struct was generated from the following file: