version 3.10-dev
Dumux::SkippingScvfIterator< SubControlVolumeFace, Vector, FVElementGeometry > Class Template Reference

Iterators over sub control volume faces of an fv geometry and a given sub control volume. More...

#include <dumux/discretization/scvandscvfiterators.hh>

Inheritance diagram for Dumux::SkippingScvfIterator< SubControlVolumeFace, Vector, FVElementGeometry >:

Description

template<class SubControlVolumeFace, class Vector, class FVElementGeometry>
class Dumux::SkippingScvfIterator< SubControlVolumeFace, Vector, FVElementGeometry >
Note
usage: for(const auto& scvf : scvfs(fvGeometry, scv))

Public Member Functions

 SkippingScvfIterator ()
 
const SubControlVolumeFace & dereference () const
 dereferencing yields a subcontrol volume face More...
 
bool equals (const ThisType &other) const
 
void increment ()
 

Static Public Member Functions

static ThisType makeBegin (const Vector &vector, const FVElementGeometry &fvGeometry, const std::size_t scvIdx)
 
static ThisType makeEnd (const Vector &vector, const FVElementGeometry &fvGeometry, const std::size_t scvIdx)
 

Constructor & Destructor Documentation

◆ SkippingScvfIterator()

template<class SubControlVolumeFace , class Vector , class FVElementGeometry >
Dumux::SkippingScvfIterator< SubControlVolumeFace, Vector, FVElementGeometry >::SkippingScvfIterator ( )
inline

Member Function Documentation

◆ dereference()

template<class SubControlVolumeFace , class Vector , class FVElementGeometry >
const SubControlVolumeFace & Dumux::SkippingScvfIterator< SubControlVolumeFace, Vector, FVElementGeometry >::dereference ( ) const
inline

◆ equals()

template<class SubControlVolumeFace , class Vector , class FVElementGeometry >
bool Dumux::SkippingScvfIterator< SubControlVolumeFace, Vector, FVElementGeometry >::equals ( const ThisType other) const
inline

◆ increment()

template<class SubControlVolumeFace , class Vector , class FVElementGeometry >
void Dumux::SkippingScvfIterator< SubControlVolumeFace, Vector, FVElementGeometry >::increment ( )
inline

◆ makeBegin()

template<class SubControlVolumeFace , class Vector , class FVElementGeometry >
static ThisType Dumux::SkippingScvfIterator< SubControlVolumeFace, Vector, FVElementGeometry >::makeBegin ( const Vector &  vector,
const FVElementGeometry &  fvGeometry,
const std::size_t  scvIdx 
)
inlinestatic

◆ makeEnd()

template<class SubControlVolumeFace , class Vector , class FVElementGeometry >
static ThisType Dumux::SkippingScvfIterator< SubControlVolumeFace, Vector, FVElementGeometry >::makeEnd ( const Vector &  vector,
const FVElementGeometry &  fvGeometry,
const std::size_t  scvIdx 
)
inlinestatic

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