3.6-git
DUNE for Multi-{Phase, Component, Scale, Physics, ...} flow and transport in porous media
Public Member Functions | List of all members
Dumux::BoxGeometryHelper< GridView, 3, ScvType, ScvfType > Class Template Reference

A class to create sub control volume and sub control volume face geometries per element. More...

#include <dumux/discretization/box/boxgeometryhelper.hh>

Inheritance diagram for Dumux::BoxGeometryHelper< GridView, 3, ScvType, ScvfType >:

Description

template<class GridView, class ScvType, class ScvfType>
class Dumux::BoxGeometryHelper< GridView, 3, ScvType, ScvfType >

A class to create sub control volume and sub control volume face geometries per element.

Public Member Functions

 BoxGeometryHelper (const typename Element::Geometry &geometry)
 
ScvCornerStorage getScvCorners (unsigned int localScvIdx) const
 Create a vector with the scv corners. More...
 
ScvfCornerStorage getScvfCorners (unsigned int localScvfIdx) const
 Create a vector with the scvf corners. More...
 
ScvfCornerStorage getBoundaryScvfCorners (unsigned localFacetIndex, unsigned int indexInFacet) const
 Create the sub control volume face geometries on the boundary. More...
 
ScvfCornerStorage getBoundaryScvfCorners (const Intersection &is, const typename Intersection::Geometry &isGeometry, unsigned int indexInIntersection) const
 Create the sub control volume face geometries on the boundary. More...
 
GlobalPosition normal (const ScvfCornerStorage &p, const std::vector< unsigned int > &scvIndices) const
 get scvf normal vector More...
 
Scalar scvVolume (const ScvCornerStorage &p) const
 get scv volume More...
 
Scalar scvfArea (const ScvfCornerStorage &p) const
 get scvf area More...
 
std::size_t numInteriorScvf () const
 number of sub control volume faces (number of edges) More...
 
std::size_t numScv () const
 number of sub control volumes (number of vertices) More...
 
const Element::Geometry & elementGeometry () const
 the wrapped element geometry More...
 

Constructor & Destructor Documentation

◆ BoxGeometryHelper()

template<class GridView , class ScvType , class ScvfType >
Dumux::BoxGeometryHelper< GridView, 3, ScvType, ScvfType >::BoxGeometryHelper ( const typename Element::Geometry &  geometry)
inline

Member Function Documentation

◆ elementGeometry()

template<class GridView , class ScvType , class ScvfType >
const Element::Geometry & Dumux::BoxGeometryHelper< GridView, 3, ScvType, ScvfType >::elementGeometry ( ) const
inline

the wrapped element geometry

◆ getBoundaryScvfCorners() [1/2]

template<class GridView , class ScvType , class ScvfType >
ScvfCornerStorage Dumux::BoxGeometryHelper< GridView, 3, ScvType, ScvfType >::getBoundaryScvfCorners ( const Intersection &  is,
const typename Intersection::Geometry &  isGeometry,
unsigned int  indexInIntersection 
) const
inline

Create the sub control volume face geometries on the boundary.

◆ getBoundaryScvfCorners() [2/2]

template<class GridView , class ScvType , class ScvfType >
ScvfCornerStorage Dumux::BoxGeometryHelper< GridView, 3, ScvType, ScvfType >::getBoundaryScvfCorners ( unsigned  localFacetIndex,
unsigned int  indexInFacet 
) const
inline

Create the sub control volume face geometries on the boundary.

◆ getScvCorners()

template<class GridView , class ScvType , class ScvfType >
ScvCornerStorage Dumux::BoxGeometryHelper< GridView, 3, ScvType, ScvfType >::getScvCorners ( unsigned int  localScvIdx) const
inline

Create a vector with the scv corners.

◆ getScvfCorners()

template<class GridView , class ScvType , class ScvfType >
ScvfCornerStorage Dumux::BoxGeometryHelper< GridView, 3, ScvType, ScvfType >::getScvfCorners ( unsigned int  localScvfIdx) const
inline

Create a vector with the scvf corners.

◆ normal()

template<class GridView , class ScvType , class ScvfType >
GlobalPosition Dumux::BoxGeometryHelper< GridView, 3, ScvType, ScvfType >::normal ( const ScvfCornerStorage &  p,
const std::vector< unsigned int > &  scvIndices 
) const
inline

get scvf normal vector

◆ numInteriorScvf()

template<class GridView , class ScvType , class ScvfType >
std::size_t Dumux::BoxGeometryHelper< GridView, 3, ScvType, ScvfType >::numInteriorScvf ( ) const
inline

number of sub control volume faces (number of edges)

◆ numScv()

template<class GridView , class ScvType , class ScvfType >
std::size_t Dumux::BoxGeometryHelper< GridView, 3, ScvType, ScvfType >::numScv ( ) const
inline

number of sub control volumes (number of vertices)

◆ scvfArea()

template<class GridView , class ScvType , class ScvfType >
Scalar Dumux::BoxGeometryHelper< GridView, 3, ScvType, ScvfType >::scvfArea ( const ScvfCornerStorage &  p) const
inline

get scvf area

◆ scvVolume()

template<class GridView , class ScvType , class ScvfType >
Scalar Dumux::BoxGeometryHelper< GridView, 3, ScvType, ScvfType >::scvVolume ( const ScvCornerStorage &  p) const
inline

get scv volume


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