#include "cs_base.h"
#include "cs_cdo_connect.h"
#include "cs_cdo_local.h"
#include "cs_cdo_quantities.h"
#include "cs_equation_common.h"
#include "cs_equation_param.h"
#include "cs_field.h"
#include "cs_matrix.h"
#include "cs_mesh.h"
#include "cs_source_term.h"
#include "cs_time_step.h"

Include dependency graph for cs_cdovb_scaleq.h:

Functions
bool	cs_cdovb_scaleq_is_initialized (void)
	Check if the generic structures for building a CDO-Vb scheme are allocated. More...

void	cs_cdovb_scaleq_init_common (const cs_cdo_quantities_t quant, const cs_cdo_connect_t connect, const cs_time_step_t time_step, const cs_matrix_structure_t ms)
	Allocate work buffer and general structures related to CDO vertex-based schemes Set shared pointers. More...

void	cs_cdovb_scaleq_get (cs_cell_sys_t csys, cs_cell_builder_t cb)
	Retrieve work buffers used for building a CDO system cellwise. More...

void	cs_cdovb_scaleq_finalize_common (void)
	Free work buffer and general structure related to CDO vertex-based schemes. More...

void *	cs_cdovb_scaleq_init_context (const cs_equation_param_t eqp, int var_id, int bflux_id, cs_equation_builder_t eqb)
	Initialize a cs_cdovb_scaleq_t structure storing data useful for building and managing such a scheme. More...

void *	cs_cdovb_scaleq_free_context (void *builder)
	Destroy a cs_cdovb_scaleq_t structure. More...

void	cs_cdovb_scaleq_init_values (cs_real_t t_eval, const int field_id, const cs_mesh_t mesh, const cs_equation_param_t eqp, cs_equation_builder_t eqb, void context)
	Set the initial values of the variable field taking into account the boundary conditions. Case of scalar-valued CDO-Vb schemes. More...

void	cs_cdovb_scaleq_solve_steady_state (const cs_mesh_t mesh, const int field_id, const cs_equation_param_t eqp, cs_equation_builder_t eqb, void context)
	Build and solve the linear system arising from a scalar steady-state convection/diffusion/reaction equation with a CDO-Vb scheme One works cellwise and then process to the assembly. More...

void	cs_cdovb_scaleq_solve_implicit (const cs_mesh_t mesh, const int field_id, const cs_equation_param_t eqp, cs_equation_builder_t eqb, void context)
	Build and solve the linear system arising from a scalar unsteady convection/diffusion/reaction equation with a CDO-Vb scheme Implicit time scheme is used to progress in time. One works cellwise and then process to the assembly. More...

void	cs_cdovb_scaleq_solve_theta (const cs_mesh_t mesh, const int field_id, const cs_equation_param_t eqp, cs_equation_builder_t eqb, void context)
	Build and solve the linear system arising from a scalar unsteady convection/diffusion/reaction equation with a CDO-Vb scheme Theta time scheme is used to progress in time. One works cellwise and then process to the assembly. More...

cs_real_t *	cs_cdovb_scaleq_get_vertex_values (void *context)
	Retrieve an array of values at mesh vertices for the variable field associated to the given context The lifecycle of this array is managed by the code. So one does not have to free the return pointer. More...

cs_real_t *	cs_cdovb_scaleq_get_cell_values (void *context)
	Compute an array of values at mesh cells by interpolating the variable field associated to the given context located at mesh vertices The lifecycle of this array is managed by the code. So one does not have to free the return pointer. More...

cs_equation_balance_t *	cs_cdovb_scaleq_balance (const cs_equation_param_t eqp, cs_equation_builder_t eqb, void *context)
	Compute the balance for an equation over the full computational domain between time t_cur and t_cur + dt_cur Case of scalar-valued CDO vertex-based scheme. More...

void	cs_cdovb_scaleq_boundary_diff_flux (const cs_real_t t_eval, const cs_equation_param_t eqp, const cs_real_t pdi, cs_equation_builder_t eqb, cs_real_t vf_flux)
	Compute for each vertex of a boundary face, the portion of diffusive flux across the boundary face. The surface attached to each vertex corresponds to the intersection of its dual cell (associated to a vertex of the face) with the face. Case of scalar-valued CDO-Vb schemes. More...

void	cs_cdovb_scaleq_flux_across_plane (const cs_real_t normal[], const cs_real_t pdi, const cs_equation_param_t eqp, int ml_id, cs_equation_builder_t eqb, void context, double d_flux, double c_flux)
	Compute the diffusive and convective flux across a list of faces Case of scalar-valued CDO-Vb schemes. More...

