Dumux::BaseGridGeometry< GV, Traits > Class Template Reference

Base class for all finite volume grid geometries. More...

#include <dumux/discretization/basegridgeometry.hh>

Inheritance diagram for Dumux::BaseGridGeometry< GV, Traits >:

Description

template<class GV, class Traits>
class Dumux::BaseGridGeometry< GV, Traits >

Base class for all finite volume grid geometries.

Template Parameters

GV	the grid view type
Traits	traits class

Public Types
using	Grid = typename GV::Grid
	export the grid type
using	GridView = GV
	export the grid view type
using	GlobalCoordinate = typename Element::Geometry::GlobalCoordinate
	export the global coordinate type
using	ElementMapper = typename Traits::ElementMapper
	export the element mapper type
using	VertexMapper = typename Traits::VertexMapper
	export the vertex mapper type

Public Member Functions
	BaseGridGeometry (const GridView &gridView)
	Constructor computes the bouding box of the entire domain, for e.g. setting boundary conditions.
void	update ()
	Update all fvElementGeometries (do this again after grid adaption).
const GridView &	gridView () const
	Return the gridView this grid geometry object lives on.
const VertexMapper &	vertexMapper () const
	Returns the mapper for vertices to indices for constant grids.
const ElementMapper &	elementMapper () const
	Returns the mapper for elements to indices for constant grids.
VertexMapper &	vertexMapper ()
	Returns the mapper for vertices to indices for possibly adaptive grids.
ElementMapper &	elementMapper ()
	Returns the mapper for elements to indices for possibly adaptive grids.
const BoundingBoxTree &	boundingBoxTree () const
	Returns the bounding box tree of the grid.
const ElementMap &	elementMap () const
	Returns the element index to element map.
template<class Scv, std::enable_if_t<!std::is_arithmetic< Scv >::value, int > = 0>
Element	element (const Scv &scv) const
	Get an element from a sub-control volume.
Element	element (GridIndexType eIdx) const
	Get an element from a global element index.
const GlobalCoordinate &	bBoxMin () const
	The coordinate of the corner of the GridView's bounding box with the smallest values.
const GlobalCoordinate &	bBoxMax () const
	The coordinate of the corner of the GridView's bounding box with the largest values.
bool	isPeriodic () const
	Returns if the grid geometry is periodic (at all).
void	setPeriodic (bool value=true)
	Set the periodicity of the grid geometry.

Member Typedef Documentation

ElementMapper

template<class GV, class Traits>

using Dumux::BaseGridGeometry< GV, Traits >::ElementMapper = typename Traits::ElementMapper

export the element mapper type

GlobalCoordinate

template<class GV, class Traits>

using Dumux::BaseGridGeometry< GV, Traits >::GlobalCoordinate = typename Element::Geometry::GlobalCoordinate

export the global coordinate type

Grid

template<class GV, class Traits>

using Dumux::BaseGridGeometry< GV, Traits >::Grid = typename GV::Grid

export the grid type

GridView

template<class GV, class Traits>

using Dumux::BaseGridGeometry< GV, Traits >::GridView = GV

export the grid view type

VertexMapper

template<class GV, class Traits>

using Dumux::BaseGridGeometry< GV, Traits >::VertexMapper = typename Traits::VertexMapper

export the vertex mapper type

Member Function Documentation

bBoxMax()

template<class GV, class Traits>

const GlobalCoordinate & Dumux::BaseGridGeometry< GV, Traits >::bBoxMax ( ) const

inline

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

bBoxMin()

template<class GV, class Traits>

const GlobalCoordinate & Dumux::BaseGridGeometry< GV, Traits >::bBoxMin ( ) const

inline

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

boundingBoxTree()

template<class GV, class Traits>

const BoundingBoxTree & Dumux::BaseGridGeometry< GV, Traits >::boundingBoxTree ( ) const

inline

Returns the bounding box tree of the grid.

element() [1/2]

template<class GV, class Traits>

template<class Scv, std::enable_if_t<!std::is_arithmetic< Scv >::value, int > = 0>

Element Dumux::BaseGridGeometry< GV, Traits >::element ( const Scv & scv ) const

inline

Get an element from a sub-control volume.

Note

This interface is deprecated

element() [2/2]

template<class GV, class Traits>

Element Dumux::BaseGridGeometry< GV, Traits >::element ( GridIndexType eIdx ) const

inline

Get an element from a global element index.

elementMap()

template<class GV, class Traits>

const ElementMap & Dumux::BaseGridGeometry< GV, Traits >::elementMap ( ) const

inline

Returns the element index to element map.

elementMapper() [1/2]

template<class GV, class Traits>

ElementMapper & Dumux::BaseGridGeometry< GV, Traits >::elementMapper ( )

inline

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

elementMapper() [2/2]

template<class GV, class Traits>

const ElementMapper & Dumux::BaseGridGeometry< GV, Traits >::elementMapper ( ) const

inline

Returns the mapper for elements to indices for constant grids.

gridView()

template<class GV, class Traits>

const GridView & Dumux::BaseGridGeometry< GV, Traits >::gridView ( ) const

inline

Return the gridView this grid geometry object lives on.

isPeriodic()

template<class GV, class Traits>

bool Dumux::BaseGridGeometry< GV, Traits >::isPeriodic ( ) const

inline

Returns if the grid geometry is periodic (at all).

setPeriodic()

template<class GV, class Traits>

void Dumux::BaseGridGeometry< GV, Traits >::setPeriodic ( bool value = true )

inline

Set the periodicity of the grid geometry.

update()

template<class GV, class Traits>

void Dumux::BaseGridGeometry< GV, Traits >::update ( )

inline

Update all fvElementGeometries (do this again after grid adaption).

Update the mappers

Compute the bouding box of the entire domain, for e.g. setting boundary conditions

reset bounding box tree and the element map until requested the next time

vertexMapper() [1/2]

template<class GV, class Traits>

VertexMapper & Dumux::BaseGridGeometry< GV, Traits >::vertexMapper ( )

inline

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

vertexMapper() [2/2]

template<class GV, class Traits>

const VertexMapper & Dumux::BaseGridGeometry< GV, Traits >::vertexMapper ( ) const

inline

Returns the mapper for vertices to indices for constant grids.

---

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

• basegridgeometry.hh