programmer's documentation
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Data Structures | Macros | Functions
cs_cdo_bc.h File Reference
#include "cs_base.h"
#include "cs_time_step.h"
#include "cs_param.h"
#include "cs_cdo_quantities.h"
#include "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_list_t
 
struct  cs_cdo_bc_t
 

Macros

#define CS_CDO_BC_DIRICHLET   (1 << 0)
 
#define CS_CDO_BC_HMG_DIRICHLET   (1 << 1)
 
#define CS_CDO_BC_NEUMANN   (1 << 2)
 
#define CS_CDO_BC_HMG_NEUMANN   (1 << 3)
 
#define CS_CDO_BC_ROBIN   (1 << 4)
 

Functions

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) More...
 
cs_cdo_bc_list_tcs_cdo_bc_list_create (cs_lnum_t n_elts, cs_lnum_t n_nhmg_elts)
 Create a cs_cdo_bc_list_t structure. More...
 
cs_cdo_bc_list_tcs_cdo_bc_list_free (cs_cdo_bc_list_t *bcl)
 Free a cs_cdo_bc_list_t structure. More...
 
cs_cdo_bc_tcs_cdo_bc_define (cs_param_bc_type_t default_bc, int n_desc, cs_xdef_t **desc, cs_lnum_t n_b_faces)
 Define the structure which translates the BC definition from the user viewpoint into a ready-to-use structure for setting the arrays keeping the values of the boundary condition to set. More...
 
cs_cdo_bc_tcs_cdo_bc_free (cs_cdo_bc_t *face_bc)
 Free a cs_cdo_bc_t structure. More...
 

Function Documentation

cs_cdo_bc_t* cs_cdo_bc_define ( cs_param_bc_type_t  default_bc,
int  n_desc,
cs_xdef_t **  desc,
cs_lnum_t  n_b_faces 
)

Define the structure which translates the BC definition 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_bctype of boundary condition to set by default
[in]n_descnumber of boundary definitions
[in]desclist of boundary condition definition
[in]n_b_facesnumber of border faces
Returns
a pointer to a new allocated cs_cdo_bc_t structure
cs_cdo_bc_t* cs_cdo_bc_free ( cs_cdo_bc_t face_bc)

Free a cs_cdo_bc_t structure.

Parameters
[in,out]face_bcpointer to a cs_cdo_bc_t structure
Returns
a NULL pointer
static 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_typepredefined type of boundary condition
Returns
a flag corresponding to the given type of boundary condition
cs_cdo_bc_list_t* cs_cdo_bc_list_create ( cs_lnum_t  n_elts,
cs_lnum_t  n_nhmg_elts 
)

Create a cs_cdo_bc_list_t structure.

Parameters
[in]n_eltsnumber of entries of the list
[in]n_nhmg_eltsnumber of elements attached to a homogeneous BC
Returns
a new allocated pointer to a cs_cdo_bc_list_t structure
cs_cdo_bc_list_t* cs_cdo_bc_list_free ( cs_cdo_bc_list_t bcl)

Free a cs_cdo_bc_list_t structure.

Parameters
[in]bclpointer to the cs_cdo_bc_list_t structure to free
Returns
a NULL pointer