cs_equation_bc.h File Reference

#include "cs_cdo_bc.h"
#include "cs_cdo_connect.h"
#include "cs_xdef_eval.h"
#include "cs_cdo_quantities.h"
#include "cs_cdo_local.h"
#include "cs_equation_param.h"
#include "cs_time_step.h"

Include dependency graph for cs_equation_bc.h:

Go to the source code of this file.

Functions
void	cs_equation_init_boundary_flux_from_bc (cs_real_t t_eval, const cs_cdo_quantities_t *cdoq, const cs_equation_param_t *eqp, cs_real_t *values)
	Set the values for the normal boundary flux stemming from the Neumann boundary conditions (zero is left where a Dirichlet is set. This can be updated later one) More...
void	cs_equation_vb_set_cell_bc (const cs_cell_mesh_t *cm, const cs_cdo_connect_t *connect, const cs_cdo_quantities_t *quant, const cs_equation_param_t *eqp, const cs_real_t dir_values[], const short int neu_tags[], cs_real_t t_eval, cs_cell_sys_t *csys, cs_cell_builder_t *cb)
	Set the BC into a cellwise view of the current system. Case of vertex-based schemes. More...
void	cs_equation_fb_set_cell_bc (const cs_cell_mesh_t *cm, const cs_cdo_connect_t *connect, const cs_cdo_quantities_t *quant, const cs_equation_param_t *eqp, const cs_real_t dir_values[], const short int neu_tags[], cs_real_t t_eval, cs_cell_sys_t *csys, cs_cell_builder_t *cb)
	Set the BC into a cellwise view of the current system. Case of Face-based schemes. More...
void	cs_equation_compute_dirichlet_vb (const cs_mesh_t *mesh, const cs_cdo_quantities_t *quant, const cs_cdo_connect_t *connect, const cs_equation_param_t *eqp, const cs_cdo_bc_t *face_bc, cs_real_t t_eval, cs_cell_builder_t *cb, cs_real_t *values)
	Compute the values of the Dirichlet BCs when DoFs are attached to vertices. More...
void	cs_equation_compute_dirichlet_fb (const cs_mesh_t *mesh, const cs_cdo_quantities_t *quant, const cs_cdo_connect_t *connect, const cs_equation_param_t *eqp, const cs_cdo_bc_t *face_bc, cs_real_t t_eval, cs_cell_builder_t *cb, cs_real_t *values)
	Compute the values of the Dirichlet BCs when DoFs are attached to CDO face-based schemes. More...
cs_flag_t *	cs_equation_set_vertex_bc_flag (const cs_cdo_connect_t *connect, const cs_cdo_bc_t *face_bc)
	Define an array of flags for each vertex collecting the flags of associated boundary faces. More...
short int *	cs_equation_tag_neumann_face (const cs_cdo_quantities_t *quant, const cs_equation_param_t *eqp)
	Tag each face related to a Neumann BC with its definition id. Default tag is -1 (not a Neumann face) More...
void	cs_equation_compute_neumann_sv (short int def_id, short int f, const cs_cdo_quantities_t *quant, const cs_equation_param_t *eqp, const cs_cell_mesh_t *cm, const short int *f2v_ids, cs_real_t t_eval, double *neu_values)
	Compute the values of the Neumann BCs when DoFs are scalar-valued and attached to vertices. More...
void	cs_equation_compute_neumann_fb (short int def_id, short int f, const cs_cdo_quantities_t *quant, const cs_equation_param_t *eqp, const cs_cell_mesh_t *cm, cs_real_t t_eval, double *neu_values)
	Compute the values of the Neumann BCs when DoFs are attached to faces. More...

Function Documentation

cs_equation_compute_dirichlet_fb()

void cs_equation_compute_dirichlet_fb	(	const cs_mesh_t *	mesh,
		const cs_cdo_quantities_t *	quant,
		const cs_cdo_connect_t *	connect,
		const cs_equation_param_t *	eqp,
		const cs_cdo_bc_t *	face_bc,
		cs_real_t	t_eval,
		cs_cell_builder_t *	cb,
		cs_real_t *	values
	)

Compute the values of the Dirichlet BCs when DoFs are attached to CDO face-based schemes.

Parameters

[in]	mesh	pointer to a cs_mesh_t structure
[in]	quant	pointer to a cs_cdo_quantities_t structure
[in]	connect	pointer to a cs_cdo_connect_t struct.
[in]	eqp	pointer to a cs_equation_param_t
[in]	face_bc	pointer to a cs_cdo_bc_t structure
[in]	t_eval	time at which one evaluates the boundary cond.
[in,out]	cb	pointer to a cs_cell_builder_t structure
[in,out]	values	pointer to the array of values to set

cs_equation_compute_dirichlet_vb()

void cs_equation_compute_dirichlet_vb	(	const cs_mesh_t *	mesh,
		const cs_cdo_quantities_t *	quant,
		const cs_cdo_connect_t *	connect,
		const cs_equation_param_t *	eqp,
		const cs_cdo_bc_t *	face_bc,
		cs_real_t	t_eval,
		cs_cell_builder_t *	cb,
		cs_real_t *	values
	)

Compute the values of the Dirichlet BCs when DoFs are attached to vertices.

Parameters

[in]	mesh	pointer to a cs_mesh_t structure
[in]	quant	pointer to a cs_cdo_quantities_t structure
[in]	connect	pointer to a cs_cdo_connect_t struct.
[in]	eqp	pointer to a cs_equation_param_t
[in]	face_bc	pointer to a cs_cdo_bc_t structure
[in]	t_eval	time at which one performs the evaluation
[in,out]	cb	pointer to a cs_cell_builder_t structure
[in,out]	values	pointer to the array of values to set

