cs_cdofb_vecteq.h File Reference

#include "cs_defs.h"
#include "cs_base.h"
#include "cs_cdo_connect.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_restart.h"
#include "cs_sles.h"
#include "cs_source_term.h"
#include "cs_time_step.h"

Include dependency graph for cs_cdofb_vecteq.h:

Go to the source code of this file.

Functions
bool	cs_cdofb_vecteq_is_initialized (void)
	Check if the generic structures for building a CDO-Fb scheme are allocated. More...
void	cs_cdofb_vecteq_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 vector-valued face-based schemes. Set shared pointers from the main domain members. More...
const cs_matrix_structure_t *	cs_cdofb_vecteq_matrix_structure (void)
	Get the pointer to the related cs_matrix_structure_t. More...
void	cs_cdofb_vecteq_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_vecteq_finalize_common (void)
	Free work buffer and general structure related to CDO face-based schemes. More...
void *	cs_cdofb_vecteq_init_context (const cs_equation_param_t *eqp, int var_id, int bflux_id, cs_equation_builder_t *eqb)
	Initialize a cs_cdofb_vecteq_t structure storing data useful for building and managing such a scheme. More...
void *	cs_cdofb_vecteq_free_context (void *data)
	Destroy a cs_cdofb_vecteq_t structure. More...
void	cs_cdofb_vecteq_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 vector-valued CDO-Fb schemes. More...
void	cs_cdofb_vecteq_init_cell_system (const cs_flag_t cell_flag, const cs_cell_mesh_t *cm, const cs_equation_param_t *eqp, const cs_equation_builder_t *eqb, const cs_cdofb_vecteq_t *eqc, const cs_real_t dir_values[], const cs_real_t field_tn[], cs_real_t t_eval, cs_cell_sys_t *csys, cs_cell_builder_t *cb)
	Initialize the local structure for the current cell. More...
void	cs_cdofb_vecteq_setup_bc (cs_real_t t_eval, const cs_mesh_t *mesh, const cs_equation_param_t *eqp, cs_equation_builder_t *eqb, cs_real_t *p_dir_values[])
	Set the boundary conditions known from the settings. More...
void	cs_cdofb_vecteq_diffusion (double time_eval, const cs_equation_param_t *eqp, const cs_equation_builder_t *eqb, const cs_cdofb_vecteq_t *eqc, const cs_cell_mesh_t *cm, cs_face_mesh_t *fm, cs_cell_sys_t *csys, cs_cell_builder_t *cb)
	Build the local matrices arising from the diffusion, advection, reaction terms in CDO-Fb schemes. More...
void	cs_cdofb_vecteq_advection_diffusion (double time_eval, const cs_equation_param_t *eqp, const cs_cdofb_vecteq_t *eqc, const cs_cell_mesh_t *cm, cs_cell_sys_t *csys, cs_cell_builder_t *cb)
	Build the local matrices arising from the diffusion, advection, reaction terms in CDO-Fb schemes. More...
static void	cs_cdofb_vecteq_sourceterm (const cs_cell_mesh_t *cm, const cs_equation_param_t *eqp, const cs_real_t t_eval, const cs_real_t coef, cs_cell_builder_t *cb, cs_equation_builder_t *eqb, cs_cell_sys_t *csys)
	Compute the term source for a vector-valued CDO-Fb scheme and add it to the local rhs. More...
int	cs_cdofb_vecteq_solve_system (cs_sles_t *sles, const cs_matrix_t *matrix, const cs_equation_param_t *eqp, cs_real_t *x, cs_real_t *b)
	Solve a linear system arising from a scalar-valued CDO-Fb scheme. More...
static void	cs_cdofb_vecteq_assembly (const cs_cell_sys_t *csys, const cs_range_set_t *rs, const cs_cell_mesh_t *cm, const bool has_sourceterm, cs_cdofb_vecteq_t *eqc, cs_equation_assemble_t *eqa, cs_matrix_assembler_values_t *mav, cs_real_t rhs[])
	Perform the assembly stage for a vector-valued system obtained with CDO-Fb scheme. More...
void	cs_cdofb_vecteq_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 vector steady-state diffusion equation with a CDO-Fb scheme One works cellwise and then process to the assembly. More...
void	cs_cdofb_vecteq_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 vector diffusion equation with a CDO-Fb scheme and an implicit Euler scheme. One works cellwise and then process to the assembly. More...
void	cs_cdofb_vecteq_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 vector diffusion equation with a CDO-Fb scheme and an implicit/explicit theta scheme. One works cellwise and then process to the assembly. More...
void	cs_cdofb_vecteq_update_field (const cs_real_t *solu, const cs_real_t *rhs, const cs_equation_param_t *eqp, cs_equation_builder_t *eqb, void *data, cs_real_t *field_val)
	Store solution(s) of the linear system into a field structure Update extra-field values if required (for hybrid discretization) More...
void	cs_cdofb_vecteq_extra_op (const char *eqname, const cs_field_t *field, const cs_equation_param_t *eqp, cs_equation_builder_t *eqb, void *data)
	Predefined extra-operations related to this equation. More...
