3.6-git
DUNE for Multi-{Phase, Component, Scale, Physics, ...} flow and transport in porous media
Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | List of all members
Dumux::CCTpfaFVGridGeometry< GV, true, Traits > Class Template Reference

The finite volume geometry (scvs and scvfs) for cell-centered TPFA models on a grid view This builds up the sub control volumes and sub control volume faces. More...

#include <dumux/discretization/cellcentered/tpfa/fvgridgeometry.hh>

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

Description

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

The finite volume geometry (scvs and scvfs) for cell-centered TPFA models on a grid view This builds up the sub control volumes and sub control volume faces.

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

Public Types

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::ElementMapper
 export dof mapper type More...
 
using DiscretizationMethod = DiscretizationMethods::CCTpfa
 export the discretization method this geometry belongs to More...
 
using GridView = GV
 export the grid view type 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

 CCTpfaFVGridGeometry (std::shared_ptr< BasicGridGeometry > gg)
 Constructor with basic grid geometry used to share state with another grid geometry on the same grid view. More...
 
 CCTpfaFVGridGeometry (const GridView &gridView)
 Constructor from gridView. More...
 
const DofMapperdofMapper () const
 
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 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 SubControlVolumescv (GridIndexType scvIdx) const
 Get a sub control volume with a global scv index. More...
 
const SubControlVolumeFacescvf (GridIndexType scvfIdx) const
 Get a sub control volume face with a global scvf index. More...
 
const SubControlVolumeFaceflipScvf (GridIndexType scvfIdx, unsigned int outsideScvfIdx=0) const
 
const std::vector< GridIndexType > & scvfIndicesOfScv (GridIndexType scvIdx) const
 Get the sub control volume face indices of an scv by global index. 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 GridViewgridView () const
 Return the gridView this grid geometry object lives on. More...
 
const VertexMappervertexMapper () const
 Returns the mapper for vertices to indices for constant grids. More...
 
VertexMappervertexMapper ()
 Returns the mapper for vertices to indices for possibly adaptive grids. More...
 
const ElementMapperelementMapper () const
 Returns the mapper for elements to indices for constant grids. More...
 
ElementMapperelementMapper ()
 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 GlobalCoordinatebBoxMin () const
 The coordinate of the corner of the GridView's bounding box with the smallest values. More...
 
const GlobalCoordinatebBoxMax () 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 int maxElementStencilSize = LocalView::maxNumElementScvfs*Traits::maxNumScvfNeighbors + 1
 The maximum admissible stencil size (used for static memory allocation during assembly) More...
 

Protected Member Functions

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

Member Typedef Documentation

◆ BasicGridGeometry

template<class GV , class Traits >
using Dumux::CCTpfaFVGridGeometry< GV, true, Traits >::BasicGridGeometry = BasicGridGeometry_t<GV, Traits>

export basic grid geometry type for the alternative constructor

◆ DiscretizationMethod

template<class GV , class Traits >
using Dumux::CCTpfaFVGridGeometry< GV, true, Traits >::DiscretizationMethod = DiscretizationMethods::CCTpfa

export the discretization method this geometry belongs to

◆ DofMapper

template<class GV , class Traits >
using Dumux::CCTpfaFVGridGeometry< GV, true, Traits >::DofMapper = typename Traits::ElementMapper

export dof mapper type

◆ ElementMapper

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

export the element mapper type

◆ Extrusion

template<class GV , class Traits >
using Dumux::CCTpfaFVGridGeometry< GV, true, Traits >::Extrusion = Extrusion_t<Traits>

export the type of extrusion

◆ GlobalCoordinate

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

export the global coordinate type

◆ Grid

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

export the grid type

◆ GridView

template<class GV , class Traits >
using Dumux::CCTpfaFVGridGeometry< GV, true, Traits >::GridView = GV

export the grid view type

◆ LocalView

template<class GV , class Traits >
using Dumux::CCTpfaFVGridGeometry< 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::CCTpfaFVGridGeometry< GV, true, Traits >::SubControlVolume = typename Traits::SubControlVolume

export the type of sub control volume

◆ SubControlVolumeFace

