MBVectorStencilIterator Class Reference

#include <MBVectorStencilIterator.H>

List of all members.


Detailed Description

iterates through the MBVectorStencilElements of a MBVectorStencil.

MBVectorStencilIterator iterates through the MBVectorStencilElements of a MBVectorStencil.

MBVectorStencil stencil; ... MBVectorStencilIterator sit(stencil); for (sit.begin(); sit.ok(); ++sit) { const MBVectorStencilElement& stencilElement = sit(); (do operations involving stencilElement) }

Public Member Functions

 MBVectorStencilIterator ()
 MBVectorStencilIterator (const MBVectorStencil &a_stencil)
void setStencil (const MBVectorStencil &a_stencil)
void define (const MBVectorStencil &a_stencil)
 MBVectorStencilIterator (const MBVectorStencilIterator &a_iterIn)
 ~MBVectorStencilIterator ()
void begin ()
void reset ()
void operator++ ()
void next ()
const MBVectorStencilElementoperator() () const
bool ok ()

Protected Attributes

MBVectorStencil m_stencil
int m_indCurrent
int m_indLo
int m_indHi


Constructor & Destructor Documentation

MBVectorStencilIterator::MBVectorStencilIterator (  )  [inline]

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

References m_indCurrent, m_indHi, and m_indLo.

MBVectorStencilIterator::MBVectorStencilIterator ( const MBVectorStencil a_stencil  )  [inline]

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

References define().

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

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

References m_indCurrent, m_indHi, m_indLo, and m_stencil.

MBVectorStencilIterator::~MBVectorStencilIterator (  )  [inline]


Member Function Documentation

void MBVectorStencilIterator::setStencil ( const MBVectorStencil a_stencil  ) 

void MBVectorStencilIterator::define ( const MBVectorStencil a_stencil  ) 

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

Referenced by MBVectorStencilIterator().

void MBVectorStencilIterator::begin (  )  [inline]

Sets this MBVectorStencilIterator to first MBVectorStencilElement in its MBVectorStencil.

References m_indCurrent, m_indHi, and m_indLo.

Referenced by reset().

void MBVectorStencilIterator::reset (  )  [inline]

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

Modifies this MBVectorStencilIterator to set it to the next MBVectorStencilElement in its MBVectorStencil.

References next().

void MBVectorStencilIterator::next (  )  [inline]

References m_indCurrent.

Referenced by operator++().

const MBVectorStencilElement & MBVectorStencilIterator::operator() (  )  const [inline]

Returns the value of the MBVectorStencilElement for the current location of this MBVectorStencilIterator.

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

bool MBVectorStencilIterator::ok (  )  [inline]

Returns true if this MBVectorStencilIterator's location is within its MBVectorStencil.

References m_indCurrent, and m_indHi.


Member Data Documentation


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

Generated on Wed Jun 28 03:27:20 2017 for Chombo + EB + MF by  doxygen 1.5.5