cs_gwf_sspf.h File Reference

#include "cs_gwf_hydraulic_model.h"

Include dependency graph for cs_gwf_sspf.h:

Go to the source code of this file.

Functions
cs_gwf_sspf_t *	cs_gwf_sspf_create (void)
	Allocate and initialize the model context structure in case of single-phase flows in a saturated porous media. More...
void	cs_gwf_sspf_free (cs_gwf_sspf_t **p_mc)
	Free the model context structure in case of a saturated single-phase flows. More...
void	cs_gwf_sspf_log_setup (cs_gwf_sspf_t *mc)
	Log the setup related to the model context of saturated single-phase flows in porous media. More...
void	cs_gwf_sspf_init (cs_gwf_sspf_t *mc, cs_property_t *abs_perm, cs_flag_t flag)
	Initialize the model context according to the settings done inside the function cs_user_model() Case of a saturated single-phase flows model in porous media. More...
void	cs_gwf_sspf_init_setup (cs_flag_t flag, cs_gwf_sspf_t *mc)
	Initial setup stage for saturated single-phase flows in a porous media. At this stage, all soils have been defined and equation parameters are set. More...
void	cs_gwf_sspf_finalize_setup (const cs_cdo_connect_t *connect, const cs_cdo_quantities_t *cdoq, cs_gwf_sspf_t *mc)
	Last setup stage in the case of single-phase flows in a saturated porous media. More...
void	cs_gwf_sspf_update (const cs_mesh_t *mesh, const cs_cdo_connect_t *connect, const cs_cdo_quantities_t *cdoq, const cs_time_step_t *ts, cs_flag_t update_flag, cs_flag_t option_flag, cs_gwf_sspf_t *mc)
	Perform the update step in the case of single-phase flows in a saturated porous media. More...
void	cs_gwf_sspf_compute_steady_state (const cs_mesh_t *mesh, const cs_cdo_connect_t *connect, const cs_cdo_quantities_t *cdoq, const cs_time_step_t *time_step, cs_flag_t flag, cs_gwf_sspf_t *mc)
	Compute the steady-state of the groundwater flows module in case of single-phase flows in a saturated porous media. More...
void	cs_gwf_sspf_compute (const cs_mesh_t *mesh, const cs_cdo_connect_t *connect, const cs_cdo_quantities_t *cdoq, const cs_time_step_t *time_step, cs_flag_t flag, cs_gwf_sspf_t *mc)
	Compute the new hydraulic state for the groundwater flows module. Case of single-phase flows in a saturated porous media. More...
void	cs_gwf_sspf_extra_op (const cs_cdo_connect_t *connect, const cs_cdo_quantities_t *cdoq, cs_flag_t post_flag, cs_gwf_sspf_t *mc)
	Predefined extra-operations for the groundwater flow module in case of single phase flows in a saturated porous media. More...
void	cs_gwf_sspf_extra_post (int mesh_id, cs_lnum_t n_cells, const cs_lnum_t cell_ids[], cs_flag_t post_flag, const cs_property_t *abs_perm, const cs_gwf_sspf_t *mc, const cs_time_step_t *time_step)
	Predefined post-processing output for the groundwater flow module in case of single-phase flows in a saturated porous media. More...

Function Documentation

cs_gwf_sspf_compute()

void cs_gwf_sspf_compute	(	const cs_mesh_t *	mesh,
		const cs_cdo_connect_t *	connect,
		const cs_cdo_quantities_t *	cdoq,
		const cs_time_step_t *	time_step,
		cs_flag_t	flag,
		cs_gwf_sspf_t *	mc
	)

Compute the new hydraulic state for the groundwater flows module. Case of single-phase flows in a saturated porous media.

Parameters

[in]	mesh	pointer to a cs_mesh_t structure
[in]	connect	pointer to a cs_cdo_connect_t structure
[in]	cdoq	pointer to a cs_cdo_quantities_t structure
[in]	time_step	pointer to a cs_time_step_t structure
[in]	flag	type of additional treatment(s) to do
[in,out]	mc	pointer to the model context structure

cs_gwf_sspf_compute_steady_state()

void cs_gwf_sspf_compute_steady_state	(	const cs_mesh_t *	mesh,
		const cs_cdo_connect_t *	connect,
		const cs_cdo_quantities_t *	cdoq,
		const cs_time_step_t *	time_step,
		cs_flag_t	flag,
		cs_gwf_sspf_t *	mc
	)

Compute the steady-state of the groundwater flows module in case of single-phase flows in a saturated porous media.

Parameters

