walberla::stencil::Iterator< Stencil > Class Template Reference

Detailed Description

template<typename Stencil>
class walberla::stencil::Iterator< Stencil >

Iterator over all directions contained in a stencil.

See Stencil.in.h for documentation how to use the iterator

#include <Iterator.h>

Public Member Functions
	Iterator (uint_t i)
Operators
Iterator &	operator++ ()
bool	operator== (const Iterator &o) const
bool	operator!= (const Iterator &o) const

Access Functions
uint_t	i_
Direction	operator* () const
Direction	direction () const
Direction	inverseDir () const
uint_t	toIdx () const
uint_t	toInvIdx () const
int	cx () const
int	cy () const
int	cz () const
int	c (const uint_t d) const
real_t	length () const
BinaryDirection	binaryDir () const
const std::string &	dirString () const
Direction	mirrorX () const
Direction	mirrorY () const
Direction	mirrorZ () const

Constructor & Destructor Documentation

Iterator()

template<typename Stencil >

walberla::stencil::Iterator< Stencil >::Iterator ( uint_t i )

inlineexplicit

Member Function Documentation

binaryDir()

template<typename Stencil >

BinaryDirection walberla::stencil::Iterator< Stencil >::binaryDir ( ) const

inline

c()

template<typename Stencil >

int walberla::stencil::Iterator< Stencil >::c ( const uint_t d ) const

inline

cx()

template<typename Stencil >

int walberla::stencil::Iterator< Stencil >::cx ( ) const

inline

cy()

template<typename Stencil >

int walberla::stencil::Iterator< Stencil >::cy ( ) const

inline

cz()

template<typename Stencil >

int walberla::stencil::Iterator< Stencil >::cz ( ) const

inline

direction()

template<typename Stencil >

Direction walberla::stencil::Iterator< Stencil >::direction ( ) const

inline

dirString()

template<typename Stencil >

const std::string & walberla::stencil::Iterator< Stencil >::dirString ( ) const

inline

inverseDir()

template<typename Stencil >

Direction walberla::stencil::Iterator< Stencil >::inverseDir ( ) const

inline

length()

template<typename Stencil >

real_t walberla::stencil::Iterator< Stencil >::length ( ) const

inline

mirrorX()

template<typename Stencil >

Direction walberla::stencil::Iterator< Stencil >::mirrorX ( ) const

inline

mirrorY()

template<typename Stencil >

Direction walberla::stencil::Iterator< Stencil >::mirrorY ( ) const

inline

mirrorZ()

template<typename Stencil >

Direction walberla::stencil::Iterator< Stencil >::mirrorZ ( ) const

inline

operator!=()

template<typename Stencil >

bool walberla::stencil::Iterator< Stencil >::operator!= ( const Iterator< Stencil > & o ) const

inline

operator*()

template<typename Stencil >

Direction walberla::stencil::Iterator< Stencil >::operator* ( ) const

inline

operator++()

template<typename Stencil >

Iterator & walberla::stencil::Iterator< Stencil >::operator++ ( )

inline

operator==()

template<typename Stencil >

bool walberla::stencil::Iterator< Stencil >::operator== ( const Iterator< Stencil > & o ) const

inline

toIdx()

template<typename Stencil >

uint_t walberla::stencil::Iterator< Stencil >::toIdx ( ) const

inline

toInvIdx()

template<typename Stencil >

uint_t walberla::stencil::Iterator< Stencil >::toInvIdx ( ) const

inline

Member Data Documentation

i_

template<typename Stencil >

uint_t walberla::stencil::Iterator< Stencil >::i_

private

---

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

• /builds/administration/walberla-website/walberla/src/stencil/Iterator.h