3.5-git
DUNE for Multi-{Phase, Component, Scale, Physics, ...} flow and transport in porous media
Public Types | Public Member Functions | List of all members
Dumux::FreeFlowStaggeredGeometryHelper< GridView, upwindSchemeOrder > Class Template Reference

Helper class constructing the dual grid finite volume geometries for the free flow staggered discretization method. More...

#include <dumux/discretization/staggered/freeflow/staggeredgeometryhelper.hh>

Description

template<class GridView, int upwindSchemeOrder>
class Dumux::FreeFlowStaggeredGeometryHelper< GridView, upwindSchemeOrder >

Helper class constructing the dual grid finite volume geometries for the free flow staggered discretization method.

Public Types

using PairData = Detail::PairData< GridView, upwindSchemeOrder >
 
using AxisData = Detail::AxisData< GridView, upwindSchemeOrder >
 

Public Member Functions

 FreeFlowStaggeredGeometryHelper (const Element &element, const GridView &gridView)
 
template<class IntersectionMapper >
void updateLocalFace (const IntersectionMapper &, const Intersection &intersection)
 update the local face More...
 
SmallLocalIndexType localFaceIndex () const
 Returns the local index of the face (i.e. the intersection) More...
 
AxisData axisData () const
 Returns a copy of the axis data. More...
 
std::array< PairData, numPairs > pairData () const
 Returns a copy of the pair data. More...
 
unsigned int directionIndex () const
 Returns the direction index of the primary facet (0 = x, 1 = y, 2 = z) More...
 
unsigned int directionIndex (const Intersection &intersection) const
 Returns the direction index of the facet passed as an argument (0 = x, 1 = y, 2 = z) More...
 

Member Typedef Documentation

◆ AxisData

template<class GridView , int upwindSchemeOrder>
using Dumux::FreeFlowStaggeredGeometryHelper< GridView, upwindSchemeOrder >::AxisData = Detail::AxisData<GridView, upwindSchemeOrder>

◆ PairData

template<class GridView , int upwindSchemeOrder>
using Dumux::FreeFlowStaggeredGeometryHelper< GridView, upwindSchemeOrder >::PairData = Detail::PairData<GridView, upwindSchemeOrder>

Constructor & Destructor Documentation

◆ FreeFlowStaggeredGeometryHelper()

template<class GridView , int upwindSchemeOrder>
Dumux::FreeFlowStaggeredGeometryHelper< GridView, upwindSchemeOrder >::FreeFlowStaggeredGeometryHelper ( const Element &  element,
const GridView &  gridView 
)
inline

Member Function Documentation

◆ axisData()

template<class GridView , int upwindSchemeOrder>
AxisData Dumux::FreeFlowStaggeredGeometryHelper< GridView, upwindSchemeOrder >::axisData ( ) const
inline

Returns a copy of the axis data.

◆ directionIndex() [1/2]

template<class GridView , int upwindSchemeOrder>
unsigned int Dumux::FreeFlowStaggeredGeometryHelper< GridView, upwindSchemeOrder >::directionIndex ( ) const
inline

Returns the direction index of the primary facet (0 = x, 1 = y, 2 = z)

◆ directionIndex() [2/2]

template<class GridView , int upwindSchemeOrder>
unsigned int Dumux::FreeFlowStaggeredGeometryHelper< GridView, upwindSchemeOrder >::directionIndex ( const Intersection &  intersection) const
inline

Returns the direction index of the facet passed as an argument (0 = x, 1 = y, 2 = z)

◆ localFaceIndex()

template<class GridView , int upwindSchemeOrder>
SmallLocalIndexType Dumux::FreeFlowStaggeredGeometryHelper< GridView, upwindSchemeOrder >::localFaceIndex ( ) const
inline

Returns the local index of the face (i.e. the intersection)

◆ pairData()

template<class GridView , int upwindSchemeOrder>
std::array< PairData, numPairs > Dumux::FreeFlowStaggeredGeometryHelper< GridView, upwindSchemeOrder >::pairData ( ) const
inline

Returns a copy of the pair data.

◆ updateLocalFace()

template<class GridView , int upwindSchemeOrder>
template<class IntersectionMapper >
void Dumux::FreeFlowStaggeredGeometryHelper< GridView, upwindSchemeOrder >::updateLocalFace ( const IntersectionMapper ,
const Intersection &  intersection 
)
inline

update the local face


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