Base class for the finite volume geometry vector for 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/staggered/fvgridgeometry.hh>

Inheritance diagram for Dumux::StaggeredFVGridGeometry< GV, true, Traits >:

Description

template<class GV, class Traits>
class Dumux::StaggeredFVGridGeometry< GV, true, Traits >

Base class for the finite volume geometry vector for 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	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	GridView = GV
	export the grid view type More...

using	DofTypeIndices = typename Traits::DofTypeIndices
	export the dof type indices More...

using	CellCenterFVGridGeometryType = CellCenterFVGridGeometry< ThisType >

using	FaceFVGridGeometryType = FaceFVGridGeometry< ThisType >

using	FVGridGeometryTuple = std::tuple< CellCenterFVGridGeometry< ThisType >, FaceFVGridGeometry< ThisType > >

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
	StaggeredFVGridGeometry (const GridView &gridView, const std::string &paramGroup="")
	Constructor. 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	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...

std::size_t	numCellCenterDofs () const

std::size_t	numFaceDofs () const

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

const SubControlVolume &	scv (GridIndexType scvIdx) const
	Get a sub control volume with a global scv index. More...

const SubControlVolumeFace &	scvf (GridIndexType scvfIdx) const
	Get a sub control volume face with a global scvf index. More...

const std::vector< GridIndexType > &	scvfIndicesOfScv (GridIndexType scvIdx) const
	Get the sub control volume face indices of an scv by global index. More...

GridIndexType	localToGlobalScvfIndex (GridIndexType eIdx, LocalIndexType localScvfIdx) const

const SubControlVolumeFace &	scvf (GridIndexType eIdx, LocalIndexType localScvfIdx) const

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

std::unique_ptr< CellCenterFVGridGeometry< ThisType > >	cellCenterFVGridGeometryPtr () const
	Returns a pointer the cell center specific auxiliary class. Required for the multi-domain FVAssembler's ctor. More...

std::unique_ptr< FaceFVGridGeometry< ThisType > >	faceFVGridGeometryPtr () const
	Returns a pointer the face specific auxiliary class. Required for the multi-domain FVAssembler's ctor. More...

CellCenterFVGridGeometry< ThisType >	cellCenterFVGridGeometry () const
	Return a copy of the cell center specific auxiliary class. More...

FaceFVGridGeometry< ThisType >	faceFVGridGeometry () const
	Return a copy of the face specific auxiliary class. More...

bool	hasBoundaryScvf (GridIndexType eIdx) const
	Returns whether one of the geometry's scvfs lies on a boundary. 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 Member Functions
static constexpr auto	cellCenterIdx ()
	return a integral constant for cell center dofs More...

static constexpr auto	faceIdx ()
	return a integral constant for face dofs More...

static constexpr int	upwindStencilOrder ()
	The order of the stencil built. More...

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

static constexpr int	upwindSchemeOrder = Traits::upwindSchemeOrder

static constexpr bool	useHigherOrder = upwindSchemeOrder > 1

Member Typedef Documentation

◆ CellCenterFVGridGeometryType

template<class GV , class Traits >

using Dumux::StaggeredFVGridGeometry< GV, true, Traits >::CellCenterFVGridGeometryType = CellCenterFVGridGeometry<ThisType>

◆ DofTypeIndices

template<class GV , class Traits >

using Dumux::StaggeredFVGridGeometry< GV, true, Traits >::DofTypeIndices = typename Traits::DofTypeIndices

export the dof type indices

◆ ElementMapper

template<class GV , class Traits >

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

inherited

export the element mapper type

◆ FaceFVGridGeometryType

template<class GV , class Traits >

using Dumux::StaggeredFVGridGeometry< GV, true, Traits >::FaceFVGridGeometryType = FaceFVGridGeometry<ThisType>

◆ FVGridGeometryTuple

template<class GV , class Traits >

using Dumux::StaggeredFVGridGeometry< GV, true, Traits >::FVGridGeometryTuple = std::tuple< CellCenterFVGridGeometry<ThisType>, FaceFVGridGeometry<ThisType> >

◆ 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::StaggeredFVGridGeometry< GV, true, Traits >::GridView = GV

export the grid view type

◆ LocalView

template<class GV , class Traits >

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

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

◆ SubControlVolume

