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, true > Class Template Reference

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

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

Description

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

 BoxDfmFVElementGeometry (const GridGeometry &gridGeometry)
 Constructor. More...
 
const SubControlVolume & scv (std::size_t scvIdx) const
 Get a sub control volume with a local scv index. More...
 
const SubControlVolumeFace & scvf (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) &
 
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. More...
 
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)*3
 

Member Typedef Documentation

◆ Element

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

export type of the element

◆ GridGeometry

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

Export type of finite volume grid geometry.

◆ SubControlVolume

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

Export type of subcontrol volume.

◆ SubControlVolumeFace

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

Export type of subcontrol volume face.

Constructor & Destructor Documentation

◆ BoxDfmFVElementGeometry()

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

Constructor.

Member Function Documentation

◆ bind() [1/2]

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

The bound element.

◆ feLocalBasis()

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

Get a local finite element basis.

◆ gridGeometry()

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

The global finite volume geometry we are a restriction of.

◆ isBound()

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

Returns true if bind/bindElement has already been called.

◆ numScv()

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

The total number of sub control volumes.

◆ numScvf()

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

The total number of sub control volume faces.

◆ scv()

template<class GG >
const SubControlVolume & Dumux::BoxDfmFVElementGeometry< GG, true >::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, true >::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, true >::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:
Generated by doxygen 1.9.3