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, true, Traits >:

Description

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

Note: For caching enabled we store the fv geometries for the whole grid view which is memory intensive but faster

Public Types
using	DiscretizationMethod = DiscretizationMethods::Box
	export the discretization method this geometry belongs to More...

using	BasicGridGeometry = BasicGridGeometry_t< GV, Traits >
	export basic grid geometry type for the alternative constructor More...

using	LocalView = typename Traits::template LocalView< ThisType, true >
	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	Extrusion = Extrusion_t< Traits >
	export the type of extrusion More...

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

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

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

using	Cache = BoxGridGeometryCache

using	Grid = typename BaseImplementation::Grid
	export the grid 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
	BoxFVGridGeometry (std::shared_ptr< BasicGridGeometry > gg)
	Constructor with basic grid geometry used to share state with another grid geometry on the same grid view. More...

	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 (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 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 > &	periodicDofMap () const
	Returns the map between dofs across periodic boundaries. 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...

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

Static Public Attributes
static constexpr DiscretizationMethod	discMethod {}

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

Member Typedef Documentation

◆ BasicGridGeometry

template<class Scalar , class GV , class Traits >

using Dumux::BoxFVGridGeometry< Scalar, GV, true, Traits >::BasicGridGeometry = BasicGridGeometry_t<GV, Traits>

◆ Cache

template<class Scalar , class GV , class Traits >

using Dumux::BoxFVGridGeometry< Scalar, GV, true, Traits >::Cache = BoxGridGeometryCache

the cache type (only the caching implementation has this) this alias should only be used by the local view implementation

◆ DiscretizationMethod

template<class Scalar , class GV , class Traits >

using Dumux::BoxFVGridGeometry< Scalar, GV, true, Traits >::DiscretizationMethod = DiscretizationMethods::Box

◆ DofMapper

template<class Scalar , class GV , class Traits >

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

◆ ElementMapper

template<class GV , class Traits >

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

inherited

◆ Extrusion

template<class Scalar , class GV , class Traits >

using Dumux::BoxFVGridGeometry< Scalar, GV, true, Traits >::Extrusion = Extrusion_t<Traits>

◆ FeCache

template<class Scalar , class GV , class Traits >

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

◆ GlobalCoordinate

template<class GV , class Traits >

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

inherited

◆ Grid

template<class GV , class Traits >

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

inherited

◆ GridView

template<class Scalar , class GV , class Traits >

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

◆ LocalView

template<class Scalar , class GV , class Traits >

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

◆ SubControlVolume

template<class Scalar , class GV , class Traits >

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

◆ SubControlVolumeFace

template<class Scalar , class GV , class Traits >

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

◆ VertexMapper

template<class GV , class Traits >

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

inherited

Constructor & Destructor Documentation

◆ BoxFVGridGeometry() [1/2]

template<class Scalar , class GV , class Traits >

Dumux::BoxFVGridGeometry< Scalar, GV, true, Traits >::BoxFVGridGeometry ( std::shared_ptr< BasicGridGeometry > gg )

inline

◆ BoxFVGridGeometry() [2/2]

template<class Scalar , class GV , class Traits >

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

inline

Member Function Documentation

◆ bBoxMax()

template<class GV , class Traits >

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

inlineinherited

◆ bBoxMin()

template<class GV , class Traits >

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

inlineinherited

◆ boundingBoxTree()

template<class GV , class Traits >

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

inlineinherited

◆ dofMapper()

template<class Scalar , class GV , class Traits >

const DofMapper & Dumux::BoxFVGridGeometry< Scalar, GV, true, 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, true, Traits >::dofOnBoundary ( GridIndexType dofIdx ) const

inline

◆ dofOnPeriodicBoundary()

template<class Scalar , class GV , class Traits >

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

inline

◆ element()

template<class GV , class Traits >

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

inlineinherited

◆ elementMap()

template<class GV , class Traits >

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

inlineinherited

◆ elementMapper() [1/2]

template<class GV , class Traits >

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

inlineinherited

◆ elementMapper() [2/2]

template<class GV , class Traits >

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

inlineinherited

◆ feCache()

template<class Scalar , class GV , class Traits >

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

inline

◆ gridView()

template<class GV , class Traits >

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

inlineinherited

◆ isPeriodic()

template<class GV , class Traits >

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

inlineinherited

◆ numBoundaryScvf()

template<class Scalar , class GV , class Traits >

std::size_t Dumux::BoxFVGridGeometry< Scalar, GV, true, 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, true, Traits >::numDofs ( ) const

inline

◆ numScv()

template<class Scalar , class GV , class Traits >

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

inline

◆ numScvf()

template<class Scalar , class GV , class Traits >

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

inline

◆ periodicallyMappedDof()

template<class Scalar , class GV , class Traits >

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

inline

◆ periodicDofMap()

template<class Scalar , class GV , class Traits >

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

inline

◆ periodicVertexMap()

template<class Scalar , class GV , class Traits >

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

inline

◆ setPeriodic()

template<class GV , class Traits >

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

inlineprotectedinherited

◆ update() [1/2]

template<class Scalar , class GV , class Traits >

void Dumux::BoxFVGridGeometry< Scalar, GV, true, Traits >::update ( const GridView & gridView )

inline

◆ update() [2/2]

template<class Scalar , class GV , class Traits >

void Dumux::BoxFVGridGeometry< Scalar, GV, true, Traits >::update ( GridView && gridView )

inline

◆ vertexMapper() [1/2]

template<class GV , class Traits >

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

inlineinherited

◆ vertexMapper() [2/2]

template<class GV , class Traits >

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

inlineinherited

Member Data Documentation

◆ discMethod

template<class Scalar , class GV , class Traits >

constexpr DiscretizationMethod Dumux::BoxFVGridGeometry< Scalar, GV, true, Traits >::discMethod {}

staticconstexpr

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

discretization/box/fvgridgeometry.hh

Description

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Member Typedef Documentation

◆ BasicGridGeometry

◆ Cache

◆ DiscretizationMethod

◆ DofMapper

◆ ElementMapper

◆ Extrusion

◆ FeCache

◆ GlobalCoordinate

◆ Grid

◆ GridView

◆ LocalView

◆ SubControlVolume

◆ SubControlVolumeFace

◆ VertexMapper

Constructor & Destructor Documentation

◆ BoxFVGridGeometry() [1/2]

◆ BoxFVGridGeometry() [2/2]

Member Function Documentation

◆ bBoxMax()

◆ bBoxMin()

◆ boundingBoxTree()

◆ dofMapper()

◆ dofOnBoundary()

◆ dofOnPeriodicBoundary()

◆ element()

◆ elementMap()

◆ elementMapper() [1/2]

◆ elementMapper() [2/2]

◆ feCache()

◆ gridView()

◆ isPeriodic()

◆ numBoundaryScvf()

◆ numDofs()

◆ numScv()

◆ numScvf()

◆ periodicallyMappedDof()

◆ periodicDofMap()

◆ periodicVertexMap()

◆ setPeriodic()

◆ update() [1/2]

◆ update() [2/2]

◆ vertexMapper() [1/2]

◆ vertexMapper() [2/2]

Member Data Documentation

◆ discMethod