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

#include <source/patchdata/side/SideIterator.h>

List of all members.

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

---

Detailed Description

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

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

Note that the side 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::SideData

pdat::SideGeometry

pdat::SideIndex

---

Constructor & Destructor Documentation

template<int DIM> SAMRAI::pdat::SideIterator< DIM >::SideIterator (   )  [inline]

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

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

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

template<int DIM> SAMRAI::pdat::SideIterator< DIM >::SideIterator (  const SideIterator< DIM > &  iterator  )  [inline]

Copy constructor for the side iterator

template<int DIM> SAMRAI::pdat::SideIterator< DIM >::~SideIterator (   )  [inline]

Destructor for the side iterator.

---

Member Function Documentation

template<int DIM> SideIterator< DIM > & SAMRAI::pdat::SideIterator< DIM >::operator= (  const SideIterator< DIM > &  iterator  )  [inline]

Assignment operator for the side iterator.

template<int DIM> const SideIndex< DIM > & SAMRAI::pdat::SideIterator< DIM >::operator * (   )  const [inline]

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

template<int DIM> const SideIndex< DIM > & SAMRAI::pdat::SideIterator< DIM >::operator() (   )  const [inline]

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

template<int DIM> SAMRAI::pdat::SideIterator< DIM >::operator bool (   )  const [inline]

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

template<int DIM> SAMRAI::pdat::SideIterator< 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::SideIterator< 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::SideIterator< DIM >::operator++ (  int   )  [inline]

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

template<int DIM> bool SAMRAI::pdat::SideIterator< DIM >::operator== (  const SideIterator< DIM > &  iterator  )  const [inline]

Test two iterators for equality (same index value).

template<int DIM> bool SAMRAI::pdat::SideIterator< DIM >::operator!= (  const SideIterator< 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/side/SideIterator.h
• source/patchdata/side/SideIterator.I

---