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

#include <source/patchdata/cell/CellIterator.h>

List of all members.

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

---

Detailed Description

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

Class CellIterator<DIM> is an iterator that provides methods for stepping through the index space associated with a cell 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 (CellIterator<DIM> c(box); c; c++) {
      // use index c of the box
   }
   

Note that the cell 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::CellData

pdat::CellGeometry

pdat::CellIndex

---

Constructor & Destructor Documentation

template<int DIM>

SAMRAI::pdat::CellIterator< DIM >::CellIterator

(

)

[inline]

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

template<int DIM>

SAMRAI::pdat::CellIterator< DIM >::CellIterator

(

const hier::Box< DIM > &

box

)

[inline]

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

template<int DIM>

SAMRAI::pdat::CellIterator< DIM >::CellIterator

(

const CellIterator< DIM > &

iterator

)

[inline]

Copy constructor for the cell iterator

template<int DIM>

SAMRAI::pdat::CellIterator< DIM >::~CellIterator

(

)

[inline]

Destructor for the cell iterator.

---

Member Function Documentation

template<int DIM>

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

(

const CellIterator< DIM > &

iterator

)

[inline]

Assignment operator for the cell iterator.

template<int DIM>

const CellIndex< DIM > & SAMRAI::pdat::CellIterator< DIM >::operator *

(

)

const [inline]

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

template<int DIM>

const CellIndex< DIM > & SAMRAI::pdat::CellIterator< DIM >::operator()

(

)

const [inline]

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

template<int DIM>

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

(

)

const [inline]

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

template<int DIM>

SAMRAI::pdat::CellIterator< 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::CellIterator< 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::CellIterator< DIM >::operator++

(

int

)

[inline]

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

template<int DIM>

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

(

const CellIterator< DIM > &

iterator

)

const [inline]

Test two iterators for equality (same index value).

template<int DIM>

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

(

const CellIterator< 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/cell/CellIterator.h
• source/patchdata/cell/CellIterator.I

---