boxSide Class Reference

Detailed Description

Struct which represents a certain side of a box.

Inheritance diagram for boxSide:

Public Member Functions
short_t	direction () const
	Returns the parametric direction orthogonal to this side.
void	getContainedCorners (short_t dim, std::vector< boxCorner > &corners) const
	returns the vector of the corners contained in the side
short_t	index () const
	Returns the index (as specified in boundary::side) of the box side.
boxSide &	operator++ ()
	Incrementset boxSide.
boxSide &	operator-- ()
	Decrement boxSide.
boxSide	opposite () const
	returns the parallel opposite side
bool	parameter () const
	Returns the parameter value (false=0=start, true=1=end) that corresponds to this side.

Static Public Member Functions
static boxSide	getEnd (short_t dim)
	helper for iterating on sides of an n-dimensional box
static boxSide	getFirst (short_t)
	helper for iterating on sides of an n-dimensional box
static boxSide	getLast (short_t dim)
	helper for iterating on sides of an n-dimensional box
static short_t	index (short_t dir, bool par)
	Returns the index of the box side implied by input direction dir and parameter par.

Public Attributes
short_t	m_index
	Index of the side.

Member Function Documentation

direction()

short_t direction ( ) const

inline

Returns the parametric direction orthogonal to this side.

Returns

Integer which says which parameter has to be fixed in order to get the boundary.

Example:
In 2D, let the parameter domain be defined by \((u,v)\in [0,1]^2\). Since the side with index 3 corresponds to "south", i.e. to \( \{ (u,v):\ v = 0 \} \), calling parameter(3) will return 1, because v (i.e., parameter direction with index 1) is fixed/set to zero.

getContainedCorners()

void getContainedCorners	(	short_t	dim,
		std::vector< boxCorner > &	corners
	)		const

returns the vector of the corners contained in the side

Parameters

dim	is the ambient dimension
corners

getEnd()

static boxSide getEnd ( short_t  dim )

inlinestatic

helper for iterating on sides of an n-dimensional box

Parameters

dim

Returns

the (invalid) side after the last one in dim-dimensional box

getFirst()

static boxSide getFirst ( short_t  )

inlinestatic

helper for iterating on sides of an n-dimensional box

Returns

the first valid side in an dim-dimensional box

getLast()

static boxSide getLast ( short_t  dim )

inlinestatic

helper for iterating on sides of an n-dimensional box

Parameters

dim

Returns

the last valid side in an dim-dimensional box

opposite()

boxSide opposite ( ) const

inline

returns the parallel opposite side

Returns

parameter()

bool parameter ( ) const

inline

Returns the parameter value (false=0=start, true=1=end) that corresponds to this side.

Returns

false, if side s is defined by setting the corresponding parameter to 0, and
true, if it is defined by setting the corresponding parameter to 1.

Example:
In 2D, let the parameter domain be defined by \((u,v)\in [0,1]^2\). Since the side with index 3 corresponds to "south", i.e. to \( \{ (u,v):\ v = 0 \} \), calling parameter(3) will return 0=false.

Member Data Documentation

m_index

short_t m_index

Index of the side.

...stored as number, specified in boundary::side