Side< Dim > Struct Template Reference

#include <nav.hpp>

Public Member Functions
	Side (Dim dim_, Dir dir_)
	Side (const Side &rhs)
int	facetag () const
Dim	dim () const
Dir	dir () const
bool	operator== (const Side< Dim > &rhs) const

Static Public Member Functions
static Side< Dim >	from_tag (int tag)
static const Side *	begin ()
static const Side *	end ()

Static Public Attributes
static const int	COUNT = Dim::COUNT * Dir::COUNT

Protected Attributes
const Dim	m_dim
const Dir	m_dir

Static Protected Attributes
static const Side	ALL []

Friends
template<typename T >
std::ostream &	operator<< (std::ostream &os, const Side< T > &s)

Detailed Description

template<typename Dim>
struct Side< Dim >

Value type that addresses sides in a n-dimensional grid cell. A side is identified by a dimensions and a direction in that dimension. The side will be located in that direction in that dimension from the center of the cell.

Constructor & Destructor Documentation

template<typename Dim>

Side< Dim >::Side ( Dim  dim_, Dir  dir_  )

inline

template<typename Dim>

Side< Dim >::Side ( const Side< Dim > &  rhs )

inline

Member Function Documentation

template<typename Dim>

static const Side* Side< Dim >::begin ( )

inlinestatic

Iterator for all possible sides

References Side< Dim >::ALL.

template<typename Dim>

Dim Side< Dim >::dim ( ) const

inline

References Side< Dim >::m_dim.

Referenced by Cart2D::face_ndx(), and Side< Dim >::facetag().

template<typename Dim>

Dir Side< Dim >::dir ( ) const

inline

References Side< Dim >::m_dir.

Referenced by Cart2D::face_ndx(), and Side< Dim >::facetag().

template<typename Dim>

static const Side* Side< Dim >::end ( )

inlinestatic

References Side< Dim >::ALL, and Side< Dim >::COUNT.

template<typename Dim>

int Side< Dim >::facetag ( ) const

inline

Numeric tag of an enumeration of the sides. The sides are enumerated in the same order the dimensions are specified in the grid; I, J then K, wih the decreasing direction first, then the increasing direction.

See also

UnstructuredGrid.cell_facetag

References Dir::COUNT, Side< Dim >::dim(), Side< Dim >::dir(), and Dir::val.

template<typename Dim>

static Side<Dim> Side< Dim >::from_tag ( int  tag )

static

Construct a side value from the facetag stored in the grid structure

template<typename Dim>

bool Side< Dim >::operator== ( const Side< Dim > &  rhs ) const

inline

Comparison of two sides

References Side< Dim >::m_dim, and Side< Dim >::m_dir.

Friends And Related Function Documentation

template<typename Dim>

template<typename T >

std::ostream& operator<< ( std::ostream &  os, const Side< T > &  s  )

friend

Member Data Documentation

template<typename Dim>

const Side Side< Dim >::ALL[]

staticprotected

Referenced by Side< Dim >::begin(), and Side< Dim >::end().

template<typename Dim>

const int Side< Dim >::COUNT = Dim::COUNT * Dir::COUNT

static

Number of possible sides in an element

Referenced by Side< Dim >::end().

template<typename Dim>

const Dim Side< Dim >::m_dim

protected

Referenced by Side< Dim >::dim(), and Side< Dim >::operator==().

template<typename Dim>

const Dir Side< Dim >::m_dir

protected

Referenced by Side< Dim >::dir(), and Side< Dim >::operator==().

---

The documentation for this struct was generated from the following file:

• nav.hpp