version 3.9.0
Loading...
Searching...
No Matches
Dumux::PQ1BubbleFVElementGeometry< GG, true > Class Template Reference

specialization in case the FVElementGeometries are stored

#include <dumux/discretization/pq1bubble/fvelementgeometry.hh>

Public Types

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

Public Member Functions

 PQ1BubbleFVElementGeometry (const GGCache &ggCache)
 Constructor.
 
const SubControlVolumescv (LocalIndexType scvIdx) const
 Get a sub control volume with a local scv index.
 
const SubControlVolumeFacescvf (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
 The total number of sub control volumes.
 
std::size_t numScvf () const
 The total number of sub control volume faces.
 
PQ1BubbleFVElementGeometry 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) &
 
PQ1BubbleFVElementGeometry 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) &
 
bool isBound () const
 Returns true if bind/bindElement has already been called.
 
const Elementelement () const
 The bound element.
 
const GridGeometrygridGeometry () const
 The grid geometry we are a restriction of.
 
bool hasBoundaryScvf () const
 Returns whether one of the geometry's scvfs lies on a boundary.
 
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 = (1<<dim) + 1
 the maximum number of scvs per element (2^dim for cubes)
 

Member Typedef Documentation

◆ Element

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

◆ GridGeometry

template<class GG >
using Dumux::PQ1BubbleFVElementGeometry< GG, true >::GridGeometry = GG

◆ SubControlVolume

template<class GG >
using Dumux::PQ1BubbleFVElementGeometry< GG, true >::SubControlVolume = typename GG::SubControlVolume

◆ SubControlVolumeFace

template<class GG >
using Dumux::PQ1BubbleFVElementGeometry< GG, true >::SubControlVolumeFace = typename GG::SubControlVolumeFace

Constructor & Destructor Documentation

◆ PQ1BubbleFVElementGeometry()

template<class GG >
Dumux::PQ1BubbleFVElementGeometry< GG, true >::PQ1BubbleFVElementGeometry ( const GGCache & ggCache)
inline

Member Function Documentation

◆ bind() [1/2]

template<class GG >
void Dumux::PQ1BubbleFVElementGeometry< GG, true >::bind ( const Element & element) &
inline

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

◆ bind() [2/2]

template<class GG >
PQ1BubbleFVElementGeometry Dumux::PQ1BubbleFVElementGeometry< GG, true >::bind ( const Element & element) &&
inline

◆ bindElement() [1/2]

template<class GG >
void Dumux::PQ1BubbleFVElementGeometry< 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 >
PQ1BubbleFVElementGeometry Dumux::PQ1BubbleFVElementGeometry< GG, true >::bindElement ( const Element & element) &&
inline

◆ element()

template<class GG >
const Element & Dumux::PQ1BubbleFVElementGeometry< GG, true >::element ( ) const
inline

◆ elementIndex()

template<class GG >
std::size_t Dumux::PQ1BubbleFVElementGeometry< GG, true >::elementIndex ( ) const
inline

◆ feLocalBasis()

template<class GG >
const FeLocalBasis & Dumux::PQ1BubbleFVElementGeometry< GG, true >::feLocalBasis ( ) const
inline

◆ geometry() [1/2]

template<class GG >
SubControlVolume::Traits::Geometry Dumux::PQ1BubbleFVElementGeometry< GG, true >::geometry ( const SubControlVolume & scv) const
inline

◆ geometry() [2/2]

template<class GG >
SubControlVolumeFace::Traits::Geometry Dumux::PQ1BubbleFVElementGeometry< GG, true >::geometry ( const SubControlVolumeFace & scvf) const
inline

◆ gridGeometry()

template<class GG >
const GridGeometry & Dumux::PQ1BubbleFVElementGeometry< GG, true >::gridGeometry ( ) const
inline

◆ hasBoundaryScvf()

template<class GG >
bool Dumux::PQ1BubbleFVElementGeometry< GG, true >::hasBoundaryScvf ( ) const
inline

◆ isBound()

template<class GG >
bool Dumux::PQ1BubbleFVElementGeometry< GG, true >::isBound ( ) const
inline

◆ numScv()

template<class GG >
std::size_t Dumux::PQ1BubbleFVElementGeometry< GG, true >::numScv ( ) const
inline

◆ numScvf()

template<class GG >
std::size_t Dumux::PQ1BubbleFVElementGeometry< GG, true >::numScvf ( ) const
inline

◆ scv()

template<class GG >
const SubControlVolume & Dumux::PQ1BubbleFVElementGeometry< GG, true >::scv ( LocalIndexType scvIdx) const
inline

◆ scvf()

template<class GG >
const SubControlVolumeFace & Dumux::PQ1BubbleFVElementGeometry< GG, true >::scvf ( LocalIndexType scvfIdx) const
inline

Member Data Documentation

◆ maxNumElementScvs

template<class GG >
std::size_t Dumux::PQ1BubbleFVElementGeometry< GG, true >::maxNumElementScvs = (1<<dim) + 1
staticconstexpr

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