7.1
general documentation
cs_cdo_bc.h File Reference
#include "cs_base.h"
#include "cs_cdo_quantities.h"
#include "cs_param_types.h"
#include "cs_time_step.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_face_t
 

Macros

#define CS_CDO_BC_DEFAULT_DEF   -1
 
#define CS_CDO_BC_NEUMANN   (1 << 0)
 
#define CS_CDO_BC_HMG_NEUMANN   (1 << 1)
 
#define CS_CDO_BC_DIRICHLET   (1 << 2)
 
#define CS_CDO_BC_HMG_DIRICHLET   (1 << 3)
 
#define CS_CDO_BC_ROBIN   (1 << 4)
 
#define CS_CDO_BC_SLIDING   (1 << 5)
 
#define CS_CDO_BC_TANGENTIAL_DIRICHLET   (1 << 6)
 

Functions

cs_cdo_bc_face_tcs_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. More...
 
cs_cdo_bc_face_tcs_cdo_bc_free (cs_cdo_bc_face_t *face_bc)
 Free a cs_cdo_bc_face_t structure. More...
 

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_bctype of boundary condition to set by default
[in]is_steadymodification or not of the BC selection in time
[in]dimdimension of the related equation
[in]n_defsnumber of boundary definitions
[in]defslist of boundary condition definition
[in]n_b_facesnumber 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_bcpointer to a cs_cdo_bc_face_t structure
Returns
a NULL pointer