The flux variables caches for an element with caching enabled. More...

#include <dumux/discretization/cellcentered/mpfa/elementfluxvariablescache.hh>

Description

template<class GFVC>
class Dumux::CCMpfaElementFluxVariablesCache< GFVC, true >

The flux variables caches for an element with caching enabled.

Public Types
using	PrimaryInteractionVolume = typename GFVC::PrimaryInteractionVolume
	export the interaction volume types More...

using	SecondaryInteractionVolume = typename GFVC::SecondaryInteractionVolume

using	PrimaryIvDataHandle = typename GFVC::PrimaryIvDataHandle
	export the data handle types used More...

using	SecondaryIvDataHandle = typename GFVC::SecondaryIvDataHandle

using	FluxVariablesCache = typename GFVC::FluxVariablesCache
	export the flux variable cache type More...

using	GridFluxVariablesCache = GFVC
	export the type of the grid flux variables More...

Public Member Functions
	CCMpfaElementFluxVariablesCache (const GridFluxVariablesCache &global)
	The constructor. More...

template<class FVElementGeometry , class ElementVolumeVariables >
CCMpfaElementFluxVariablesCache	bindElement (const typename FVElementGeometry::GridGeometry::GridView::template Codim< 0 >::Entity &element, const FVElementGeometry &fvGeometry, const ElementVolumeVariables &elemVolVars) &&
	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...

template<class FVElementGeometry , class ElementVolumeVariables >
void	bindElement (const typename FVElementGeometry::GridGeometry::GridView::template Codim< 0 >::Entity &element, const FVElementGeometry &fvGeometry, const ElementVolumeVariables &elemVolVars) &
	Specialization for the global caching being enabled - do nothing here. More...

template<class FVElementGeometry , class ElementVolumeVariables >
CCMpfaElementFluxVariablesCache	bind (const typename FVElementGeometry::GridGeometry::GridView::template Codim< 0 >::Entity &element, const FVElementGeometry &fvGeometry, const ElementVolumeVariables &elemVolVars) &&
	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...

template<class FVElementGeometry , class ElementVolumeVariables >
void	bind (const typename FVElementGeometry::GridGeometry::GridView::template Codim< 0 >::Entity &element, const FVElementGeometry &fvGeometry, const ElementVolumeVariables &elemVolVars) &
	Specialization for the global caching being enabled - do nothing here. More...

template<class FVElementGeometry , class ElementVolumeVariables >
CCMpfaElementFluxVariablesCache	bindScvf (const typename FVElementGeometry::GridGeometry::GridView::template Codim< 0 >::Entity &element, const FVElementGeometry &fvGeometry, const ElementVolumeVariables &elemVolVars, const typename FVElementGeometry::SubControlVolumeFace &scvf) &&
	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...

template<class FVElementGeometry , class ElementVolumeVariables >
void	bindScvf (const typename FVElementGeometry::GridGeometry::GridView::template Codim< 0 >::Entity &element, const FVElementGeometry &fvGeometry, const ElementVolumeVariables &elemVolVars, const typename FVElementGeometry::SubControlVolumeFace &scvf) &
	Specialization for the global caching being enabled - do nothing here. More...

template<class FVElementGeometry , class ElementVolumeVariables >
void	update (const typename FVElementGeometry::GridGeometry::GridView::template Codim< 0 >::Entity &element, const FVElementGeometry &fvGeometry, const ElementVolumeVariables &elemVolVars)
	Specialization for the global caching being enabled - do nothing here. More...

template<class SubControlVolumeFace >
const FluxVariablesCache &	operator[] (const SubControlVolumeFace &scvf) const
	access operators in the case of caching More...

template<class SubControlVolumeFace >
const PrimaryInteractionVolume &	primaryInteractionVolume (const SubControlVolumeFace &scvf) const
	access to the interaction volume an scvf is embedded in More...

template<class SubControlVolumeFace >
const PrimaryIvDataHandle &	primaryDataHandle (const SubControlVolumeFace &scvf) const
	access to the data handle of an interaction volume an scvf is embedded in More...

template<class SubControlVolumeFace >
const SecondaryInteractionVolume &	secondaryInteractionVolume (const SubControlVolumeFace &scvf) const
	access to the interaction volume an scvf is embedded in More...

template<class SubControlVolumeFace >
const SecondaryIvDataHandle &	secondaryDataHandle (const SubControlVolumeFace &scvf) const
	access to the data handle of an interaction volume an scvf is embedded in More...

const GridFluxVariablesCache &	gridFluxVarsCache () const
	The global object we are a restriction of. More...

Static Public Attributes
static constexpr bool	cachingEnabled = true
	make it possible to query if caching is enabled More...

Member Typedef Documentation

◆ FluxVariablesCache

template<class GFVC >

using Dumux::CCMpfaElementFluxVariablesCache< GFVC, true >::FluxVariablesCache = typename GFVC::FluxVariablesCache

export the flux variable cache type

◆ GridFluxVariablesCache

template<class GFVC >

using Dumux::CCMpfaElementFluxVariablesCache< GFVC, true >::GridFluxVariablesCache = GFVC

export the type of the grid flux variables

◆ PrimaryInteractionVolume

template<class GFVC >

using Dumux::CCMpfaElementFluxVariablesCache< GFVC, true >::PrimaryInteractionVolume = typename GFVC::PrimaryInteractionVolume

export the interaction volume types

◆ PrimaryIvDataHandle

template<class GFVC >

using Dumux::CCMpfaElementFluxVariablesCache< GFVC, true >::PrimaryIvDataHandle = typename GFVC::PrimaryIvDataHandle

export the data handle types used

◆ SecondaryInteractionVolume

template<class GFVC >

using Dumux::CCMpfaElementFluxVariablesCache< GFVC, true >::SecondaryInteractionVolume = typename GFVC::SecondaryInteractionVolume

◆ SecondaryIvDataHandle

template<class GFVC >

using Dumux::CCMpfaElementFluxVariablesCache< GFVC, true >::SecondaryIvDataHandle = typename GFVC::SecondaryIvDataHandle

Constructor & Destructor Documentation

◆ CCMpfaElementFluxVariablesCache()

template<class GFVC >

Dumux::CCMpfaElementFluxVariablesCache< GFVC, true >::CCMpfaElementFluxVariablesCache ( const GridFluxVariablesCache & global )

inline

The constructor.

Member Function Documentation

◆ bind() [1/2]

template<class GFVC >

template<class FVElementGeometry , class ElementVolumeVariables >

void Dumux::CCMpfaElementFluxVariablesCache< GFVC, true >::bind	(	const typename FVElementGeometry::GridGeometry::GridView::template Codim< 0 >::Entity &	element,
		const FVElementGeometry &	fvGeometry,
		const ElementVolumeVariables &	elemVolVars
	)		&

inline

Specialization for the global caching being enabled - do nothing here.

◆ bind() [2/2]

template<class GFVC >

template<class FVElementGeometry , class ElementVolumeVariables >

CCMpfaElementFluxVariablesCache Dumux::CCMpfaElementFluxVariablesCache< GFVC, true >::bind	(	const typename FVElementGeometry::GridGeometry::GridView::template Codim< 0 >::Entity &	element,
		const FVElementGeometry &	fvGeometry,
		const ElementVolumeVariables &	elemVolVars
	)		&&

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 GFVC >

template<class FVElementGeometry , class ElementVolumeVariables >

void Dumux::CCMpfaElementFluxVariablesCache< GFVC, true >::bindElement	(	const typename FVElementGeometry::GridGeometry::GridView::template Codim< 0 >::Entity &	element,
		const FVElementGeometry &	fvGeometry,
		const ElementVolumeVariables &	elemVolVars
	)		&

inline

Specialization for the global caching being enabled - do nothing here.

◆ bindElement() [2/2]

template<class GFVC >

template<class FVElementGeometry , class ElementVolumeVariables >

CCMpfaElementFluxVariablesCache Dumux::CCMpfaElementFluxVariablesCache< GFVC, true >::bindElement	(	const typename FVElementGeometry::GridGeometry::GridView::template Codim< 0 >::Entity &	element,
		const FVElementGeometry &	fvGeometry,
		const ElementVolumeVariables &	elemVolVars
	)		&&

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);

◆ bindScvf() [1/2]

template<class GFVC >

template<class FVElementGeometry , class ElementVolumeVariables >

void Dumux::CCMpfaElementFluxVariablesCache< GFVC, true >::bindScvf	(	const typename FVElementGeometry::GridGeometry::GridView::template Codim< 0 >::Entity &	element,
		const FVElementGeometry &	fvGeometry,
		const ElementVolumeVariables &	elemVolVars,
		const typename FVElementGeometry::SubControlVolumeFace &	scvf
	)		&