void	cs_cdovb_scaleq_diff_flux_in_cells (const cs_real_t values, const cs_equation_param_t eqp, cs_real_t t_eval, cs_equation_builder_t eqb, void context, cs_real_t *diff_flux)
	Cellwise computation of an approximation of a constant diffusive flux (a vector) in each cell. Case of scalar-valued CDO-Vb schemes. More...

void	cs_cdovb_scaleq_diff_flux_dfaces (const cs_real_t values, const cs_equation_param_t eqp, cs_real_t t_eval, cs_equation_builder_t eqb, void context, cs_real_t *diff_flux)
	Cellwise computation of the diffusive flux accross dual faces (a scalar) in each cell. Case of scalar-valued CDO-Vb schemes. More...

void	cs_cdovb_scaleq_extra_op (const char eqname, const cs_field_t field, const cs_equation_param_t eqp, cs_equation_builder_t eqb, void *context)
	Predefined extra-operations related to this equation. More...

Function Documentation

◆ cs_cdovb_scaleq_balance()

cs_equation_balance_t* cs_cdovb_scaleq_balance	(	const cs_equation_param_t *	eqp,
		cs_equation_builder_t *	eqb,
		void *	context
	)

Compute the balance for an equation over the full computational domain between time t_cur and t_cur + dt_cur Case of scalar-valued CDO vertex-based scheme.

Parameters

[in]	eqp	pointer to a cs_equation_param_t structure
[in,out]	eqb	pointer to a cs_equation_builder_t structure
[in,out]	context	pointer to a scheme builder structure

Returns: a pointer to a cs_equation_balance_t structure

◆ cs_cdovb_scaleq_boundary_diff_flux()

void cs_cdovb_scaleq_boundary_diff_flux	(	const cs_real_t	t_eval,
		const cs_equation_param_t *	eqp,
		const cs_real_t *	pdi,
		cs_equation_builder_t *	eqb,
		cs_real_t *	vf_flux
	)

Compute for each vertex of a boundary face, the portion of diffusive flux across the boundary face. The surface attached to each vertex corresponds to the intersection of its dual cell (associated to a vertex of the face) with the face. Case of scalar-valued CDO-Vb schemes.

Parameters

[in]	t_eval	time at which one performs the evaluation
[in]	eqp	pointer to a cs_equation_param_t structure
[in]	pdi	pointer to an array of field values
[in,out]	eqb	pointer to a cs_equation_builder_t structure
[in,out]	vf_flux	pointer to the values of the diffusive flux

◆ cs_cdovb_scaleq_diff_flux_dfaces()

void cs_cdovb_scaleq_diff_flux_dfaces	(	const cs_real_t *	values,
		const cs_equation_param_t *	eqp,
		cs_real_t	t_eval,
		cs_equation_builder_t *	eqb,
		void *	context,
		cs_real_t *	diff_flux
	)

Cellwise computation of the diffusive flux accross dual faces (a scalar) in each cell. Case of scalar-valued CDO-Vb schemes.

Parameters

[in]	values	discrete values for the potential
[in]	eqp	pointer to a cs_equation_param_t structure
[in]	t_eval	time at which one performs the evaluation
[in,out]	eqb	pointer to a cs_equation_builder_t structure
[in,out]	context	pointer to cs_cdovb_scaleq_t structure
[in,out]	diff_flux	value of the diffusive flux

◆ cs_cdovb_scaleq_diff_flux_in_cells()

void cs_cdovb_scaleq_diff_flux_in_cells	(	const cs_real_t *	values,
		const cs_equation_param_t *	eqp,
		cs_real_t	t_eval,
		cs_equation_builder_t *	eqb,
		void *	context,
		cs_real_t *	diff_flux
	)

Cellwise computation of an approximation of a constant diffusive flux (a vector) in each cell. Case of scalar-valued CDO-Vb schemes.

Parameters

[in]	values	discrete values for the potential
[in]	eqp	pointer to a cs_equation_param_t structure
[in]	t_eval	time at which one performs the evaluation
[in,out]	eqb	pointer to a cs_equation_builder_t structure
[in,out]	context	pointer to cs_cdovb_scaleq_t structure
[in,out]	diff_flux	value of the diffusive flux

◆ cs_cdovb_scaleq_extra_op()

