#include "cs_base.h"
#include "cs_time_step.h"
#include "cs_mesh.h"
#include "cs_equation_builder.h"
#include "cs_equation_param.h"
#include "cs_field.h"
#include "cs_cdo_connect.h"
#include "cs_cdo_quantities.h"
#include "cs_restart.h"
#include "cs_source_term.h"

Include dependency graph for cs_cdovcb_scaleq.h:

Functions
bool	cs_cdovcb_scaleq_is_initialized (void)
	Check if the generic structures for building a CDO-vertex+cell based scheme are allocated. More...

void	cs_cdovcb_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 vertex+cell-based schemes Set shared pointers. More...

void	cs_cdovcb_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_cdovcb_scaleq_finalize_sharing (void)
	Free buffers and generic structures related to CDO vertex+cell-based schemes. More...

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

void *	cs_cdovcb_scaleq_free_context (void *data)
	Destroy a cs_cdovcb_scaleq_t structure. More...

void	cs_cdovcb_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-VCb schemes. More...

void	cs_cdovcb_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 equation with a CDO-VCb scheme. Use for interpolation purpose from cell values to vertex values. One works cellwise and then process to the assembly. More...

void	cs_cdovcb_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-VCb scheme One works cellwise and then process to the assembly. More...

void	cs_cdovcb_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 unsteady convection/diffusion/reaction equation with a CDO-VCb scheme Time scheme is an implicit Euler One works cellwise and then process to the assembly. More...

void	cs_cdovcb_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 unsteady convection/diffusion/reaction equation with a CDO-VCb scheme Time scheme is a theta scheme. One works cellwise and then process to the assembly. More...

cs_real_t *	cs_cdovcb_scaleq_get_vertex_values (void *context, bool previous)
	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_cdovcb_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 vertices and field related to the structure equation is also attached to primal vertices) 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_cdovcb_scaleq_get_source_term_values (void *context)
	Retrieve the array storing the source term values associated to each DoF. The lifecycle of this array is managed by the code. So one does not have to free the return pointer. More...

