3.6-git
DUNE for Multi-{Phase, Component, Scale, Physics, ...} flow and transport in porous media
Public Types | Public Member Functions | Static Public Attributes | List of all members
Dumux::PoreNetwork::PNMFVElementGeometry< GG, false > Class Template Reference

specialization in case the FVElementGeometries are not stored More...

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

Description

template<class GG>
class Dumux::PoreNetwork::PNMFVElementGeometry< GG, false >

specialization in case the FVElementGeometries are not stored

Public Types

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...
 
using Element = typename GridView::template Codim< 0 >::Entity
 export element type More...
 

Public Member Functions

 PNMFVElementGeometry (const GridGeometry &gridGeometry)
 Constructor. More...
 
const SubControlVolumescv (LocalIndexType scvIdx) const
 Get a sub control volume with a local scv index. More...
 
const SubControlVolumeFacescvf (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...
 
PNMFVElementGeometry 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) &
 
PNMFVElementGeometry 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) &
 
bool isBound () const
 Returns true if bind/bindElement has already been called. More...
 
const Elementelement () const
 The bound element. More...
 
const GridGeometrygridGeometry () const
 The global finite volume geometry we are a restriction of. More...
 
bool hasBoundaryScvf () const
 Returns whether one of the geometry's scvfs lies on a boundary. More...
 

Static Public Attributes

static constexpr std::size_t maxNumElementScvs = 2
 the maximum number of scvs per element More...
 

Member Typedef Documentation

◆ Element

template<class GG >
using Dumux::PoreNetwork::PNMFVElementGeometry< GG, false >::Element = typename GridView::template Codim<0>::Entity

export element type

◆ GridGeometry

template<class GG >
using Dumux::PoreNetwork::PNMFVElementGeometry< GG, false >::GridGeometry = GG

export type of finite volume grid geometry

◆ SubControlVolume

template<class GG >
using Dumux::PoreNetwork::PNMFVElementGeometry< GG, false >::SubControlVolume = typename GG::SubControlVolume

export type of subcontrol volume

◆ SubControlVolumeFace

template<class GG >
using Dumux::PoreNetwork::PNMFVElementGeometry< GG, false >::SubControlVolumeFace = typename GG::SubControlVolumeFace

export type of subcontrol volume face

Constructor & Destructor Documentation

◆ PNMFVElementGeometry()

template<class GG >
Dumux::PoreNetwork::PNMFVElementGeometry< GG, false >::PNMFVElementGeometry ( const GridGeometry gridGeometry)
inline

Constructor.

Member Function Documentation

◆ bind() [1/2]

template<class GG >
void Dumux::PoreNetwork::PNMFVElementGeometry< GG, false >::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 >
PNMFVElementGeometry Dumux::PoreNetwork::PNMFVElementGeometry< GG, false >::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::PoreNetwork::PNMFVElementGeometry< GG, false >::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 >
PNMFVElementGeometry Dumux::PoreNetwork::PNMFVElementGeometry< GG, false >::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::PoreNetwork::PNMFVElementGeometry< GG, false >::element ( ) const
inline

The bound element.

◆ feLocalBasis()

template<class GG >
const FeLocalBasis & Dumux::PoreNetwork::PNMFVElementGeometry< GG, false >::feLocalBasis ( ) const
inline

Get a local finite element basis.

◆ gridGeometry()

template<class GG >
const GridGeometry & Dumux::PoreNetwork::PNMFVElementGeometry< GG, false >::gridGeometry ( ) const
inline

The global finite volume geometry we are a restriction of.

◆ hasBoundaryScvf()

template<class GG >
bool Dumux::PoreNetwork::PNMFVElementGeometry< GG, false >::hasBoundaryScvf ( ) const
inline

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

◆ isBound()

template<class GG >
bool Dumux::PoreNetwork::PNMFVElementGeometry< GG, false >::isBound ( ) const
inline

Returns true if bind/bindElement has already been called.

◆ numScv()

template<class GG >
std::size_t Dumux::PoreNetwork::PNMFVElementGeometry< GG, false >::numScv ( ) const
inline

The total number of sub control volumes.

◆ numScvf()

template<class GG >
std::size_t Dumux::PoreNetwork::PNMFVElementGeometry< GG, false >::numScvf ( ) const
inline

The total number of sub control volume faces.

◆ scv()

template<class GG >
const SubControlVolume & Dumux::PoreNetwork::PNMFVElementGeometry< GG, false >::scv ( LocalIndexType  scvIdx) const
inline

Get a sub control volume with a local scv index.

◆ scvf()

template<class GG >
const SubControlVolumeFace & Dumux::PoreNetwork::PNMFVElementGeometry< GG, false >::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::PoreNetwork::PNMFVElementGeometry< GG, false >::maxNumElementScvs = 2
staticconstexpr

the maximum number of scvs per element


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