patchComponent Struct Reference

Detailed Description

Struct which represents a certain component (interior, face, egde, corner) of a particular patch.

This struct is a generalization of patchSide and of patchCorner.

Inheritance diagram for patchComponent:

Collaboration diagram for patchComponent:

Public Types
enum	location {   interior,   begin,   end }
	Represents a location. More...

Public Member Functions
patchCorner	asCorner () const
	Converts to patchCorner and fails if the component is not a corner.
patchSide	asSide () const
	Converts to patchSide and fails if the component is not a corner.
std::vector< patchCorner >	containedCorners () const
	Returns a vector of all patchCorner s that are contained in the component.
std::vector< patchSide >	containingSides () const
	Returns a vector of all patchSide s that contain the component.
short_t	dim () const
	Dimension of the component.
index_t	index () const
	Returns the index.
location	locationForDirection (index_t direction) const
patchComponent	opposite () const
	Returns the opposite boxCorner.
index_t	patch () const
	Returns the patch number.
	patchComponent (index_t p, index_t b, short_t total_dim)
	Constructor. More...
	patchComponent (index_t p, short_t total_dim)
	Constructor creating patchComponent representing the interior. More...
	patchComponent (index_t p, boxComponent b)
	Constructor converting boxComponent to a patchComponent. More...
	patchComponent (patchSide p, short_t total_dim)
	Constructor converting patchSide to a patchComponent. More...
	patchComponent (patchCorner p, short_t total_dim)
	Constructor converting patchCorner to a patchComponent. More...
void	setLocationForDirection (index_t direction, location par)
short_t	totalDim () const
	Dimension of the computational domain (the box itself)

Private Attributes
index_t	m_patch
	The particular patch.

Member Enumeration Documentation

enum location

inherited

Represents a location.

Enumerator
interior	Represents the interior.
begin	Represents the beginning.
end	Represents the end.

Constructor & Destructor Documentation

patchComponent ( index_t  p, index_t  b, short_t  total_dim  )

inline

Constructor.

Parameters

p	The patch index
b	The index that defines the component
total_dim	The dimension of the box itself

patchComponent ( index_t  p, short_t  total_dim  )

inline

Constructor creating patchComponent representing the interior.

Parameters

p	The patch index
total_dim	The dimension of the box itself

patchComponent ( index_t  p, boxComponent  b  )

inline

Constructor converting boxComponent to a patchComponent.

Parameters

p	The patch index
b	The box component

patchComponent ( patchSide  p, short_t  total_dim  )

inline

Constructor converting patchSide to a patchComponent.

Parameters

p	The patch side
total_dim	The dimension of the box itself

patchComponent ( patchCorner  p, short_t  total_dim  )

inline

Constructor converting patchCorner to a patchComponent.

Parameters

p	The patch corner
total_dim	The dimension of the box itself

Member Function Documentation

boxComponent::location locationForDirection ( index_t  direction ) const

inherited

Gets the location for the direction

If the result value is begin, then the component is characterized by \( x_i = 0 \) If the result value is end, then the component is characterized by \( x_i = 1 \) If the result value is begin, then the component is characterized by \( x_i \in (0,1) \)

Parameters

direction

The index \( i \) from above

void setLocationForDirection ( index_t  direction, boxComponent::location  par  )

inherited

Sets the location for the direction

See locationForDirection

Parameters

direction	The index \( i \) from above
par	See locationForDirection