Dumux::CCMpfaOInteractionVolumeIndexSet< DualGridNodalIndexSet > Class Template Reference

The interaction volume index set class for the mpfa-o scheme. More...

#include <dumux/discretization/cellcentered/mpfa/omethod/interactionvolumeindexset.hh>

Inheritance diagram for Dumux::CCMpfaOInteractionVolumeIndexSet< DualGridNodalIndexSet >:

Description

template<class DualGridNodalIndexSet>
class Dumux::CCMpfaOInteractionVolumeIndexSet< DualGridNodalIndexSet >

The interaction volume index set class for the mpfa-o scheme.

Template Parameters

DualGridNodalIndexSet

The type used for the nodal index set in the dual grid.

Public Types
using	NodalIndexSet = DualGridNodalIndexSet
	Export the type used for the nodal grid index sets.
using	LocalIndexType = typename DualGridNodalIndexSet::LocalIndexType
	Export the types used for local/grid indices.
using	GridIndexType = typename DualGridNodalIndexSet::GridIndexType
using	NodalGridStencilType = typename DualGridNodalIndexSet::NodalGridStencilType
	Export the stencil types used.
using	NodalLocalStencilType = typename DualGridNodalIndexSet::NodalLocalStencilType
using	NodalGridScvfStencilType = typename DualGridNodalIndexSet::NodalGridScvfStencilType
using	ScvfNeighborLocalIndexSet = typename DualGridNodalIndexSet::ScvfNeighborLocalIndexSet
	Export the type used for the neighbor scv index sets of the scvfs.

Public Member Functions
template<class FlipScvfIndexSet>
	CCMpfaOInteractionVolumeIndexSet (const NodalIndexSet &nodalIndexSet, const FlipScvfIndexSet &flipScvfIndexSet)
	The constructor.
const NodalIndexSet &	nodalIndexSet () const
	returns the corresponding nodal index set
const NodalGridStencilType &	gridScvIndices () const
	returns the global scv indices connected to this dual grid node
const NodalGridScvfStencilType &	gridScvfIndices () const
	returns the global scvf indices embedded in this interaction volume
std::size_t	numFaces () const
	returns the number of faces in the interaction volume
std::size_t	numScvs () const
	returns the number of scvs in the interaction volume
GridIndexType	gridScvIndex (LocalIndexType ivLocalScvIdx) const
	returns a grid scv idx for a given iv-local scv index
GridIndexType	gridScvfIndex (LocalIndexType ivLocalScvfIdx) const
	returns a grid scvf idx for a given iv-local scvf index
LocalIndexType	localScvfIndex (LocalIndexType scvIdxLocal, unsigned int i) const
	returns the iv-local scvf idx of the i-th scvf embedded in a local scv
const ScvfNeighborLocalIndexSet &	neighboringLocalScvIndices (LocalIndexType ivLocalScvfIdx) const
	returns the local indices of the neighboring scvs of an scvf

Member Typedef Documentation

GridIndexType

template<class DualGridNodalIndexSet>

using Dumux::CCMpfaOInteractionVolumeIndexSet< DualGridNodalIndexSet >::GridIndexType = typename DualGridNodalIndexSet::GridIndexType

LocalIndexType

template<class DualGridNodalIndexSet>

using Dumux::CCMpfaOInteractionVolumeIndexSet< DualGridNodalIndexSet >::LocalIndexType = typename DualGridNodalIndexSet::LocalIndexType

Export the types used for local/grid indices.

NodalGridScvfStencilType

template<class DualGridNodalIndexSet>

using Dumux::CCMpfaOInteractionVolumeIndexSet< DualGridNodalIndexSet >::NodalGridScvfStencilType = typename DualGridNodalIndexSet::NodalGridScvfStencilType

NodalGridStencilType

template<class DualGridNodalIndexSet>

using Dumux::CCMpfaOInteractionVolumeIndexSet< DualGridNodalIndexSet >::NodalGridStencilType = typename DualGridNodalIndexSet::NodalGridStencilType

Export the stencil types used.

NodalIndexSet

template<class DualGridNodalIndexSet>

