#include "cs_gwf_hydraulic_model.h"

Include dependency graph for cs_gwf_tpf.h:

Functions
cs_gwf_tpf_t *	cs_gwf_tpf_create (cs_gwf_model_type_t model)
	Allocate and initialize the model context structure for two-phase flows in a porous media. More...

void	cs_gwf_tpf_free (cs_gwf_tpf_t **p_tpf)
	Free the context structure associated to the modelling of two-phase flows in a porous media. More...

void	cs_gwf_tpf_log_setup (cs_gwf_tpf_t *tpf)
	Log the setup related to the model context of two-phase flows. Common to the different sub-models relying on two-phase flows. More...

void	cs_gwf_tpf_init (cs_gwf_tpf_t *tpf, cs_property_type_t perm_type)
	Initialize the model context according to the settings done inside the function cs_user_model() Case of a two-phase flows model in porous media. More...

void	cs_gwf_tpf_init_setup (cs_flag_t post_flag, cs_gwf_tpf_t *tpf)
	Initial setup stage for two-phase flows in porous media. At this stage, all soils have been defined and equation parameters are set. Case of a miscible or immiscible model. More...

void	cs_gwf_tpf_finalize_setup (const cs_cdo_connect_t connect, const cs_cdo_quantities_t cdoq, cs_flag_t flag, cs_gwf_tpf_t *tpf)
	Last setup stage in the case of two-phase flows in a porous media (miscible or immiscible case) More...

void	cs_gwf_tpf_init_values (const cs_cdo_connect_t connect, const cs_cdo_quantities_t cdoq, cs_gwf_tpf_t *tpf)
	Last setup stage in the case of two-phase flows in a porous media (miscible or immiscible case) More...

void	cs_gwf_tpf_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 option_flag, cs_gwf_tpf_t *tpf)
	Compute the new state for the groundwater flows module. Case of two-phase flows in porous media. More...

cs_real_t	cs_gwf_tpf_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_tpf_t *tpf)
	Perform the update step in the case of a two-phase flow model in porous media (miscible or immiscible) More...

void	cs_gwf_tpf_extra_op (const cs_cdo_connect_t connect, const cs_cdo_quantities_t cdoq, const cs_time_step_t ts, cs_flag_t post_flag, cs_gwf_tpf_t tpf)
	Predefined extra-operations for the groundwater flow module in case of miscible or immiscible two-phase flows in porous media. More...

void	cs_gwf_tpf_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_tpf_t tpf, const cs_cdo_connect_t connect, const cs_cdo_quantities_t cdoq, const cs_time_step_t *time_step)
	Predefined post-processing output for the groundwater flow module in case of saturated two-phase flows (tpf) in porous media. More...

Function Documentation

◆ cs_gwf_tpf_compute()

void cs_gwf_tpf_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	option_flag,
		cs_gwf_tpf_t *	tpf
	)

Compute the new state for the groundwater flows module. Case of two-phase flows in 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]	option_flag	calculation option related to the GWF module
[in,out]	tpf	pointer to the model context structure

◆ cs_gwf_tpf_create()

cs_gwf_tpf_t* cs_gwf_tpf_create ( cs_gwf_model_type_t model )

Allocate and initialize the model context structure for two-phase flows in a porous media.

Parameters

[in] model type of physical modelling

Returns: a pointer to a new allocated structure

◆ cs_gwf_tpf_extra_op()

void cs_gwf_tpf_extra_op	(	const cs_cdo_connect_t *	connect,
		const cs_cdo_quantities_t *	cdoq,
		const cs_time_step_t *	ts,
		cs_flag_t	post_flag,
		cs_gwf_tpf_t *	tpf
	)

Predefined extra-operations for the groundwater flow module in case of miscible or immiscible two-phase flows in porous media.

Parameters

