class SideIterator

Iterator for low and high side

Inheritance:

SideIterator


public members:

Constructors, destructors
SideIterator()
~SideIterator()

Modification functions
void begin()
void reset()
void operator++()

Access functions
Side::LoHiSide operator() () const
bool ok() const

Documentation

SideIterator iterates over the values Side::Lo and Side::Hi. There are no adjustable parameters whatsoever.
SideIterator ()
Default, and only, constructor.

~SideIterator ()
Default destructor.

void begin ()
Set the iterator to the first side.

Arguments: none.
Returns: none.
This:
This object is modified.

void reset ()
Set the iterator to the first side.

Arguments: none.
Returns: none.
This:
This object is modified.

void operator++ ()
Advances the iterator to the next face.

Arguments: none.
Returns: none.
This:
This object is modified.

Side::LoHiSide operator() () const
Returns the value of the side for the current iteration.

Arguments: none.
Returns:
Returns the value of the side for the current iteration.
This:
This object is not modified.

bool ok () const
Checks to see if there is a next side.

Arguments: none.
Returns:
true if there is a next side.
false otherwise.
This:
This object is not modified.


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.