DataIterator Class Reference
#include <DataIterator.H>
Collaboration diagram for DataIterator:
[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, since it is intended to work with all of BoxLayouts, DisjointBoxLayouts, BoxLayoutDatas LevelDatas, and any object that is built on top of a BoxLayout object.
DataIterator accesses the data in a BoxLayout-based object in a data-parallel manner. This means that it skips over entries for Boxes not assigned to this processor. The order of access is not defined.
In serial execution mode, there is no difference between DataIterator and LayoutIterator.
Constructor & Destructor Documentation
DataIterator::DataIterator |
( |
|
) |
[inline] |
|
|
a null constructed DataIterator will return false on ok()
|
DataIterator::DataIterator |
( |
const BoxLayout & |
a_layout |
) |
[inline] |
|
DataIterator::DataIterator |
( |
const BoxLayout & |
boxlayout, |
|
|
const int * |
layoutID |
|
) |
[private] |
|
Member Function Documentation
const DataIndex & DataIterator::operator() |
( |
|
) |
const [inline] |
|
|
return the index that this iterator is at
Aborts if the iterator is not ok() |
|
return a copy of the index that this iterator is at
Aborts if the iterator is not ok() |
void DataIterator::operator++ |
( |
|
) |
[inline] |
|
|
move the iterator to the next index in the layout
|
void DataIterator::incr |
( |
|
) |
[inline] |
|
|
move the iterator to the next index in the layout
|
bool DataIterator::ok |
( |
|
) |
const [inline] |
|
|
return true if this iterator is still in the layout
|
void DataIterator::begin |
( |
|
) |
[inline] |
|
|
initialize this iterator to the first index in the layout
|
void DataIterator::reset |
( |
|
) |
[inline] |
|
void DataIterator::end |
( |
|
) |
|
|
|
move this iterator to after the last index 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:45 2004 for Chombo by
1.3.2