Dumux::PoreNetwork::PNMSubControlVolume< GV, T > Class Template Reference

the sub control volume for porenetworks More...

#include <dumux/discretization/porenetwork/subcontrolvolume.hh>

Inheritance diagram for Dumux::PoreNetwork::PNMSubControlVolume< GV, T >:

Description

template<class GV, class T = PNMDefaultScvGeometryTraits<GV>>
class Dumux::PoreNetwork::PNMSubControlVolume< GV, T >

Template Parameters

GV	the type of the grid view
T	the scv geometry traits

Public Types
using	GlobalPosition = typename T::GlobalPosition
	export the type used for global coordinates More...
using	Traits = T
	state the traits public and thus export all types More...

Public Member Functions
	PNMSubControlVolume ()=default
	The default constructor. More...
template<class Corners >
	PNMSubControlVolume (GridIndexType dofIndex, LocalIndexType scvIdx, GridIndexType elementIndex, Corners &&corners, const Scalar volume)
const GlobalPosition &	center () const
Scalar	volume () const
	The volume of the sub control volume (part of a pore) More...
LocalIndexType	localDofIndex () const
	The element-local index of the dof this scv is embedded in. More...
LocalIndexType	indexInElement () const
	The element-local index of this scv. More...
GridIndexType	dofIndex () const
	The index of the dof this scv is embedded in. More...
const GlobalPosition &	dofPosition () const
GridIndexType	elementIndex () const
	The global index of the element this scv is embedded in. More...

Member Typedef Documentation

GlobalPosition

template<class GV , class T = PNMDefaultScvGeometryTraits<GV>>

using Dumux::PoreNetwork::PNMSubControlVolume< GV, T >::GlobalPosition = typename T::GlobalPosition

Traits

template<class GV , class T = PNMDefaultScvGeometryTraits<GV>>

using Dumux::PoreNetwork::PNMSubControlVolume< GV, T >::Traits = T

Constructor & Destructor Documentation

PNMSubControlVolume() [1/2]

template<class GV , class T = PNMDefaultScvGeometryTraits<GV>>

Dumux::PoreNetwork::PNMSubControlVolume< GV, T >::PNMSubControlVolume ( )

default

PNMSubControlVolume() [2/2]

template<class GV , class T = PNMDefaultScvGeometryTraits<GV>>

template<class Corners >

Dumux::PoreNetwork::PNMSubControlVolume< GV, T >::PNMSubControlVolume ( GridIndexType  dofIndex, LocalIndexType  scvIdx, GridIndexType  elementIndex, Corners &&  corners, const Scalar  volume  )

inline

Member Function Documentation

center()

template<class GV , class T = PNMDefaultScvGeometryTraits<GV>>

const GlobalPosition & Dumux::PoreNetwork::PNMSubControlVolume< GV, T >::center ( ) const

inline

The center of the sub control volume (return pore center). Be aware that this is not the pore-body center! Use dofPosition() for the latter!

dofIndex()

template<class GV , class T = PNMDefaultScvGeometryTraits<GV>>

GridIndexType Dumux::PoreNetwork::PNMSubControlVolume< GV, T >::dofIndex ( ) const

inline

dofPosition()

template<class GV , class T = PNMDefaultScvGeometryTraits<GV>>

const GlobalPosition & Dumux::PoreNetwork::PNMSubControlVolume< GV, T >::dofPosition ( ) const

inline

elementIndex()

template<class GV , class T = PNMDefaultScvGeometryTraits<GV>>

GridIndexType Dumux::PoreNetwork::PNMSubControlVolume< GV, T >::elementIndex ( ) const

inline

indexInElement()

template<class GV , class T = PNMDefaultScvGeometryTraits<GV>>

LocalIndexType Dumux::PoreNetwork::PNMSubControlVolume< GV, T >::indexInElement ( ) const

inline

localDofIndex()

template<class GV , class T = PNMDefaultScvGeometryTraits<GV>>

LocalIndexType Dumux::PoreNetwork::PNMSubControlVolume< GV, T >::localDofIndex ( ) const

inline

volume()

template<class GV , class T = PNMDefaultScvGeometryTraits<GV>>

Scalar Dumux::PoreNetwork::PNMSubControlVolume< GV, T >::volume ( ) const

inline

---

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

• discretization/porenetwork/subcontrolvolume.hh