Dumux::FaceCenteredDiamondFVElementGeometry< GG, true > Class Template Reference

Element-wise grid geometry (local view). More...

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

Inheritance diagram for Dumux::FaceCenteredDiamondFVElementGeometry< GG, true >:

Description

template<class GG>
class Dumux::FaceCenteredDiamondFVElementGeometry< GG, true >

Element-wise grid geometry (local view).

Public Types
using	SubControlVolume = typename GG::SubControlVolume
	export type of subcontrol volume face
using	SubControlVolumeFace = typename GG::SubControlVolumeFace
using	Element = typename GridView::template Codim<0>::Entity
using	GridGeometry = GG

Public Member Functions
	FaceCenteredDiamondFVElementGeometry (const GGCache &ggCache)
const SubControlVolume &	scv (LocalIndexType scvIdx) const
	Get a sub control volume with a local scv index.
const SubControlVolumeFace &	scvf (LocalIndexType scvfIdx) const
	Get a sub control volume face with a local scvf index.
const FeLocalBasis &	feLocalBasis () const
	Get a local finite element basis.
std::size_t	numScv () const
	number of sub control volumes in this fv element geometry
std::size_t	numScvf () const
	number of sub control volumes in this fv element geometry
bool	hasBoundaryScvf () const
	Returns whether one of the geometry's scvfs lies on a boundary.
FaceCenteredDiamondFVElementGeometry	bind (const Element &element) &&
	bind the local view (r-value overload) This overload is called when an instance of this class is a temporary in the usage context This allows a usage like this: const auto view = localView(...).bind(element);
void	bind (const Element &element) &
FaceCenteredDiamondFVElementGeometry	bindElement (const Element &element) &&
	bind the local view (r-value overload) This overload is called when an instance of this class is a temporary in the usage context This allows a usage like this: const auto view = localView(...).bindElement(element);
void	bindElement (const Element &element) &
	Bind only element-local.
bool	isBound () const
	Returns true if bind/bindElement has already been called.
const Element &	element () const
	The bound element.
const GridGeometry &	gridGeometry () const
	The grid geometry we are a restriction of.
std::size_t	elementIndex () const
	The bound element index.
SubControlVolume::Traits::Geometry	geometry (const SubControlVolume &scv) const
	Geometry of a sub control volume.
SubControlVolumeFace::Traits::Geometry	geometry (const SubControlVolumeFace &scvf) const
	Geometry of a sub control volume face.

Static Public Attributes
static constexpr std::size_t	maxNumElementScvs = 2*GridView::dimension
	the maximum number of scvs per element

Member Typedef Documentation

Element

template<class GG>

using Dumux::FaceCenteredDiamondFVElementGeometry< GG, true >::Element = typename GridView::template Codim<0>::Entity

GridGeometry

template<class GG>

using Dumux::FaceCenteredDiamondFVElementGeometry< GG, true >::GridGeometry = GG

SubControlVolume

template<class GG>

using Dumux::FaceCenteredDiamondFVElementGeometry< GG, true >::SubControlVolume = typename GG::SubControlVolume

export type of subcontrol volume face

SubControlVolumeFace

template<class GG>

using Dumux::FaceCenteredDiamondFVElementGeometry< GG, true >::SubControlVolumeFace = typename GG::SubControlVolumeFace

Constructor & Destructor Documentation

FaceCenteredDiamondFVElementGeometry()

template<class GG>

Dumux::FaceCenteredDiamondFVElementGeometry< GG, true >::FaceCenteredDiamondFVElementGeometry ( const GGCache & ggCache )

inline

Member Function Documentation

bind() [1/2]

template<class GG>

void Dumux::FaceCenteredDiamondFVElementGeometry< GG, true >::bind ( const Element & element ) &

inline

bind() [2/2]

template<class GG>

FaceCenteredDiamondFVElementGeometry Dumux::FaceCenteredDiamondFVElementGeometry< GG, true >::bind ( const Element & element ) &&

inline

bind the local view (r-value overload) This overload is called when an instance of this class is a temporary in the usage context This allows a usage like this: const auto view = localView(...).bind(element);

bindElement() [1/2]

template<class GG>

void Dumux::FaceCenteredDiamondFVElementGeometry< GG, true >::bindElement ( const Element & element ) &

inline

Bind only element-local.

bindElement() [2/2]

template<class GG>

FaceCenteredDiamondFVElementGeometry Dumux::FaceCenteredDiamondFVElementGeometry< GG, true >::bindElement ( const Element & element ) &&

inline

bind the local view (r-value overload) This overload is called when an instance of this class is a temporary in the usage context This allows a usage like this: const auto view = localView(...).bindElement(element);

element()

template<class GG>

const Element & Dumux::FaceCenteredDiamondFVElementGeometry< GG, true >::element ( ) const

inline

The bound element.

elementIndex()

template<class GG>

std::size_t Dumux::FaceCenteredDiamondFVElementGeometry< GG, true >::elementIndex ( ) const

inline

The bound element index.

feLocalBasis()

template<class GG>

const FeLocalBasis & Dumux::FaceCenteredDiamondFVElementGeometry< GG, true >::feLocalBasis ( ) const

inline

Get a local finite element basis.

geometry() [1/2]

template<class GG>

SubControlVolume::Traits::Geometry Dumux::FaceCenteredDiamondFVElementGeometry< GG, true >::geometry ( const SubControlVolume & scv ) const

inline

Geometry of a sub control volume.

geometry() [2/2]

template<class GG>

SubControlVolumeFace::Traits::Geometry Dumux::FaceCenteredDiamondFVElementGeometry< GG, true >::geometry ( const SubControlVolumeFace & scvf ) const

inline

Geometry of a sub control volume face.

gridGeometry()

template<class GG>

const GridGeometry & Dumux::FaceCenteredDiamondFVElementGeometry< GG, true >::gridGeometry ( ) const

inline

The grid geometry we are a restriction of.

hasBoundaryScvf()

template<class GG>

bool Dumux::FaceCenteredDiamondFVElementGeometry< GG, true >::hasBoundaryScvf ( ) const

inline

Returns whether one of the geometry's scvfs lies on a boundary.

isBound()

template<class GG>

bool Dumux::FaceCenteredDiamondFVElementGeometry< GG, true >::isBound ( ) const

inline

Returns true if bind/bindElement has already been called.

numScv()

template<class GG>

std::size_t Dumux::FaceCenteredDiamondFVElementGeometry< GG, true >::numScv ( ) const

inline

number of sub control volumes in this fv element geometry

numScvf()

template<class GG>

std::size_t Dumux::FaceCenteredDiamondFVElementGeometry< GG, true >::numScvf ( ) const

inline

number of sub control volumes in this fv element geometry

scv()

template<class GG>

const SubControlVolume & Dumux::FaceCenteredDiamondFVElementGeometry< GG, true >::scv ( LocalIndexType scvIdx ) const

inline

Get a sub control volume with a local scv index.

scvf()

template<class GG>

const SubControlVolumeFace & Dumux::FaceCenteredDiamondFVElementGeometry< GG, true >::scvf ( LocalIndexType scvfIdx ) const

inline

Get a sub control volume face with a local scvf index.

Member Data Documentation

maxNumElementScvs

template<class GG>

std::size_t Dumux::FaceCenteredDiamondFVElementGeometry< GG, true >::maxNumElementScvs = 2*GridView::dimension

staticconstexpr

the maximum number of scvs per element

---

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

• discretization/facecentered/diamond/fvelementgeometry.hh