[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 struct.
[in]	post_flag	requested quantities to be postprocessed
[in,out]	tpf	pointer to the casted model context

◆ cs_gwf_tpf_extra_post()

void cs_gwf_tpf_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_tpf_t *	tpf,
		const cs_cdo_connect_t *	connect,
		const cs_cdo_quantities_t *	cdoq,
		const cs_time_step_t *	time_step
	)

Predefined post-processing output for the groundwater flow module in case of saturated two-phase flows (tpf) in 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]	tpf	pointer to the model context structure
[in]	connect	pointer to additional connectivities for CDO
[in]	cdoq	pointer to additional mesh quantities for CDO
[in]	time_step	pointer to a cs_time_step_t struct.

◆ cs_gwf_tpf_finalize_setup()

void cs_gwf_tpf_finalize_setup	(	const cs_cdo_connect_t *	connect,
		const cs_cdo_quantities_t *	cdoq,
		cs_flag_t	flag,
		cs_gwf_tpf_t *	tpf
	)

Last setup stage in the case of two-phase flows in a porous media (miscible or immiscible case)

Parameters

[in]	connect	pointer to a cs_cdo_connect_t structure
[in]	cdoq	pointer to a cs_cdo_quantities_t structure
[in]	flag	optional settings for the module
[in,out]	tpf	pointer to the casted model context

◆ cs_gwf_tpf_free()

void cs_gwf_tpf_free ( cs_gwf_tpf_t ** p_tpf )

Free the context structure associated to the modelling of two-phase flows in a porous media.

Parameters

[in,out] p_tpf pointer of pointer to the model context structure

◆ cs_gwf_tpf_init()

void cs_gwf_tpf_init	(	cs_gwf_tpf_t *	tpf,
		cs_property_type_t	perm_type
	)

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

Parameters

[in,out]	tpf	pointer to the model context structure
[in,out]	perm_type	type of permeability to handle

◆ cs_gwf_tpf_init_setup()

void cs_gwf_tpf_init_setup	(	cs_flag_t	post_flag,
		cs_gwf_tpf_t *	tpf
	)

Initial setup stage for two-phase flows in porous media. At this stage, all soils have been defined and equation parameters are set. Case of a miscible or immiscible model.

Parameters

[in]	post_flag	optional postprocessing request(s)
[in,out]	tpf	pointer to the casted model context

◆ cs_gwf_tpf_init_values()

void cs_gwf_tpf_init_values	(	const cs_cdo_connect_t *	connect,
		const cs_cdo_quantities_t *	cdoq,
		cs_gwf_tpf_t *	tpf
	)

Last setup stage in the case of two-phase flows in a porous media (miscible or immiscible case)

Parameters

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

◆ cs_gwf_tpf_log_setup()

void cs_gwf_tpf_log_setup ( cs_gwf_tpf_t * tpf )

Log the setup related to the model context of two-phase flows. Common to the different sub-models relying on two-phase flows.

Parameters

[in] tpf pointer to the model context structure

◆ cs_gwf_tpf_update()

cs_real_t cs_gwf_tpf_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_tpf_t *	tpf
	)

Perform the update step in the case of a two-phase flow model in porous media (miscible or immiscible)

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	metadata associated to type of operation to do
[in]	option_flag	calculation option related to the GWF module
[in,out]	tpf	pointer to the casted model context
[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	metadata associated to type of operation to do
[in]	option_flag	calculation option related to the GWF module
[in,out]	tpf	pointer to a TPF model context

Functions

Function Documentation

◆ cs_gwf_tpf_compute()

◆ cs_gwf_tpf_create()

◆ cs_gwf_tpf_extra_op()

◆ cs_gwf_tpf_extra_post()

◆ cs_gwf_tpf_finalize_setup()

◆ cs_gwf_tpf_free()

◆ cs_gwf_tpf_init()

◆ cs_gwf_tpf_init_setup()

◆ cs_gwf_tpf_init_values()

◆ cs_gwf_tpf_log_setup()

◆ cs_gwf_tpf_update()