DuMuX: Dumux::FaceCenteredDiamondSubControlVolumeFace< GridView, T > Class Template Reference

Loading [MathJax]/extensions/tex2jax.js

The SCVF implementation for diamond. More...

#include <dumux/discretization/facecentered/diamond/subcontrolvolumeface.hh>

Description

template<class GridView, class T = FaceCenteredDiamondScvfGeometryTraits<GridView>>
class Dumux::FaceCenteredDiamondSubControlVolumeFace< GridView, T >

The SCVF implementation for diamond.

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

using	GlobalPosition = typename T::GlobalPosition

Public Member Functions
	FaceCenteredDiamondSubControlVolumeFace ()=default

	FaceCenteredDiamondSubControlVolumeFace (const GlobalPosition &center, const Scalar area, const GlobalPosition &normal, const std::array< LocalIndexType, 2 > &scvIndices, const LocalIndexType localScvfIdx)

	FaceCenteredDiamondSubControlVolumeFace (const GlobalPosition &center, const Scalar area, const GlobalPosition &normal, const std::array< LocalIndexType, 2 > &scvIndices, const LocalIndexType localScvfIdx, const BoundaryFlag &bFlag)

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

const GlobalPosition &	ipGlobal () const
	The integration point of the sub control volume face. More...

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

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

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

std::size_t	numOutsideScvs () const

GridIndexType	index () const

bool	boundary () const

Scalar	area () const

BoundaryFlag::value_type	boundaryFlag () const
	Return the boundary flag. More...

Member Typedef Documentation

◆ GlobalPosition

template<class GridView , class T = FaceCenteredDiamondScvfGeometryTraits<GridView>>

using Dumux::FaceCenteredDiamondSubControlVolumeFace< GridView, T >::GlobalPosition = typename T::GlobalPosition

◆ Traits

template<class GridView , class T = FaceCenteredDiamondScvfGeometryTraits<GridView>>

using Dumux::FaceCenteredDiamondSubControlVolumeFace< GridView, T >::Traits = T

state the traits public and thus export all types

Constructor & Destructor Documentation

◆ FaceCenteredDiamondSubControlVolumeFace() [1/3]

template<class GridView , class T = FaceCenteredDiamondScvfGeometryTraits<GridView>>

Dumux::FaceCenteredDiamondSubControlVolumeFace< GridView, T >::FaceCenteredDiamondSubControlVolumeFace ( )

default

◆ FaceCenteredDiamondSubControlVolumeFace() [2/3]

template<class GridView , class T = FaceCenteredDiamondScvfGeometryTraits<GridView>>

Dumux::FaceCenteredDiamondSubControlVolumeFace< GridView, T >::FaceCenteredDiamondSubControlVolumeFace	(	const GlobalPosition &	center,
		const Scalar	area,
		const GlobalPosition &	normal,
		const std::array< LocalIndexType, 2 > &	scvIndices,
		const LocalIndexType	localScvfIdx
	)

inline

◆ FaceCenteredDiamondSubControlVolumeFace() [3/3]

template<class GridView , class T = FaceCenteredDiamondScvfGeometryTraits<GridView>>

Dumux::FaceCenteredDiamondSubControlVolumeFace< GridView, T >::FaceCenteredDiamondSubControlVolumeFace	(	const GlobalPosition &	center,
		const Scalar	area,
		const GlobalPosition &	normal,
		const std::array< LocalIndexType, 2 > &	scvIndices,
		const LocalIndexType	localScvfIdx,
		const BoundaryFlag &	bFlag
	)

inline

Member Function Documentation

◆ area()

template<class GridView , class T = FaceCenteredDiamondScvfGeometryTraits<GridView>>

Scalar Dumux::FaceCenteredDiamondSubControlVolumeFace< GridView, T >::area ( ) const

inline

◆ boundary()

template<class GridView , class T = FaceCenteredDiamondScvfGeometryTraits<GridView>>

bool Dumux::FaceCenteredDiamondSubControlVolumeFace< GridView, T >::boundary ( ) const

inline

◆ boundaryFlag()

template<class GridView , class T = FaceCenteredDiamondScvfGeometryTraits<GridView>>

BoundaryFlag::value_type Dumux::FaceCenteredDiamondSubControlVolumeFace< GridView, T >::boundaryFlag ( ) const

inline

Return the boundary flag.

◆ center()

template<class GridView , class T = FaceCenteredDiamondScvfGeometryTraits<GridView>>

const GlobalPosition & Dumux::FaceCenteredDiamondSubControlVolumeFace< GridView, T >::center ( ) const

inline

The center of the sub control volume face.

◆ index()

template<class GridView , class T = FaceCenteredDiamondScvfGeometryTraits<GridView>>

GridIndexType Dumux::FaceCenteredDiamondSubControlVolumeFace< GridView, T >::index ( ) const

inline

◆ insideScvIdx()

template<class GridView , class T = FaceCenteredDiamondScvfGeometryTraits<GridView>>

GridIndexType Dumux::FaceCenteredDiamondSubControlVolumeFace< GridView, T >::insideScvIdx ( ) const

inline

Index of the inside sub control volume.

◆ ipGlobal()

template<class GridView , class T = FaceCenteredDiamondScvfGeometryTraits<GridView>>

const GlobalPosition & Dumux::FaceCenteredDiamondSubControlVolumeFace< GridView, T >::ipGlobal ( ) const

inline

The integration point of the sub control volume face.

◆ numOutsideScvs()

template<class GridView , class T = FaceCenteredDiamondScvfGeometryTraits<GridView>>

std::size_t Dumux::FaceCenteredDiamondSubControlVolumeFace< GridView, T >::numOutsideScvs ( ) const

inline

◆ outsideScvIdx()

template<class GridView , class T = FaceCenteredDiamondScvfGeometryTraits<GridView>>

GridIndexType Dumux::FaceCenteredDiamondSubControlVolumeFace< GridView, T >::outsideScvIdx ( ) const

inline

index of the outside sub control volume

◆ unitOuterNormal()

template<class GridView , class T = FaceCenteredDiamondScvfGeometryTraits<GridView>>

const GlobalPosition Dumux::FaceCenteredDiamondSubControlVolumeFace< GridView, T >::unitOuterNormal ( ) const

inline

The unit outer normal.

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

discretization/facecentered/diamond/subcontrolvolumeface.hh