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

specialization in case the FVElementGeometries are stored More...

#include <dumux/multidomain/facet/box/fvelementgeometry.hh>

Description

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

specialization in case the FVElementGeometries are stored

Public Types
using	Element = typename GridView::template Codim< 0 >::Entity
	export type of the element More...
using	SubControlVolume = typename GG::SubControlVolume
	export type of subcontrol volume More...
using	SubControlVolumeFace = typename GG::SubControlVolumeFace
	export type of subcontrol volume face More...
using	GridGeometry = GG
	export type of finite volume grid geometry More...

Public Member Functions
	BoxFacetCouplingFVElementGeometry (const GridGeometry &gridGeometry)
	Constructor. More...
const SubControlVolume &	scv (LocalIndexType scvIdx) const
	Get a sub control volume with a local scv index. More...
const SubControlVolumeFace &	scvf (LocalIndexType scvfIdx) const
	Get a sub control volume face with a local scvf index. More...
const FeLocalBasis &	feLocalBasis () const
	Get a local finite element basis. More...
std::size_t	numScv () const
	The total number of sub control volumes. More...
std::size_t	numScvf () const
	The total number of sub control volume faces. More...
BoxFacetCouplingFVElementGeometry	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); More...
void	bind (const Element &element) &
BoxFacetCouplingFVElementGeometry	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); More...
void	bindElement (const Element &element) &
const GridGeometry &	gridGeometry () const
	The global finite volume geometry we are a restriction of. More...
bool	isBound () const
	Returns true if bind/bindElement has already been called. More...
const Element &	element () const
	The bound element. More...

Static Public Attributes
static constexpr std::size_t	maxNumElementScvs = (1<<dim)
	the maximum number of scvs per element (2^dim for cubes) More...

Member Typedef Documentation

Element

template<class GG >

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

export type of the element

GridGeometry

template<class GG >

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

export type of finite volume grid geometry

SubControlVolume

template<class GG >

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

export type of subcontrol volume

SubControlVolumeFace

template<class GG >

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

export type of subcontrol volume face

Constructor & Destructor Documentation

BoxFacetCouplingFVElementGeometry()

template<class GG >

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

inline

Constructor.

Member Function Documentation

bind() [1/2]

template<class GG >

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

inline

this function is for compatibility reasons with cc methods The box stencil is always element-local so bind and bindElement are identical.

bind() [2/2]

template<class GG >

BoxFacetCouplingFVElementGeometry Dumux::BoxFacetCouplingFVElementGeometry< 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::BoxFacetCouplingFVElementGeometry< GG, true >::bindElement ( const Element &  element ) &

inline

Binding of an element, has to be called before using the fvgeometries Prepares all the volume variables within the element For compatibility reasons with the FVGeometry cache being disabled

bindElement() [2/2]

template<class GG >

BoxFacetCouplingFVElementGeometry Dumux::BoxFacetCouplingFVElementGeometry< 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::BoxFacetCouplingFVElementGeometry< GG, true >::element ( ) const

inline

The bound element.

feLocalBasis()

template<class GG >

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

inline

Get a local finite element basis.

gridGeometry()

template<class GG >

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

inline

The global finite volume geometry we are a restriction of.

isBound()

template<class GG >

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

inline

Returns true if bind/bindElement has already been called.

numScv()

template<class GG >

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

inline

The total number of sub control volumes.

numScvf()

template<class GG >

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

inline

The total number of sub control volume faces.

scv()

template<class GG >

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

inline

Get a sub control volume with a local scv index.

scvf()

template<class GG >

const SubControlVolumeFace & Dumux::BoxFacetCouplingFVElementGeometry< 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 >

constexpr std::size_t Dumux::BoxFacetCouplingFVElementGeometry< GG, true >::maxNumElementScvs = (1<<dim)

staticconstexpr

the maximum number of scvs per element (2^dim for cubes)

---

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

• multidomain/facet/box/fvelementgeometry.hh