chombo-discharge
Public Member Functions | Protected Attributes | List of all members
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. More...
 
const T & operator[] (const size_t a_dir) const noexcept
 Get the index in specified coordinate direction. More...
 
std::array< T, DIM > & getIndices () noexcept
 Get the indices. More...
 
const std::array< T, DIM > & getIndices () const noexcept
 Get the indices. More...
 
constexpr bool operator< (const TileI &a_otherTile) const noexcept
 Comparison operator. Uses lexicographical comparison. More...
 
constexpr bool operator> (const TileI &a_otherTile) const noexcept
 Comparison operator. Uses lexicographical comparison. More...
 
constexpr bool operator== (const TileI &a_otherTile) const noexcept
 Comparison operator. Uses lexicographical comparison. More...
 

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)

Member Function Documentation

◆ getIndices() [1/2]

template<class T , size_t DIM>
const std::array< T, DIM > & TileI< T, DIM >::getIndices
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_otherTileOther tile.

◆ 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_otherTileOther tile.

◆ 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_otherTileOther tile.

◆ 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_dirCoordinate direction

◆ 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_dirCoordinate direction

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