Class for a sub control volume face in the staggered method, i.e a part of the boundary of a sub control volume we compute fluxes on. More...

#include <dumux/discretization/staggered/subcontrolvolumeface.hh>

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

Description

template<class GV, class T = StaggeredDefaultScvfGeometryTraits<GV>>
class Dumux::StaggeredSubControlVolumeFace< GV, T >

Class for a sub control volume face in the staggered method, i.e a part of the boundary of a sub control volume we compute fluxes on.

Public Types
using	GlobalPosition = typename T::GlobalPosition

using	Traits = T
	state the traits public and thus export all types More...

Public Member Functions
	StaggeredSubControlVolumeFace ()=default

template<class Intersection , class GeometryHelper >
	StaggeredSubControlVolumeFace (const Intersection &is, const typename Intersection::Geometry &isGeometry, GridIndexType scvfIndex, const std::vector< GridIndexType > &scvIndices, const GeometryHelper &geometryHelper)
	Constructor with intersection. More...

const GlobalPosition &	center () const
	The center of the sub control volume face. More...

const GlobalPosition &	dofPosition () const
	The position of the dof living on the face. More...

const 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 boolean if the sub control volume face is on the boundary. More...

const GlobalPosition &	unitOuterNormal () const
	The unit outer normal vector. More...

GridIndexType	insideScvIdx () const
	Index of the inside sub control volume. More...

GridIndexType	outsideScvIdx () const
	Index of the outside sub control volume. More...

GridIndexType	index () const
	The global index of this sub control volume face. More...

const GlobalPosition &	corner (unsigned int localIdx) const
	The positions of the corners. More...

const Geometry	geometry () const
	The geometry of the sub control volume face. More...

GridIndexType	dofIndex () const
	The global index of the dof living on this face. More...

LocalIndexType	localFaceIdx () const
	The local index of this sub control volume face. More...

GridIndexType	outsideScvIdx (int i=0) const

Member Typedef Documentation

◆ GlobalPosition

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

using Dumux::StaggeredSubControlVolumeFace< GV, T >::GlobalPosition = typename T::GlobalPosition

◆ Traits

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

using Dumux::StaggeredSubControlVolumeFace< GV, T >::Traits = T

state the traits public and thus export all types

Constructor & Destructor Documentation

◆ StaggeredSubControlVolumeFace() [1/2]

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

Dumux::StaggeredSubControlVolumeFace< GV, T >::StaggeredSubControlVolumeFace ( )

default

◆ StaggeredSubControlVolumeFace() [2/2]

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

template<class Intersection , class GeometryHelper >

Dumux::StaggeredSubControlVolumeFace< GV, T >::StaggeredSubControlVolumeFace	(	const Intersection &	is,
		const typename Intersection::Geometry &	isGeometry,
		GridIndexType	scvfIndex,
		const std::vector< GridIndexType > &	scvIndices,
		const GeometryHelper &	geometryHelper
	)

inline

Constructor with intersection.

Member Function Documentation

◆ area()

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

Scalar Dumux::StaggeredSubControlVolumeFace< GV, T >::area ( ) const

inline

The area of the sub control volume face.

◆ boundary()

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

bool Dumux::StaggeredSubControlVolumeFace< GV, T >::boundary ( ) const

inline

Returns boolean if the sub control volume face is on the boundary.

◆ center()

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

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

inline

The center of the sub control volume face.

◆ corner()

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

const GlobalPosition & Dumux::StaggeredSubControlVolumeFace< GV, T >::corner ( unsigned int localIdx ) const

inline

The positions of the corners.

◆ dofIndex()

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

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

inline

The global index of the dof living on this face.

◆ dofPosition()

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

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

inline

The position of the dof living on the face.

◆ geometry()

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

const Geometry Dumux::StaggeredSubControlVolumeFace< GV, T >::geometry ( ) const

inline

The geometry of the sub control volume face.

◆ index()

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

GridIndexType Dumux::StaggeredSubControlVolumeFace< GV, T >::index ( ) const

inline

The global index of this sub control volume face.

◆ insideScvIdx()

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

GridIndexType Dumux::StaggeredSubControlVolumeFace< GV, T >::insideScvIdx ( ) const

inline

Index of the inside sub control volume.

◆ ipGlobal()

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

const GlobalPosition & Dumux::StaggeredSubControlVolumeFace< GV, T >::ipGlobal ( ) const

inline

The integration point for flux evaluations in global coordinates.

◆ localFaceIdx()

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

LocalIndexType Dumux::StaggeredSubControlVolumeFace< GV, T >::localFaceIdx ( ) const

inline

The local index of this sub control volume face.

◆ outsideScvIdx() [1/2]

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

GridIndexType Dumux::StaggeredSubControlVolumeFace< GV, T >::outsideScvIdx ( ) const

inline

Index of the outside sub control volume.

◆ outsideScvIdx() [2/2]

GridIndexType Dumux::SubControlVolumeFaceBase< StaggeredSubControlVolumeFace< GV, StaggeredDefaultScvfGeometryTraits< GV > > , StaggeredDefaultScvfGeometryTraits< GV > >::outsideScvIdx ( int i = 0 ) const

inlineinherited

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 GV , class T = StaggeredDefaultScvfGeometryTraits<GV>>

const GlobalPosition & Dumux::StaggeredSubControlVolumeFace< GV, T >::unitOuterNormal ( ) const

inline

The unit outer normal vector.

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

discretization/staggered/subcontrolvolumeface.hh

Description

Public Types

Public Member Functions

Member Typedef Documentation

◆ GlobalPosition

◆ Traits

Constructor & Destructor Documentation

◆ StaggeredSubControlVolumeFace() [1/2]

◆ StaggeredSubControlVolumeFace() [2/2]

Member Function Documentation

◆ area()

◆ boundary()

◆ center()

◆ corner()

◆ dofIndex()

◆ dofPosition()

◆ geometry()

◆ index()

◆ insideScvIdx()

◆ ipGlobal()

◆ localFaceIdx()

◆ outsideScvIdx() [1/2]

◆ outsideScvIdx() [2/2]

◆ unitOuterNormal()