Private Types | List of all members
util::GridContainerIndicesBase3D< DIMS > Class Template Reference

Index manager for a container of data arranged on a >=3-dim grid. More...

#include <GridContainerIndices.h>

Inheritance diagram for util::GridContainerIndicesBase3D< DIMS >:
util::GridContainerIndicesBase2D< DIMS > util::GridContainerIndicesBase1D< DIMS > util::details::GridContainerIndicesBase< DIMS >

Public Member Functions

Grid structure
bool hasZ (typename Base_t::CellDimIndex_t index) const
 Returns whether the specified z index is valid. More...
 
size_t sizeZ () const
 Returns the number of cells on the z axis of the grid. More...
 
- Public Member Functions inherited from util::GridContainerIndicesBase2D< DIMS >
bool hasY (typename Base_t::CellDimIndex_t index) const
 Returns whether the specified y index is valid. More...
 
size_t sizeY () const
 Returns the number of cells on the y axis of the grid. More...
 
- Public Member Functions inherited from util::GridContainerIndicesBase1D< DIMS >
bool hasX (typename Base_t::CellDimIndex_t index) const
 Returns whether the specified x index is valid. More...
 
size_t sizeX () const
 Returns the number of cells on the x axis of the grid. More...
 
- Public Member Functions inherited from util::details::GridContainerIndicesBase< DIMS >
 GridContainerIndicesBase (std::array< size_t, dims()> const &new_dims)
 Constructor: specifies the size of the container and allocates it. More...
 
bool has (CellIndexOffset_t index) const
 Returns whether the specified index is valid. More...
 
size_t size () const
 Returns the number of cells in the grid. More...
 
CellIndex_t operator[] (CellID_t id) const
 Returns the index of the element from its cell coordinates (no check!) More...
 
CellIndexOffset_t offset (CellID_t const &origin, CellID_t const &cellID) const
 Returns the difference in index of cellID respect to origin. More...
 

Private Types

using Base_t = GridContainerIndicesBase2D< DIMS >
 

Additional Inherited Members

- Public Types inherited from util::details::GridContainerIndicesBase< DIMS >
using CellIndex_t = typename IndexManager_t::LinIndex_t
 type of index for direct access to the cell More...
 
using CellIndexOffset_t = std::ptrdiff_t
 type of difference between indices More...
 
using CellDimIndex_t = CellIndexOffset_t
 type of difference between indices along a dimension More...
 
using CellID_t = std::array< CellDimIndex_t, dims()>
 type of cell coordinate (x, y, z) More...
 
- Static Public Member Functions inherited from util::details::GridContainerIndicesBase< DIMS >
static constexpr unsigned int dims ()
 Returns the number of dimensions in this object. More...
 
- Protected Member Functions inherited from util::details::GridContainerIndicesBase< DIMS >
CellIndex_t index (CellID_t id) const
 Returns the index of the element from its cell coordinates (no check!) More...
 
- Protected Attributes inherited from util::details::GridContainerIndicesBase< DIMS >
IndexManager_t indices
 the actual worker More...
 

Detailed Description

template<unsigned int DIMS = 3U>
class util::GridContainerIndicesBase3D< DIMS >

Index manager for a container of data arranged on a >=3-dim grid.

Definition at line 155 of file GridContainerIndices.h.

Member Typedef Documentation

template<unsigned int DIMS = 3U>
using util::GridContainerIndicesBase3D< DIMS >::Base_t = GridContainerIndicesBase2D<DIMS>
private

Definition at line 158 of file GridContainerIndices.h.

Member Function Documentation

template<unsigned int DIMS = 3U>
bool util::GridContainerIndicesBase3D< DIMS >::hasZ ( typename Base_t::CellDimIndex_t  index) const
inline

Returns whether the specified z index is valid.

Definition at line 168 of file GridContainerIndices.h.

169  { return Base_t::indices.template hasIndex<2>(index); }
CellIndex_t index(CellID_t id) const
Returns the index of the element from its cell coordinates (no check!)
IndexManager_t indices
the actual worker
template<unsigned int DIMS = 3U>
size_t util::GridContainerIndicesBase3D< DIMS >::sizeZ ( ) const
inline

Returns the number of cells on the z axis of the grid.

Definition at line 172 of file GridContainerIndices.h.

172 { return Base_t::indices.template dim<2>(); }
IndexManager_t indices
the actual worker

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