cs_real_t *	cs_cdofb_vecteq_get_cell_values (void *context)
	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_vecteq_get_face_values (void *context)
	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_vecteq_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_vecteq_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_vecteq_advection_diffusion()

void cs_cdofb_vecteq_advection_diffusion	(	double	time_eval,
		const cs_equation_param_t *	eqp,
		const cs_cdofb_vecteq_t *	eqc,
		const cs_cell_mesh_t *	cm,
		cs_cell_sys_t *	csys,
		cs_cell_builder_t *	cb
	)

Build the local matrices arising from the diffusion, advection, reaction terms in CDO-Fb schemes.

Parameters

[in]	time_eval	time at which analytic function are evaluated
[in]	eqp	pointer to a cs_equation_param_t structure
[in]	eqc	context for this kind of discretization
[in]	cm	pointer to a cellwise view of the mesh
[in,out]	csys	pointer to a cellwise view of the system
[in,out]	cb	pointer to a cellwise builder

cs_cdofb_vecteq_assembly()

static void cs_cdofb_vecteq_assembly ( const cs_cell_sys_t *  csys, const cs_range_set_t *  rs, const cs_cell_mesh_t *  cm, const bool  has_sourceterm, cs_cdofb_vecteq_t *  eqc, cs_equation_assemble_t *  eqa, cs_matrix_assembler_values_t *  mav, cs_real_t  rhs[]  )

inlinestatic

Perform the assembly stage for a vector-valued system obtained with CDO-Fb scheme.

Parameters

[in]	csys	pointer to a cs_cell_sys_t structure
[in]	rs	pointer to a cs_range_set_t structure
[in]	cm	pointer to a cs_cell_mesh_t structure
[in]	has_sourceterm	has the equation a source term?
[in,out]	eqc	context structure for a vector-valued Fb
[in,out]	eqa	pointer to cs_equation_assemble_t
[in,out]	mav	pointer to cs_matrix_assembler_values_t
[in,out]	rhs	right-end side of the system

cs_cdofb_vecteq_diffusion()

void cs_cdofb_vecteq_diffusion	(	double	time_eval,
		const cs_equation_param_t *	eqp,
		const cs_equation_builder_t *	eqb,
		const cs_cdofb_vecteq_t *	eqc,
		const cs_cell_mesh_t *	cm,
		cs_face_mesh_t *	fm,
		cs_cell_sys_t *	csys,
		cs_cell_builder_t *	cb
	)

Build the local matrices arising from the diffusion, advection, reaction terms in CDO-Fb schemes.

Parameters

[in]	time_eval	time at which analytic function are evaluated
[in]	eqp	pointer to a cs_equation_param_t structure
[in]	eqb	pointer to a cs_equation_builder_t structure
[in]	eqc	context for this kind of discretization
[in]	cm	pointer to a cellwise view of the mesh
[in,out]	fm	pointer to a facewise view of the mesh
[in,out]	csys	pointer to a cellwise view of the system
[in,out]	cb	pointer to a cellwise builder

cs_cdofb_vecteq_extra_op()

void cs_cdofb_vecteq_extra_op	(	const char *	eqname,
		const cs_field_t *	field,
		const cs_equation_param_t *	eqp,
		cs_equation_builder_t *	eqb,
		void *	data
	)

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]	data	pointer to cs_cdofb_vecteq_t structure

cs_cdofb_vecteq_finalize_common()

void cs_cdofb_vecteq_finalize_common

(

void

)

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

cs_cdofb_vecteq_free_context()

void* cs_cdofb_vecteq_free_context

(

void *

data

)

Destroy a cs_cdofb_vecteq_t structure.

Parameters

[in,out]

data

pointer to a cs_cdofb_vecteq_t structure

Returns

a NULL pointer

cs_cdofb_vecteq_get()

void cs_cdofb_vecteq_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_vecteq_get_cell_values()

cs_real_t* cs_cdofb_vecteq_get_cell_values

(

void *

context

)

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

Returns

a pointer to an array of cs_real_t

cs_cdofb_vecteq_get_face_values()

cs_real_t* cs_cdofb_vecteq_get_face_values

(

void *

context

)

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

Returns

a pointer to an array of cs_real_t (size n_faces)

cs_cdofb_vecteq_init_cell_system()

void cs_cdofb_vecteq_init_cell_system	(	const cs_flag_t	cell_flag,
		const cs_cell_mesh_t *	cm,
		const cs_equation_param_t *	eqp,
		const cs_equation_builder_t *	eqb,
		const cs_cdofb_vecteq_t *	eqc,
		const cs_real_t	dir_values[],
		const cs_real_t	field_tn[],
		cs_real_t	t_eval,
		cs_cell_sys_t *	csys,
		cs_cell_builder_t *	cb
	)

Initialize the local structure for the current cell.

Parameters

