cs_gwf_priv.h File Reference

#include "cs_advection_field.h"
#include "cs_equation_system.h"
#include "cs_gwf_param.h"
#include "cs_param_sles.h"

Include dependency graph for cs_gwf_priv.h:

Go to the source code of this file.

Data Structures
struct	cs_gwf_darcy_flux_t
struct	cs_gwf_saturated_single_phase_t
	Structure to handle the modelling of a single-phase flows in a porous media considered as saturated. More...
struct	cs_gwf_unsaturated_single_phase_t
	Structure to handle the modelling of a single-phase flows in a porous media considered as saturated or not. Several simplifications can be be operated in this context. Only the liquid phase is taken into account. More...
struct	cs_gwf_two_phase_t
	Structure to handle the modelling of miscible or immiscible two-phase flows in a porous media. More...
struct	cs_gwf_t
	Main set of parameters/structures to manage the groundwater flow (GWF) module. This is an explicit definition of the structure cs_gwf_t. More...

Typedefs
typedef void()	cs_gwf_darcy_update_t(const cs_real_t t_eval, const cs_equation_t *eq, bool cur2prev, void *input, cs_gwf_darcy_flux_t *darcy)
	Update the advection field/arrays related to the Darcy flux. More...

Functions
cs_gwf_darcy_flux_t *	cs_gwf_darcy_flux_create (cs_flag_t loc_flag)
	Allocate and initialize a cs_gwf_darcy_flux_t structure. More...
void	cs_gwf_darcy_flux_free (cs_gwf_darcy_flux_t **p_darcy)
	Free a cs_gwf_darcy_flux_t structure. More...
void	cs_gwf_darcy_flux_log (cs_gwf_darcy_flux_t *darcy)
	Log a cs_gwf_darcy_flux_t structure. More...
void	cs_gwf_darcy_flux_define (const cs_cdo_connect_t *connect, const cs_cdo_quantities_t *quant, cs_param_space_scheme_t space_scheme, void *update_context, cs_gwf_darcy_update_t *update_func, cs_gwf_darcy_flux_t *darcy)
	Set the definition of the advection field attached to a cs_gwf_darcy_flux_t structure If the function pointer is set to NULL, then an automatic settings is done. More...
void	cs_gwf_darcy_flux_balance (const cs_cdo_connect_t *connect, const cs_cdo_quantities_t *quant, const cs_equation_param_t *eqp, cs_gwf_darcy_flux_t *darcy)
	Operate the balance by zone (relying on the splitting arising from the boundary settings) for the advection field attached to a cs_gwf_darcy_flux_t structure. More...

Typedef Documentation

cs_gwf_darcy_update_t

typedef void() cs_gwf_darcy_update_t(const cs_real_t t_eval, const cs_equation_t *eq, bool cur2prev, void *input, cs_gwf_darcy_flux_t *darcy)

Update the advection field/arrays related to the Darcy flux.

Parameters

[in]	t_eval	time at which one performs the evaluation
[in]	eq	pointer to the equation related to this Darcy flux
[in]	cur2prev	true or false
[in]	input	pointer to the context structure
[in,out]	darcy	pointer to the darcy flux structure

Function Documentation

cs_gwf_darcy_flux_balance()

void cs_gwf_darcy_flux_balance	(	const cs_cdo_connect_t *	connect,
		const cs_cdo_quantities_t *	quant,
		const cs_equation_param_t *	eqp,
		cs_gwf_darcy_flux_t *	darcy
	)

Operate the balance by zone (relying on the splitting arising from the boundary settings) for the advection field attached to a cs_gwf_darcy_flux_t structure.

Parameters

[in]	connect	pointer to a cs_cdo_connect_t structure
[in]	quant	pointer to a cs_cdo_quantities_t structure
[in]	eqp	pointer to the set of equation parameters
[in,out]	darcy	pointer to the darcy structure

cs_gwf_darcy_flux_create()

cs_gwf_darcy_flux_t* cs_gwf_darcy_flux_create

(

cs_flag_t

loc_flag

)

Allocate and initialize a cs_gwf_darcy_flux_t structure.

Parameters

[in]

loc_flag

flag to define where the flux is defined

Returns

a pointer to the newly allocated structure

cs_gwf_darcy_flux_define()

void cs_gwf_darcy_flux_define	(	const cs_cdo_connect_t *	connect,
		const cs_cdo_quantities_t *	quant,
		cs_param_space_scheme_t	space_scheme,
		void *	update_context,
		cs_gwf_darcy_update_t *	update_func,
		cs_gwf_darcy_flux_t *	darcy
	)

Set the definition of the advection field attached to a cs_gwf_darcy_flux_t structure If the function pointer is set to NULL, then an automatic settings is done.

Parameters

[in]	connect	pointer to a cs_cdo_connect_t structure
[in]	quant	pointer to a cs_cdo_quantities_t structure
[in]	space_scheme	space discretization using this structure
[in]	update_context	pointer to the context for the update step
[in]	update_func	pointer to an update function or NULL
[in,out]	darcy	pointer to the darcy structure

cs_gwf_darcy_flux_free()

void cs_gwf_darcy_flux_free

(

cs_gwf_darcy_flux_t **

p_darcy

)

Free a cs_gwf_darcy_flux_t structure.

Parameters

[in,out]

p_darcy

pointer of pointer to the darcy structure

cs_gwf_darcy_flux_log()

void cs_gwf_darcy_flux_log

(

cs_gwf_darcy_flux_t *

darcy

)

Log a cs_gwf_darcy_flux_t structure.

Parameters

[in,out]

darcy

pointer to the darcy structure