SAMRAI::hier::PatchLevelIterator< DIM > Class Template Reference

#include <source/hierarchy/patches/PatchLevel.h>

List of all members.

Public Member Functions
	PatchLevelIterator ()
	PatchLevelIterator (const PatchLevel< DIM > &pl)
	PatchLevelIterator (const PatchLevel< DIM > *pl)
	PatchLevelIterator (const PatchLevelIterator< DIM > &iterator)
void	initialize (const PatchLevel< DIM > &pl)
void	initialize (const PatchLevel< DIM > *pl)
PatchLevelIterator< DIM > &	operator= (const PatchLevelIterator< DIM > &iterator)
	~PatchLevelIterator ()
int	operator * () const
int	operator() () const
	operator bool () const
	operator const void * () const
bool	operator! () const
void	operator++ (int)
bool	operator== (const PatchLevelIterator< DIM > &iterator) const
bool	operator!= (const PatchLevelIterator< DIM > &iterator) const

---

Detailed Description

template<int DIM>
class SAMRAI::hier::PatchLevelIterator< DIM >

Class PatchLevelIterator<DIM> iterates over the locally owned patches of a patch level. This is consistent with the standard owner-computes rule. The iterator should be accessed via PatchLevel<DIM>::Iterator since the implementation may change to be a nested class in the future.

See also:

hier::PatchLevel

---

Constructor & Destructor Documentation

template<int DIM>

SAMRAI::hier::PatchLevelIterator< DIM >::PatchLevelIterator

(

)

[inline]

Default constructor for the patch iterator. This iterator must be initialized before it can be used to iterate over the patches.

See also:

initialize()

template<int DIM>

SAMRAI::hier::PatchLevelIterator< DIM >::PatchLevelIterator

(

const PatchLevel< DIM > &

pl

)

Constructor for the patch level iterator. The iterator will enumerate the local patches in the patch level belonging to the local processor.

template<int DIM>

SAMRAI::hier::PatchLevelIterator< DIM >::PatchLevelIterator

(

const PatchLevel< DIM > *

pl

)

Constructor for the patch level iterator. The iterator will enumerate the local patches in the patch level belonging to the local processor.

template<int DIM>

SAMRAI::hier::PatchLevelIterator< DIM >::PatchLevelIterator

(

const PatchLevelIterator< DIM > &

iterator

)

[inline]

Const copy constructor for the iterator.

template<int DIM>

SAMRAI::hier::PatchLevelIterator< DIM >::~PatchLevelIterator

(

)

[inline]

Destructor for the patch level iterator.

---

Member Function Documentation

template<int DIM>

void SAMRAI::hier::PatchLevelIterator< DIM >::initialize

(

const PatchLevel< DIM > &

pl

)

Initializer for the patch level iterator. The iterator will enumerate the local patches in the patch level belonging to the local processor.

template<int DIM>

void SAMRAI::hier::PatchLevelIterator< DIM >::initialize

(

const PatchLevel< DIM > *

pl

)

Initializer for the patch level iterator. The iterator will enumerate the local patches in the patch level belonging to the local processor.

template<int DIM>

PatchLevelIterator< DIM > & SAMRAI::hier::PatchLevelIterator< DIM >::operator=

(

const PatchLevelIterator< DIM > &

iterator

)

[inline]

Assignment operator for the iterator.

template<int DIM>

int SAMRAI::hier::PatchLevelIterator< DIM >::operator *

(

)

const [inline]

Extract the integer patch index corresponding to the current patch in the patch level.

template<int DIM>

int SAMRAI::hier::PatchLevelIterator< DIM >::operator()

(

)

const [inline]

Extract the integer patch index corresponding to the current patch in the patch level.

template<int DIM>

SAMRAI::hier::PatchLevelIterator< DIM >::operator bool

(

)

const [inline]

Return true if the iterator points to a valid patch on the level.

template<int DIM>

SAMRAI::hier::PatchLevelIterator< DIM >::operator const void *

(

)

const [inline]

Return non-NULL if the iterator points to a valid patch on the level.

template<int DIM>

bool SAMRAI::hier::PatchLevelIterator< DIM >::operator!

(

)

const [inline]

Return whether the iterator points to a valid patch in the level. This operator mimics the !p operation applied to a pointer p.

template<int DIM>

void SAMRAI::hier::PatchLevelIterator< DIM >::operator++

(

int

)

[inline]

Increment the iterator to point to the next patch in the level.

template<int DIM>

bool SAMRAI::hier::PatchLevelIterator< DIM >::operator==

(

const PatchLevelIterator< DIM > &

iterator

)

const [inline]

Test whether two patch level iterators point to the same patch index.

template<int DIM>

bool SAMRAI::hier::PatchLevelIterator< DIM >::operator!=

(

const PatchLevelIterator< DIM > &

iterator

)

const [inline]

Test whether two patch level iterators point to different patch indices.

---

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

• source/hierarchy/patches/PatchLevel.h
• source/hierarchy/patches/PatchLevel.C
• source/hierarchy/patches/PatchLevel.I

---