TileI< T, DIM > Class Template Reference

Class for representing a tile (used in, e.g., TiledMeshRefine) More...

#include <CD_Tile.H>

Public Member Functions
	TileI () noexcept
	Default constructor. Sets m_indices = 0.
template<typename... Args, typename std::enable_if< sizeof...(Args)==DIM, int >::type = 0>
	TileI (Args... args) noexcept
	Full constructor. Sets indices. Use as TileI(0,1,2,...)
virtual	~TileI () noexcept
	Destructor.
T &	operator[] (const size_t a_dir) noexcept
	Get the index in specified coordinate direction.
const T &	operator[] (const size_t a_dir) const noexcept
	Get the index in specified coordinate direction.
std::array< T, DIM > &	getIndices () noexcept
	Get the indices.
const std::array< T, DIM > &	getIndices () const noexcept
	Get the indices.
constexpr bool	operator< (const TileI &a_otherTile) const noexcept
	Comparison operator. Uses lexicographical comparison.
constexpr bool	operator> (const TileI &a_otherTile) const noexcept
	Comparison operator. Uses lexicographical comparison.
constexpr bool	operator== (const TileI &a_otherTile) const noexcept
	Comparison operator. Uses lexicographical comparison.

Protected Attributes
std::array< T, DIM >	m_indices
	Index in N-dimensional space.

Detailed Description

template<class T, size_t DIM>
class TileI< T, DIM >

Class for representing a tile (used in, e.g., TiledMeshRefine)

Constructor & Destructor Documentation

TileI()

template<class T , size_t DIM>

template<typename... Args, typename std::enable_if< sizeof...(Args)==DIM, int >::type = 0>

TileI< T, DIM >::TileI ( Args...  args )

inlineexplicitnoexcept

Full constructor. Sets indices. Use as TileI(0,1,2,...)

Parameters

[in]

args

Indices to assign.

Member Function Documentation

getIndices() [1/2]

template<class T , size_t DIM>

const std::array< T, DIM > & TileI< T, DIM >::getIndices ( ) const

inlinenoexcept

Get the indices.

Returns

m_indices

getIndices() [2/2]

template<class T , size_t DIM>

std::array< T, DIM > & TileI< T, DIM >::getIndices ( )

inlinenoexcept

Get the indices.

Returns

m_indices

operator<()

template<class T , size_t DIM>

constexpr bool TileI< T, DIM >::operator< ( const TileI< T, DIM > &  a_otherTile ) const

inlineconstexprnoexcept

Comparison operator. Uses lexicographical comparison.

Parameters

[in]

a_otherTile

Other tile.

Returns

Return value

operator==()

template<class T , size_t DIM>

constexpr bool TileI< T, DIM >::operator== ( const TileI< T, DIM > &  a_otherTile ) const

inlineconstexprnoexcept

Comparison operator. Uses lexicographical comparison.

Parameters

[in]

a_otherTile

Other tile.

Returns

Return value

operator>()

template<class T , size_t DIM>

constexpr bool TileI< T, DIM >::operator> ( const TileI< T, DIM > &  a_otherTile ) const

inlineconstexprnoexcept

Comparison operator. Uses lexicographical comparison.

Parameters

[in]

a_otherTile

Other tile.

Returns

Return value

operator[]() [1/2]

template<class T , size_t DIM>

const T & TileI< T, DIM >::operator[] ( const size_t  a_dir ) const

inlinenoexcept

Get the index in specified coordinate direction.

Parameters

[in]

a_dir

Coordinate direction

Returns

Return value

operator[]() [2/2]

template<class T , size_t DIM>

T & TileI< T, DIM >::operator[] ( const size_t  a_dir )

inlinenoexcept

Get the index in specified coordinate direction.

Parameters

[in]

a_dir

Coordinate direction

Returns

Return value

---

The documentation for this class was generated from the following files:

• Source/AmrMesh/CD_Tile.H
• Source/AmrMesh/CD_TileImplem.H