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

#include <PatchLevel.h>

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

Private Attributes
int	d_patch
int	d_number_patches
const tbox::Array< int > *	d_local_box_indices

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

PatchLevelIterator() [1/4]

template<int DIM>

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

(

)

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

See also

initialize()

PatchLevelIterator() [2/4]

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.

PatchLevelIterator() [3/4]

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.

PatchLevelIterator() [4/4]

template<int DIM>

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

(

const PatchLevelIterator< DIM > &

iterator

)

Const copy constructor for the iterator.

~PatchLevelIterator()

template<int DIM>

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

(

)

Destructor for the patch level iterator.

Member Function Documentation

initialize() [1/2]

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.

initialize() [2/2]

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.

operator=()

template<int DIM>

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

(

const PatchLevelIterator< DIM > &

iterator

)

Assignment operator for the iterator.

operator*()

template<int DIM>

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

(

)

const

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

operator()()

template<int DIM>

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

(

)

const

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

operator bool()

template<int DIM>

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

(

)

const

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

operator const void *()

template<int DIM>

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

(

)

const

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

operator!()

template<int DIM>

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

(

)

const

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

operator++()

template<int DIM>

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

(

int

)

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

operator==()

template<int DIM>

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

(

const PatchLevelIterator< DIM > &

iterator

)

const

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

operator!=()

template<int DIM>

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

(

const PatchLevelIterator< DIM > &

iterator

)

const

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

Member Data Documentation

d_patch

template<int DIM>

int SAMRAI::hier::PatchLevelIterator< DIM >::d_patch

private

d_number_patches

template<int DIM>

int SAMRAI::hier::PatchLevelIterator< DIM >::d_number_patches

private

d_local_box_indices

template<int DIM>

const tbox::Array<int>* SAMRAI::hier::PatchLevelIterator< DIM >::d_local_box_indices

private

---

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

• /samrai/include/PatchLevel.h