#include "cs_defs.h"
#include "cs_base.h"
#include "cs_cdo_connect.h"
#include "cs_cdo_local.h"
#include "cs_cdo_toolbox.h"
#include "cs_cdo_quantities.h"
#include "cs_cdofb_priv.h"
#include "cs_equation_builder.h"
#include "cs_equation_param.h"
#include "cs_field.h"
#include "cs_matrix.h"
#include "cs_mesh.h"
#include "cs_restart.h"
#include "cs_source_term.h"
#include "cs_time_step.h"

Include dependency graph for cs_cdofb_scaleq.h:

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

void	cs_cdofb_scaleq_init_sharing (const cs_cdo_quantities_t quant, const cs_cdo_connect_t connect, const cs_time_step_t *time_step)
	Allocate work buffer and general structures related to CDO scalar-valued face-based schemes. Set shared pointers from the main domain members. More...

void	cs_cdofb_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_cdofb_scaleq_finalize_sharing (void)
	Free work buffer and general structure related to CDO face-based schemes. More...

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

void *	cs_cdofb_scaleq_free_context (void *data)
	Destroy a cs_cdofb_scaleq_t structure. More...

void	cs_cdofb_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-Fb schemes. More...

void	cs_cdofb_scaleq_interpolate (const cs_mesh_t mesh, const cs_real_t cell_values, 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-Fb scheme Use for interpolation purpose from cell values to face values. One works cellwise and then process to the assembly. More...

void	cs_cdofb_scaleq_solve_steady_state (bool cur2prev, 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-Fb scheme One works cellwise and then process to the assembly. More...

void	cs_cdofb_scaleq_solve_implicit (bool cur2prev, 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 convection/diffusion/reaction equation with a CDO-Fb scheme and an implicit Euler scheme. One works cellwise and then process to the assembly. More...

void	cs_cdofb_scaleq_solve_theta (bool cur2prev, 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 convection/diffusion/reaction equation with a CDO-Fb scheme and an implicit/explicit theta scheme. One works cellwise and then process to the assembly. More...

cs_cdo_balance_t *	cs_cdofb_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 face-based scheme. More...

void	cs_cdofb_scaleq_diff_flux_faces (const cs_real_t c_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 primal faces. Interior faces first and then boundary faces. Values at faces are recovered thanks to the equation builder Case of scalar-valued CDO-Fb schemes. More...

void	cs_cdofb_scaleq_boundary_diff_flux (const cs_real_t t_eval, const cs_equation_param_t eqp, const cs_real_t pot_f, const cs_real_t pot_c, cs_equation_builder_t eqb, void context, cs_real_t bflux)
	Compute an approximation of the the diffusive flux across each boundary face. Case of scalar-valued CDO-Fb schemes. More...

void	cs_cdofb_scaleq_current_to_previous (const cs_equation_param_t eqp, cs_equation_builder_t eqb, void *context)
	Operate a current to previous operation for the field associated to this equation and potentially for related fields/arrays. More...

void	cs_cdofb_scaleq_extra_post (const cs_equation_param_t eqp, cs_equation_builder_t eqb, void *context)
	Predefined extra-operations related to this equation. More...

cs_real_t *	cs_cdofb_scaleq_get_cell_values (void *context, bool previous)
	Get the computed values at mesh cells from the inverse operation w.r.t. the static condensation (DoF used in the linear system are located at primal faces) 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_cdofb_scaleq_get_face_values (void *context, bool previous)
	Retrieve an array of values at mesh faces for the current context. The lifecycle of this array is managed by the code. So one does not have to free the return pointer. More...

void	cs_cdofb_scaleq_read_restart (cs_restart_t restart, const char eqname, void *scheme_context)
	Read additional arrays (not defined as fields) but useful for the checkpoint/restart process. More...

void	cs_cdofb_scaleq_write_restart (cs_restart_t restart, const char eqname, void *scheme_context)
	Write additional arrays (not defined as fields) but useful for the checkpoint/restart process. More...

Function Documentation

◆ cs_cdofb_scaleq_balance()

cs_cdo_balance_t* cs_cdofb_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 face-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_cdo_balance_t structure

◆ cs_cdofb_scaleq_boundary_diff_flux()

void cs_cdofb_scaleq_boundary_diff_flux	(	const cs_real_t	t_eval,
		const cs_equation_param_t *	eqp,
		const cs_real_t *	pot_f,
		const cs_real_t *	pot_c,
		cs_equation_builder_t *	eqb,
		void *	context,
		cs_real_t *	bflux
	)

Compute an approximation of the the diffusive flux across each boundary face. Case of scalar-valued CDO-Fb schemes.

Parameters

[in]	t_eval	time at which one performs the evaluation
[in]	eqp	pointer to a cs_equation_param_t structure
[in]	pot_f	array of values at faces
[in]	pot_c	array of values at cells
[in,out]	eqb	pointer to a cs_equation_builder_t structure
[in,out]	context	pointer to a scheme builder structure
[in,out]	bflux	pointer to the values of the diffusive flux

◆ cs_cdofb_scaleq_current_to_previous()

void cs_cdofb_scaleq_current_to_previous	(	const cs_equation_param_t *	eqp,
		cs_equation_builder_t *	eqb,
		void *	context
	)

Operate a current to previous operation for the field associated to this equation and potentially for related fields/arrays.

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 cs_cdofb_scaleq_t structure

◆ cs_cdofb_scaleq_diff_flux_faces()

void cs_cdofb_scaleq_diff_flux_faces	(	const cs_real_t *	c_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 primal faces. Interior faces first and then boundary faces. Values at faces are recovered thanks to the equation builder Case of scalar-valued CDO-Fb schemes.

Parameters

[in]	c_values	values for the potential at cells
[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 at primal faces

◆ cs_cdofb_scaleq_extra_post()

void cs_cdofb_scaleq_extra_post	(	const cs_equation_param_t *	eqp,
		cs_equation_builder_t *	eqb,
		void *	context
	)

Predefined extra-operations related to this equation.

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 cs_cdofb_scaleq_t structure

◆ cs_cdofb_scaleq_finalize_sharing()

void cs_cdofb_scaleq_finalize_sharing ( void )

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

◆ cs_cdofb_scaleq_free_context()

void* cs_cdofb_scaleq_free_context ( void * data )

Destroy a cs_cdofb_scaleq_t structure.

Parameters

[in,out] data pointer to a cs_cdofb_scaleq_t structure

Returns: a NULL pointer

◆ cs_cdofb_scaleq_get()

void cs_cdofb_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_cdofb_scaleq_get_cell_values()

cs_real_t* cs_cdofb_scaleq_get_cell_values	(	void *	context,
		bool	previous
	)

Get the computed values at mesh cells from the inverse operation w.r.t. the static condensation (DoF used in the linear system are located at primal faces) 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
[in]	previous	retrieve the previous state (true/false)

Returns: a pointer to an array of cs_real_t (size n_cells)

◆ cs_cdofb_scaleq_get_face_values()

cs_real_t* cs_cdofb_scaleq_get_face_values	(	void *	context,
		bool	previous
	)

Retrieve an array of values at mesh faces for the current 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
[in]	previous	retrieve the previous state (true/false)

Returns: a pointer to an array of cs_real_t (size n_faces)

◆ cs_cdofb_scaleq_init_context()

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

Initialize a cs_cdofb_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 structure

Returns: a pointer to a new allocated cs_cdofb_scaleq_t structure

◆ cs_cdofb_scaleq_init_sharing()

void cs_cdofb_scaleq_init_sharing	(	const cs_cdo_quantities_t *	quant,
		const cs_cdo_connect_t *	connect,
		const cs_time_step_t *	time_step
	)

Allocate work buffer and general structures related to CDO scalar-valued face-based schemes. Set shared pointers from the main domain members.

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

◆ cs_cdofb_scaleq_init_values()

void cs_cdofb_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-Fb 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_cdofb_scaleq_interpolate()

void cs_cdofb_scaleq_interpolate	(	const cs_mesh_t *	mesh,
		const cs_real_t *	cell_values,
		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-Fb scheme Use for interpolation purpose from cell values to face values. One works cellwise and then process to the assembly.

Parameters

[in]	mesh	pointer to a cs_mesh_t structure
[in]	cell_values	array of cell values
[in]	field_id	id of the variable field
[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_cdofb_scaleq_t structure

◆ cs_cdofb_scaleq_is_initialized()

bool cs_cdofb_scaleq_is_initialized ( void )

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

Returns: true or false

◆ cs_cdofb_scaleq_read_restart()

void cs_cdofb_scaleq_read_restart	(	cs_restart_t *	restart,
		const char *	eqname,
		void *	scheme_context
	)

Read additional arrays (not defined as fields) but useful for the checkpoint/restart process.

Parameters

[in,out]	restart	pointer to cs_restart_t structure
[in]	eqname	name of the related equation
[in]	scheme_context	pointer to a data structure cast on-the-fly

◆ cs_cdofb_scaleq_solve_implicit()

void cs_cdofb_scaleq_solve_implicit	(	bool	cur2prev,
		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 convection/diffusion/reaction equation with a CDO-Fb scheme and an implicit Euler scheme. One works cellwise and then process to the assembly.

Parameters

[in]	cur2prev	true="current to previous" operation is performed
[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_cdofb_scaleq_t structure

◆ cs_cdofb_scaleq_solve_steady_state()

void cs_cdofb_scaleq_solve_steady_state	(	bool	cur2prev,
		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-Fb scheme One works cellwise and then process to the assembly.

Parameters

[in]	cur2prev	true="current to previous" operation is performed
[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_cdofb_scaleq_t structure

◆ cs_cdofb_scaleq_solve_theta()

void cs_cdofb_scaleq_solve_theta	(	bool	cur2prev,
		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 convection/diffusion/reaction equation with a CDO-Fb scheme and an implicit/explicit theta scheme. One works cellwise and then process to the assembly.

Parameters

[in]	cur2prev	true="current to previous" operation is performed
[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_cdofb_scaleq_t structure

◆ cs_cdofb_scaleq_write_restart()

void cs_cdofb_scaleq_write_restart	(	cs_restart_t *	restart,
		const char *	eqname,
		void *	scheme_context
	)

Write additional arrays (not defined as fields) but useful for the checkpoint/restart process.

Parameters

[in,out]	restart	pointer to cs_restart_t structure
[in]	eqname	name of the related equation
[in]	scheme_context	pointer to a data structure cast on-the-fly

Functions

Function Documentation

◆ cs_cdofb_scaleq_balance()

◆ cs_cdofb_scaleq_boundary_diff_flux()

◆ cs_cdofb_scaleq_current_to_previous()

◆ cs_cdofb_scaleq_diff_flux_faces()

◆ cs_cdofb_scaleq_extra_post()

◆ cs_cdofb_scaleq_finalize_sharing()

◆ cs_cdofb_scaleq_free_context()

◆ cs_cdofb_scaleq_get()

◆ cs_cdofb_scaleq_get_cell_values()

◆ cs_cdofb_scaleq_get_face_values()

◆ cs_cdofb_scaleq_init_context()

◆ cs_cdofb_scaleq_init_sharing()

◆ cs_cdofb_scaleq_init_values()

◆ cs_cdofb_scaleq_interpolate()

◆ cs_cdofb_scaleq_is_initialized()

◆ cs_cdofb_scaleq_read_restart()

◆ cs_cdofb_scaleq_solve_implicit()

◆ cs_cdofb_scaleq_solve_steady_state()

◆ cs_cdofb_scaleq_solve_theta()

◆ cs_cdofb_scaleq_write_restart()