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

#include <dumux/discretization/basefvgridgeometry.hh>

Inheritance diagram for Dumux::BaseFVGridGeometry< Impl, GV, Traits >:

Description

template<class Impl, class GV, class Traits>
class Dumux::BaseFVGridGeometry< Impl, GV, Traits >

Base class for all finite volume grid geometries.

Template Parameters

Impl	the type of the actual implementation
GV	the grid view type
Traits	the fv geometry traits

Note: This has been deprecated in favour of a discretization-scheme agnostic implementation in Dumux::BaseGridGeometry.

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 = typename Traits::ElementMapper
	export the element mapper type More...

using	VertexMapper = typename Traits::VertexMapper
	export the vertex mapper type More...

Public Member Functions
	BaseFVGridGeometry (const GV &gridView)

void	update ()
	Update all fvElementGeometries (do this again 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...

VertexMapper &	vertexMapper ()
	Returns the mapper for vertices to indices for possibly adaptive grids. More...

const ElementMapper &	elementMapper () const
	Returns the mapper for elements to indices for constant 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...

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. 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...

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 Traits::ElementMapper

inherited

export the element mapper type

◆ GlobalCoordinate

template<class GV , class Traits >

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

inherited

export the global coordinate type

◆ Grid

template<class GV , class Traits >

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

inherited

export the grid type

◆ GridView

template<class GV , class Traits >

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

inherited

export the grid view type

◆ VertexMapper

template<class GV , class Traits >

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

inherited

export the vertex mapper type

Constructor & Destructor Documentation

◆ BaseFVGridGeometry()

template<class Impl , class GV , class Traits >

Dumux::BaseFVGridGeometry< Impl, GV, Traits >::BaseFVGridGeometry ( const GV & gridView )

inline

Member Function Documentation

◆ bBoxMax()

template<class GV , class Traits >

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

inlineinherited

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

inlineinherited

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

inlineinherited

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

inlineinherited

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

inlineinherited

Get an element from a global element index.

◆ elementMap()

template<class GV , class Traits >

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

inlineinherited

Returns the element index to element map.

◆ elementMapper() [1/2]

template<class GV , class Traits >

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

inlineinherited

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

inlineinherited

Returns the mapper for elements to indices for constant grids.

◆ gridView()

template<class GV , class Traits >

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

inlineinherited

Return the gridView this grid geometry object lives on.

◆ isPeriodic()

template<class GV , class Traits >

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

inlineinherited

Returns if the grid geometry is periodic (at all)

◆ setPeriodic()

template<class GV , class Traits >

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

inlineinherited

Set the periodicity of the grid geometry.

◆ update()

template<class GV , class Traits >

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

inlineinherited

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

inlineinherited

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

inlineinherited

Returns the mapper for vertices to indices for constant grids.

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

basefvgridgeometry.hh

Description

Public Types

Public Member Functions

Member Typedef Documentation

◆ ElementMapper

◆ GlobalCoordinate

◆ Grid

◆ GridView

◆ VertexMapper

Constructor & Destructor Documentation

◆ BaseFVGridGeometry()

Member Function Documentation

◆ bBoxMax()

◆ bBoxMin()

◆ boundingBoxTree()

◆ element() [1/2]

◆ element() [2/2]

◆ elementMap()

◆ elementMapper() [1/2]

◆ elementMapper() [2/2]

◆ gridView()

◆ isPeriodic()

◆ setPeriodic()

◆ update()

◆ vertexMapper() [1/2]

◆ vertexMapper() [2/2]