cs_equation_compute_neumann_fb()

void cs_equation_compute_neumann_fb	(	short int	def_id,
		short int	f,
		const cs_cdo_quantities_t *	quant,
		const cs_equation_param_t *	eqp,
		const cs_cell_mesh_t *	cm,
		cs_real_t	t_eval,
		double *	neu_values
	)

Compute the values of the Neumann BCs when DoFs are attached to faces.

Parameters

[in]	def_id	id of the definition for setting the Neumann BC
[in]	f	local face number in the cs_cell_mesh_t
[in]	quant	pointer to a cs_cdo_quantities_t structure
[in]	eqp	pointer to a cs_equation_param_t
[in]	cm	pointer to a cs_cell_mesh_t structure
[in]	t_eval	time at which one performs the evaluation
[in,out]	neu_values	array storing Neumann values to use

cs_equation_compute_neumann_sv()

void cs_equation_compute_neumann_sv	(	short int	def_id,
		short int	f,
		const cs_cdo_quantities_t *	quant,
		const cs_equation_param_t *	eqp,
		const cs_cell_mesh_t *	cm,
		const short int *	f2v_ids,
		cs_real_t	t_eval,
		double *	neu_values
	)

Compute the values of the Neumann BCs when DoFs are scalar-valued and attached to vertices.

Parameters

[in]	def_id	id of the definition for setting the Neumann BC
[in]	f	local face number in the cs_cell_mesh_t
[in]	quant	pointer to a cs_cdo_quantities_t structure
[in]	eqp	pointer to a cs_equation_param_t
[in]	cm	pointer to a cs_cell_mesh_t structure
[in]	f2v_ids	vertex ids of the face in the cell numbering
[in]	t_eval	time at which one performs the evaluation
[in,out]	neu_values	array storing the Neumann values

cs_equation_fb_set_cell_bc()

void cs_equation_fb_set_cell_bc	(	const cs_cell_mesh_t *	cm,
		const cs_cdo_connect_t *	connect,
		const cs_cdo_quantities_t *	quant,
		const cs_equation_param_t *	eqp,
		const cs_real_t	dir_values[],
		const short int	neu_tags[],
		cs_real_t	t_eval,
		cs_cell_sys_t *	csys,
		cs_cell_builder_t *	cb
	)

Set the BC into a cellwise view of the current system. Case of Face-based schemes.

Parameters

[in]	cm	pointer to a cellwise view of the mesh
[in]	connect	pointer to a cs_cdo_connect_t struct.
[in]	quant	pointer to a cs_cdo_quantities_t structure
[in]	eqp	pointer to a cs_equation_param_t structure
[in]	dir_values	Dirichlet values associated to each vertex
[in]	neu_tags	definition id related to each Neumann face
[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_equation_init_boundary_flux_from_bc()

void cs_equation_init_boundary_flux_from_bc	(	cs_real_t	t_eval,
		const cs_cdo_quantities_t *	cdoq,
		const cs_equation_param_t *	eqp,
		cs_real_t *	values
	)

Set the values for the normal boundary flux stemming from the Neumann boundary conditions (zero is left where a Dirichlet is set. This can be updated later one)

Parameters

[in]	t_eval	time at which one performs the evaluation
[in]	cdoq	pointer to a cs_cdo_quantities_t structure
[in]	eqp	pointer to a cs_equation_param_t structure
[in,out]	values	pointer to the array of values to set

Set the values for the normal boundary flux stemming from the Neumann boundary conditions (zero is left where a Dirichlet is set. This can be updated later one)

Parameters

[in]	t_eval	time at which one performs the evaluation
[in]	cdoq	pointer to a cs_cdo_quantities_t structure
[in]	eqp	pointer to a cs_equation_param_t structure
[in,out]	values	pointer to the array of values to set

cs_equation_set_vertex_bc_flag()

cs_flag_t* cs_equation_set_vertex_bc_flag	(	const cs_cdo_connect_t *	connect,
		const cs_cdo_bc_t *	face_bc
	)

Define an array of flags for each vertex collecting the flags of associated boundary faces.

Parameters

[in]	connect	pointer to a cs_cdo_connect_t struct.
[in]	face_bc	pointer to a structure collecting boundary conditions applied to faces

Returns

an array collecting bc flags

cs_equation_tag_neumann_face()

short int* cs_equation_tag_neumann_face	(	const cs_cdo_quantities_t *	quant,
		const cs_equation_param_t *	eqp
	)

Tag each face related to a Neumann BC with its definition id. Default tag is -1 (not a Neumann face)

Parameters

[in]	quant	pointer to a cs_cdo_quantities_t structure
[in]	eqp	pointer to a cs_equation_param_t

Returns

an array with prescribed tags

cs_equation_vb_set_cell_bc()

void cs_equation_vb_set_cell_bc	(	const cs_cell_mesh_t *	cm,
		const cs_cdo_connect_t *	connect,
		const cs_cdo_quantities_t *	quant,
		const cs_equation_param_t *	eqp,
		const cs_real_t	dir_values[],
		const short int	neu_tags[],
		cs_real_t	t_eval,
		cs_cell_sys_t *	csys,
		cs_cell_builder_t *	cb
	)

Set the BC into a cellwise view of the current system. Case of vertex-based schemes.

Parameters

[in]	cm	pointer to a cellwise view of the mesh
[in]	connect	pointer to a cs_cdo_connect_t struct.
[in]	quant	pointer to a cs_cdo_quantities_t structure
[in]	eqp	pointer to a cs_equation_param_t structure
[in]	dir_values	Dirichlet values associated to each vertex
[in]	neu_tags	definition id related to each Neumann face
[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