Base class for the finite volume geometry vector for face-centered staggered models This builds up the sub control volumes and sub control volume faces for each element. Specialization in case the FVElementGeometries are stored. More...

#include <dumux/discretization/facecentered/staggered/fvgridgeometry.hh>

Inheritance diagram for Dumux::FaceCenteredStaggeredFVGridGeometry< GV, false, Traits >:

Description

template<class GV, class Traits>
class Dumux::FaceCenteredStaggeredFVGridGeometry< GV, false, Traits >

Base class for the finite volume geometry vector for face-centered staggered models This builds up the sub control volumes and sub control volume faces for each element. Specialization in case the FVElementGeometries are stored.

Public Types
using	DiscretizationMethod = DiscretizationMethods::FCStaggered
	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, 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	GridView = GV
	export the grid view type More...

using	GeometryHelper = typename Traits::GeometryHelper
	export the geometry helper type More...

using	LocalIntersectionMapper = typename Traits::LocalIntersectionMapper
	export the local intersection mapper More...

using	StaticInformation = typename Traits::StaticInfo
	export static information More...

using	Extrusion = Extrusion_t< Traits >
	export the type of extrusion More...

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
	FaceCenteredStaggeredFVGridGeometry (std::shared_ptr< BasicGridGeometry > gg, const std::string &paramGroup="")
	Constructor with basic grid geometry used to share state with another grid geometry on the same grid view. More...

	FaceCenteredStaggeredFVGridGeometry (const GridView &gridView, const std::string &paramGroup="")
	Constructor from gridView. More...

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

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

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

std::size_t	numBoundaryScvf () const
	The total number of boundary sub control volume faces. More...

std::size_t	numIntersections () const
	The total number of intersections. More...

std::size_t	numDofs () const
	the total number of dofs More...

const ConnectivityMap &	connectivityMap () const
	Returns the connectivity map of which dofs have derivatives with respect to a given dof. More...

bool	hasBoundaryScvf (GridIndexType eIdx) const
	Returns whether one of the geometry's scvfs lies on a boundary. More...

const IntersectionMapper &	intersectionMapper () const
	Return a reference to the intersection mapper. More...

const std::vector< GridIndexType > &	scvfIndicesOfElement (GridIndexType eIdx) const
	Get the global sub control volume face indices of an element. More...

GridIndexType	outsideVolVarIndex (GridIndexType scvfIdx) const
	Get the global sub control volume face indices of an element. 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...

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

GridIndexType	periodicallyMappedDof (GridIndexType dofIdx) const
	The index of the 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 // TODO rename to periodic dof map in fvassembler. 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 {}

static constexpr bool	cachingEnabled = false

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