MBStencilIterator Class Reference

#include <MBStencilIterator.H>

List of all members.


Detailed Description

iterates through the MBStencilElements of a MBStencil.

MBStencilIterator iterates through the MBStencilElements of a MBStencil.

MBStencil stencil; ... MBStencilIterator sit(stencil); for (sit.begin(); sit.ok(); ++sit) { const MBStencilElement& stencilElement = sit(); (do operations involving stencilElement) }

Public Member Functions

 MBStencilIterator ()
 MBStencilIterator (const MBStencil &a_stencil)
void setStencil (const MBStencil &a_stencil)
void define (const MBStencil &a_stencil)
 MBStencilIterator (const MBStencilIterator &a_iterIn)
 ~MBStencilIterator ()
void begin ()
void reset ()
void operator++ ()
void next ()
const MBStencilElementoperator() () const
bool ok ()

Protected Attributes

MBStencil m_stencil
int m_indCurrent
int m_indLo
int m_indHi


Constructor & Destructor Documentation

MBStencilIterator::MBStencilIterator (  )  [inline]

Default constructor. This constructs an invalid iterator. The user must call define before using.

References m_indCurrent, m_indHi, and m_indLo.

MBStencilIterator::MBStencilIterator ( const MBStencil a_stencil  )  [inline]

Constructs a MBStencilIterator and associates it with a Box. Arguments: a_bx (not modified) the Box to iterate over.

References define().

MBStencilIterator::MBStencilIterator ( const MBStencilIterator a_iterIn  )  [inline]

Copy constructor. Arguments: a_iterIn (not modified) the MBStencilIterator to copy.

References m_indCurrent, m_indHi, m_indLo, and m_stencil.

MBStencilIterator::~MBStencilIterator (  )  [inline]


Member Function Documentation

void MBStencilIterator::setStencil ( const MBStencil a_stencil  ) 

void MBStencilIterator::define ( const MBStencil a_stencil  ) 

Associates a MBStencil with this MBStencilIterator. Arguments: a_stencil (not modified) the MBStencil to iterate over.

Referenced by MBStencilIterator().

void MBStencilIterator::begin (  )  [inline]

Sets this MBStencilIterator to first MBStencilElement in its MBStencil.

References m_indCurrent, m_indHi, and m_indLo.

Referenced by reset().

void MBStencilIterator::reset (  )  [inline]

Sets this MBStencilIterator to first MBStencilElement in its MBStencil.

References begin().

void MBStencilIterator::operator++ (  )  [inline]

Modifies this MBStencilIterator to set it to the next MBStencilElement in its MBStencil.

References next().

void MBStencilIterator::next (  )  [inline]

References m_indCurrent.

Referenced by operator++().

const MBStencilElement & MBStencilIterator::operator() (  )  const [inline]

Returns the value of the MBStencilElement for the current location of this MBStencilIterator.

References CH_assert, m_indCurrent, m_indHi, m_indLo, and m_stencil.

bool MBStencilIterator::ok (  )  [inline]

Returns true if this MBStencilIterator's location is within its MBStencil.

References m_indCurrent, and m_indHi.


Member Data Documentation

Referenced by MBStencilIterator(), and operator()().

int MBStencilIterator::m_indLo [protected]

int MBStencilIterator::m_indHi [protected]


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

Generated on Wed Mar 29 03:27:09 2017 for Chombo + EB + MF by  doxygen 1.5.5