8.0
general documentation
cs_gwf_tracer_t Struct Reference

#include <cs_gwf_tracer.h>

+ Collaboration diagram for cs_gwf_tracer_t:

Data Fields

Physical modelling information for a tracer
cs_gwf_model_type_t hydraulic_model
 
cs_gwf_tracer_model_t model
 
cs_field_tdiffusivity
 
int reaction_id
 
Other members
cs_equation_tequation
 
void * context
 
int chain_position_id
 
int chain_id
 
Function pointers associated to a tracer
cs_gwf_tracer_update_tupdate_diff_pty
 
cs_gwf_tracer_update_tupdate_precipitation
 
cs_gwf_tracer_update_tupdate_decay_chain_st
 
cs_gwf_tracer_integrate_tintegrate
 
cs_gwf_tracer_init_setup_tinit_setup
 
cs_gwf_tracer_finalize_setup_tfinalize_setup
 
cs_gwf_tracer_free_context_tfree_context
 

Field Documentation

◆ chain_id

chain_id

id in the array of decay chains. (-1 if not associated to a decay chain; this is the default behavior)

◆ chain_position_id

chain_position_id

Position of the current tracer inside a decay chain. The default value is -1 meaning that this is not a tracer associated to a decay chain.

◆ context

context

Pointer to a context structure cast on-the-fly according to the model.

◆ diffusivity

diffusivity

Field related to the property associated to the diffusion term. NULL if no diffusion term is build in the tracer equation.

◆ equation

equation

Pointer to the related equation structure

◆ finalize_setup

finalize_setup

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

◆ free_context

free_context

Function to free quantities or structure associated to the context structure of a tracer.

◆ hydraulic_model

hydraulic_model

Type of hydraulic model to consider. This is an information shared with the main gorundwater flow structure

◆ init_setup

init_setup

This is a function pointer to initialize the setup (adding terms in an equation). At this stage, the mesh has not been loaded. There is a function pointer by default but this can be overloaded by a user-defined function in the case of a user-defined tracer.

◆ integrate

integrate

Function to compute the quantity of tracer inside a volume. The way to compute this quantity may be optimized according to the hydraulic model or the tracer modelling.

◆ model

model

Type of tracer model to consider. 0 corresponds to the default behavior.

◆ reaction_id

reaction_id

Since there can be several reaction terms associated to an equation. One stores the id related to the reaction term wich is automatically added when a radioactive tracer is considered.

◆ update_decay_chain_st

update_decay_chain_st

Function used to update the source term induced by the parent in a decay chain

◆ update_diff_pty

update_diff_pty

Function used to update the diffusion property which is a tensor in the most generic case (dispersion + diffusion)

◆ update_precipitation

update_precipitation

Function used to update the quantities related to the precipitation model


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