7.1
general documentation
cs_gwf_soil_t Struct Reference

Main structure to handle a soil in the groundawater flow module. Store a set of parameters and pointers describing a soil. More...

#include <cs_gwf_soil.h>

+ Collaboration diagram for cs_gwf_soil_t:

Data Fields

int id
 
int zone_id
 
double bulk_density
 
double saturated_moisture
 
cs_gwf_soil_hydraulic_model_t model
 
void * context
 
cs_gwf_soil_update_tupdate_properties
 
cs_gwf_soil_free_context_tfree_context
 

Detailed Description

Main structure to handle a soil in the groundawater flow module. Store a set of parameters and pointers describing a soil.

Field Documentation

◆ bulk_density

bulk_density

Value of the mass density of the soil

◆ context

context

Pointer to an context structure which depends on the model. This pointer has to be casted on-the-fly.

◆ free_context

free_context

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

◆ 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. for more details)

◆ saturated_moisture

saturated_moisture

Value of the liquid saturation (or moisture content)

◆ 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: