Base class for the finite volume geometry vector for box schemes This builds up the sub control volumes and sub control volume faces. More...

#include <dumux/discretization/box/fvgridgeometry.hh>

Inheritance diagram for Dumux::BoxFVGridGeometry< Scalar, GV, false, Traits >:

Description

template<class Scalar, class GV, class Traits>
class Dumux::BoxFVGridGeometry< Scalar, GV, false, Traits >

Base class for the finite volume geometry vector for box schemes This builds up the sub control volumes and sub control volume faces.

Note: For caching disabled we store only some essential index maps to build up local systems on-demand in the corresponding FVElementGeometry

Public Types
using	LocalView = typename Traits::template LocalView< ThisType, false >
	export the type of the fv element geometry (the local view type) More...

using	SubControlVolume = typename Traits::SubControlVolume
	export the type of sub control volume More...

using	SubControlVolumeFace = typename Traits::SubControlVolumeFace
	export the type of sub control volume More...

using	DofMapper = typename Traits::VertexMapper
	export dof mapper type More...

using	FeCache = Dune::PQkLocalFiniteElementCache< CoordScalar, Scalar, dim, 1 >
	export the finite element cache type More...

using	GridView = GV
	export the grid view type More...

using	Grid = typename GV::Grid
	export the grid 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
	BoxFVGridGeometry (const GridView gridView)
	Constructor. More...

const DofMapper &	dofMapper () const

std::size_t	numScv () const
	The total number of sub control volumes. More...

std::size_t	numScvf () const
	The total number of sun control volume faces. More...

std::size_t	numBoundaryScvf () const

std::size_t	numDofs () const
	The total number of degrees of freedom. More...

void	update ()
	update all fvElementGeometries (do this again after grid adaption) More...

const FeCache &	feCache () const
	The finite element cache for creating local FE bases. More...

bool	dofOnBoundary (GridIndexType dofIdx) const
	If a vertex / d.o.f. is on the boundary. More...

bool	dofOnPeriodicBoundary (GridIndexType dofIdx) const
	If a vertex / d.o.f. is on a periodic boundary. More...

GridIndexType	periodicallyMappedDof (GridIndexType dofIdx) const
	The index of the vertex / d.o.f. on the other side of the periodic boundary. More...

const std::unordered_map< GridIndexType, GridIndexType > &	periodicVertexMap () const
	Returns the map between dofs across periodic boundaries. 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...

Static Public Attributes
static constexpr DiscretizationMethod	discMethod = DiscretizationMethod::box
	export discretization method More...

Member Typedef Documentation

◆ DofMapper

template<class Scalar , class GV , class Traits >

using Dumux::BoxFVGridGeometry< Scalar, GV, false, Traits >::DofMapper = typename Traits::VertexMapper

export dof mapper type

◆ ElementMapper

template<class GV , class Traits >

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

inherited

export the element mapper type

◆ FeCache

template<class Scalar , class GV , class Traits >

using Dumux::BoxFVGridGeometry< Scalar, GV, false, Traits >::FeCache = Dune::PQkLocalFiniteElementCache<CoordScalar, Scalar, dim, 1>

export the finite element cache 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 Scalar , class GV , class Traits >

using Dumux::BoxFVGridGeometry< Scalar, GV, false, Traits >::GridView = GV

export the grid view type

◆ LocalView

template<class Scalar , class GV , class Traits >

using Dumux::BoxFVGridGeometry< Scalar, GV, false, Traits >::LocalView = typename Traits::template LocalView<ThisType, false>

export the type of the fv element geometry (the local view type)

◆ SubControlVolume

template<class Scalar , class GV , class Traits >

using Dumux::BoxFVGridGeometry< Scalar, GV, false, Traits >::SubControlVolume = typename Traits::SubControlVolume

export the type of sub control volume

◆ SubControlVolumeFace

template<class Scalar , class GV , class Traits >

using Dumux::BoxFVGridGeometry< Scalar, GV, false, Traits >::SubControlVolumeFace = typename Traits::SubControlVolumeFace

export the type of sub control volume

◆ VertexMapper

template<class GV , class Traits >

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

inherited

export the vertex mapper type

Constructor & Destructor Documentation

◆ BoxFVGridGeometry()

template<class Scalar , class GV , class Traits >

Dumux::BoxFVGridGeometry< Scalar, GV, false, Traits >::BoxFVGridGeometry ( const GridView gridView )

inline

Constructor.

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.

◆ dofMapper()

