version 3.8
Dumux::BasicGridGeometry< GV, EM, VM > Class Template Reference

An implementation of a grid geometry with some basic features. More...

#include <dumux/discretization/basicgridgeometry.hh>

Description

template<class GV, class EM, class VM>
class Dumux::BasicGridGeometry< GV, EM, VM >
Template Parameters
GVthe grid view type
EMthe type of the element mapper
VMthe type of the vertex mapper

Public Types

using Grid = typename GV::Grid
 export the grid type More...
 
using GridView = GV
 export the grid view type More...
 
using GlobalCoordinate = typename Element::Geometry::GlobalCoordinate
 export the global coordinate type More...
 
using ElementMapper = EM
 export the element mapper type More...
 
using VertexMapper = VM
 export the vertex mapper type More...
 

Public Member Functions

 BasicGridGeometry (const GridView &gridView)
 Constructor computes the bounding box of the entire domain, for e.g. setting boundary conditions. More...
 
void update (const GridView &gridView)
 Update internal state after grid changed. More...
 
void update (GridView &&gridView)
 Update internal state after grid changed. More...
 
const GridViewgridView () const
 Return the gridView this grid geometry object lives on. More...
 
const VertexMappervertexMapper () const
 Returns the mapper for vertices to indices for constant grids. More...
 
const ElementMapperelementMapper () const
 Returns the mapper for elements to indices for constant grids. More...
 
VertexMappervertexMapper ()
 Returns the mapper for vertices to indices for possibly adaptive grids. More...
 
ElementMapperelementMapper ()
 Returns the mapper for elements to indices for possibly adaptive grids. More...
 
const BoundingBoxTreeboundingBoxTree () const
 Returns the bounding box tree of the grid. More...
 
const ElementMapelementMap () const
 Returns the element index to element map. More...
 
Element element (GridIndexType eIdx) const
 Get an element from a global element index. More...
 
const GlobalCoordinatebBoxMin () const
 The coordinate of the corner of the GridView's bounding box with the smallest values. More...
 
const GlobalCoordinatebBoxMax () const
 The coordinate of the corner of the GridView's bounding box with the largest values. More...
 

Member Typedef Documentation

◆ ElementMapper

template<class GV , class EM , class VM >
using Dumux::BasicGridGeometry< GV, EM, VM >::ElementMapper = EM

◆ GlobalCoordinate

template<class GV , class EM , class VM >
using Dumux::BasicGridGeometry< GV, EM, VM >::GlobalCoordinate = typename Element::Geometry::GlobalCoordinate

◆ Grid

template<class GV , class EM , class VM >
using Dumux::BasicGridGeometry< GV, EM, VM >::Grid = typename GV::Grid

◆ GridView

template<class GV , class EM , class VM >
using Dumux::BasicGridGeometry< GV, EM, VM >::GridView = GV

◆ VertexMapper

template<class GV , class EM , class VM >
using Dumux::BasicGridGeometry< GV, EM, VM >::VertexMapper = VM

Member Function Documentation

◆ bBoxMax()

template<class GV , class EM , class VM >
const GlobalCoordinate & Dumux::BasicGridGeometry< GV, EM, VM >::bBoxMax ( ) const
inline

◆ bBoxMin()

template<class GV , class EM , class VM >
const GlobalCoordinate & Dumux::BasicGridGeometry< GV, EM, VM >::bBoxMin ( ) const
inline

◆ boundingBoxTree()

template<class GV , class EM , class VM >
const BoundingBoxTree & Dumux::BasicGridGeometry< GV, EM, VM >::boundingBoxTree ( ) const
inline

◆ element()

template<class GV , class EM , class VM >
Element Dumux::BasicGridGeometry< GV, EM, VM >::element ( GridIndexType  eIdx) const
inline

◆ elementMap()

template<class GV , class EM , class VM >
const ElementMap & Dumux::BasicGridGeometry< GV, EM, VM >::elementMap ( ) const
inline

◆ elementMapper() [1/2]

template<class GV , class EM , class VM >
ElementMapper & Dumux::BasicGridGeometry< GV, EM, VM >::elementMapper ( )
inline

◆ elementMapper() [2/2]

template<class GV , class EM , class VM >
const ElementMapper & Dumux::BasicGridGeometry< GV, EM, VM >::elementMapper ( ) const
inline

◆ gridView()

template<class GV , class EM , class VM >
const GridView & Dumux::BasicGridGeometry< GV, EM, VM >::gridView ( ) const
inline

◆ update() [1/2]

template<class GV , class EM , class VM >
void Dumux::BasicGridGeometry< GV, EM, VM >::update ( const GridView gridView)
inline

◆ update() [2/2]

template<class GV , class EM , class VM >
void Dumux::BasicGridGeometry< GV, EM, VM >::update ( GridView &&  gridView)
inline

◆ vertexMapper() [1/2]

template<class GV , class EM , class VM >
VertexMapper & Dumux::BasicGridGeometry< GV, EM, VM >::vertexMapper ( )
inline

◆ vertexMapper() [2/2]

template<class GV , class EM , class VM >
const VertexMapper & Dumux::BasicGridGeometry< GV, EM, VM >::vertexMapper ( ) const
inline

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