#include <ple_locator.h>
#include "fvm_nodal.h"
#include "fvm_writer.h"
#include "cs_base.h"
#include "cs_field.h"
#include "cs_math.h"
#include "cs_mesh_location.h"

Include dependency graph for cs_boundary_conditions.h:

Functions
void	cs_boundary_conditions_error (const int bc_type, const char type_name)
	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 (const 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 nvar, cs_real_t rcodcl[])
	Set mapped boundary conditions for a given field and mapping locator. More...

int	cs_boundary_conditions_add_map (int bc_location_id, int source_location_id, cs_real_t coord_shift[3], double tolerance)
	Add location of locate shifted boundary face coordinates on cells or boundary faces for automatic interpolation. More...

void	cs_boundary_conditions_create (void)
	Create the legacy boundary conditions face type and face zone arrays. More...

void	cs_boundary_conditions_free (void)
	Free the boundary conditions face type and face zone arrays. More...

void	cs_boundary_conditions_set_convective_outlet_scalar (cs_real_t coefa, cs_real_t cofaf, cs_real_t coefb, cs_real_t cofbf, cs_real_t pimp, cs_real_t cfl, cs_real_t hint)
	Set convective oulet boundary condition for a scalar. More...

void	cs_boundary_conditions_compute (int nvar, int itypfb[], int icodcl[], double rcodcl[])
	Update per variable boundary condition codes. More...

void	cs_boundary_conditions_complete (int nvar, int itypfb[], int icodcl[], double rcodcl[])
	Automatic adjustments for boundary condition codes. More...

Variables
const int *	cs_glob_bc_type

const int *	cs_glob_bc_face_zone

Function Documentation

◆ cs_boundary_conditions_add_map()

int cs_boundary_conditions_add_map	(	int	bc_location_id,
		int	source_location_id,
		cs_real_t	coord_shift[3],
		double	tolerance
	)

Add location of locate shifted boundary face coordinates on cells or boundary faces for automatic interpolation.

Note: This function is currently restricted to mapping of boundary face locations (usually from boundary zones) to cell of boundary face locations, but could be extended to other location types in the future.

Parameters

[in]	bc_location_id	id of selected boundary mesh location; currently restricted to subsets of boundary faces (i.e. boundary zone location ids).
[in]	source_location_id	id of selected location mesh location (usually CS_MESH_LOCATION_CELLS but can be a more restricted cell or boundary face zone location location id).
[in]	coord_shift	coordinates shift relative to selected boundary faces
[in]	tolerance	relative tolerance for point location.

Returns: id of added map

◆ cs_boundary_conditions_complete()

void cs_boundary_conditions_complete	(	int	nvar,
		int	itypfb[],
		int	icodcl[],
		double	rcodcl[]
	)

Automatic adjustments for boundary condition codes.

Currently handles mapped inlets, after the call to stdtcl. As portions of stdtcl are migrated to C, they should be called here, before mapped inlets.

Parameters

[in]	nvar	number of variables requiring BC's
[in]	itypfb	type of boundary for each face
[in,out]	icodcl	boundary condition codes
[in,out]	rcodcl	boundary condition values

◆ cs_boundary_conditions_compute()

void cs_boundary_conditions_compute	(	int	nvar,
		int	itypfb[],
		int	icodcl[],
		double	rcodcl[]
	)

Update per variable boundary condition codes.

Parameters

[in]	nvar	number of variables requiring BC's
[in]	itypfb	type of boundary for each face
[in,out]	icodcl	boundary condition codes
[in,out]	rcodcl	boundary condition values

◆ cs_boundary_conditions_create()

void cs_boundary_conditions_create ( void )

Create the legacy boundary conditions face type and face zone arrays.

◆ cs_boundary_conditions_error()

void cs_boundary_conditions_error	(	const int *	bc_flag,
		const char *	type_name
	)

Handling of boundary condition definition errors and associated output.

This function checks for errors, and simply returns if no error is encountered. In case of error, it outputs helpful information so as to make it easier to locate the matching faces.

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.

