version 3.11-dev
Loading...
Searching...
No Matches

the sub control volume for the box scheme More...

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

Inheritance diagram for Dumux::BoxSubControlVolume< GV, T >:

Description

template<class GV, class T = BoxDefaultScvGeometryTraits<GV>>
class Dumux::BoxSubControlVolume< GV, T >
Template Parameters
GVthe type of the grid view
Tthe scvf geometry traits

Public Types

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

Public Member Functions

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

Member Typedef Documentation

◆ GlobalPosition

template<class GV, class T = BoxDefaultScvGeometryTraits<GV>>
using Dumux::BoxSubControlVolume< GV, T >::GlobalPosition = typename T::GlobalPosition

◆ Traits

template<class GV, class T = BoxDefaultScvGeometryTraits<GV>>
using Dumux::BoxSubControlVolume< GV, T >::Traits = T

Constructor & Destructor Documentation

◆ BoxSubControlVolume() [1/2]

template<class GV, class T = BoxDefaultScvGeometryTraits<GV>>
Dumux::BoxSubControlVolume< GV, T >::BoxSubControlVolume ( )
default

◆ BoxSubControlVolume() [2/2]

template<class GV, class T = BoxDefaultScvGeometryTraits<GV>>
template<class Corners>
Dumux::BoxSubControlVolume< GV, T >::BoxSubControlVolume ( const Corners & corners,
LocalIndexType scvIdx,
GridIndexType elementIndex,
GridIndexType dofIndex )
inline

Member Function Documentation

◆ center()

template<class GV, class T = BoxDefaultScvGeometryTraits<GV>>
const GlobalPosition & Dumux::BoxSubControlVolume< GV, T >::center ( ) const
inline

◆ dofIndex()

template<class GV, class T = BoxDefaultScvGeometryTraits<GV>>
GridIndexType Dumux::BoxSubControlVolume< GV, T >::dofIndex ( ) const
inline

◆ dofPosition()

template<class GV, class T = BoxDefaultScvGeometryTraits<GV>>
const GlobalPosition & Dumux::BoxSubControlVolume< GV, T >::dofPosition ( ) const
inline

◆ elementIndex()

template<class GV, class T = BoxDefaultScvGeometryTraits<GV>>
GridIndexType Dumux::BoxSubControlVolume< GV, T >::elementIndex ( ) const
inline

◆ indexInElement()

template<class GV, class T = BoxDefaultScvGeometryTraits<GV>>
LocalIndexType Dumux::BoxSubControlVolume< GV, T >::indexInElement ( ) const
inline

The element-local index of this scv. For the standard box scheme this is the local dof index.

◆ localDofIndex()

template<class GV, class T = BoxDefaultScvGeometryTraits<GV>>
LocalIndexType Dumux::BoxSubControlVolume< GV, T >::localDofIndex ( ) const
inline

◆ volume()

template<class GV, class T = BoxDefaultScvGeometryTraits<GV>>
Scalar Dumux::BoxSubControlVolume< GV, T >::volume ( ) const
inline

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