waLBerla 7.3
Loading...
Searching...
No Matches
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

constexpr Iterator (uint_t i)
Operators
constexpr Iterator & operator++ ()
constexpr bool operator== (const Iterator &o) const
constexpr bool operator!= (const Iterator &o) const

Access Functions

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

Constructor & Destructor Documentation

◆ Iterator()

template<typename Stencil>
walberla::stencil::Iterator< Stencil >::Iterator ( uint_t i)
inlineexplicitconstexpr

Member Function Documentation

◆ binaryDir()

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

◆ c()

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

◆ cx()

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

◆ cy()

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

◆ cz()

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

◆ direction()

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

◆ dirString()

template<typename Stencil>
std::string_view walberla::stencil::Iterator< Stencil >::dirString ( ) const
inlineconstexpr

◆ inverseDir()

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

◆ length()

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

◆ mirrorX()

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

◆ mirrorY()

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

◆ mirrorZ()

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

◆ operator!=()

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

◆ operator*()

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

◆ operator++()

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

◆ operator==()

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

◆ toIdx()

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

◆ toInvIdx()

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

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