version 3.9-dev
Dumux::CCTpfaFVGridGeometry< GV, false, 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, false, Traits >:

Description

template<class GV, class Traits>
class Dumux::CCTpfaFVGridGeometry< GV, false, Traits >
Note
For caching disabled we store only some essential index maps to build up local systems on-demand in the corresponding FVElementGeometry

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, 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 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 type of the grid view. 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 std::vector< GridIndexType > & scvfIndicesOfScv (GridIndexType scvIdx) const
 
const std::vector< NeighborVolVarIndices > & neighborVolVarIndices (GridIndexType scvIdx) const
 Return the neighbor volVar indices for all scvfs in the scv with index scvIdx. More...
 
const ConnectivityMap & connectivityMap () const
 Returns the connectivity map of which dofs have derivatives with respect to a given dof. 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, false, Traits >::BasicGridGeometry = BasicGridGeometry_t<GV, Traits>

◆ DiscretizationMethod

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

◆ DofMapper

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

◆ ElementMapper

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

◆ Extrusion

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

◆ 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 GV , class Traits >
using Dumux::CCTpfaFVGridGeometry< GV, false, Traits >::GridView = GV

◆ LocalView

template<class GV , class Traits >
using Dumux::CCTpfaFVGridGeometry< GV, false, Traits >::LocalView = typename Traits::template LocalView<ThisType, false>

◆ SubControlVolume

template<class GV , class Traits >
using Dumux::CCTpfaFVGridGeometry< GV, false, Traits >::SubControlVolume = typename Traits::SubControlVolume

◆ SubControlVolumeFace

template<class GV , class Traits >
using Dumux::CCTpfaFVGridGeometry< GV, false, Traits >::SubControlVolumeFace = typename Traits::SubControlVolumeFace

◆ VertexMapper

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

Constructor & Destructor Documentation

◆ CCTpfaFVGridGeometry() [1/2]

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

◆ CCTpfaFVGridGeometry() [2/2]

template<class GV , class Traits >
Dumux::CCTpfaFVGridGeometry< GV, false, Traits >::CCTpfaFVGridGeometry ( 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

◆ connectivityMap()

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

◆ dofMapper()

template<class GV , class Traits >
const DofMapper & Dumux::CCTpfaFVGridGeometry< GV, false, 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

◆ 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

◆ 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

◆ neighborVolVarIndices()

template<class GV , class Traits >
const std::vector< NeighborVolVarIndices > & Dumux::CCTpfaFVGridGeometry< GV, false, Traits >::neighborVolVarIndices ( GridIndexType  scvIdx) const
inline

◆ numBoundaryScvf()

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

◆ numDofs()

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

◆ numScv()

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

◆ numScvf()

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

◆ scvfIndicesOfScv()

template<class GV , class Traits >
const std::vector< GridIndexType > & Dumux::CCTpfaFVGridGeometry< GV, false, Traits >::scvfIndicesOfScv ( GridIndexType  scvIdx) const
inline

◆ setPeriodic()

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

◆ update() [1/2]

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

◆ update() [2/2]

template<class GV , class Traits >
void Dumux::CCTpfaFVGridGeometry< GV, false, 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 GV , class Traits >
constexpr DiscretizationMethod Dumux::CCTpfaFVGridGeometry< GV, false, Traits >::discMethod {}
staticconstexpr

◆ maxElementStencilSize

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

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