7.1
general documentation
cs_gwf_t Struct Reference

Main set of parameters/structures to manage the groundwater flow (GWF) module. This is an explicit definition of the structure cs_gwf_t. More...

#include <cs_gwf_priv.h>

+ Collaboration diagram for cs_gwf_t:

Data Fields

Metadata
cs_gwf_model_type_t model
 
cs_gwf_option_flag_t flag
 
cs_flag_t post_flag
 
Properties
cs_property_tabs_permeability
 
Modelling context
void * model_context
 
Associated tracers
int n_tracers
 
cs_gwf_tracer_t ** tracers
 
cs_gwf_tracer_setup_t ** finalize_tracer_setup
 
cs_gwf_tracer_add_terms_t ** add_tracer_terms
 

Detailed Description

Main set of parameters/structures to manage the groundwater flow (GWF) module. This is an explicit definition of the structure cs_gwf_t.

Field Documentation

◆ abs_permeability

abs_permeability

Absolute (or intrinsic) permeability which characterizes the behavior of a soil. According to the model of soil, this absolute permeability can be weigthed by a relative (scalar-valued) permeability. In the simplest case (saturated soil) the relative permeability is useless since this is equal to 1 (no weigth).

◆ add_tracer_terms

add_tracer_terms

This is a function pointer to add non-standard terms in a tracer equation. There is a default pointer but this can be overloaded by a user-defined function in the case of a user-defined tracer.

◆ finalize_tracer_setup

finalize_tracer_setup

This is a function pointer to finalize the setup of a tracer equation. There is a default pointer but this can be overloaded by a user-defined function in the case of a user-defined tracer.

◆ flag

flag

Flag dedicated to general options to handle the GWF module

◆ model

model

Model used to describe the behavior of the flow in the GWF module (system of equations related to the chosen physical modelling). See cs_gwf_model_type_t for more details on each model

◆ model_context

model_context

Pointer to a structure cast on-the-fly which depends on the choice of model (for instance single-phase or two-phase flows in porous media)

◆ n_tracers

n_tracers

Number of tracers to consider. Each tracer is related to a scalar-valued transport equation. There is at least an unsteady term and an advection term. The advection term is linked to the Darcy flux in the liquid phase.

◆ post_flag

post_flag

Flag dedicated to the (automatic) post-processing of the GWF module

◆ tracers

tracers

Array of pointers to the cs_gwf_tracer_t structure which manages each tracer equation and its related quantities/metadata.


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