SAMRAI::pdat::FaceIterator< DIM > Class Template Reference

#include <source/patchdata/face/FaceIterator.h>

List of all members.

Public Member Functions
	FaceIterator ()
	FaceIterator (const hier::Box< DIM > &box, const int axis)
	FaceIterator (const FaceIterator< DIM > &iterator)
FaceIterator< DIM > &	operator= (const FaceIterator< DIM > &iterator)
	~FaceIterator ()
const FaceIndex< DIM > &	operator * () const
const FaceIndex< DIM > &	operator() () const
	operator bool () const
	operator const void * () const
bool	operator! () const
void	operator++ (int)
bool	operator== (const FaceIterator< DIM > &iterator) const
bool	operator!= (const FaceIterator< DIM > &iterator) const

---

Detailed Description

template<int DIM>
class SAMRAI::pdat::FaceIterator< DIM >

Class FaceIterator<DIM> is an iterator that provides methods for stepping through the index space associated with a face centered box. The indices are enumerated in column-major (e.g., Fortran) order. The iterator should be used as follows:

   hier::Box<DIM> box;
   ...
   for (FaceIterator<DIM> c(box, axis); c; c++) {
      // use index c of the box
   }
   

Note that the face iterator may not compile to efficient code, depending on your compiler. Many compilers are not smart enough to optimize the looping constructs and indexing operations.

See also:

pdat::FaceData

pdat::FaceGeometry

pdat::FaceIndex

---

Constructor & Destructor Documentation

template<int DIM>

SAMRAI::pdat::FaceIterator< DIM >::FaceIterator

(

)

[inline]

Default constructor for the face iterator. The iterator must be initialized before it can be used to iterate over a box.

template<int DIM>

SAMRAI::pdat::FaceIterator< DIM >::FaceIterator	(	const hier::Box< DIM > &	box,
		const int	axis
	)			[inline]

Constructor for the face iterator. The iterator will enumerate the indices in the argument box.

template<int DIM>

SAMRAI::pdat::FaceIterator< DIM >::FaceIterator

(

const FaceIterator< DIM > &

iterator

)

[inline]

Copy constructor for the face iterator

template<int DIM>

SAMRAI::pdat::FaceIterator< DIM >::~FaceIterator

(

)

[inline]

Destructor for the face iterator.

---

Member Function Documentation

template<int DIM>

FaceIterator< DIM > & SAMRAI::pdat::FaceIterator< DIM >::operator=

(

const FaceIterator< DIM > &

iterator

)

[inline]

Assignment operator for the face iterator.

template<int DIM>

const FaceIndex< DIM > & SAMRAI::pdat::FaceIterator< DIM >::operator *

(

)

const [inline]

Extract the face index corresponding to the iterator position in the box.

template<int DIM>

const FaceIndex< DIM > & SAMRAI::pdat::FaceIterator< DIM >::operator()

(

)

const [inline]

Extract the face index corresponding to the iterator position in the box.

template<int DIM>

SAMRAI::pdat::FaceIterator< DIM >::operator bool

(

)

const [inline]

Return true if the iterator points to a valid index within the box.

template<int DIM>

SAMRAI::pdat::FaceIterator< DIM >::operator const void *

(

)

const [inline]

Return a non-NULL if the iterator points to a valid index within the box.

template<int DIM>

bool SAMRAI::pdat::FaceIterator< DIM >::operator!

(

)

const [inline]

Return whether the iterator points to a valid index within the box. This operator mimics the !p operation applied to a pointer p.

template<int DIM>

void SAMRAI::pdat::FaceIterator< DIM >::operator++

(

int

)

[inline]

Increment the iterator to point to the next index in the box.

template<int DIM>

bool SAMRAI::pdat::FaceIterator< DIM >::operator==

(

const FaceIterator< DIM > &

iterator

)

const [inline]

Test two iterators for equality (same index value).

template<int DIM>

bool SAMRAI::pdat::FaceIterator< DIM >::operator!=

(

const FaceIterator< DIM > &

iterator

)

const [inline]

Test two iterators for inequality (different index values).

---

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

• source/patchdata/face/FaceIterator.h
• source/patchdata/face/FaceIterator.I

---