Proto  3.2
Public Member Functions | Protected Attributes | List of all members
Proto::NeighborIterator Class Reference

#include <Proto_NeighborIterator.H>

Public Member Functions

 NeighborIterator (const DisjointBoxLayout &a_dbl, const Box &a_bx)
 Constructor takes DBL, and Box that we are intersecting with the DBL. More...
 
NeighborIteratorbegin ()
 Iterator functions begin, end, ++. More...
 
const DataIndex< BoxPartition > & end () const
 
bool ok () const
 
NeighborIteratoroperator++ ()
 
const DataIndex< BoxPartition > & operator* () const
 Dereference operator returns the DataIndex corresponding to the current iterate. More...
 
Point point () const
 The Point corresponding to the Box for that index. Undefined if invalid. More...
 
Box srcBox () const
 The region to be copied from corresponding to that index. Undefined if invalid. More...
 
Box destBox () const
 The region to be copied from corresponding to that index. Undefined if invalid. More...
 
Point shift ()
 The amount by which the srcBox is shifted to obtain destBox a_bx. More...
 
int procID ()
 

Protected Attributes

DisjointBoxLayout m_layout
 
Box m_bx
 
BoxIterator m_bxit
 
Point m_shift
 
DataIndex< BoxPartitionm_current
 
DataIndex< BoxPartitionm_end
 
ProblemDomain m_dProbC
 

Constructor & Destructor Documentation

◆ NeighborIterator()

Proto::NeighborIterator::NeighborIterator ( const DisjointBoxLayout a_dbl,
const Box a_bx 
)
inline

Constructor takes DBL, and Box that we are intersecting with the DBL.

Member Function Documentation

◆ begin()

Proto::NeighborIterator & Proto::NeighborIterator::begin ( )
inline

Iterator functions begin, end, ++.

◆ end()

const DataIndex<BoxPartition>& Proto::NeighborIterator::end ( ) const
inline

References m_end.

◆ ok()

bool Proto::NeighborIterator::ok ( ) const
inline

References operator++().

◆ operator++()

Proto::NeighborIterator & Proto::NeighborIterator::operator++ ( )
inline

Referenced by ok().

◆ operator*()

const DataIndex<BoxPartition>& Proto::NeighborIterator::operator* ( ) const
inline

Dereference operator returns the DataIndex corresponding to the current iterate.

References destBox(), m_current, point(), shift(), and srcBox().

◆ point()

Proto::Point Proto::NeighborIterator::point ( ) const
inline

The Point corresponding to the Box for that index. Undefined if invalid.

Referenced by operator*().

◆ srcBox()

Proto::Box Proto::NeighborIterator::srcBox ( ) const
inline

The region to be copied from corresponding to that index. Undefined if invalid.

Referenced by operator*().

◆ destBox()

Proto::Box Proto::NeighborIterator::destBox ( ) const
inline

The region to be copied from corresponding to that index. Undefined if invalid.

Referenced by operator*().

◆ shift()

Proto::Point Proto::NeighborIterator::shift ( )
inline

The amount by which the srcBox is shifted to obtain destBox a_bx.

Referenced by operator*().

◆ procID()

int Proto::NeighborIterator::procID ( )
inline

Member Data Documentation

◆ m_layout

DisjointBoxLayout Proto::NeighborIterator::m_layout
protected

◆ m_bx

Box Proto::NeighborIterator::m_bx
protected

◆ m_bxit

BoxIterator Proto::NeighborIterator::m_bxit
protected

◆ m_shift

Point Proto::NeighborIterator::m_shift
protected

◆ m_current

DataIndex<BoxPartition> Proto::NeighborIterator::m_current
protected

Referenced by operator*().

◆ m_end

DataIndex<BoxPartition> Proto::NeighborIterator::m_end
protected

Referenced by end().

◆ m_dProbC

ProblemDomain Proto::NeighborIterator::m_dProbC
protected

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