Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

SideIterator Class Reference

Iterator for low and high side. More...

#include <LoHiSide.H>

List of all members.

Public Methods

 SideIterator ()
 {\bf Constructors, destructors}

 ~SideIterator ()
void begin ()
 {\bf Modification functions}

void reset ()
void next ()
void operator++ ()
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  
 

{\bf Constructors, destructors}

Default, and only, constructor.

SideIterator::~SideIterator   [inline]
 

Default destructor.


Member Function Documentation

void SideIterator::begin  
 

{\bf Modification functions}

Set the iterator to the first side. \

{\bf Arguments:} none. \ {\bf Returns:} none. \ {\bf This:} \ This object is modified.

void SideIterator::next  
 

bool SideIterator::ok   const
 

Checks to see if there is a next side. \

{\bf Arguments:} none. \ {\bf Returns:} \ true if there is a next side. \ false otherwise. \ {\bf This:} \ This object is not modified.

Side::LoHiSide SideIterator::operator()   const
 

Returns the value of the side for the current iteration. \

{\bf Arguments:} none. \ {\bf Returns:} \ Returns the value of the side for the current iteration. \ {\bf This:} \ This object is not modified.

void SideIterator::operator++  
 

Advances the iterator to the next face. \

{\bf Arguments:} none. \ {\bf Returns:} none. \ {\bf This:} \ This object is modified.

void SideIterator::reset   [inline]
 

Set the iterator to the first side. \

{\bf Arguments:} none. \ {\bf Returns:} none. \ {\bf This:} \ This object is modified.


The documentation for this class was generated from the following file:
Generated on Thu Aug 29 11:07:50 2002 for Chombo&INS by doxygen1.2.16