#include "cs_advection_field.h"
#include "cs_base.h"
#include "cs_equation.h"

Include dependency graph for cs_gwf_tracer.h:

Data Structures
struct	cs_gwf_std_tracer_input_t

struct	cs_gwf_tracer_t

Typedefs
typedef void()	cs_gwf_tracer_update_t(void input, const cs_mesh_t mesh, const cs_cdo_connect_t connect, const cs_cdo_quantities_t quant, cs_real_t t_eval)
	Generic function to update the phisical properties related to a tracer modelling. More...

typedef void()	cs_gwf_tracer_free_input_t(void *input)
	Generic function to free the input of a tracer model. More...

typedef void()	cs_gwf_tracer_setup_t(const cs_cdo_connect_t connect, const cs_cdo_quantities_t quant, cs_gwf_tracer_t *tracer)
	Generic function to set the parameters related to a tracer equation. More...

typedef void()	cs_gwf_tracer_add_terms_t(cs_gwf_tracer_t *tracer)
	Generic function to update the terms to build in the algebraic system for a tracer equation according to the settings. More...

Enumerations
enum	cs_gwf_tracer_model_t { CS_GWF_TRACER_STANDARD, CS_GWF_TRACER_USER, CS_GWF_N_TRACER_MODELS }

Functions
cs_gwf_tracer_t *	cs_gwf_tracer_init (int tracer_id, const char eq_name, const char var_name, cs_adv_field_t *adv_field, cs_gwf_tracer_model_t model)
	Create a new cs_gwf_tracer_t structure and initialize its members by default. Add a new equation related to the groundwater flow module. This equation is a specific transport equation. Tracer is advected thanks to the darcian velocity which is given by the resolution of the Richards equation. Diffusion/reaction parameters result from a physical modelling. More...

cs_gwf_tracer_t *	cs_gwf_tracer_free (cs_gwf_tracer_t *tracer)
	Free a cs_gwf_tracer_t structure. More...

void	cs_gwf_set_standard_tracer (cs_gwf_tracer_t tracer, const char soil_name, double wmd, double alpha_l, double alpha_t, double distrib_coef, double reaction_rate)
	Set a tracer for a specified soil when the tracer is attached to the default model. More...

void	cs_gwf_tracer_standard_add_terms (cs_gwf_tracer_t *tracer)
	Add terms to the algebraic system related to a tracer equation according to the settings. Case of the standar tracer modelling Rely on the generic functinon: cs_gwf_tracer_add_terms_t. More...

void	cs_gwf_tracer_standard_setup (const cs_cdo_connect_t connect, const cs_cdo_quantities_t quant, cs_gwf_tracer_t *tracer)
	Set the parameters related to a standard tracer equation. More...

Typedef Documentation

◆ cs_gwf_tracer_add_terms_t

typedef void() cs_gwf_tracer_add_terms_t(cs_gwf_tracer_t *tracer)

Generic function to update the terms to build in the algebraic system for a tracer equation according to the settings.

Parameters

[in,out] tracer pointer to a cs_gwf_tracer_t structure

◆ cs_gwf_tracer_free_input_t

typedef void() cs_gwf_tracer_free_input_t(void *input)

Generic function to free the input of a tracer model.

Parameters

[in,out] input pointer to a structure cast on-the-fly

◆ cs_gwf_tracer_setup_t

typedef void() cs_gwf_tracer_setup_t(const cs_cdo_connect_t *connect, const cs_cdo_quantities_t *quant, cs_gwf_tracer_t *tracer)

Generic function to set the parameters related to a tracer equation.

Parameters

[in]	connect	pointer to a cs_cdo_connect_t structure
[in]	quant	pointer to a cs_cdo_quantities_t structure
[in,out]	tracer	pointer to a cs_gwf_tracer_t structure

◆ cs_gwf_tracer_update_t

typedef void() cs_gwf_tracer_update_t(void *input, const cs_mesh_t *mesh, const cs_cdo_connect_t *connect, const cs_cdo_quantities_t *quant, cs_real_t t_eval)

Generic function to update the phisical properties related to a tracer modelling.

Parameters

