Workspace 6.21.5
Public Member Functions | List of all members
FaceIterator< T > Class Template Reference

This class provides an iterator that iterates through all the faces in a container of VolumeElement's. More...

#include <Mesh/DataStructures/faceiterator.h>

Public Member Functions

 FaceIterator ()
 
 FaceIterator (typename T::iterator eIter)
 
long getCompID () const
 
VolumeElementgetVolumeElement ()
 
const VolumeElementgetVolumeElement () const
 
bool isValid () const
 
bool operator!= (const FaceIterator &rhs) const
 
VolumeFaceoperator* ()
 
const VolumeFaceoperator* () const
 
FaceIteratoroperator++ ()
 
FaceIteratoroperator++ (int)
 
FaceIteratoroperator-- ()
 
FaceIteratoroperator-- (int)
 
bool operator== (const FaceIterator &rhs) const
 
Deprecated functions
bool IsValid () const
 
long GetCompID () const
 
const VolumeElementGetVolumeElement () const
 
VolumeElementGetVolumeElement ()
 

Detailed Description

template<typename T>
class CSIRO::Mesh::FaceIterator< T >
Warning
It is possible to encounter a face more than once using these iterators if a face is used by more than one volume element. Note that faces with normal vectors in opposite directions are distinct from each other, so a simple, well-formed volume mesh will lead to face iterators that only visit each face once.

Constructor & Destructor Documentation

◆ FaceIterator() [1/2]

FaceIterator ( )
inline

◆ FaceIterator() [2/2]

FaceIterator ( typename T::iterator  eIter)
inline

Member Function Documentation

◆ getCompID()

long getCompID ( ) const
inline

◆ GetCompID()

long GetCompID ( ) const
inline

◆ getVolumeElement() [1/2]

VolumeElement * getVolumeElement ( )
inline

◆ GetVolumeElement() [1/2]

VolumeElement * GetVolumeElement ( )
inline

◆ getVolumeElement() [2/2]

const VolumeElement * getVolumeElement ( ) const
inline

◆ GetVolumeElement() [2/2]

const VolumeElement * GetVolumeElement ( ) const
inline

◆ isValid()

bool isValid ( ) const
inline

◆ IsValid()

bool IsValid ( ) const
inline

◆ operator!=()

bool operator!= ( const FaceIterator< T > &  rhs) const
inline

◆ operator*() [1/2]

VolumeFace * operator* ( )
inline

◆ operator*() [2/2]

const VolumeFace * operator* ( ) const
inline

◆ operator++() [1/2]

FaceIterator & operator++ ( )
inline

◆ operator++() [2/2]

FaceIterator & operator++ ( int  )
inline

◆ operator--() [1/2]

FaceIterator & operator-- ( )
inline

◆ operator--() [2/2]

FaceIterator & operator-- ( int  )
inline

◆ operator==()

bool operator== ( const FaceIterator< T > &  rhs) const
inline