Dumux::SubControlVolumeFaceBase< Imp, ScvfGeometryTraits > Class Template Reference

Base class for a sub control volume face, i.e a part of the boundary of a sub control volume we computing a flux on. More...

#include <dumux/discretization/subcontrolvolumefacebase.hh>

Inheritance diagram for Dumux::SubControlVolumeFaceBase< Imp, ScvfGeometryTraits >:

Description

template<class Imp, class ScvfGeometryTraits>
class Dumux::SubControlVolumeFaceBase< Imp, ScvfGeometryTraits >

Base class for a sub control volume face, i.e a part of the boundary of a sub control volume we computing a flux on.

Template Parameters

Imp	the implementation
ScvGeometryTraits	traits of this class

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

Public Member Functions
GlobalPosition	center () const
	The center of the sub control volume face. More...
GlobalPosition	ipGlobal () const
	The integration point for flux evaluations in global coordinates. More...
Scalar	area () const
	The area of the sub control volume face. More...
bool	boundary () const
	returns bolean if the sub control volume face is on the boundary More...
GlobalPosition	unitOuterNormal () const
	the unit outward pointing normal on the scv face More...
GridIndexType	insideScvIdx () const
	index of the inside sub control volume for spatial param evaluation More...
GridIndexType	outsideScvIdx (int i=0) const
GridIndexType	index () const
	The global index of this sub control volume face. More...

Member Typedef Documentation

GlobalPosition

template<class Imp , class ScvfGeometryTraits >

using Dumux::SubControlVolumeFaceBase< Imp, ScvfGeometryTraits >::GlobalPosition = typename ScvfGeometryTraits::GlobalPosition

export the type used for global coordinates

Traits

template<class Imp , class ScvfGeometryTraits >

using Dumux::SubControlVolumeFaceBase< Imp, ScvfGeometryTraits >::Traits = ScvfGeometryTraits

state the traits public and thus export all types

Member Function Documentation

area()

template<class Imp , class ScvfGeometryTraits >

Scalar Dumux::SubControlVolumeFaceBase< Imp, ScvfGeometryTraits >::area ( ) const

inline

The area of the sub control volume face.

boundary()

template<class Imp , class ScvfGeometryTraits >

bool Dumux::SubControlVolumeFaceBase< Imp, ScvfGeometryTraits >::boundary ( ) const

inline

returns bolean if the sub control volume face is on the boundary

center()

template<class Imp , class ScvfGeometryTraits >

GlobalPosition Dumux::SubControlVolumeFaceBase< Imp, ScvfGeometryTraits >::center ( ) const

inline

The center of the sub control volume face.

index()

template<class Imp , class ScvfGeometryTraits >

GridIndexType Dumux::SubControlVolumeFaceBase< Imp, ScvfGeometryTraits >::index ( ) const

inline

The global index of this sub control volume face.

insideScvIdx()

template<class Imp , class ScvfGeometryTraits >

GridIndexType Dumux::SubControlVolumeFaceBase< Imp, ScvfGeometryTraits >::insideScvIdx ( ) const

inline

index of the inside sub control volume for spatial param evaluation

ipGlobal()

template<class Imp , class ScvfGeometryTraits >

GlobalPosition Dumux::SubControlVolumeFaceBase< Imp, ScvfGeometryTraits >::ipGlobal ( ) const

inline

The integration point for flux evaluations in global coordinates.

outsideScvIdx()

template<class Imp , class ScvfGeometryTraits >

GridIndexType Dumux::SubControlVolumeFaceBase< Imp, ScvfGeometryTraits >::outsideScvIdx ( int  i = 0 ) const

inline

index of the outside sub control volume for spatial param evaluation This results in undefined behaviour if boundary is true In case of multiple outside scv indices (network grids) an index can be supplied

unitOuterNormal()

template<class Imp , class ScvfGeometryTraits >

GlobalPosition Dumux::SubControlVolumeFaceBase< Imp, ScvfGeometryTraits >::unitOuterNormal ( ) const

inline

the unit outward pointing normal on the scv face

---

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

• subcontrolvolumefacebase.hh