[in,out]	input	pointer to a structure cast on-the-fly
[in]	mesh	pointer to a cs_mesh_t structure
[in]	connect	pointer to a cs_cdo_connect_t structure
[in]	quant	pointer to a cs_cdo_quantities_t structure
[in]	t_eval	time at which one performs the evaluation

Enumeration Type Documentation

◆ cs_gwf_tracer_model_t

enum cs_gwf_tracer_model_t

Enumerator
CS_GWF_TRACER_STANDARD
CS_GWF_TRACER_USER
CS_GWF_N_TRACER_MODELS

Function Documentation

◆ cs_gwf_set_standard_tracer()

void cs_gwf_set_standard_tracer	(	cs_gwf_tracer_t *	tracer,
		const char *	soil_name,
		double	wmd,
		double	alpha_l,
		double	alpha_t,
		double	distrib_coef,
		double	reaction_rate
	)

Set a tracer for a specified soil when the tracer is attached to the default model.

Parameters

[in,out]	tracer	pointer to a cs_gwf_tracer_t structure
[in]	soil_name	name of the related soil (or NULL if all soils are selected)
[in]	wmd	value of the water molecular diffusivity
[in]	alpha_l	value of the longitudinal dispersivity
[in]	alpha_t	value of the transversal dispersivity
[in]	distrib_coef	value of the distribution coefficient
[in]	reaction_rate	value of the first order rate of reaction

◆ cs_gwf_tracer_free()

cs_gwf_tracer_t* cs_gwf_tracer_free ( cs_gwf_tracer_t * tracer )

Free a cs_gwf_tracer_t structure.

Parameters

[in,out] tracer pointer to a cs_gwf_tracer_t structure

Returns: a NULL pointer

◆ cs_gwf_tracer_init()

cs_gwf_tracer_t* cs_gwf_tracer_init	(	int	tracer_id,
		const char *	eq_name,
		const char *	var_name,
		cs_adv_field_t *	adv_field,
		cs_gwf_tracer_model_t	model
	)

Create a new cs_gwf_tracer_t structure and initialize its members by default. Add a new equation related to the groundwater flow module. This equation is a specific transport equation. Tracer is advected thanks to the darcian velocity which is given by the resolution of the Richards equation. Diffusion/reaction parameters result from a physical modelling.

Parameters

[in]	tracer_id	id number of the soil
[in]	eq_name	name of the tracer equation
[in]	var_name	name of the related variable
[in]	adv_field	pointer to a cs_adv_field_t structure
[in]	model	model related to this tracer

Returns: a pointer to the new allocated structure

◆ cs_gwf_tracer_standard_add_terms()

void cs_gwf_tracer_standard_add_terms ( cs_gwf_tracer_t * tracer )

Add terms to the algebraic system related to a tracer equation according to the settings. Case of the standar tracer modelling Rely on the generic functinon: cs_gwf_tracer_add_terms_t.

Parameters

[in,out] tracer pointer to a cs_gwf_tracer_t structure

Add terms to the algebraic system related to a tracer equation according to the settings. Case of the standar tracer modelling Rely on the generic functinon: cs_gwf_tracer_add_terms_t.

Parameters

[in,out] tracer pointer to a cs_gwf_tracer_t structure

◆ cs_gwf_tracer_standard_setup()

void cs_gwf_tracer_standard_setup	(	const cs_cdo_connect_t *	connect,
		const cs_cdo_quantities_t *	quant,
		cs_gwf_tracer_t *	tracer
	)

Set the parameters related to a standard tracer equation.

Parameters

[in]	connect	pointer to a cs_cdo_connect_t structure
[in]	quant	pointer to a cs_cdo_quantities_t structure
[in,out]	tracer	pointer to a cs_gwf_tracer_t structure

Data Structures

Typedefs

Enumerations

Functions

Typedef Documentation

◆ cs_gwf_tracer_add_terms_t

◆ cs_gwf_tracer_free_input_t

◆ cs_gwf_tracer_setup_t

◆ cs_gwf_tracer_update_t

Enumeration Type Documentation

◆ cs_gwf_tracer_model_t

Function Documentation

◆ cs_gwf_set_standard_tracer()

◆ cs_gwf_tracer_free()

◆ cs_gwf_tracer_init()

◆ cs_gwf_tracer_standard_add_terms()

◆ cs_gwf_tracer_standard_setup()