Chombo + EB  3.0
Public Member Functions | Private Attributes | List of all members
ShiftIterator Class Reference

Class to manage box-shifting used to enforce periodic BC's. More...

#include <ProblemDomain.H>

Public Member Functions

 ShiftIterator ()
 Basic constructor. More...
 
 ShiftIterator (const bool *a_isPeriodic)
 Defining Constructor. More...
 
 ShiftIterator (const ShiftIterator &a_shiftIt)
 Copy constructor. More...
 
 ~ShiftIterator ()
 Destructor. More...
 
ShiftIteratoroperator= (const ShiftIterator &a_src)
 Assignment operator. More...
 
void computeShifts (const bool *a_isPeriodic)
 Recompute shift vectors based on periodic directions. More...
 
IntVect operator() () const
 Returns the current shift unit vector. More...
 
IntVect i () const
 Equivalent to the () operator. More...
 
void operator++ ()
 Increment to the next shift unit vector. More...
 
void incr ()
 Equivalent to the ++ operator. More...
 
bool ok () const
 Is the iterator still within its range of shift vectors? More...
 
int index () const
 which periodic image is this More...
 
const IntVectoperator[] (int index) const
 
void reset ()
 Reset to first shift unit vector. More...
 
void begin ()
 Equivalent to reset() More...
 
void end ()
 Skip the iterator to the end. More...
 

Private Attributes

int m_index
 
Vector< IntVectm_shift_vectors
 

Detailed Description

Class to manage box-shifting used to enforce periodic BC's.

The ShiftIterator class contains a list of shift vectors necessary to enforce periodic boundary conditions (enforced by shifting the Box of each Fab, then copying any overlapping valid cells with ghost cells of the shifted Fab. Depending on the number of periodic directions, the list of shift vectors over which to iterate differs.

Constructor & Destructor Documentation

ShiftIterator::ShiftIterator ( )
inline

Basic constructor.

ShiftIterator::ShiftIterator ( const bool *  a_isPeriodic)

Defining Constructor.

Builds a ShiftIterator based on the periodicity in a_isPeriodic

ShiftIterator::ShiftIterator ( const ShiftIterator a_shiftIt)
inline

Copy constructor.

References m_index, and m_shift_vectors.

ShiftIterator::~ShiftIterator ( )

Destructor.

Member Function Documentation

ShiftIterator & ShiftIterator::operator= ( const ShiftIterator a_src)
inline

Assignment operator.

References m_index, and m_shift_vectors.

void ShiftIterator::computeShifts ( const bool *  a_isPeriodic)

Recompute shift vectors based on periodic directions.

IntVect ShiftIterator::operator() ( ) const
inline

Returns the current shift unit vector.

References CH_assert, m_index, m_shift_vectors, and ok().

Referenced by i().

IntVect ShiftIterator::i ( ) const
inline

Equivalent to the () operator.

References operator()().

void ShiftIterator::operator++ ( )
inline

Increment to the next shift unit vector.

References m_index.

void ShiftIterator::incr ( )
inline

Equivalent to the ++ operator.

bool ShiftIterator::ok ( ) const
inline

Is the iterator still within its range of shift vectors?

References m_index, m_shift_vectors, and Vector< T >::size().

Referenced by operator()().

int ShiftIterator::index ( ) const
inline

which periodic image is this

References m_index.

Referenced by operator[]().

const IntVect& ShiftIterator::operator[] ( int  index) const
inline

References index(), and m_shift_vectors.

void ShiftIterator::reset ( )
inline

Reset to first shift unit vector.

References m_index.

void ShiftIterator::begin ( )
inline

Equivalent to reset()

References m_index.

void ShiftIterator::end ( )
inline

Skip the iterator to the end.

ok() will return false after this method is called.

References m_index, m_shift_vectors, and Vector< T >::size().

Member Data Documentation

int ShiftIterator::m_index
private
Vector<IntVect> ShiftIterator::m_shift_vectors
private

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