3.5-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::BoxDfmFVElementGeometry< GG, false > Class Template Reference

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

#include <dumux/porousmediumflow/boxdfm/fvelementgeometry.hh>

Description

template<class GG>
class Dumux::BoxDfmFVElementGeometry< GG, false >

Specialization in case the FVElementGeometries are not 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

 BoxDfmFVElementGeometry (const GridGeometry &gridGeometry)
 Constructor. More...
 
const SubControlVolumescv (std::size_t scvIdx) const
 Get a sub control volume with a local scv index. More...
 
const SubControlVolumeFacescvf (std::size_t 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...
 
BoxDfmFVElementGeometry 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) &
 Binding of an element, has to be called before using the fvgeometries Prepares all the volume variables within the element. More...
 
BoxDfmFVElementGeometry 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) &
 Binding of an element, has to be called before using the fvgeometries Prepares all the volume variables within the element. More...
 
const GridGeometrygridGeometry () 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 Elementelement () const
 The bound element. More...
 

Static Public Attributes

static constexpr std::size_t maxNumElementScvs = (1<<dim)*3
 

Member Typedef Documentation

◆ Element

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

export type of the element

◆ GridGeometry

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

Export type of finite volume grid geometry.

◆ SubControlVolume

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

Export type of subcontrol volume.

◆ SubControlVolumeFace

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

Export type of subcontrol volume face.

Constructor & Destructor Documentation

◆ BoxDfmFVElementGeometry()

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

Constructor.

Member Function Documentation

◆ bind() [1/2]

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

Binding of an element, has to be called before using the fvgeometries Prepares all the volume variables within the element.

Note
For the box scheme, bind() and bindElement() are identical, but the distinction is here for the sake of compatibility with cc schemes.

◆ bind() [2/2]

template<class GG >
BoxDfmFVElementGeometry Dumux::BoxDfmFVElementGeometry< 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::BoxDfmFVElementGeometry< 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.

◆ bindElement() [2/2]

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

The bound element.

◆ feLocalBasis()

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

Get a local finite element basis.

◆ gridGeometry()

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

The global finite volume geometry we are a restriction of.

◆ isBound()

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

Returns true if bind/bindElement has already been called.

◆ numScv()

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

The total number of sub control volumes.

◆ numScvf()

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

The total number of sub control volume faces.

◆ scv()

template<class GG >
const SubControlVolume & Dumux::BoxDfmFVElementGeometry< GG, false >::scv ( std::size_t  scvIdx) const
inline

Get a sub control volume with a local scv index.

◆ scvf()

template<class GG >
const SubControlVolumeFace & Dumux::BoxDfmFVElementGeometry< GG, false >::scvf ( std::size_t  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::BoxDfmFVElementGeometry< GG, false >::maxNumElementScvs = (1<<dim)*3
staticconstexpr

The maximum number of scvs per element (2^dim for cubes) multiplied by 3 for the maximum number of fracture scvs per vertex


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