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, T >:

Description

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

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	Traits = typename T::PublicTraits
	export the traits More...

using	DiscretizationMethod = DiscretizationMethods::Staggered
	export the discretization method this geometry belongs to More...

using	LocalView = typename T::template LocalView< ThisType, true >
	export the type of the fv element geometry (the local view type) More...

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

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

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

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

using	DofTypeIndices = typename T::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 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
	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 (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 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...

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 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 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 {}

static constexpr int	upwindSchemeOrder = T::upwindSchemeOrder

static constexpr bool	useHigherOrder = upwindSchemeOrder > 1

static constexpr bool	cachingEnabled = true

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

Member Typedef Documentation

◆ CellCenterFVGridGeometryType

template<class GV , class T >

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

◆ DiscretizationMethod

template<class GV , class T >

using Dumux::StaggeredFVGridGeometry< GV, true, T >::DiscretizationMethod = DiscretizationMethods::Staggered

export the discretization method this geometry belongs to

◆ DofTypeIndices

template<class GV , class T >

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

export the dof type indices

◆ ElementMapper

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

inherited

export the element mapper type

◆ Extrusion

template<class GV , class T >

using Dumux::StaggeredFVGridGeometry< GV, true, T >::Extrusion = Extrusion_t<T>

export the type of extrusion

◆ FaceFVGridGeometryType

template<class GV , class T >

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

◆ FVGridGeometryTuple

template<class GV , class T >

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

◆ GlobalCoordinate

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

inherited

export the global coordinate type

◆ Grid

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

inherited

export the grid type

◆ GridView

template<class GV , class T >

using Dumux::StaggeredFVGridGeometry< GV, true, T >::GridView = GV

export the grid view type

◆ LocalView

template<class GV , class T >

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

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

◆ SubControlVolume

template<class GV , class T >

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

export the type of sub control volume

◆ SubControlVolumeFace

template<class GV , class T >

using Dumux::StaggeredFVGridGeometry< GV, true, T >::SubControlVolumeFace = typename T::SubControlVolumeFace

export the type of sub control volume

◆ Traits

template<class GV , class T >

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

export the traits

◆ VertexMapper

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

inherited

export the vertex mapper type

Constructor & Destructor Documentation

◆ StaggeredFVGridGeometry()

template<class GV , class T >

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

inline

Constructor.

Member Function Documentation

◆ bBoxMax()

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

inlineinherited

The coordinate of the corner of the GridView's bounding box with the largest values.

◆ bBoxMin()

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

inlineinherited

The coordinate of the corner of the GridView's bounding box with the smallest values.

◆ boundingBoxTree()

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

inlineinherited

Returns the bounding box tree of the grid.

◆ cellCenterFVGridGeometry()

template<class GV , class T >

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

inline

Return a copy of the cell center specific auxiliary class.

◆ cellCenterFVGridGeometryPtr()

template<class GV , class T >

std::unique_ptr< CellCenterFVGridGeometry< ThisType > > Dumux::StaggeredFVGridGeometry< GV, true, T >::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 T >

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

inlinestaticconstexpr

return a integral constant for cell center dofs

◆ connectivityMap()

template<class GV , class T >

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

inline

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

◆ element()

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

inlineinherited

Get an element from a global element index.

◆ elementMap()

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

inlineinherited

Returns the element index to element map.

◆ elementMapper() [1/2]

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

inlineinherited

Returns the mapper for elements to indices for possibly adaptive grids.

◆ elementMapper() [2/2]

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

inlineinherited

Returns the mapper for elements to indices for constant grids.

◆ faceFVGridGeometry()

template<class GV , class T >

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

inline

Return a copy of the face specific auxiliary class.

◆ faceFVGridGeometryPtr()

template<class GV , class T >

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

inline

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

◆ faceIdx()

template<class GV , class T >

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

inlinestaticconstexpr

return a integral constant for face dofs

◆ gridView()

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

inlineinherited

Return the gridView this grid geometry object lives on.

◆ hasBoundaryScvf()

template<class GV , class T >

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

inline

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

◆ isPeriodic()

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

inlineinherited

Returns if the grid geometry is periodic (at all)

◆ localToGlobalScvfIndex()

template<class GV , class T >

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

inline

◆ numBoundaryScvf()

template<class GV , class T >

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

inline

The total number of boundary sub control volume faces.

◆ numCellCenterDofs()

template<class GV , class T >

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

inline

◆ numDofs()

template<class GV , class T >

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

inline

the total number of dofs

◆ numFaceDofs()

template<class GV , class T >

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

inline

◆ numIntersections()

template<class GV , class T >

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

inline

The total number of intersections.

◆ numScv()

template<class GV , class T >

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

inline

The total number of sub control volumes.

◆ numScvf()

template<class GV , class T >

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

inline

The total number of sub control volume faces.

◆ scv()

template<class GV , class T >

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

inline

Get a sub control volume with a global scv index.

◆ scvf() [1/2]

template<class GV , class T >

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

inline

◆ scvf() [2/2]

template<class GV , class T >

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

inline

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

◆ scvfIndicesOfScv()

template<class GV , class T >

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

inline

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

◆ setPeriodic()

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

inlineprotectedinherited

Set the periodicity of the grid geometry.

◆ update() [1/4]

void Dumux::BaseGridGeometry< GV, T >::update ( const GridView & gridView )

inlineinherited

Update all fvElementGeometries (call this after grid adaption)

◆ update() [2/4]

template<class GV , class T >

void Dumux::StaggeredFVGridGeometry< GV, true, T >::update ( const GridView & gridView )

inline

update all fvElementGeometries (call this after grid adaption)

◆ update() [3/4]

void Dumux::BaseGridGeometry< GV, T >::update ( GridView && gridView )

inlineinherited

Update all fvElementGeometries (call this after grid adaption)

◆ update() [4/4]

template<class GV , class T >

void Dumux::StaggeredFVGridGeometry< GV, true, T >::update ( GridView && gridView )

inline

update all fvElementGeometries (call this after grid adaption)

◆ upwindStencilOrder()

template<class GV , class T >

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

inlinestaticconstexpr

The order of the stencil built.

◆ vertexMapper() [1/2]

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

inlineinherited

Returns the mapper for vertices to indices for possibly adaptive grids.

◆ vertexMapper() [2/2]

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

inlineinherited

Returns the mapper for vertices to indices for constant grids.

Member Data Documentation

◆ cachingEnabled

template<class GV , class T >

constexpr bool Dumux::StaggeredFVGridGeometry< GV, true, T >::cachingEnabled = true

staticconstexpr

◆ discMethod

template<class GV , class T >

constexpr DiscretizationMethod Dumux::StaggeredFVGridGeometry< GV, true, T >::discMethod {}

staticconstexpr

◆ upwindSchemeOrder

template<class GV , class T >

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

staticconstexpr

◆ useHigherOrder

template<class GV , class T >

constexpr bool Dumux::StaggeredFVGridGeometry< GV, true, T >::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

Protected Member Functions

Member Typedef Documentation

◆ CellCenterFVGridGeometryType

◆ DiscretizationMethod

◆ DofTypeIndices

◆ ElementMapper

◆ Extrusion

◆ FaceFVGridGeometryType

◆ FVGridGeometryTuple

◆ GlobalCoordinate

◆ Grid

◆ GridView

◆ LocalView

◆ SubControlVolume

◆ SubControlVolumeFace

◆ Traits

◆ VertexMapper

Constructor & Destructor Documentation

◆ StaggeredFVGridGeometry()

Member Function Documentation

◆ bBoxMax()

◆ bBoxMin()

◆ boundingBoxTree()

◆ cellCenterFVGridGeometry()

◆ cellCenterFVGridGeometryPtr()

◆ cellCenterIdx()

◆ connectivityMap()

◆ element()

◆ 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() [1/4]

◆ update() [2/4]

◆ update() [3/4]

◆ update() [4/4]

◆ upwindStencilOrder()

◆ vertexMapper() [1/2]

◆ vertexMapper() [2/2]

Member Data Documentation

◆ cachingEnabled

◆ discMethod

◆ upwindSchemeOrder

◆ useHigherOrder