cs_boundary.h File Reference

#include "cs_base.h"
#include "cs_defs.h"

Include dependency graph for cs_boundary.h:

Go to the source code of this file.

Data Structures
struct	cs_boundary_t
	Structure storing information related to the "physical" boundaries that one want to set on the computational domain. More...

Macros
#define	CS_BOUNDARY_WALLS_NAME   "cs_boundary_walls"

Enumerations
enum	cs_boundary_type_t {   CS_BOUNDARY_WALL, CS_BOUNDARY_SLIDING_WALL, CS_BOUNDARY_INLET, CS_BOUNDARY_OUTLET,   CS_BOUNDARY_PRESSURE_INLET_OUTLET, CS_BOUNDARY_SYMMETRY, CS_BOUNDARY_ALE_FIXED, CS_BOUNDARY_ALE_SLIDING,   CS_BOUNDARY_ALE_IMPOSED_VEL, CS_BOUNDARY_ALE_IMPOSED_DISP, CS_BOUNDARY_ALE_INTERNAL_COUPLING, CS_BOUNDARY_ALE_EXTERNAL_COUPLING,   CS_BOUNDARY_ALE_FREE_SURFACE, CS_BOUNDARY_N_TYPES }

Functions
const char *	cs_boundary_get_name (cs_boundary_type_t type)
	Get the name of the domain boundary condition. More...
bool	cs_boundary_has_pressure_boundary (const cs_boundary_t *boundaries)
	Check if there is a pressure-related boundary among the prescribed bounadries. More...
int	cs_boundary_id_by_zone_id (const cs_boundary_t *boundaries, int z_id)
	Retrieve the related id associated to a boundary from its zone id. More...
void	cs_boundary_set_default (cs_boundary_t *boundaries, cs_boundary_type_t type)
	Set the default boundary related to the given cs_boundary_t structure. More...
cs_boundary_t *	cs_boundary_create (cs_boundary_type_t type)
	Create a default boundary structure for the computational domain. More...
void	cs_boundary_free (cs_boundary_t **p_boundaries)
	Free all metadate related to the domain boundaries. More...
void	cs_boundary_add (cs_boundary_t *bdy, cs_boundary_type_t type, const char *zone_name)
	Add a new boundary type for a given boundary zone. More...
void	cs_boundary_build_type_array (const cs_boundary_t *boundaries, cs_lnum_t n_b_faces, cs_boundary_type_t *bf_type)
	Build an array on boundary faces which specify the type of boundary for each face. More...
void	cs_boundary_def_wall_zones (cs_boundary_t *boundaries)
	Add a new zone gathering all CS_BOUNDARY_WALL zone type. More...
void	cs_boundary_log_setup (const cs_boundary_t *bdy)
	Summarize the setup of the boundary of the computational domain. More...

Variables
cs_boundary_t *	cs_glob_boundaries

Macro Definition Documentation

CS_BOUNDARY_WALLS_NAME

#define CS_BOUNDARY_WALLS_NAME   "cs_boundary_walls"

Enumeration Type Documentation

cs_boundary_type_t

enum cs_boundary_type_t

Enumerator
CS_BOUNDARY_WALL
CS_BOUNDARY_SLIDING_WALL
CS_BOUNDARY_INLET
CS_BOUNDARY_OUTLET
CS_BOUNDARY_PRESSURE_INLET_OUTLET
CS_BOUNDARY_SYMMETRY
CS_BOUNDARY_ALE_FIXED
CS_BOUNDARY_ALE_SLIDING
CS_BOUNDARY_ALE_IMPOSED_VEL
CS_BOUNDARY_ALE_IMPOSED_DISP
CS_BOUNDARY_ALE_INTERNAL_COUPLING
CS_BOUNDARY_ALE_EXTERNAL_COUPLING
CS_BOUNDARY_ALE_FREE_SURFACE
CS_BOUNDARY_N_TYPES

Function Documentation

cs_boundary_add()

void cs_boundary_add	(	cs_boundary_t *	bdy,
		cs_boundary_type_t	type,
		const char *	zone_name
	)

Add a new boundary type for a given boundary zone.

Parameters

[in,out]	bdy	pointer to a structure storing boundary info
[in]	type	type of boundary to set
[in]	zone_name	name of the zone related to this boundary

cs_boundary_build_type_array()

void cs_boundary_build_type_array	(	const cs_boundary_t *	boundaries,
		cs_lnum_t	n_b_faces,
		cs_boundary_type_t *	bf_type
	)

Build an array on boundary faces which specify the type of boundary for each face.

Parameters

[in]	boundaries	pointer to the domain boundaries
[in]	n_b_faces	number of boundaries faces
[in,out]	bf_type	array to define the type of boundary

cs_boundary_create()

cs_boundary_t* cs_boundary_create

(

cs_boundary_type_t

type

)

Create a default boundary structure for the computational domain.

Parameters

[in]

type

default type of boundary to set

Returns

a pointer to the new allocated structure

cs_boundary_def_wall_zones()

void cs_boundary_def_wall_zones

(

cs_boundary_t *

bdy

)

Add a new zone gathering all CS_BOUNDARY_WALL zone type.

Parameters

[in,out]

boundaries

pointer to the domain boundaries

cs_boundary_free()

void cs_boundary_free

(

cs_boundary_t **

p_boundaries

)

Free all metadate related to the domain boundaries.

Parameters

[in,out]

p_boundaries

pointer to the structure to free

cs_boundary_get_name()

const char* cs_boundary_get_name

(

cs_boundary_type_t

type

)

Get the name of the domain boundary condition.

Parameters

[in]

type

type of domain boundary

Returns

the associated boundary name

Get the name of the domain boundary condition.

Parameters

[in]

type

type of boundary

Returns

the associated boundary name

cs_boundary_has_pressure_boundary()

bool cs_boundary_has_pressure_boundary

(

const cs_boundary_t *

boundaries

)

Check if there is a pressure-related boundary among the prescribed bounadries.

Parameters

[in]

boundaries

pointer to a cs_boundary_t structure

Returns

true or false

cs_boundary_id_by_zone_id()

int cs_boundary_id_by_zone_id	(	const cs_boundary_t *	boundaries,
		int	z_id
	)

Retrieve the related id associated to a boundary from its zone id.

Parameters

[in]	boundaries	pointer to a cs_boundary_t structure
[in]	z_id	id of the related zone

Returns

the associated boundary id in the boundary list

cs_boundary_log_setup()

void cs_boundary_log_setup

(

const cs_boundary_t *

bdy

)

Summarize the setup of the boundary of the computational domain.

Parameters

[in]

bdy

pointer to a structure storing boundary info

cs_boundary_set_default()

void cs_boundary_set_default	(	cs_boundary_t *	boundaries,
		cs_boundary_type_t	type
	)

Set the default boundary related to the given cs_boundary_t structure.

Parameters

[in,out]	boundaries	pointer to a structure storing boundary info
[in]	type	type of boundary to set

Variable Documentation

cs_glob_boundaries

cs_boundary_t* cs_glob_boundaries