template<class GV , class Traits >

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

export the type of sub control volume

◆ SubControlVolumeFace

template<class GV , class Traits >

using Dumux::StaggeredFVGridGeometry< GV, true, 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

◆ StaggeredFVGridGeometry()

template<class GV , class Traits >

Dumux::StaggeredFVGridGeometry< GV, true, Traits >::StaggeredFVGridGeometry	(	const GridView &	gridView,
		const std::string &	paramGroup = `""`
	)

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.

◆ cellCenterFVGridGeometry()

template<class GV , class Traits >

CellCenterFVGridGeometry< ThisType > Dumux::StaggeredFVGridGeometry< GV, true, Traits >::cellCenterFVGridGeometry ( ) const

inline

Return a copy of the cell center specific auxiliary class.

◆ cellCenterFVGridGeometryPtr()

template<class GV , class Traits >

std::unique_ptr< CellCenterFVGridGeometry< ThisType > > Dumux::StaggeredFVGridGeometry< GV, true, Traits >::cellCenterFVGridGeometryPtr ( ) const

inline

Returns a pointer the cell center specific auxiliary class. Required for the multi-domain FVAssembler's ctor.

◆ cellCenterIdx()

template<class GV , class Traits >

static constexpr auto Dumux::StaggeredFVGridGeometry< GV, true, Traits >::cellCenterIdx ( )

inlinestaticconstexpr

return a integral constant for cell center dofs

◆ connectivityMap()

template<class GV , class Traits >

const ConnectivityMap & Dumux::StaggeredFVGridGeometry< GV, true, Traits >::connectivityMap ( ) const

inline

Returns the connectivity map of which dofs have derivatives with respect to a given dof.

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

◆ faceFVGridGeometry()

template<class GV , class Traits >

FaceFVGridGeometry< ThisType > Dumux::StaggeredFVGridGeometry< GV, true, Traits >::faceFVGridGeometry ( ) const

inline

Return a copy of the face specific auxiliary class.

◆ faceFVGridGeometryPtr()

template<class GV , class Traits >

std::unique_ptr< FaceFVGridGeometry< ThisType > > Dumux::StaggeredFVGridGeometry< GV, true, Traits >::faceFVGridGeometryPtr ( ) const

inline

Returns a pointer the face specific auxiliary class. Required for the multi-domain FVAssembler's ctor.

◆ faceIdx()

template<class GV , class Traits >

static constexpr auto Dumux::StaggeredFVGridGeometry< GV, true, Traits >::faceIdx ( )

inlinestaticconstexpr

return a integral constant for face dofs

◆ gridView()

template<class GV , class Traits >

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

inlineinherited

Return the gridView this grid geometry object lives on.

◆ hasBoundaryScvf()

template<class GV , class Traits >

bool Dumux::StaggeredFVGridGeometry< GV, true, Traits >::hasBoundaryScvf ( GridIndexType eIdx ) const

inline

Returns whether one of the geometry's scvfs lies on a boundary.

◆ isPeriodic()

template<class GV , class Traits >

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

inlineinherited

Returns if the grid geometry is periodic (at all)

◆ localToGlobalScvfIndex()

template<class GV , class Traits >

GridIndexType Dumux::StaggeredFVGridGeometry< GV, true, Traits >::localToGlobalScvfIndex	(	GridIndexType	eIdx,
		LocalIndexType	localScvfIdx
	)		const

inline

◆ numBoundaryScvf()

template<class GV , class Traits >

std::size_t Dumux::StaggeredFVGridGeometry< GV, true, Traits >::numBoundaryScvf ( ) const

inline

The total number of boundary sub control volume faces.

◆ numCellCenterDofs()

template<class GV , class Traits >

std::size_t Dumux::StaggeredFVGridGeometry< GV, true, Traits >::numCellCenterDofs ( ) const

inline

◆ numDofs()

template<class GV , class Traits >

std::size_t Dumux::StaggeredFVGridGeometry< GV, true, Traits >::numDofs ( ) const

inline

the total number of dofs

◆ numFaceDofs()

template<class GV , class Traits >

std::size_t Dumux::StaggeredFVGridGeometry< GV, true, Traits >::numFaceDofs ( ) const

inline

◆ numIntersections()

template<class GV , class Traits >

