cs_domain_boundary.h File Reference

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

Include dependency graph for cs_domain_boundary.h:

Go to the source code of this file.

Macros
#define	CS_DOMAIN_BOUNDARY_WALLS_NAME   "cs_domain_boundary_walls"

Enumerations
enum	cs_domain_boundary_type_t {   CS_DOMAIN_BOUNDARY_WALL, CS_DOMAIN_BOUNDARY_SLIDING_WALL, CS_DOMAIN_BOUNDARY_INLET, CS_DOMAIN_BOUNDARY_OUTLET,   CS_DOMAIN_BOUNDARY_SYMMETRY, CS_DOMAIN_N_BOUNDARY_TYPES }

Functions
const char *	cs_domain_boundary_get_name (cs_domain_boundary_type_t type)
	Get the name of the domain boundary condition. More...
void	cs_domain_boundary_set_default (cs_domain_boundary_type_t type)
	Set the default boundary related to this domain. More...
cs_domain_boundary_type_t	cs_domain_boundary_get_default (void)
	Get the default boundary associated to the computational domain. More...
void	cs_domain_boundary_free (void)
	Free all metadate related to the domain boundaries. More...
void	cs_domain_boundary_add (cs_domain_boundary_type_t type, const char *zone_name)
	Add a new boundary type for a given boundary zone. More...
void	cs_domain_boundary_def_wall_zones (void)
	Add a new zone gathering all CS_DOMAIN_BOUNDARY_WALL zone type. More...
void	cs_domain_boundary_log_setup (void)
	Summarize the setup of the boundary of the computational domain. More...

Macro Definition Documentation

CS_DOMAIN_BOUNDARY_WALLS_NAME

#define CS_DOMAIN_BOUNDARY_WALLS_NAME   "cs_domain_boundary_walls"

Enumeration Type Documentation

cs_domain_boundary_type_t

enum cs_domain_boundary_type_t

Enumerator
CS_DOMAIN_BOUNDARY_WALL
CS_DOMAIN_BOUNDARY_SLIDING_WALL
CS_DOMAIN_BOUNDARY_INLET
CS_DOMAIN_BOUNDARY_OUTLET
CS_DOMAIN_BOUNDARY_SYMMETRY
CS_DOMAIN_N_BOUNDARY_TYPES

Function Documentation

cs_domain_boundary_add()

void cs_domain_boundary_add	(	cs_domain_boundary_type_t	type,
		const char *	zone_name
	)

Add a new boundary type for a given boundary zone.

Parameters

[in]	type	type of boundary to set
[in]	zone_name	name of the zone related to this boundary

cs_domain_boundary_def_wall_zones()

void cs_domain_boundary_def_wall_zones

(

void

)

Add a new zone gathering all CS_DOMAIN_BOUNDARY_WALL zone type.

cs_domain_boundary_free()

void cs_domain_boundary_free

(

void

)

Free all metadate related to the domain boundaries.

cs_domain_boundary_get_default()

cs_domain_boundary_type_t cs_domain_boundary_get_default

(

void

)

Get the default boundary associated to the computational domain.

Returns

the type of the domain boundary defined by default

cs_domain_boundary_get_name()

const char* cs_domain_boundary_get_name

(

cs_domain_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_domain_boundary_log_setup()

void cs_domain_boundary_log_setup

(

void

)

Summarize the setup of the boundary of the computational domain.

cs_domain_boundary_set_default()

void cs_domain_boundary_set_default

(

cs_domain_boundary_type_t

type

)

Set the default boundary related to this domain.

Parameters

[in]

type

type of boundary to set