An optional label may be used if the error is related to another attribute than the boundary type, for appropriate error reporting.

Parameters

[in]	bc_flag	array of BC type ids
[in]	type_name	name of attribute in error, or NULL

◆ cs_boundary_conditions_free()

void cs_boundary_conditions_free ( void )

Free the boundary conditions face type and face zone arrays.

This also frees boundary condition mappings which may have been defined.

◆ cs_boundary_conditions_map()

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_type	matching values location (CS_MESH_LOCATION_CELLS or CS_MESH_LOCATION_BOUNDARY_FACES)
[in]	n_location_elts	number of selected location elements
[in]	n_faces	number of selected boundary faces
[in]	location_elts	list of selected location elements (0 to n-1), or NULL if no indirection is needed
[in]	faces	list of selected boundary faces (0 to n-1), or NULL if no indirection is needed
[in]	coord_shift	array of coordinates shift relative to selected boundary faces
[in]	coord_stride	access stride in coord_shift: 0 for uniform shift, 1 for "per face" shift.
[in]	tolerance	relative tolerance for point location.

Returns: associated locator structure

◆ cs_boundary_conditions_mapped_set()

void cs_boundary_conditions_mapped_set	(	const 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	nvar,
		cs_real_t	rcodcl[]
	)

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

Parameters

[in]	f	field whose boundary conditions are set
[in]	locator	associated mapping locator, as returned by cs_boundary_conditions_map.
[in]	location_type	matching values location (CS_MESH_LOCATION_CELLS or CS_MESH_LOCATION_BOUNDARY_FACES)
[in]	normalize	normalization 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]	interpolate	interpolation 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_faces	number of selected boundary faces
[in]	faces	list of selected boundary faces (0 to n-1), or NULL if no indirection is needed
[in]	balance_w	optional balance weight, or NULL
[in]	nvar	number of variables requiring BC's
[in,out]	rcodcl	boundary condition values

◆ cs_boundary_conditions_set_convective_outlet_scalar()

void cs_boundary_conditions_set_convective_outlet_scalar	(	cs_real_t *	coefa,
		cs_real_t *	cofaf,
		cs_real_t *	coefb,
		cs_real_t *	cofbf,
		cs_real_t	pimp,
		cs_real_t	cfl,
		cs_real_t	hint
	)

Set convective oulet boundary condition for a scalar.

Parameters:

Parameters

[out]	coefa	explicit BC coefficient for gradients
[out]	cofaf	explicit BC coefficient for diffusive flux
[out]	coefb	implicit BC coefficient for gradients
[out]	cofbf	implicit BC coefficient for diffusive flux
[in]	pimp	Flux value to impose
[in]	cfl	Local Courant number used to convect
[in]	hint	Internal exchange coefficient
[out]	coefa	explicit BC coefficient for gradients
[out]	cofaf	explicit BC coefficient for diffusive flux
[out]	coefb	implicit BC coefficient for gradients
[out]	cofbf	implicit BC coefficient for diffusive flux
[in]	pimp	Flux value to impose
[in]	cfl	Local Courant number used to convect
[in]	hint	Internal exchange coefficient

Variable Documentation

◆ cs_glob_bc_face_zone

const int* cs_glob_bc_face_zone

boundary zone number associated with each boundary face (specific physical models)

◆ cs_glob_bc_type

const int* cs_glob_bc_type

Boundary condition type (code) associated with each boundary face

Functions

Variables

Function Documentation

◆ cs_boundary_conditions_add_map()

◆ cs_boundary_conditions_complete()

◆ cs_boundary_conditions_compute()

◆ cs_boundary_conditions_create()

◆ cs_boundary_conditions_error()

◆ cs_boundary_conditions_free()

◆ cs_boundary_conditions_map()

◆ cs_boundary_conditions_mapped_set()

◆ cs_boundary_conditions_set_convective_outlet_scalar()

Variable Documentation

◆ cs_glob_bc_face_zone

◆ cs_glob_bc_type