Chombo + EB  3.0
Public Member Functions | List of all members
SideIterator Class Reference

Iterator for low and high side. More...

#include <LoHiSide.H>

Public Member Functions

 SideIterator ()
 
 ~SideIterator ()
 
Modification functions
void begin ()
 
void reset ()
 
void next ()
 
void operator++ ()
 

Access functions

int m_current
 
Side::LoHiSide operator() () const
 
bool ok () const
 

Detailed Description

Iterator for low and high side.

SideIterator iterates over the values Side::Lo and Side::Hi. There are no adjustable parameters whatsoever.

Constructor & Destructor Documentation

◆ SideIterator()

SideIterator::SideIterator ( )

Default, and only, constructor.

◆ ~SideIterator()

SideIterator::~SideIterator ( )
inline

Default destructor.

Member Function Documentation

◆ begin()

void SideIterator::begin ( )

Set the iterator to the first side.

◆ reset()

void SideIterator::reset ( )
inline

Set the iterator to the first side.

◆ next()

void SideIterator::next ( )

Advance the iterator to the next face.

◆ operator++()

void SideIterator::operator++ ( )

Advance the iterator to the next face.

◆ operator()()

Side::LoHiSide SideIterator::operator() ( ) const

Returns the value of the side for the current iteration.

◆ ok()

bool SideIterator::ok ( ) const

Member Data Documentation

◆ m_current

int SideIterator::m_current
private

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