SideIterator Class Reference

#include <LoHiSide.H>

List of all members.


Detailed Description

Iterator for low and high side.

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

Access functions

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

Public Member Functions

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


Constructor & Destructor Documentation

SideIterator::SideIterator (  ) 

Default, and only, constructor.

SideIterator::~SideIterator (  )  [inline]

Default destructor.


Member Function Documentation

void SideIterator::begin (  ) 

Set the iterator to the first side.

Referenced by reset().

void SideIterator::reset (  )  [inline]

Set the iterator to the first side.

References begin().

void SideIterator::next (  ) 

Advance the iterator to the next face.

void SideIterator::operator++ (  ) 

Advance the iterator to the next face.

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

Returns the value of the side for the current iteration.

bool SideIterator::ok (  )  const

Returns true if there is a next side, false if not.


Member Data Documentation

int SideIterator::m_current [private]


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

Generated on Mon Oct 23 04:04:12 2017 for Chombo + EB by  doxygen 1.5.5