version 3.8
Dumux::GridGeometryView< ActualGridGeometry > Class Template Reference

Base class for cell center of face specific auxiliary FvGridGeometry classes. Provides a common interface and a pointer to the actual gridGeometry.

#include <dumux/discretization/staggered/fvgridgeometry.hh>

Inheritance diagram for Dumux::GridGeometryView< ActualGridGeometry >:

Public Types

using GridView = typename ActualGridGeometry::GridView
 export the GridView type and the discretization method More...
 
using DiscretizationMethod = DiscretizationMethods::Staggered
 export the discretization method this geometry belongs to More...
 
using LocalView = typename ActualGridGeometry::LocalView
 

Public Member Functions

 GridGeometryView (const ActualGridGeometry *actualGridGeometry)
 
const auto & gridView () const
 Return the gridView this grid geometry object lives on. More...
 
const auto & connectivityMap () const
 Returns the connectivity map of which dofs have derivatives with respect to a given dof. More...
 
const auto & vertexMapper () const
 Returns the mapper for vertices to indices for possibly adaptive grids. More...
 
const auto & elementMapper () const
 Returns the mapper for elements to indices for constant grids. More...
 
const ActualGridGeometry & actualGridGeometry () const
 Returns the actual gridGeometry we are a restriction of. More...
 

Static Public Member Functions

static constexpr bool isCellCenter ()
 Returns true if this view if related to cell centered dofs. More...
 
static constexpr bool isFace ()
 Returns true if this view if related to face dofs. More...
 
static constexpr auto cellCenterIdx ()
 Return an integral constant index for cell centered dofs. More...
 
static constexpr auto faceIdx ()
 Return an integral constant index for face dofs. More...
 

Static Public Attributes

static constexpr DiscretizationMethod discMethod {}
 

Protected Attributes

const ActualGridGeometry * gridGeometry_
 

Member Typedef Documentation

◆ DiscretizationMethod

template<class ActualGridGeometry >
using Dumux::GridGeometryView< ActualGridGeometry >::DiscretizationMethod = DiscretizationMethods::Staggered

◆ GridView

template<class ActualGridGeometry >
using Dumux::GridGeometryView< ActualGridGeometry >::GridView = typename ActualGridGeometry::GridView

◆ LocalView

template<class ActualGridGeometry >
using Dumux::GridGeometryView< ActualGridGeometry >::LocalView = typename ActualGridGeometry::LocalView

Constructor & Destructor Documentation

◆ GridGeometryView()

template<class ActualGridGeometry >
Dumux::GridGeometryView< ActualGridGeometry >::GridGeometryView ( const ActualGridGeometry *  actualGridGeometry)
inlineexplicit

Member Function Documentation

◆ actualGridGeometry()

template<class ActualGridGeometry >
const ActualGridGeometry & Dumux::GridGeometryView< ActualGridGeometry >::actualGridGeometry ( ) const
inline

◆ cellCenterIdx()

template<class ActualGridGeometry >
static constexpr auto Dumux::GridGeometryView< ActualGridGeometry >::cellCenterIdx ( )
inlinestaticconstexpr

◆ connectivityMap()

template<class ActualGridGeometry >
const auto & Dumux::GridGeometryView< ActualGridGeometry >::connectivityMap ( ) const
inline

◆ elementMapper()

template<class ActualGridGeometry >
const auto & Dumux::GridGeometryView< ActualGridGeometry >::elementMapper ( ) const
inline

◆ faceIdx()

template<class ActualGridGeometry >
static constexpr auto Dumux::GridGeometryView< ActualGridGeometry >::faceIdx ( )
inlinestaticconstexpr

◆ gridView()

template<class ActualGridGeometry >
const auto & Dumux::GridGeometryView< ActualGridGeometry >::gridView ( ) const
inline

◆ isCellCenter()

template<class ActualGridGeometry >
static constexpr bool Dumux::GridGeometryView< ActualGridGeometry >::isCellCenter ( )
inlinestaticconstexpr

◆ isFace()

template<class ActualGridGeometry >
static constexpr bool Dumux::GridGeometryView< ActualGridGeometry >::isFace ( )
inlinestaticconstexpr

◆ vertexMapper()

template<class ActualGridGeometry >
const auto & Dumux::GridGeometryView< ActualGridGeometry >::vertexMapper ( ) const
inline

Member Data Documentation

◆ discMethod

template<class ActualGridGeometry >
constexpr DiscretizationMethod Dumux::GridGeometryView< ActualGridGeometry >::discMethod {}
staticconstexpr

◆ gridGeometry_

template<class ActualGridGeometry >
const ActualGridGeometry* Dumux::GridGeometryView< ActualGridGeometry >::gridGeometry_
protected

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