programmer's documentation
Functions
cs_boundary_conditions.h File Reference
#include "fvm_nodal.h"
#include "fvm_writer.h"
#include "cs_base.h"
#include "cs_field.h"
#include "cs_mesh_location.h"
Include dependency graph for cs_boundary_conditions.h:

Go to the source code of this file.

Functions

void cs_boundary_conditions_error (const cs_int_t bc_type[])
 Handling of boundary condition definition errors and associated output. More...
 
ple_locator_t * cs_boundary_conditions_map (cs_mesh_location_type_t location_type, cs_lnum_t n_location_elts, cs_lnum_t n_faces, const cs_lnum_t *location_elts, const cs_lnum_t *faces, cs_real_3_t *coord_shift, int coord_stride, double tolerance)
 Locate shifted boundary face coordinates on possibly filtered cells or boundary faces for later interpolation. More...
 
void cs_boundary_conditions_mapped_set (cs_field_t *f, ple_locator_t *locator, cs_mesh_location_type_t location_type, int normalize, int interpolate, cs_lnum_t n_faces, const cs_lnum_t *faces, cs_real_t *balance_w, int nvarcl, cs_real_t rcodcl[])
 Set mapped boundary conditions for a given field and mapping locator. More...
 

Function Documentation

void cs_boundary_conditions_error ( const cs_int_t  bc_type[])

Handling of boundary condition definition errors and associated output.

For each boundary face, bc_type defines the boundary condition type. As a convention here, zero values correspond to undefined types, positive values to defined types (with no error), and negative values to defined types with inconsistent or incompatible values, the absolute value indicating the original boundary condition type.

Parameters
[in]bc_typearray of BC type ids
ple_locator_t* cs_boundary_conditions_map ( cs_mesh_location_type_t  location_type,
cs_lnum_t  n_location_elts,
cs_lnum_t  n_faces,
const cs_lnum_t location_elts,
const cs_lnum_t faces,
cs_real_3_t coord_shift,
int  coord_stride,
double  tolerance 
)

Locate shifted boundary face coordinates on possibly filtered cells or boundary faces for later interpolation.

Parameters
[in]location_typematching values location (CS_MESH_LOCATION_CELLS or CS_MESH_LOCATION_BOUNDARY_FACES)
[in]n_location_eltsnumber of selected location elements
[in]n_facesnumber of selected boundary faces
[in]location_eltslist of selected location elements (0 to n-1), or NULL if no indirection is needed
[in]faceslist of selected boundary faces (0 to n-1), or NULL if no indirection is needed
[in]coord_shiftarray of coordinates shift relative to selected boundary faces
[in]coord_strideaccess stride in coord_shift: 0 for uniform shift, 1 for "per face" shift.
[in]tolerancerelative tolerance for point location.
Returns
associated locator structure
void cs_boundary_conditions_mapped_set ( cs_field_t f,
ple_locator_t *  locator,
cs_mesh_location_type_t  location_type,
int  normalize,
int  interpolate,
cs_lnum_t  n_faces,
const cs_lnum_t faces,
cs_real_t balance_w,
int  nvarcl,
cs_real_t  rcodcl[] 
)

Set mapped boundary conditions for a given field and mapping locator.

Parameters
[in]ffield whose boundary conditions are set
[in]locatorassociated mapping locator, as returned by cs_boundary_conditions_map.
[in]location_typematching values location (CS_MESH_LOCATION_CELLS or CS_MESH_LOCATION_BOUNDARY_FACES)
[in]normalizenormalization option: 0: values are simply mapped 1: values are mapped, then multiplied by a constant factor so that their surface integral on selected faces is preserved (relative to the input values) 2: as 1, but with a boundary-defined weight, defined by balance_w 3: as 1, but with a cell-defined weight, defined by balance_w
[in]interpolateinterpolation option: 0: values are simply based on matching cell or face center values 1: values are based on matching cell or face center values, corrected by gradient interpolation
[in]n_facesnumber of selected boundary faces
[in]faceslist of selected boundary faces (0 to n-1), or NULL if no indirection is needed
[in]balance_woptional balance weight, or NULL
[in]nvarclnumber of variables requiring BC's
[in,out]rcodclboundary condition values