template<class GV , class Traits >
using Dumux::CCTpfaFVGridGeometry< 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 BaseImplementation::VertexMapper
inherited

export the vertex mapper type

Constructor & Destructor Documentation

◆ CCTpfaFVGridGeometry() [1/2]

template<class GV , class Traits >
Dumux::CCTpfaFVGridGeometry< GV, true, Traits >::CCTpfaFVGridGeometry ( std::shared_ptr< BasicGridGeometry gg)
inline

Constructor with basic grid geometry used to share state with another grid geometry on the same grid view.

◆ CCTpfaFVGridGeometry() [2/2]

template<class GV , class Traits >
Dumux::CCTpfaFVGridGeometry< GV, true, Traits >::CCTpfaFVGridGeometry ( const GridView gridView)
inline

Constructor from gridView.

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 >
decltype(auto) Dumux::BaseGridGeometry< GV, Traits >::boundingBoxTree ( ) const
inlineinherited

Returns the bounding box tree of the grid.

◆ connectivityMap()

template<class GV , class Traits >
const ConnectivityMap & Dumux::CCTpfaFVGridGeometry< GV, true, Traits >::connectivityMap ( ) const
inline

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

◆ dofMapper()

template<class GV , class Traits >
const DofMapper & Dumux::CCTpfaFVGridGeometry< GV, true, Traits >::dofMapper ( ) const
inline

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

◆ element()

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 >
decltype(auto) 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.

◆ flipScvf()

template<class GV , class Traits >
const SubControlVolumeFace & Dumux::CCTpfaFVGridGeometry< GV, true, Traits >::flipScvf ( GridIndexType  scvfIdx,
unsigned int  outsideScvfIdx = 0 
) const
inline

Get the scvf on the same face but from the other side Note that e.g. the normals might be different in the case of surface grids

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

◆ numBoundaryScvf()

template<class GV , class Traits >
std::size_t Dumux::CCTpfaFVGridGeometry< GV, true, Traits >::numBoundaryScvf ( ) const
inline

The total number of boundary sub control volume faces.

◆ numDofs()

template<class GV , class Traits >
std::size_t Dumux::CCTpfaFVGridGeometry< GV, true, Traits >::numDofs ( ) const
inline

The total number of degrees of freedom.

◆ numScv()

template<class GV , class Traits >
std::size_t Dumux::CCTpfaFVGridGeometry< GV, true, Traits >::numScv ( ) const
inline

The total number of sub control volumes.

◆ numScvf()

template<class GV , class Traits >
std::size_t Dumux::CCTpfaFVGridGeometry< GV, true, Traits >::numScvf ( ) const
inline

The total number of sub control volume faces.

◆ scv()

template<class GV , class Traits >
const SubControlVolume & Dumux::CCTpfaFVGridGeometry< GV, true, Traits >::scv ( GridIndexType  scvIdx) const
inline

Get a sub control volume with a global scv index.

◆ scvf()

template<class GV , class Traits >
const SubControlVolumeFace & Dumux::CCTpfaFVGridGeometry< 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::CCTpfaFVGridGeometry< 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)
inlineprotectedinherited

Set the periodicity of the grid geometry.

◆ update() [1/2]

template<class GV , class Traits >
void Dumux::CCTpfaFVGridGeometry< GV, true, Traits >::update ( const GridView gridView)
inline

update all fvElementGeometries (call this after grid adaption)

◆ update() [2/2]

template<class GV , class Traits >
void Dumux::CCTpfaFVGridGeometry< GV, true, Traits >::update ( GridView &&  gridView)
inline

update all fvElementGeometries (call this 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 GV , class Traits >
constexpr DiscretizationMethod Dumux::CCTpfaFVGridGeometry< GV, true, Traits >::discMethod {}
staticconstexpr

◆ maxElementStencilSize

template<class GV , class Traits >
constexpr int Dumux::CCTpfaFVGridGeometry< GV, true, Traits >::maxElementStencilSize = LocalView::maxNumElementScvfs*Traits::maxNumScvfNeighbors + 1
staticconstexpr

The maximum admissible stencil size (used for static memory allocation during assembly)


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