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

Face specific auxiliary FvGridGeometry classes. Required for the Dumux multi-domain framework. More...

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

Inheritance diagram for Dumux::FaceFVGridGeometry< ActualGridGeometry >:

Description

template<class ActualGridGeometry>
class Dumux::FaceFVGridGeometry< ActualGridGeometry >

Face specific auxiliary FvGridGeometry classes. Required for the Dumux multi-domain framework.

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

std::size_t numDofs () const
 The total number of cell centered dofs. More...
 
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 isFace ()
 Returns true because this view is related to face dofs. More...
 
static constexpr bool isCellCenter ()
 Returns true if this view if related to cell centered 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
inherited

export the discretization method this geometry belongs to

◆ GridView

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

export the GridView type and the discretization method

◆ LocalView

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

Member Function Documentation

◆ actualGridGeometry()

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

Returns the actual gridGeometry we are a restriction of.

◆ cellCenterIdx()

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

Return an integral constant index for cell centered dofs.

◆ connectivityMap()

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

Returns the connectivity map of which dofs have derivatives with respect to a given dof.

◆ elementMapper()

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

Returns the mapper for elements to indices for constant grids.

◆ faceIdx()

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

Return an integral constant index for face dofs.

◆ gridView()

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

Return the gridView this grid geometry object lives on.

◆ isCellCenter()

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

Returns true if this view if related to cell centered dofs.

◆ isFace()

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

Returns true because this view is related to face dofs.

◆ numDofs()

template<class ActualGridGeometry >
std::size_t Dumux::FaceFVGridGeometry< ActualGridGeometry >::numDofs ( ) const
inline

The total number of cell centered dofs.

◆ vertexMapper()

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

Returns the mapper for vertices to indices for possibly adaptive grids.

Member Data Documentation

◆ discMethod

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

◆ gridGeometry_

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

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