class ShiftIterator

clase to manage box-shifting used to enforce periodic BC's

Inheritance:

ShiftIterator


public members:

ShiftIterator()
basic constructor
ShiftIterator(const bool* a_isPeriodic)
ShiftIterator(const ShiftIterator & a_shiftIt)
copy constructor
~ShiftIterator()
ShiftIterator & operator=(const ShiftIterator & a_src)
void computeShifts(const bool* a_isPeriodic)
recompute shift vectors based on periodic directions
inline IntVect operator()() const
returns the current shift unit vector
inline void operator++()
increment to the next shift unit vector
inline bool ok() const
inline void reset()
reset to first shift unit vector
inline void begin()
void end()

Documentation

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.
void end ()
skip the iterator to the end. ok() will return false after this method is called.


this class has no child classes.

alphabetic index hierarchy of classes


Chombo

Copyright Notice

This software is copyright (C) by the Lawrence Berkeley National Laboratory. Permission is granted to reproduce this software for non-commercial purposes provided that this notice is left intact.

It is acknowledged that the U.S. Government has rights to this software under Contract DE-AC03-765F00098 between the U.S. Department of Energy and the University of California.

This software is provided as a professional and academic contribution for joint exchange. Thus it is experimental, is provided ``as is'', with no warranties of any kind whatsoever, no support, no promise of updates, or printed documentation. By using this software, you acknowledge that the Lawrence Berkeley National Laboratory and Regents of the University of California shall have no liability with respect to the infringement of other copyrights by any part of this software.