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

Base class for all 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 grid geometries.

Template Parameters

GV	the grid view type
Traits	traits class that specifies mappers and basic grid geometry

Public Types
using	Grid = typename BaseImplementation::Grid
	export the grid type More...
using	GridView = typename BaseImplementation::GridView
	export the grid view type More...
using	GlobalCoordinate = typename BaseImplementation::GlobalCoordinate
	export the global coordinate type More...
using	ElementMapper = typename BaseImplementation::ElementMapper
	export the element mapper type More...
using	VertexMapper = typename BaseImplementation::VertexMapper
	export the vertex mapper type More...

Public Member Functions
	BaseGridGeometry (std::shared_ptr< BaseImplementation > impl)
	Constructor from a BaseImplementation. More...
	BaseGridGeometry (const GridView &gridView)
	Constructor from a grid view. More...
void	update (const GridView &gridView)
	Update all fvElementGeometries (call this after grid adaption) More...
void	update (GridView &&gridView)
	Update all fvElementGeometries (call this after grid adaption) 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...
decltype(auto)	boundingBoxTree () const
	Returns the bounding box tree of the grid. More...
decltype(auto)	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...
bool	isPeriodic () const
	Returns if the grid geometry is periodic (at all) More...

Protected Member Functions
void	setPeriodic (bool value=true)
	Set the periodicity of the grid geometry. More...

Member Typedef Documentation

ElementMapper

template<class GV , class Traits >

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

export the element mapper type

GlobalCoordinate

template<class GV , class Traits >

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

export the global coordinate type

Grid

template<class GV , class Traits >

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

export the grid type

GridView

template<class GV , class Traits >

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

export the grid view type

VertexMapper

template<class GV , class Traits >

using Dumux::BaseGridGeometry< GV, Traits >::VertexMapper = typename BaseImplementation::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 >

decltype(auto) Dumux::BaseGridGeometry< GV, Traits >::boundingBoxTree ( ) const

inline

Returns the bounding box tree of the grid.

element()

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 >

decltype(auto) 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 )

inlineprotected

Set the periodicity of the grid geometry.

update() [1/2]

template<class GV , class Traits >

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

inline

Update all fvElementGeometries (call this after grid adaption)

update() [2/2]

template<class GV , class Traits >

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

inline

Update all fvElementGeometries (call this after grid adaption)

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