Dune::CartesianIndexMapper< Grid > Class Template Reference

Interface class to access the logical Cartesian grid as used in industry standard simulator decks. More...

#include <CartesianIndexMapper.hpp>

Public Member Functions
	CartesianIndexMapper (const Grid &)
	constructor taking grid More...
const std::array< int, dimension > &	cartesianDimensions () const
	return Cartesian dimensions, i.e. number of cells in each direction More...
int	cartesianSize () const
	return total number of cells in the logical Cartesian grid More...
int	compressedSize () const
	return number of cells in the active grid More...
int	compressedLevelZeroSize () const
	return number of cells in the active level zero grid. Only relevant for CpGrid specialization. More...
int	cartesianIndex (const int) const
	return index of the cells in the logical Cartesian grid More...
void	cartesianCoordinate (const int, std::array< int, dimension > &) const
	return Cartesian coordinate, i.e. IJK, for a given cell More...
void	cartesianCoordinateLevel (const int, std::array< int, dimension > &, int) const
	return Cartesian coordinate, i.e. IJK, for a given cell. Only relevant for CpGrid specialization. More...

Static Public Attributes
static const int	dimension = Grid :: dimension
	dimension of the grid More...

Detailed Description

template<class Grid>
class Dune::CartesianIndexMapper< Grid >

Interface class to access the logical Cartesian grid as used in industry standard simulator decks.

Constructor & Destructor Documentation

CartesianIndexMapper()

template<class Grid >

Dune::CartesianIndexMapper< Grid >::CartesianIndexMapper ( const Grid &  )

inlineexplicit

constructor taking grid

Member Function Documentation

cartesianCoordinate()

template<class Grid >

void Dune::CartesianIndexMapper< Grid >::cartesianCoordinate ( const int  , std::array< int, dimension > &    ) const

inline

return Cartesian coordinate, i.e. IJK, for a given cell

Referenced by Dune::CartesianIndexMapper< PolyhedralGrid< dim, dimworld, coord_t > >::cartesianCoordinateLevel().

cartesianCoordinateLevel()

template<class Grid >

void Dune::CartesianIndexMapper< Grid >::cartesianCoordinateLevel ( const int  , std::array< int, dimension > &  , int    ) const

inline

return Cartesian coordinate, i.e. IJK, for a given cell. Only relevant for CpGrid specialization.

cartesianDimensions()

template<class Grid >

const std::array< int, dimension > & Dune::CartesianIndexMapper< Grid >::cartesianDimensions ( ) const

inline

return Cartesian dimensions, i.e. number of cells in each direction

Referenced by Dune::CartesianIndexMapper< PolyhedralGrid< dim, dimworld, coord_t > >::cartesianCoordinate(), and Dune::CartesianIndexMapper< CpGrid >::computeCartesianSize().

cartesianIndex()

template<class Grid >

int Dune::CartesianIndexMapper< Grid >::cartesianIndex ( const int  ) const

inline

return index of the cells in the logical Cartesian grid

Referenced by Dune::CartesianIndexMapper< PolyhedralGrid< dim, dimworld, coord_t > >::cartesianCoordinate().

cartesianSize()

template<class Grid >

int Dune::CartesianIndexMapper< Grid >::cartesianSize ( ) const

inline

return total number of cells in the logical Cartesian grid

compressedLevelZeroSize()

template<class Grid >

int Dune::CartesianIndexMapper< Grid >::compressedLevelZeroSize ( ) const

inline

return number of cells in the active level zero grid. Only relevant for CpGrid specialization.

compressedSize()

template<class Grid >

int Dune::CartesianIndexMapper< Grid >::compressedSize ( ) const

inline

return number of cells in the active grid

Referenced by Dune::CartesianIndexMapper< CpGrid >::cartesianIndex(), and Dune::CartesianIndexMapper< PolyhedralGrid< dim, dimworld, coord_t > >::cartesianIndex().

Member Data Documentation

dimension

template<class Grid >

const int Dune::CartesianIndexMapper< Grid >::dimension = Grid :: dimension

static

dimension of the grid

Referenced by Dune::CartesianIndexMapper< PolyhedralGrid< dim, dimworld, coord_t > >::cartesianCoordinate(), and Dune::CartesianIndexMapper< CpGrid >::computeCartesianSize().

---

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

• common/CartesianIndexMapper.hpp