using Dumux::CCMpfaOInteractionVolumeIndexSet< DualGridNodalIndexSet >::NodalIndexSet = DualGridNodalIndexSet

Export the type used for the nodal grid index sets.

NodalLocalStencilType

template<class DualGridNodalIndexSet>

using Dumux::CCMpfaOInteractionVolumeIndexSet< DualGridNodalIndexSet >::NodalLocalStencilType = typename DualGridNodalIndexSet::NodalLocalStencilType

ScvfNeighborLocalIndexSet

template<class DualGridNodalIndexSet>

using Dumux::CCMpfaOInteractionVolumeIndexSet< DualGridNodalIndexSet >::ScvfNeighborLocalIndexSet = typename DualGridNodalIndexSet::ScvfNeighborLocalIndexSet

Export the type used for the neighbor scv index sets of the scvfs.

Constructor & Destructor Documentation

CCMpfaOInteractionVolumeIndexSet()

template<class DualGridNodalIndexSet>

template<class FlipScvfIndexSet>

Dumux::CCMpfaOInteractionVolumeIndexSet< DualGridNodalIndexSet >::CCMpfaOInteractionVolumeIndexSet ( const NodalIndexSet & nodalIndexSet, const FlipScvfIndexSet & flipScvfIndexSet )

inline

The constructor.

Member Function Documentation

gridScvfIndex()

template<class DualGridNodalIndexSet>

GridIndexType Dumux::CCMpfaOInteractionVolumeIndexSet< DualGridNodalIndexSet >::gridScvfIndex ( LocalIndexType ivLocalScvfIdx ) const

inline

returns a grid scvf idx for a given iv-local scvf index

gridScvfIndices()

template<class DualGridNodalIndexSet>

const NodalGridScvfStencilType & Dumux::CCMpfaOInteractionVolumeIndexSet< DualGridNodalIndexSet >::gridScvfIndices ( ) const

inline

returns the global scvf indices embedded in this interaction volume

gridScvIndex()

template<class DualGridNodalIndexSet>

GridIndexType Dumux::CCMpfaOInteractionVolumeIndexSet< DualGridNodalIndexSet >::gridScvIndex ( LocalIndexType ivLocalScvIdx ) const

inline

returns a grid scv idx for a given iv-local scv index

gridScvIndices()

template<class DualGridNodalIndexSet>

const NodalGridStencilType & Dumux::CCMpfaOInteractionVolumeIndexSet< DualGridNodalIndexSet >::gridScvIndices ( ) const

inline

returns the global scv indices connected to this dual grid node

localScvfIndex()

template<class DualGridNodalIndexSet>

LocalIndexType Dumux::CCMpfaOInteractionVolumeIndexSet< DualGridNodalIndexSet >::localScvfIndex ( LocalIndexType scvIdxLocal, unsigned int i ) const

inline

returns the iv-local scvf idx of the i-th scvf embedded in a local scv

neighboringLocalScvIndices()

template<class DualGridNodalIndexSet>

const ScvfNeighborLocalIndexSet & Dumux::CCMpfaOInteractionVolumeIndexSet< DualGridNodalIndexSet >::neighboringLocalScvIndices ( LocalIndexType ivLocalScvfIdx ) const

inline

returns the local indices of the neighboring scvs of an scvf

nodalIndexSet()

template<class DualGridNodalIndexSet>

const NodalIndexSet & Dumux::CCMpfaOInteractionVolumeIndexSet< DualGridNodalIndexSet >::nodalIndexSet ( ) const

inline

returns the corresponding nodal index set

numFaces()

template<class DualGridNodalIndexSet>

std::size_t Dumux::CCMpfaOInteractionVolumeIndexSet< DualGridNodalIndexSet >::numFaces ( ) const

inline

returns the number of faces in the interaction volume

numScvs()

template<class DualGridNodalIndexSet>

std::size_t Dumux::CCMpfaOInteractionVolumeIndexSet< DualGridNodalIndexSet >::numScvs ( ) const

inline

returns the number of scvs in the interaction volume

---

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

• interactionvolumeindexset.hh