void cs_cdovb_scaleq_extra_op	(	const char *	eqname,
		const cs_field_t *	field,
		const cs_equation_param_t *	eqp,
		cs_equation_builder_t *	eqb,
		void *	context
	)

Predefined extra-operations related to this equation.

Parameters

[in]	eqname	name of the equation
[in]	field	pointer to a field structure
[in]	eqp	pointer to a cs_equation_param_t structure
[in,out]	eqb	pointer to a cs_equation_builder_t structure
[in,out]	context	pointer to cs_cdovb_scaleq_t structure

◆ cs_cdovb_scaleq_finalize_common()

void cs_cdovb_scaleq_finalize_common ( void )

Free work buffer and general structure related to CDO vertex-based schemes.

◆ cs_cdovb_scaleq_flux_across_plane()

void cs_cdovb_scaleq_flux_across_plane	(	const cs_real_t	normal[],
		const cs_real_t *	pdi,
		const cs_equation_param_t *	eqp,
		int	ml_id,
		cs_equation_builder_t *	eqb,
		void *	context,
		double *	d_flux,
		double *	c_flux
	)

Compute the diffusive and convective flux across a list of faces Case of scalar-valued CDO-Vb schemes.

Parameters

[in]	normal	indicate in which direction flux is > 0
[in]	pdi	pointer to an array of field values
[in]	eqp	pointer to a cs_equation_param_t structure
[in]	ml_id	id related to a cs_mesh_location_t struct.
[in,out]	eqb	pointer to a cs_equation_builder_t structure
[in,out]	context	pointer to data specific for this scheme
[in,out]	d_flux	pointer to the value of the diffusive flux
[in,out]	c_flux	pointer to the value of the convective flux

◆ cs_cdovb_scaleq_free_context()

void* cs_cdovb_scaleq_free_context ( void * builder )

Destroy a cs_cdovb_scaleq_t structure.

Parameters

[in,out] builder pointer to a cs_cdovb_scaleq_t structure

Returns: a NULL pointer

◆ cs_cdovb_scaleq_get()

void cs_cdovb_scaleq_get	(	cs_cell_sys_t **	csys,
		cs_cell_builder_t **	cb
	)

Retrieve work buffers used for building a CDO system cellwise.

Parameters

[out]	csys	pointer to a pointer on a cs_cell_sys_t structure
[out]	cb	pointer to a pointer on a cs_cell_builder_t structure

◆ cs_cdovb_scaleq_get_cell_values()

cs_real_t* cs_cdovb_scaleq_get_cell_values ( void * context )

Compute an array of values at mesh cells by interpolating the variable field associated to the given context located at mesh vertices The lifecycle of this array is managed by the code. So one does not have to free the return pointer.

Parameters

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

Returns: a pointer to an array of cs_real_t

◆ cs_cdovb_scaleq_get_vertex_values()

cs_real_t* cs_cdovb_scaleq_get_vertex_values ( void * context )

Retrieve an array of values at mesh vertices for the variable field associated to the given context The lifecycle of this array is managed by the code. So one does not have to free the return pointer.

Parameters

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

Returns: a pointer to an array of cs_real_t

◆ cs_cdovb_scaleq_init_common()

void cs_cdovb_scaleq_init_common	(	const cs_cdo_quantities_t *	quant,
		const cs_cdo_connect_t *	connect,
		const cs_time_step_t *	time_step,
		const cs_matrix_structure_t *	ms
	)

Allocate work buffer and general structures related to CDO vertex-based schemes Set shared pointers.

Parameters

[in]	quant	additional mesh quantities struct.
[in]	connect	pointer to a cs_cdo_connect_t struct.
[in]	time_step	pointer to a time step structure
[in]	ms	pointer to a cs_matrix_structure_t structure

◆ cs_cdovb_scaleq_init_context()

void* cs_cdovb_scaleq_init_context	(	const cs_equation_param_t *	eqp,
		int	var_id,
		int	bflux_id,
		cs_equation_builder_t *	eqb
	)

Initialize a cs_cdovb_scaleq_t structure storing data useful for building and managing such a scheme.

Parameters

[in]	eqp	pointer to a cs_equation_param_t structure
[in]	var_id	id of the variable field
[in]	bflux_id	id of the boundary flux field
[in,out]	eqb	pointer to a cs_equation_builder_t struct.

Returns: a pointer to a new allocated cs_cdovb_scaleq_t structure

◆ cs_cdovb_scaleq_init_values()