template<class Scalar , class GV , class Traits >

const DofMapper & Dumux::BoxFVGridGeometry< Scalar, GV, false, Traits >::dofMapper ( ) const

inline

the vertex mapper is the dofMapper this is convenience to have better chance to have the same main files for box/tpfa/mpfa...

◆ dofOnBoundary()

template<class Scalar , class GV , class Traits >

bool Dumux::BoxFVGridGeometry< Scalar, GV, false, Traits >::dofOnBoundary ( GridIndexType dofIdx ) const

inline

If a vertex / d.o.f. is on the boundary.

◆ dofOnPeriodicBoundary()

template<class Scalar , class GV , class Traits >

bool Dumux::BoxFVGridGeometry< Scalar, GV, false, Traits >::dofOnPeriodicBoundary ( GridIndexType dofIdx ) const

inline

If a vertex / d.o.f. is on a periodic boundary.

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

◆ feCache()

template<class Scalar , class GV , class Traits >

const FeCache & Dumux::BoxFVGridGeometry< Scalar, GV, false, Traits >::feCache ( ) const

inline

The finite element cache for creating local FE bases.

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

◆ numBoundaryScvf()

template<class Scalar , class GV , class Traits >

std::size_t Dumux::BoxFVGridGeometry< Scalar, GV, false, Traits >::numBoundaryScvf ( ) const

inline

The total number of boundary sub control volume faces For compatibility reasons with cc methods

◆ numDofs()

template<class Scalar , class GV , class Traits >

std::size_t Dumux::BoxFVGridGeometry< Scalar, GV, false, Traits >::numDofs ( ) const

inline

The total number of degrees of freedom.

◆ numScv()

template<class Scalar , class GV , class Traits >

std::size_t Dumux::BoxFVGridGeometry< Scalar, GV, false, Traits >::numScv ( ) const

inline

The total number of sub control volumes.

◆ numScvf()

template<class Scalar , class GV , class Traits >

std::size_t Dumux::BoxFVGridGeometry< Scalar, GV, false, Traits >::numScvf ( ) const

inline

The total number of sun control volume faces.

◆ periodicallyMappedDof()

template<class Scalar , class GV , class Traits >

GridIndexType Dumux::BoxFVGridGeometry< Scalar, GV, false, Traits >::periodicallyMappedDof ( GridIndexType dofIdx ) const

inline

The index of the vertex / d.o.f. on the other side of the periodic boundary.

◆ periodicVertexMap()

template<class Scalar , class GV , class Traits >

const std::unordered_map< GridIndexType, GridIndexType > & Dumux::BoxFVGridGeometry< Scalar, GV, false, Traits >::periodicVertexMap ( ) const

inline

Returns the map between dofs across periodic boundaries.

◆ 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 Scalar , class GV , class Traits >

void Dumux::BoxFVGridGeometry< Scalar, GV, false, Traits >::update ( )

inline

update all fvElementGeometries (do this again after grid adaption)

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

Member Data Documentation

◆ discMethod

template<class Scalar , class GV , class Traits >

constexpr DiscretizationMethod Dumux::BoxFVGridGeometry< Scalar, GV, false, Traits >::discMethod = DiscretizationMethod::box

staticconstexpr

export discretization method

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

discretization/box/fvgridgeometry.hh

Description

Public Types

Public Member Functions

Static Public Attributes

Member Typedef Documentation

◆ DofMapper

◆ ElementMapper

◆ FeCache

◆ GlobalCoordinate

◆ Grid

◆ GridView

◆ LocalView

◆ SubControlVolume

◆ SubControlVolumeFace

◆ VertexMapper

Constructor & Destructor Documentation

◆ BoxFVGridGeometry()

Member Function Documentation

◆ bBoxMax()

◆ bBoxMin()

◆ boundingBoxTree()

◆ dofMapper()

◆ dofOnBoundary()

◆ dofOnPeriodicBoundary()

◆ element() [1/2]

◆ element() [2/2]

◆ elementMap()

◆ elementMapper() [1/2]

◆ elementMapper() [2/2]

◆ feCache()

◆ gridView()

◆ isPeriodic()

◆ numBoundaryScvf()

◆ numDofs()

◆ numScv()

◆ numScvf()

◆ periodicallyMappedDof()

◆ periodicVertexMap()

◆ setPeriodic()

◆ update()

◆ vertexMapper() [1/2]

◆ vertexMapper() [2/2]

Member Data Documentation

◆ discMethod