Dumux::CCMpfaGridInteractionVolumeIndexSets< FVG, NI, PI, SI > Class Template Reference

Class that holds all interaction volume index sets on a grid view. More...

#include <dumux/discretization/cellcentered/mpfa/gridinteractionvolumeindexsets.hh>

Description

template<class FVG, class NI, class PI, class SI = PI>
class Dumux::CCMpfaGridInteractionVolumeIndexSets< FVG, NI, PI, SI >

Class that holds all interaction volume index sets on a grid view.

Template Parameters

FVG	the finite volume grid geometry
NI	the type used for nodal index sets
PI	primary interaction volume type
SI	secondary interaction volume type

Public Types
using	GridGeometry = FVG
using	PrimaryInteractionVolume = PI
using	SecondaryInteractionVolume = SI
using	GridIndexType = typename NI::GridIndexType
using	DualGridIndexSet = CCMpfaDualGridIndexSet< NI >

Public Member Functions
void	update (GridGeometry &gridGeometry, DualGridIndexSet &&dualGridIdSet)
	Construct all interaction volume index sets on the grid view. More...
const PrimaryIVIndexSet &	primaryIndexSet (const SubControlVolumeFace &scvf) const
	Return the iv index set in which a given scvf is embedded in. More...
const PrimaryIVIndexSet &	primaryIndexSet (const GridIndexType scvfIdx) const
	Return the iv index set in which a given scvf (index) is embedded in. More...
const SecondaryIVIndexSet &	secondaryIndexSet (const SubControlVolumeFace &scvf) const
	Return the iv index set in which a given scvf is embedded in. More...
const SecondaryIVIndexSet &	secondaryIndexSet (const GridIndexType scvfIdx) const
	Return the iv index set in which a given scvf (index) is embedded in. More...
std::size_t	numPrimaryInteractionVolumes () const
	Returns number of primary/secondary interaction volumes on the grid view. More...
std::size_t	numSecondaryInteractionVolumes () const

Member Typedef Documentation

DualGridIndexSet

template<class FVG , class NI , class PI , class SI = PI>

using Dumux::CCMpfaGridInteractionVolumeIndexSets< FVG, NI, PI, SI >::DualGridIndexSet = CCMpfaDualGridIndexSet< NI >

GridGeometry

template<class FVG , class NI , class PI , class SI = PI>

using Dumux::CCMpfaGridInteractionVolumeIndexSets< FVG, NI, PI, SI >::GridGeometry = FVG

GridIndexType

template<class FVG , class NI , class PI , class SI = PI>

using Dumux::CCMpfaGridInteractionVolumeIndexSets< FVG, NI, PI, SI >::GridIndexType = typename NI::GridIndexType

PrimaryInteractionVolume

template<class FVG , class NI , class PI , class SI = PI>

using Dumux::CCMpfaGridInteractionVolumeIndexSets< FVG, NI, PI, SI >::PrimaryInteractionVolume = PI

SecondaryInteractionVolume

template<class FVG , class NI , class PI , class SI = PI>

using Dumux::CCMpfaGridInteractionVolumeIndexSets< FVG, NI, PI, SI >::SecondaryInteractionVolume = SI

Member Function Documentation

numPrimaryInteractionVolumes()

template<class FVG , class NI , class PI , class SI = PI>

std::size_t Dumux::CCMpfaGridInteractionVolumeIndexSets< FVG, NI, PI, SI >::numPrimaryInteractionVolumes ( ) const

inline

Returns number of primary/secondary interaction volumes on the grid view.

numSecondaryInteractionVolumes()

template<class FVG , class NI , class PI , class SI = PI>

std::size_t Dumux::CCMpfaGridInteractionVolumeIndexSets< FVG, NI, PI, SI >::numSecondaryInteractionVolumes ( ) const

inline

primaryIndexSet() [1/2]

template<class FVG , class NI , class PI , class SI = PI>

const PrimaryIVIndexSet & Dumux::CCMpfaGridInteractionVolumeIndexSets< FVG, NI, PI, SI >::primaryIndexSet ( const GridIndexType  scvfIdx ) const

inline

Return the iv index set in which a given scvf (index) is embedded in.

primaryIndexSet() [2/2]

template<class FVG , class NI , class PI , class SI = PI>

const PrimaryIVIndexSet & Dumux::CCMpfaGridInteractionVolumeIndexSets< FVG, NI, PI, SI >::primaryIndexSet ( const SubControlVolumeFace &  scvf ) const

inline

Return the iv index set in which a given scvf is embedded in.

secondaryIndexSet() [1/2]

template<class FVG , class NI , class PI , class SI = PI>

const SecondaryIVIndexSet & Dumux::CCMpfaGridInteractionVolumeIndexSets< FVG, NI, PI, SI >::secondaryIndexSet ( const GridIndexType  scvfIdx ) const

inline

Return the iv index set in which a given scvf (index) is embedded in.

secondaryIndexSet() [2/2]

template<class FVG , class NI , class PI , class SI = PI>

const SecondaryIVIndexSet & Dumux::CCMpfaGridInteractionVolumeIndexSets< FVG, NI, PI, SI >::secondaryIndexSet ( const SubControlVolumeFace &  scvf ) const

inline

Return the iv index set in which a given scvf is embedded in.

update()

template<class FVG , class NI , class PI , class SI = PI>

void Dumux::CCMpfaGridInteractionVolumeIndexSets< FVG, NI, PI, SI >::update ( GridGeometry &  gridGeometry, DualGridIndexSet &&  dualGridIdSet  )

inline

Construct all interaction volume index sets on the grid view.

Parameters

gridGeometry	The finite volume geometry on the grid view
dualGridIdSet	The index sets of the dual grid on the grid view

---

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

• gridinteractionvolumeindexsets.hh