[in]	mesh	pointer to a cs_mesh_t structure
[in]	connect	pointer to a cs_cdo_connect_t structure
[in]	cdoq	pointer to a cs_cdo_quantities_t structure
[in]	time_step	pointer to a cs_time_step_t structure
[in]	flag	type of additional treatment(s) to do
[in,out]	mc	pointer to the model context structure

cs_gwf_sspf_create()

cs_gwf_sspf_t * cs_gwf_sspf_create

(

void

)

Allocate and initialize the model context structure in case of single-phase flows in a saturated porous media.

Returns

a pointer to a new allocated structure

cs_gwf_sspf_extra_op()

void cs_gwf_sspf_extra_op	(	const cs_cdo_connect_t *	connect,
		const cs_cdo_quantities_t *	cdoq,
		cs_flag_t	post_flag,
		cs_gwf_sspf_t *	mc
	)

Predefined extra-operations for the groundwater flow module in case of single phase flows in a saturated porous media.

Parameters

[in]	connect	pointer to a cs_cdo_connect_t structure
[in]	cdoq	pointer to a cs_cdo_quantities_t structure
[in]	post_flag	requested quantities to be postprocessed
[in,out]	mc	pointer to the casted model context

cs_gwf_sspf_extra_post()

void cs_gwf_sspf_extra_post	(	int	mesh_id,
		cs_lnum_t	n_cells,
		const cs_lnum_t	cell_ids[],
		cs_flag_t	post_flag,
		const cs_property_t *	abs_perm,
		const cs_gwf_sspf_t *	mc,
		const cs_time_step_t *	time_step
	)

Predefined post-processing output for the groundwater flow module in case of single-phase flows in a saturated porous media.

Parameters

[in]	mesh_id	id of the output mesh for the current call
[in]	n_cells	local number of cells of post_mesh
[in]	cell_ids	list of cells (0 to n-1)
[in]	post_flag	flag gathering quantities to postprocess
[in]	abs_perm	property for the absolute permeability
[in]	mc	pointer to the model context structure
[in]	time_step	pointer to a cs_time_step_t struct.

cs_gwf_sspf_finalize_setup()

void cs_gwf_sspf_finalize_setup	(	const cs_cdo_connect_t *	connect,
		const cs_cdo_quantities_t *	cdoq,
		cs_gwf_sspf_t *	mc
	)

Last setup stage in the case of single-phase flows in a saturated porous media.

Parameters

[in]	connect	pointer to a cs_cdo_connect_t structure
[in]	cdoq	pointer to a cs_cdo_quantities_t structure
[in,out]	mc	pointer to the casted model context

cs_gwf_sspf_free()

void cs_gwf_sspf_free

(

cs_gwf_sspf_t **

p_mc

)

Free the model context structure in case of a saturated single-phase flows.

Parameters

[in,out]

p_mc

pointer of pointer to the model context structure

cs_gwf_sspf_init()

void cs_gwf_sspf_init	(	cs_gwf_sspf_t *	mc,
		cs_property_t *	abs_perm,
		cs_flag_t	flag
	)

Initialize the model context according to the settings done inside the function cs_user_model() Case of a saturated single-phase flows model in porous media.

Parameters

[in,out]	mc	pointer to the model context structure
[in]	abs_perm	property struct. for the absolute permeability
[in]	flag	optional metadata

cs_gwf_sspf_init_setup()

void cs_gwf_sspf_init_setup	(	cs_flag_t	flag,
		cs_gwf_sspf_t *	mc
	)

Initial setup stage for saturated single-phase flows in a porous media. At this stage, all soils have been defined and equation parameters are set.

Parameters

[in]	flag	optional settings for the module
[in,out]	mc	pointer to the model context structure

cs_gwf_sspf_log_setup()

void cs_gwf_sspf_log_setup

(

cs_gwf_sspf_t *

mc

)

Log the setup related to the model context of saturated single-phase flows in porous media.

Parameters

[in]

mc

pointer to the model context structure

cs_gwf_sspf_update()

void cs_gwf_sspf_update	(	const cs_mesh_t *	mesh,
		const cs_cdo_connect_t *	connect,
		const cs_cdo_quantities_t *	cdoq,
		const cs_time_step_t *	ts,
		cs_flag_t	update_flag,
		cs_flag_t	option_flag,
		cs_gwf_sspf_t *	mc
	)

Perform the update step in the case of single-phase flows in a saturated porous media.

Parameters

[in]	mesh	pointer to a cs_mesh_t structure
[in]	connect	pointer to a cs_cdo_connect_t structure
[in]	cdoq	pointer to a cs_cdo_quantities_t structure
[in]	ts	pointer to a cs_time_step_t structure
[in]	update_flag	type of operation(s) to do
[in]	option_flag	calculation option related to the GWF module
[in,out]	mc	pointer to the casted model context