version 3.9.0
Loading...
Searching...
No Matches
Dumux::BoxGeometryHelper< GridView, 2, ScvType, ScvfType > Class Template Reference

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

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

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

Public Member Functions

 BoxGeometryHelper (const typename Element::Geometry &geometry)
 
ScvCornerStorage getScvCorners (unsigned int localScvIdx) const
 Create a vector with the scv corners.
 
ScvfCornerStorage getScvfCorners (unsigned int localScvfIdx) const
 Create a vector with the corners of sub control volume faces.
 
ScvfCornerStorage getBoundaryScvfCorners (unsigned int localFacetIndex, unsigned int indexInFacet) const
 Create the sub control volume face geometries on the boundary.
 
template<int w = dimWorld>
std::enable_if< w==3, GlobalPosition >::type normal (const ScvfCornerStorage &scvfCorners, const std::vector< unsigned int > &scvIndices) const
 get scvf normal vector for dim == 2, dimworld == 3
 
template<int w = dimWorld>
std::enable_if< w==2, GlobalPosition >::type normal (const ScvfCornerStorage &scvfCorners, const std::vector< unsigned int > &scvIndices) const
 get scvf normal vector for dim == 2, dimworld == 2
 
std::size_t numInteriorScvf () const
 number of sub control volume faces (number of edges)
 
std::size_t numScv () const
 number of sub control volumes (number of vertices)
 
const Element::Geometry & elementGeometry () const
 the wrapped element geometry
 

Constructor & Destructor Documentation

◆ BoxGeometryHelper()

template<class GridView , class ScvType , class ScvfType >
Dumux::BoxGeometryHelper< GridView, 2, 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, 2, ScvType, ScvfType >::elementGeometry ( ) const
inline

◆ getBoundaryScvfCorners()

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

◆ getScvCorners()

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

◆ getScvfCorners()

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

◆ normal() [1/2]

template<class GridView , class ScvType , class ScvfType >
template<int w = dimWorld>
std::enable_if< w==3, GlobalPosition >::type Dumux::BoxGeometryHelper< GridView, 2, ScvType, ScvfType >::normal ( const ScvfCornerStorage & scvfCorners,
const std::vector< unsigned int > & scvIndices ) const
inline

ensure the right direction of the normal

◆ normal() [2/2]

template<class GridView , class ScvType , class ScvfType >
template<int w = dimWorld>
std::enable_if< w==2, GlobalPosition >::type Dumux::BoxGeometryHelper< GridView, 2, ScvType, ScvfType >::normal ( const ScvfCornerStorage & scvfCorners,
const std::vector< unsigned int > & scvIndices ) const
inline

obtain normal vector by 90° counter-clockwise rotation of t

ensure the right direction of the normal

◆ numInteriorScvf()

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

◆ numScv()

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

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