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

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

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

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.

void SideIterator::reset  )  [inline]
 

Set the iterator to the first side.

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::current [private]
 


The documentation for this class was generated from the following file:
Generated on Fri Jul 2 17:56:02 2004 for Chombo by doxygen 1.3.2