inline

Specialization for the global caching being enabled - do nothing here.

◆ bindScvf() [2/2]

template<class GFVC >

template<class FVElementGeometry , class ElementVolumeVariables >

CCMpfaElementFluxVariablesCache Dumux::CCMpfaElementFluxVariablesCache< GFVC, true >::bindScvf	(	const typename FVElementGeometry::GridGeometry::GridView::template Codim< 0 >::Entity &	element,
		const FVElementGeometry &	fvGeometry,
		const ElementVolumeVariables &	elemVolVars,
		const typename FVElementGeometry::SubControlVolumeFace &	scvf
	)		&&

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);

◆ gridFluxVarsCache()

template<class GFVC >

const GridFluxVariablesCache & Dumux::CCMpfaElementFluxVariablesCache< GFVC, true >::gridFluxVarsCache ( ) const

inline

The global object we are a restriction of.

◆ operator[]()

template<class GFVC >

template<class SubControlVolumeFace >

const FluxVariablesCache & Dumux::CCMpfaElementFluxVariablesCache< GFVC, true >::operator[] ( const SubControlVolumeFace & scvf ) const

inline

access operators in the case of caching

◆ primaryDataHandle()

template<class GFVC >

template<class SubControlVolumeFace >

const PrimaryIvDataHandle & Dumux::CCMpfaElementFluxVariablesCache< GFVC, true >::primaryDataHandle ( const SubControlVolumeFace & scvf ) const

inline

access to the data handle of an interaction volume an scvf is embedded in

◆ primaryInteractionVolume()

template<class GFVC >

template<class SubControlVolumeFace >

const PrimaryInteractionVolume & Dumux::CCMpfaElementFluxVariablesCache< GFVC, true >::primaryInteractionVolume ( const SubControlVolumeFace & scvf ) const

inline

access to the interaction volume an scvf is embedded in

◆ secondaryDataHandle()

template<class GFVC >

template<class SubControlVolumeFace >

const SecondaryIvDataHandle & Dumux::CCMpfaElementFluxVariablesCache< GFVC, true >::secondaryDataHandle ( const SubControlVolumeFace & scvf ) const

inline

access to the data handle of an interaction volume an scvf is embedded in

◆ secondaryInteractionVolume()

template<class GFVC >

template<class SubControlVolumeFace >

const SecondaryInteractionVolume & Dumux::CCMpfaElementFluxVariablesCache< GFVC, true >::secondaryInteractionVolume ( const SubControlVolumeFace & scvf ) const

inline

access to the interaction volume an scvf is embedded in

◆ update()

template<class GFVC >

template<class FVElementGeometry , class ElementVolumeVariables >

void Dumux::CCMpfaElementFluxVariablesCache< GFVC, true >::update	(	const typename FVElementGeometry::GridGeometry::GridView::template Codim< 0 >::Entity &	element,
		const FVElementGeometry &	fvGeometry,
		const ElementVolumeVariables &	elemVolVars
	)

inline

Specialization for the global caching being enabled - do nothing here.

Member Data Documentation

◆ cachingEnabled

template<class GFVC >

constexpr bool Dumux::CCMpfaElementFluxVariablesCache< GFVC, true >::cachingEnabled = true

staticconstexpr

make it possible to query if caching is enabled

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

discretization/cellcentered/mpfa/elementfluxvariablescache.hh

Description

Public Types

Public Member Functions

Static Public Attributes

Member Typedef Documentation

◆ FluxVariablesCache

◆ GridFluxVariablesCache

◆ PrimaryInteractionVolume

◆ PrimaryIvDataHandle

◆ SecondaryInteractionVolume

◆ SecondaryIvDataHandle

Constructor & Destructor Documentation

◆ CCMpfaElementFluxVariablesCache()

Member Function Documentation

◆ bind() [1/2]

◆ bind() [2/2]

◆ bindElement() [1/2]

◆ bindElement() [2/2]

◆ bindScvf() [1/2]

◆ bindScvf() [2/2]

◆ gridFluxVarsCache()

◆ operator[]()

◆ primaryDataHandle()

◆ primaryInteractionVolume()

◆ secondaryDataHandle()

◆ secondaryInteractionVolume()

◆ update()

Member Data Documentation

◆ cachingEnabled