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 >

An implementation of a grid geometry with some basic features.

Template Parameters

GV	the grid view type
EM	the type of the element mapper
VM	the 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 GridView &	gridView () const
	Return the gridView this grid geometry object lives on. More...
const VertexMapper &	vertexMapper () const
	Returns the mapper for vertices to indices for constant grids. More...
const ElementMapper &	elementMapper () const
	Returns the mapper for elements to indices for constant grids. More...
VertexMapper &	vertexMapper ()
	Returns the mapper for vertices to indices for possibly adaptive grids. More...
ElementMapper &	elementMapper ()
	Returns the mapper for elements to indices for possibly adaptive grids. More...
const BoundingBoxTree &	boundingBoxTree () const
	Returns the bounding box tree of the grid. More...
const ElementMap &	elementMap () const
	Returns the element index to element map. More...
Element	element (GridIndexType eIdx) const
	Get an element from a global element index. More...
const GlobalCoordinate &	bBoxMin () const
	The coordinate of the corner of the GridView's bounding box with the smallest values. More...
const GlobalCoordinate &	bBoxMax () 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

export the element mapper type

GlobalCoordinate

template<class GV , class EM , class VM >

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

export the global coordinate type

Grid

template<class GV , class EM , class VM >

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

export the grid type

GridView

template<class GV , class EM , class VM >

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

export the grid view type

VertexMapper

template<class GV , class EM , class VM >

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

export the vertex mapper type

Member Function Documentation

bBoxMax()

template<class GV , class EM , class VM >

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

inline

The coordinate of the corner of the GridView's bounding box with the largest values.

bBoxMin()

template<class GV , class EM , class VM >

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

inline

The coordinate of the corner of the GridView's bounding box with the smallest values.

boundingBoxTree()

template<class GV , class EM , class VM >

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

inline

Returns the bounding box tree of the grid.

element()

template<class GV , class EM , class VM >

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

inline

Get an element from a global element index.

elementMap()

template<class GV , class EM , class VM >

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

inline

Returns the element index to element map.

elementMapper() [1/2]

template<class GV , class EM , class VM >

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

inline

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

elementMapper() [2/2]

template<class GV , class EM , class VM >

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

inline

Returns the mapper for elements to indices for constant grids.

gridView()

template<class GV , class EM , class VM >

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

inline

Return the gridView this grid geometry object lives on.

update() [1/2]

template<class GV , class EM , class VM >

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

inline

Update internal state after grid changed.

update() [2/2]

template<class GV , class EM , class VM >

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

inline

Update internal state after grid changed.

vertexMapper() [1/2]

template<class GV , class EM , class VM >

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

inline

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

vertexMapper() [2/2]

template<class GV , class EM , class VM >

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

inline

Returns the mapper for vertices to indices for constant grids.

---

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

• basicgridgeometry.hh