Dumux::SubControlVolumeBase< Imp, ScvGeometryTraits > Class Template Reference

Base class for a sub control volume, i.e a part of the control volume we are making the balance for. Defines the general interface. More...

#include <dumux/discretization/subcontrolvolumebase.hh>

Inheritance diagram for Dumux::SubControlVolumeBase< Imp, ScvGeometryTraits >:

Description

template<class Imp, class ScvGeometryTraits>
class Dumux::SubControlVolumeBase< Imp, ScvGeometryTraits >

Base class for a sub control volume, i.e a part of the control volume we are making the balance for. Defines the general interface.

Template Parameters

Imp	the implementation
ScvGeometryTraits	traits of this class

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

Public Member Functions
GlobalPosition	center () const
	The center of the sub control volume. More...
Scalar	volume () const
	The volume of the sub control volume. More...
GridIndexType	dofIndex () const
	The index of the dof this scv is embedded in (ccfv) More...
LocalIndexType	localDofIndex () const
	The index of the dof this scv is embedded in (box) More...
GlobalPosition	dofPosition () const
GridIndexType	elementIndex () const
	The global index of the element this scv is embedded in. More...

Member Typedef Documentation

GlobalPosition

template<class Imp , class ScvGeometryTraits >

using Dumux::SubControlVolumeBase< Imp, ScvGeometryTraits >::GlobalPosition = typename ScvGeometryTraits::GlobalPosition

export the type used for global coordinates

Traits

template<class Imp , class ScvGeometryTraits >

using Dumux::SubControlVolumeBase< Imp, ScvGeometryTraits >::Traits = ScvGeometryTraits

state the traits public and thus export all types

Member Function Documentation

center()

template<class Imp , class ScvGeometryTraits >

GlobalPosition Dumux::SubControlVolumeBase< Imp, ScvGeometryTraits >::center ( ) const

inline

The center of the sub control volume.

dofIndex()

template<class Imp , class ScvGeometryTraits >

GridIndexType Dumux::SubControlVolumeBase< Imp, ScvGeometryTraits >::dofIndex ( ) const

inline

The index of the dof this scv is embedded in (ccfv)

dofPosition()

template<class Imp , class ScvGeometryTraits >

GlobalPosition Dumux::SubControlVolumeBase< Imp, ScvGeometryTraits >::dofPosition ( ) const

inline

elementIndex()

template<class Imp , class ScvGeometryTraits >

GridIndexType Dumux::SubControlVolumeBase< Imp, ScvGeometryTraits >::elementIndex ( ) const

inline

The global index of the element this scv is embedded in.

localDofIndex()

template<class Imp , class ScvGeometryTraits >

LocalIndexType Dumux::SubControlVolumeBase< Imp, ScvGeometryTraits >::localDofIndex ( ) const

inline

The index of the dof this scv is embedded in (box)

volume()

template<class Imp , class ScvGeometryTraits >

Scalar Dumux::SubControlVolumeBase< Imp, ScvGeometryTraits >::volume ( ) const

inline

The volume of the sub control volume.

---

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

• subcontrolvolumebase.hh