Chombo + EB
3.0
|
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... | |
ShiftIterator & | operator= (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 IntVect & | operator[] (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< IntVect > | m_shift_vectors |
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.
|
inline |
Basic constructor.
ShiftIterator::ShiftIterator | ( | const bool * | a_isPeriodic | ) |
Defining Constructor.
Builds a ShiftIterator based on the periodicity in a_isPeriodic
|
inline |
Copy constructor.
References m_index, and m_shift_vectors.
ShiftIterator::~ShiftIterator | ( | ) |
Destructor.
|
inline |
Assignment operator.
References m_index, and m_shift_vectors.
void ShiftIterator::computeShifts | ( | const bool * | a_isPeriodic | ) |
Recompute shift vectors based on periodic directions.
|
inline |
Returns the current shift unit vector.
References CH_assert, m_index, m_shift_vectors, and ok().
Referenced by i().
|
inline |
Equivalent to the () operator.
References operator()().
|
inline |
Increment to the next shift unit vector.
References m_index.
|
inline |
Equivalent to the ++ operator.
|
inline |
Is the iterator still within its range of shift vectors?
References m_index, m_shift_vectors, and Vector< T >::size().
Referenced by operator()().
|
inline |
|
inline |
References index(), and m_shift_vectors.
|
inline |
Reset to first shift unit vector.
References m_index.
|
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().
|
private |
Referenced by begin(), end(), index(), ok(), operator()(), operator++(), operator=(), reset(), and ShiftIterator().
Referenced by end(), ok(), operator()(), operator=(), operator[](), and ShiftIterator().