Chombo + EB  3.2
Public Member Functions | Private Member Functions | Private Attributes | List of all members
FaceIterator Class Reference

Iterator over faces within an IntVectSet and an Ebgraph. More...

#include <FaceIterator.H>

Public Member Functions

 FaceIterator (const IntVectSet &a_ivs, const EBGraph &a_ebgraph, int a_direction, const FaceStop::WhichFaces &a_location)
 general construction More...
 
 FaceIterator ()
 
 ~FaceIterator ()
 Going with the default... More...
 
void define (const IntVectSet &a_ivs, const EBGraph &a_ebgraph, int a_direction, const FaceStop::WhichFaces &a_location)
 
void reset ()
 
void operator++ ()
 
const FaceIndexoperator() () const
 
bool ok () const
 
bool isDefined () const
 
const Vector< FaceIndex > & getVector () const
 

Private Member Functions

void doDefine (const IntVectSet &a_ivs, const EBGraph &a_ebgraph, int a_direction, const FaceStop::WhichFaces &a_location)
 

Private Attributes

bool m_isDefined
 
Vector< FaceIndexm_faces
 
int m_iface
 
int m_direction
 

Detailed Description

Iterator over faces within an IntVectSet and an Ebgraph.

Iterator over within an IntVectSet and an Ebgraph. The enumeration tells which faces on which to stop.

Constructor & Destructor Documentation

◆ FaceIterator() [1/2]

FaceIterator::FaceIterator ( const IntVectSet a_ivs,
const EBGraph a_ebgraph,
int  a_direction,
const FaceStop::WhichFaces a_location 
)

general construction

◆ FaceIterator() [2/2]

FaceIterator::FaceIterator ( )

◆ ~FaceIterator()

FaceIterator::~FaceIterator ( )

Going with the default...

Going with the default...

Member Function Documentation

◆ define()

void FaceIterator::define ( const IntVectSet a_ivs,
const EBGraph a_ebgraph,
int  a_direction,
const FaceStop::WhichFaces a_location 
)

◆ reset()

void FaceIterator::reset ( )

◆ operator++()

void FaceIterator::operator++ ( )

◆ operator()()

const FaceIndex& FaceIterator::operator() ( ) const

◆ ok()

bool FaceIterator::ok ( ) const

◆ isDefined()

bool FaceIterator::isDefined ( ) const

◆ getVector()

const Vector<FaceIndex>& FaceIterator::getVector ( ) const

◆ doDefine()

void FaceIterator::doDefine ( const IntVectSet a_ivs,
const EBGraph a_ebgraph,
int  a_direction,
const FaceStop::WhichFaces a_location 
)
private

Does the real work. this->define() looks in the cache first.

Member Data Documentation

◆ m_isDefined

bool FaceIterator::m_isDefined
private

◆ m_faces

Vector<FaceIndex> FaceIterator::m_faces
private

◆ m_iface

int FaceIterator::m_iface
private

◆ m_direction

int FaceIterator::m_direction
private

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