void cs_cdovb_scaleq_init_values	(	cs_real_t	t_eval,
		const int	field_id,
		const cs_mesh_t *	mesh,
		const cs_equation_param_t *	eqp,
		cs_equation_builder_t *	eqb,
		void *	context
	)

Set the initial values of the variable field taking into account the boundary conditions. Case of scalar-valued CDO-Vb schemes.

Parameters

[in]	t_eval	time at which one evaluates BCs
[in]	field_id	id related to the variable field of this equation
[in]	mesh	pointer to a cs_mesh_t structure
[in]	eqp	pointer to a cs_equation_param_t structure
[in,out]	eqb	pointer to a cs_equation_builder_t structure
[in,out]	context	pointer to the scheme context (cast on-the-fly)

◆ cs_cdovb_scaleq_is_initialized()

bool cs_cdovb_scaleq_is_initialized ( void )

Check if the generic structures for building a CDO-Vb scheme are allocated.

Returns: true or false

◆ cs_cdovb_scaleq_solve_implicit()

void cs_cdovb_scaleq_solve_implicit	(	const cs_mesh_t *	mesh,
		const int	field_id,
		const cs_equation_param_t *	eqp,
		cs_equation_builder_t *	eqb,
		void *	context
	)

Build and solve the linear system arising from a scalar unsteady convection/diffusion/reaction equation with a CDO-Vb scheme Implicit time scheme is used to progress in time. One works cellwise and then process to the assembly.

Parameters

[in]	mesh	pointer to a cs_mesh_t structure
[in]	field_id	id of the variable field related to this equation
[in]	eqp	pointer to a cs_equation_param_t structure
[in,out]	eqb	pointer to a cs_equation_builder_t structure
[in,out]	context	pointer to cs_cdovb_scaleq_t structure

◆ cs_cdovb_scaleq_solve_steady_state()

void cs_cdovb_scaleq_solve_steady_state	(	const cs_mesh_t *	mesh,
		const int	field_id,
		const cs_equation_param_t *	eqp,
		cs_equation_builder_t *	eqb,
		void *	context
	)

Build and solve the linear system arising from a scalar steady-state convection/diffusion/reaction equation with a CDO-Vb scheme One works cellwise and then process to the assembly.

Parameters

[in]	mesh	pointer to a cs_mesh_t structure
[in]	field_id	id of the variable field related to this equation
[in]	eqp	pointer to a cs_equation_param_t structure
[in,out]	eqb	pointer to a cs_equation_builder_t structure
[in,out]	context	pointer to cs_cdovb_scaleq_t structure

◆ cs_cdovb_scaleq_solve_theta()

void cs_cdovb_scaleq_solve_theta	(	const cs_mesh_t *	mesh,
		const int	field_id,
		const cs_equation_param_t *	eqp,
		cs_equation_builder_t *	eqb,
		void *	context
	)

Build and solve the linear system arising from a scalar unsteady convection/diffusion/reaction equation with a CDO-Vb scheme Theta time scheme is used to progress in time. One works cellwise and then process to the assembly.

Parameters

[in]	mesh	pointer to a cs_mesh_t structure
[in]	field_id	id of the variable field related to this equation
[in]	eqp	pointer to a cs_equation_param_t structure
[in,out]	eqb	pointer to a cs_equation_builder_t structure
[in,out]	context	pointer to cs_cdovb_scaleq_t structure

Functions

Function Documentation

◆ cs_cdovb_scaleq_balance()

◆ cs_cdovb_scaleq_boundary_diff_flux()

◆ cs_cdovb_scaleq_diff_flux_dfaces()

◆ cs_cdovb_scaleq_diff_flux_in_cells()

◆ cs_cdovb_scaleq_extra_op()

◆ cs_cdovb_scaleq_finalize_common()

◆ cs_cdovb_scaleq_flux_across_plane()

◆ cs_cdovb_scaleq_free_context()

◆ cs_cdovb_scaleq_get()

◆ cs_cdovb_scaleq_get_cell_values()

◆ cs_cdovb_scaleq_get_vertex_values()

◆ cs_cdovb_scaleq_init_common()

◆ cs_cdovb_scaleq_init_context()

◆ cs_cdovb_scaleq_init_values()

◆ cs_cdovb_scaleq_is_initialized()

◆ cs_cdovb_scaleq_solve_implicit()

◆ cs_cdovb_scaleq_solve_steady_state()

◆ cs_cdovb_scaleq_solve_theta()