std::size_t Dumux::StaggeredFVGridGeometry< GV, true, Traits >::numIntersections ( ) const

inline

The total number of intersections.

◆ numScv()

template<class GV , class Traits >

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

inline

The total number of sub control volumes.

◆ numScvf()

template<class GV , class Traits >

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

inline

The total number of sub control volume faces.

◆ scv()

template<class GV , class Traits >

const SubControlVolume & Dumux::StaggeredFVGridGeometry< GV, true, Traits >::scv ( GridIndexType scvIdx ) const

inline

Get a sub control volume with a global scv index.

◆ scvf() [1/2]

template<class GV , class Traits >

const SubControlVolumeFace & Dumux::StaggeredFVGridGeometry< GV, true, Traits >::scvf	(	GridIndexType	eIdx,
		LocalIndexType	localScvfIdx
	)		const

inline

◆ scvf() [2/2]

template<class GV , class Traits >

const SubControlVolumeFace & Dumux::StaggeredFVGridGeometry< GV, true, Traits >::scvf ( GridIndexType scvfIdx ) const

inline

Get a sub control volume face with a global scvf index.

◆ scvfIndicesOfScv()

template<class GV , class Traits >

const std::vector< GridIndexType > & Dumux::StaggeredFVGridGeometry< GV, true, Traits >::scvfIndicesOfScv ( GridIndexType scvIdx ) const

inline

Get the sub control volume face indices of an scv by global index.

◆ 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::StaggeredFVGridGeometry< GV, true, Traits >::update ( )

inline

update all fvElementGeometries (do this again after grid adaption)

◆ upwindStencilOrder()

template<class GV , class Traits >

static constexpr int Dumux::StaggeredFVGridGeometry< GV, true, Traits >::upwindStencilOrder ( )

inlinestaticconstexpr

The order of the stencil built.

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

constexpr DiscretizationMethod Dumux::StaggeredFVGridGeometry< GV, true, Traits >::discMethod = DiscretizationMethod::staggered

staticconstexpr

export discretization method

◆ upwindSchemeOrder

template<class GV , class Traits >

constexpr int Dumux::StaggeredFVGridGeometry< GV, true, Traits >::upwindSchemeOrder = Traits::upwindSchemeOrder

staticconstexpr

◆ useHigherOrder

template<class GV , class Traits >

constexpr bool Dumux::StaggeredFVGridGeometry< GV, true, Traits >::useHigherOrder = upwindSchemeOrder > 1

staticconstexpr

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

discretization/staggered/fvgridgeometry.hh

Description

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Member Typedef Documentation

◆ CellCenterFVGridGeometryType

◆ DofTypeIndices

◆ ElementMapper

◆ FaceFVGridGeometryType

◆ FVGridGeometryTuple

◆ GlobalCoordinate

◆ Grid

◆ GridView

◆ LocalView

◆ SubControlVolume

◆ SubControlVolumeFace

◆ VertexMapper

Constructor & Destructor Documentation

◆ StaggeredFVGridGeometry()

Member Function Documentation

◆ bBoxMax()

◆ bBoxMin()

◆ boundingBoxTree()

◆ cellCenterFVGridGeometry()

◆ cellCenterFVGridGeometryPtr()

◆ cellCenterIdx()

◆ connectivityMap()

◆ element() [1/2]

◆ element() [2/2]

◆ elementMap()

◆ elementMapper() [1/2]

◆ elementMapper() [2/2]

◆ faceFVGridGeometry()

◆ faceFVGridGeometryPtr()

◆ faceIdx()

◆ gridView()

◆ hasBoundaryScvf()

◆ isPeriodic()

◆ localToGlobalScvfIndex()

◆ numBoundaryScvf()

◆ numCellCenterDofs()

◆ numDofs()

◆ numFaceDofs()

◆ numIntersections()

◆ numScv()

◆ numScvf()

◆ scv()

◆ scvf() [1/2]

◆ scvf() [2/2]

◆ scvfIndicesOfScv()

◆ setPeriodic()

◆ update()

◆ upwindStencilOrder()

◆ vertexMapper() [1/2]

◆ vertexMapper() [2/2]

Member Data Documentation

◆ discMethod

◆ upwindSchemeOrder

◆ useHigherOrder