cs_cdo_bc.h File Reference

#include "base/cs_base.h"
#include "cdo/cs_cdo_quantities.h"
#include "base/cs_param_types.h"
#include "base/cs_time_step.h"
#include "cdo/cs_xdef.h"

Include dependency graph for cs_cdo_bc.h:

Go to the source code of this file.

Data Structures
struct	cs_cdo_bc_face_t

Macros
#define	CS_CDO_BC_DEFAULT_DEF   -1
#define	CS_CDO_BC_NEUMANN   (1 << 0)
#define	CS_CDO_BC_FULL_NEUMANN   (1 << 1)
#define	CS_CDO_BC_SYMMETRY   (1 << 2)
#define	CS_CDO_BC_DIRICHLET   (1 << 3)
#define	CS_CDO_BC_HMG_DIRICHLET   (1 << 4)
#define	CS_CDO_BC_ROBIN   (1 << 5)
#define	CS_CDO_BC_TANGENTIAL_DIRICHLET   (1 << 6)
#define	CS_CDO_BC_WALL_PRESCRIBED   (1 << 7)

Functions
static void	cs_cdo_bc_get_desc (cs_flag_t bc_flag, char *desc)
	Convert a flag into a description.
static cs_flag_t	cs_cdo_bc_get_flag (cs_param_bc_type_t bc_type)
	Convert a cs_param_bc_type_t into a flag (enable multiple type for a same entity as required for vertices and edges)
static bool	cs_cdo_bc_is_dirichlet (cs_flag_t flag)
	Check if a flag is associated to a Dirichlet BC (homogeneous or not)
static bool	cs_cdo_bc_is_neumann (cs_flag_t flag)
	Check if a flag is associated to a Neumann BC (homogeneous or not)
static bool	cs_cdo_bc_is_sliding (cs_flag_t flag)
	Check if a flag is associated to a sliding boundary.
static bool	cs_cdo_bc_is_circulation (cs_flag_t flag)
	Check if a flag is associated to a Dirichlet BC (homogeneous or not)
cs_cdo_bc_face_t *	cs_cdo_bc_face_define (cs_param_bc_type_t default_bc, bool is_steady, int dim, int n_defs, cs_xdef_t **defs, cs_lnum_t n_b_faces)
	Define the structure which translates the BC definitions from the user viewpoint into a ready-to-use structure for setting the arrays keeping the values of the boundary condition to set.
cs_cdo_bc_face_t *	cs_cdo_bc_free (cs_cdo_bc_face_t *face_bc)
	Free a cs_cdo_bc_face_t structure.

Macro Definition Documentation

CS_CDO_BC_DEFAULT_DEF

#define CS_CDO_BC_DEFAULT_DEF   -1

Function Documentation

cs_cdo_bc_face_define()

cs_cdo_bc_face_t * cs_cdo_bc_face_define	(	cs_param_bc_type_t	default_bc,
		bool	is_steady,
		int	dim,
		int	n_defs,
		cs_xdef_t **	defs,
		cs_lnum_t	n_b_faces )

Define the structure which translates the BC definitions from the user viewpoint into a ready-to-use structure for setting the arrays keeping the values of the boundary condition to set.

Parameters

[in]	default_bc	type of boundary condition to set by default
[in]	is_steady	modification or not of the BC selection in time
[in]	dim	dimension of the related equation
[in]	n_defs	number of boundary definitions
[in]	defs	list of boundary condition definition
[in]	n_b_faces	number of border faces

Returns

a pointer to a new allocated cs_cdo_bc_face_t structure

cs_cdo_bc_free()

cs_cdo_bc_face_t * cs_cdo_bc_free

(

cs_cdo_bc_face_t *

face_bc

)

Free a cs_cdo_bc_face_t structure.

Parameters

[in,out]

face_bc

pointer to a cs_cdo_bc_face_t structure

Returns

a null pointer

cs_cdo_bc_get_desc()

void cs_cdo_bc_get_desc ( cs_flag_t bc_flag, char * desc )

inlinestatic

Convert a flag into a description.

Parameters

[in]	bc_flag	flag of boundary condition
[in,out]	desc	string storing the description of the BC

cs_cdo_bc_get_flag()

cs_flag_t cs_cdo_bc_get_flag ( cs_param_bc_type_t bc_type )

inlinestatic

Convert a cs_param_bc_type_t into a flag (enable multiple type for a same entity as required for vertices and edges)

Parameters

[in]

bc_type

predefined type of boundary condition

Returns

a flag corresponding to the given type of boundary condition

cs_cdo_bc_is_circulation()

bool cs_cdo_bc_is_circulation ( cs_flag_t flag )

inlinestatic

Check if a flag is associated to a Dirichlet BC (homogeneous or not)

Parameters

[in]

flag

flag to test

Returns

true or false

cs_cdo_bc_is_dirichlet()

bool cs_cdo_bc_is_dirichlet ( cs_flag_t flag )

inlinestatic

Check if a flag is associated to a Dirichlet BC (homogeneous or not)

Parameters

[in]

flag

flag to test

Returns

true or false

cs_cdo_bc_is_neumann()

bool cs_cdo_bc_is_neumann ( cs_flag_t flag )

inlinestatic

Check if a flag is associated to a Neumann BC (homogeneous or not)

Parameters

[in]

flag

flag to test

Returns

true or false

cs_cdo_bc_is_sliding()

bool cs_cdo_bc_is_sliding ( cs_flag_t flag )

inlinestatic

Check if a flag is associated to a sliding boundary.

Parameters

[in]

flag

flag to test

Returns

true or false