[in]	cell_flag	flag related to the current cell
[in]	cm	pointer to a cellwise view of the mesh
[in]	eqp	pointer to a cs_equation_param_t structure
[in]	eqb	pointer to a cs_equation_builder_t structure
[in]	eqc	pointer to a cs_cdofb_vecteq_t structure
[in]	dir_values	Dirichlet values associated to each face
[in]	field_tn	values of the field at the last computed time
[in]	t_eval	time at which one performs the evaluation
[in,out]	csys	pointer to a cellwise view of the system
[in,out]	cb	pointer to a cellwise builder

cs_cdofb_vecteq_init_common()

void cs_cdofb_vecteq_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 vector-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
[in]	ms	pointer to a cs_matrix_structure_t structure

cs_cdofb_vecteq_init_context()

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

Initialize a cs_cdofb_vecteq_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_vecteq_t structure

cs_cdofb_vecteq_init_values()

void cs_cdofb_vecteq_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 vector-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_vecteq_is_initialized()

bool cs_cdofb_vecteq_is_initialized

(

void

)

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

Returns

true or false

cs_cdofb_vecteq_matrix_structure()

const cs_matrix_structure_t* cs_cdofb_vecteq_matrix_structure

(

void

)

Get the pointer to the related cs_matrix_structure_t.

Returns

a pointer to a cs_matrix_structure_t structure

cs_cdofb_vecteq_read_restart()

void cs_cdofb_vecteq_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_vecteq_setup_bc()

void cs_cdofb_vecteq_setup_bc	(	cs_real_t	t_eval,
		const cs_mesh_t *	mesh,
		const cs_equation_param_t *	eqp,
		cs_equation_builder_t *	eqb,
		cs_real_t *	p_dir_values[]
	)

Set the boundary conditions known from the settings.

Parameters

[in]	t_eval	time at which one evaluates BCs
[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]	p_dir_values	pointer to the Dirichlet values to set

DOXYGEN_SHOULD_SKIP_THIS

Parameters

[in]	t_eval	time at which one evaluates BCs
[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]	p_dir_values	pointer to the Dirichlet values to set

cs_cdofb_vecteq_solve_implicit()

void cs_cdofb_vecteq_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 vector diffusion equation with a CDO-Fb scheme and an implicit Euler 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_cdofb_vecteq_t structure

cs_cdofb_vecteq_solve_steady_state()

void cs_cdofb_vecteq_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 vector steady-state diffusion equation with a CDO-Fb 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_cdofb_vecteq_t structure

cs_cdofb_vecteq_solve_system()

int cs_cdofb_vecteq_solve_system	(	cs_sles_t *	sles,
		const cs_matrix_t *	matrix,
		const cs_equation_param_t *	eqp,
		cs_real_t *	x,
		cs_real_t *	b
	)

Solve a linear system arising from a scalar-valued CDO-Fb scheme.

Parameters

[in,out]	sles	pointer to a cs_sles_t structure
[in]	matrix	pointer to a cs_matrix_t structure
[in]	eqp	pointer to a cs_equation_param_t structure
[in,out]	x	solution of the linear system (in: initial guess)
[in,out]	b	right-hand side (scatter/gather if needed)

Returns

the number of iterations of the linear solver

cs_cdofb_vecteq_solve_theta()

void cs_cdofb_vecteq_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 vector diffusion equation with a CDO-Fb scheme and an implicit/explicit theta 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_cdofb_vecteq_t structure

cs_cdofb_vecteq_sourceterm()

static void cs_cdofb_vecteq_sourceterm ( const cs_cell_mesh_t *  cm, const cs_equation_param_t *  eqp, const cs_real_t  t_eval, const cs_real_t  coef, cs_cell_builder_t *  cb, cs_equation_builder_t *  eqb, cs_cell_sys_t *  csys  )

inlinestatic

Compute the term source for a vector-valued CDO-Fb scheme and add it to the local rhs.

Parameters

[in]	cm	pointer to a cs_cell_mesh_t structure
[in]	eqp	pointer to a cs_equation_param_t structure
[in]	t_eval	time at which the term source is evaluated
[in]	coef	scaling of the time source (for theta schemes)
[in,out]	cb	pointer to a cs_cell_builder_t structure
[in,out]	eqb	pointer to a cs_equation_builder_t structure
[in,out]	csys	pointer to a cs_cell_sys_t structure

cs_cdofb_vecteq_update_field()

void cs_cdofb_vecteq_update_field	(	const cs_real_t *	solu,
		const cs_real_t *	rhs,
		const cs_equation_param_t *	eqp,
		cs_equation_builder_t *	eqb,
		void *	data,
		cs_real_t *	field_val
	)

Store solution(s) of the linear system into a field structure Update extra-field values if required (for hybrid discretization)

Parameters

[in]	solu	solution array
[in]	rhs	rhs associated to this solution array
[in]	eqp	pointer to a cs_equation_param_t structure
[in,out]	eqb	pointer to a cs_equation_builder_t structure
[in,out]	data	pointer to cs_cdofb_vecteq_t structure
[in,out]	field_val	pointer to the current value of the field

cs_cdofb_vecteq_write_restart()

void cs_cdofb_vecteq_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