LayoutIterator Class Reference
#include <LayoutIterator.H>
Collaboration diagram for LayoutIterator:
[legend]List of all members.
Detailed Description
An Iterator based on a BoxLayout object.
An Iterator based on a BoxLayout object. It does not support a dereferencing operation(1), since it is intended to work with all of BoxLayouts, DisjointBoxLayouts, BoxLayoutDatas LevelData's, and any object that is built on top of a BoxLayout object. LayoutIterator accesses the data in a BoxLayout-based object in a NON-data-parallel manner (i.e. every processor iterates through all the Boxes in the BoxLayout). This differs from the DataIterator class.
BoxLayout-based objects can act as the Factory for the LayoutIterator.
(1) STL-speak. not critical for comprehension, but can help people familiar with STL iterators and expecting similar behaviour.
Constructor & Destructor Documentation
LayoutIterator::LayoutIterator |
( |
|
) |
[inline] |
|
|
a null constructed LayoutIterator will return false on ok()
|
LayoutIterator::LayoutIterator |
( |
const BoxLayout & |
a_layout |
) |
[inline] |
|
LayoutIterator::LayoutIterator |
( |
const BoxLayout & |
boxlayout, |
|
|
const int * |
layoutID |
|
) |
[protected] |
|
Member Function Documentation
const LayoutIndex & LayoutIterator::operator() |
( |
|
) |
const [inline] |
|
|
return the index that this iterator is at
|
|
return a copy of the index that this iterator is at
|
void LayoutIterator::operator++ |
( |
|
) |
[inline] |
|
|
move the iterator to the next Box in the layout
|
void LayoutIterator::incr |
( |
|
) |
[inline] |
|
|
move the iterator to the next Box in the layout
|
bool LayoutIterator::ok |
( |
|
) |
const [inline] |
|
|
return true if this iterator is still in its Layout
|
void LayoutIterator::begin |
( |
|
) |
[inline] |
|
|
initialize this iterator to the first Box in its Layout
|
void LayoutIterator::reset |
( |
|
) |
|
|
void LayoutIterator::end |
( |
|
) |
|
|
|
move this iterator to after the last Box in the layout
The iterator will be !ok() afterwards. |
Friends And Related Function Documentation
Member Data Documentation
The documentation for this class was generated from the following file:
Generated on Fri Jul 2 17:55:51 2004 for Chombo by
1.3.2