void	cs_cdovcb_scaleq_boundary_diff_flux (const cs_real_t t_eval, const cs_equation_param_t eqp, const cs_real_t pot_v, const cs_real_t pot_c, cs_equation_builder_t eqb, void context, 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-VCb schemes. More...

void	cs_cdovcb_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-Vcb schemes. More...

void	cs_cdovcb_scaleq_diff_flux_in_cells (const cs_real_t v_values, const cs_real_t c_values, const cs_equation_param_t eqp, const cs_property_t diff_pty, cs_real_t t_eval, cs_equation_builder_t eqb, void context, cs_real_t *diff_flux)
	Cellwise and threaed computation of the diffusive flux in each cells. Case of scalar-valued CDO-VCb schemes. More...

void	cs_cdovcb_scaleq_diff_flux_dfaces (const cs_real_t v_values, const cs_real_t c_values, const cs_equation_param_t eqp, const cs_property_t diff_pty, cs_real_t t_eval, cs_equation_builder_t eqb, void context, cs_real_t *diff_flux)
	Cellwise and threaded computation of the diffusive flux across dual faces. This is only an interpolation since the dual faces are not the natural location for this discretization. Case of scalar-valued CDO-VCb schemes. More...

void	cs_cdovcb_scaleq_vtx_gradient (const cs_real_t v_values, cs_equation_builder_t eqb, void context, cs_real_t v_gradient)
	Cellwise computation of the discrete gradient at vertices. More...

void	cs_cdovcb_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_cdovcb_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...

void	cs_cdovcb_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_cdovcb_scaleq_extra_post (const cs_equation_param_t eqp, cs_equation_builder_t eqb, void *context)
	Predefined extra-operations related to this equation. More...

Function Documentation

◆ cs_cdovcb_scaleq_boundary_diff_flux()

void cs_cdovcb_scaleq_boundary_diff_flux	(	const cs_real_t	t_eval,
		const cs_equation_param_t *	eqp,
		const cs_real_t *	pot_v,
		const cs_real_t *	pot_c,
		cs_equation_builder_t *	eqb,
		void *	context,
		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-VCb schemes.

Parameters

[in]	t_eval	time at which one performs the evaluation
[in]	eqp	pointer to a cs_equation_param_t structure
[in]	pot_v	pointer to an array of field values at vertices
[in]	pot_c	pointer to an array of field 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]	vf_flux	pointer to the values of the diffusive flux

◆ cs_cdovcb_scaleq_current_to_previous()

void cs_cdovcb_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_cdovcb_scaleq_t structure

◆ cs_cdovcb_scaleq_diff_flux_dfaces()

void cs_cdovcb_scaleq_diff_flux_dfaces	(	const cs_real_t *	v_values,
		const cs_real_t *	c_values,
		const cs_equation_param_t *	eqp,
		const cs_property_t *	diff_pty,
		cs_real_t	t_eval,
		cs_equation_builder_t *	eqb,
		void *	context,
		cs_real_t *	diff_flux
	)

Cellwise and threaded computation of the diffusive flux across dual faces. This is only an interpolation since the dual faces are not the natural location for this discretization. Case of scalar-valued CDO-VCb schemes.

Parameters

[in]	v_values	values at vertices
[in]	c_values	values at cells
[in]	eqp	pointer to a cs_equation_param_t structure
[in]	diff_pty	pointer to the diffusion property to use
[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 data structure cast on-the-fly
[in,out]	diff_flux	value of the diffusive flux

◆ cs_cdovcb_scaleq_diff_flux_in_cells()

void cs_cdovcb_scaleq_diff_flux_in_cells	(	const cs_real_t *	v_values,
		const cs_real_t *	c_values,
		const cs_equation_param_t *	eqp,
		const cs_property_t *	diff_pty,
		cs_real_t	t_eval,
		cs_equation_builder_t *	eqb,
		void *	context,
		cs_real_t *	diff_flux
	)

Cellwise and threaed computation of the diffusive flux in each cells. Case of scalar-valued CDO-VCb schemes.

Parameters

[in]	v_values	values at vertices
[in]	c_values	values at cells
[in]	eqp	pointer to a cs_equation_param_t structure
[in]	diff_pty	pointer to the diffusion property to use
[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 data structure cast on-the-fly
[in,out]	diff_flux	value of the diffusive flux

◆ cs_cdovcb_scaleq_extra_post()

void cs_cdovcb_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_cdovcb_scaleq_t structure

◆ cs_cdovcb_scaleq_finalize_sharing()

void cs_cdovcb_scaleq_finalize_sharing ( void )

Free buffers and generic structures related to CDO vertex+cell-based schemes.

◆ cs_cdovcb_scaleq_flux_across_plane()

void cs_cdovcb_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-Vcb 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

Compute the diffusive and convective flux across a list of faces Case of scalar-valued CDO-Vcb 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_cdovcb_scaleq_free_context()

void* cs_cdovcb_scaleq_free_context ( void * data )

Destroy a cs_cdovcb_scaleq_t structure.

Parameters

[in,out] data pointer to a cs_cdovcb_scaleq_t structure

Returns: a NULL pointer

◆ cs_cdovcb_scaleq_get()

void cs_cdovcb_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_cdovcb_scaleq_get_cell_values()

cs_real_t* cs_cdovcb_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 vertices and field related to the structure equation is also attached to primal 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
[in]	previous	retrieve the previous state (true/false)

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

◆ cs_cdovcb_scaleq_get_source_term_values()

cs_real_t* cs_cdovcb_scaleq_get_source_term_values ( void * context )

Retrieve the array storing the source term values associated to each DoF. 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 (size n_vertices + n_cells)

◆ cs_cdovcb_scaleq_get_vertex_values()

cs_real_t* cs_cdovcb_scaleq_get_vertex_values	(	void *	context,
		bool	previous
	)

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
[in]	previous	retrieve the previous state (true/false)

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

◆ cs_cdovcb_scaleq_init_context()

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

Initialize a cs_cdovcb_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_cdovcb_scaleq_t structure

◆ cs_cdovcb_scaleq_init_sharing()

void cs_cdovcb_scaleq_init_sharing	(	const cs_cdo_quantities_t *	cdoq,
		const cs_cdo_connect_t *	connect,
		const cs_time_step_t *	time_step
	)

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

Parameters

[in]	cdoq	additional CDO mesh quantities
[in]	connect	pointer to a cs_cdo_connect_t struct.
[in]	time_step	pointer to a time step structure

◆ cs_cdovcb_scaleq_init_values()

void cs_cdovcb_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-VCb 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_cdovcb_scaleq_interpolate()

void cs_cdovcb_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 equation with a CDO-VCb scheme. Use for interpolation purpose from cell values to vertex 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_cdovcb_scaleq_t structure

◆ cs_cdovcb_scaleq_is_initialized()

bool cs_cdovcb_scaleq_is_initialized ( void )

Check if the generic structures for building a CDO-vertex+cell based scheme are allocated.

Returns: true or false

◆ cs_cdovcb_scaleq_read_restart()

void cs_cdovcb_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_cdovcb_scaleq_solve_implicit()

void cs_cdovcb_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 unsteady convection/diffusion/reaction equation with a CDO-VCb scheme Time scheme is an implicit Euler 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_cdovcb_scaleq_t structure

◆ cs_cdovcb_scaleq_solve_steady_state()

void cs_cdovcb_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-VCb 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_cdovcb_scaleq_t structure

◆ cs_cdovcb_scaleq_solve_theta()

void cs_cdovcb_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 unsteady convection/diffusion/reaction equation with a CDO-VCb scheme Time scheme is a 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_cdovcb_scaleq_t structure

◆ cs_cdovcb_scaleq_vtx_gradient()

void cs_cdovcb_scaleq_vtx_gradient	(	const cs_real_t *	v_values,
		cs_equation_builder_t *	eqb,
		void *	context,
		cs_real_t *	v_gradient
	)

Cellwise computation of the discrete gradient at vertices.

Parameters

[in]	v_values	discrete values for the potential at vertices
[in,out]	eqb	pointer to a cs_equation_builder_t structure
[in,out]	context	pointer to data structure cast on-the-fly
[in,out]	v_gradient	gradient at vertices

◆ cs_cdovcb_scaleq_write_restart()

void cs_cdovcb_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_cdovcb_scaleq_boundary_diff_flux()

◆ cs_cdovcb_scaleq_current_to_previous()

◆ cs_cdovcb_scaleq_diff_flux_dfaces()

◆ cs_cdovcb_scaleq_diff_flux_in_cells()

◆ cs_cdovcb_scaleq_extra_post()

◆ cs_cdovcb_scaleq_finalize_sharing()

◆ cs_cdovcb_scaleq_flux_across_plane()

◆ cs_cdovcb_scaleq_free_context()

◆ cs_cdovcb_scaleq_get()

◆ cs_cdovcb_scaleq_get_cell_values()

◆ cs_cdovcb_scaleq_get_source_term_values()

◆ cs_cdovcb_scaleq_get_vertex_values()

◆ cs_cdovcb_scaleq_init_context()

◆ cs_cdovcb_scaleq_init_sharing()

◆ cs_cdovcb_scaleq_init_values()

◆ cs_cdovcb_scaleq_interpolate()

◆ cs_cdovcb_scaleq_is_initialized()

◆ cs_cdovcb_scaleq_read_restart()

◆ cs_cdovcb_scaleq_solve_implicit()

◆ cs_cdovcb_scaleq_solve_steady_state()

◆ cs_cdovcb_scaleq_solve_theta()

◆ cs_cdovcb_scaleq_vtx_gradient()

◆ cs_cdovcb_scaleq_write_restart()