version 3.11-dev
Classes | Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | List of all members
Dumux::FaceCenteredDiamondFVGridGeometry< GV, enableCaching, Traits > Class Template Reference
Discretization schemes » Control-volume Finite Element Methods » Diamond discretization scheme

Grid geometry for the diamond discretization.

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

Inheritance diagram for Dumux::FaceCenteredDiamondFVGridGeometry< GV, enableCaching, Traits >:

Public Types

using DiscretizationMethod = DiscretizationMethods::FCDiamond
 export discretization method 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 GridView = GV
 export the grid view type More...
 
using DofMapper = typename Traits::DofMapper
 export the dof mapper type More...
 
using Extrusion = Extrusion_t< Traits >
 export the type of extrusion More...
 
using FeCache = NonconformingFECache< Scalar, Scalar, dim >
 export the finite element cache type More...
 
using SupportsPeriodicity = typename PeriodicGridTraits< typename GV::Grid >::SupportsPeriodicity
 export whether the grid(geometry) supports periodicity More...
 
using Cache = FCDiamondGridGeometryCache
 
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

 FaceCenteredDiamondFVGridGeometry (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 numDofs () const
 the total number of dofs 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 FeCache & feCache () const
 The finite element cache for creating local FE bases. More...
 
bool dofOnBoundary (GridIndexType dofIdx) const
 If a face / d.o.f. is on the boundary. More...
 
const DofMapper & dofMapper () const
 Return a reference to the dof mapper. 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 > & periodicDofMap () const
 Returns the map between dofs across periodic boundaries. 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 Attributes

static constexpr DiscretizationMethod discMethod = DiscretizationMethod{}
 
static constexpr bool cachingEnabled = true
 

Protected Member Functions

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

Member Typedef Documentation

◆ Cache

template<class GV , bool enableCaching = true, class Traits = FaceCenteredDiamondDefaultGridGeometryTraits<GV>>
using Dumux::FaceCenteredDiamondFVGridGeometry< GV, enableCaching, Traits >::Cache = FCDiamondGridGeometryCache

the cache type (only the caching implementation has this) this alias should only be used by the local view implementation

◆ DiscretizationMethod

template<class GV , bool enableCaching = true, class Traits = FaceCenteredDiamondDefaultGridGeometryTraits<GV>>
using Dumux::FaceCenteredDiamondFVGridGeometry< GV, enableCaching, Traits >::DiscretizationMethod = DiscretizationMethods::FCDiamond

◆ DofMapper

template<class GV , bool enableCaching = true, class Traits = FaceCenteredDiamondDefaultGridGeometryTraits<GV>>
using Dumux::FaceCenteredDiamondFVGridGeometry< GV, enableCaching, Traits >::DofMapper = typename Traits::DofMapper

◆ ElementMapper

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

◆ Extrusion

template<class GV , bool enableCaching = true, class Traits = FaceCenteredDiamondDefaultGridGeometryTraits<GV>>
using Dumux::FaceCenteredDiamondFVGridGeometry< GV, enableCaching, Traits >::Extrusion = Extrusion_t<Traits>

◆ FeCache

template<class GV , bool enableCaching = true, class Traits = FaceCenteredDiamondDefaultGridGeometryTraits<GV>>
using Dumux::FaceCenteredDiamondFVGridGeometry< GV, enableCaching, Traits >::FeCache = NonconformingFECache<Scalar, Scalar, dim>

◆ GlobalCoordinate

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

◆ Grid

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

◆ GridView

template<class GV , bool enableCaching = true, class Traits = FaceCenteredDiamondDefaultGridGeometryTraits<GV>>
using Dumux::FaceCenteredDiamondFVGridGeometry< GV, enableCaching, Traits >::GridView = GV

◆ LocalView

template<class GV , bool enableCaching = true, class Traits = FaceCenteredDiamondDefaultGridGeometryTraits<GV>>
using Dumux::FaceCenteredDiamondFVGridGeometry< GV, enableCaching, Traits >::LocalView = typename Traits::template LocalView<ThisType, true>

◆ SubControlVolume

template<class GV , bool enableCaching = true, class Traits = FaceCenteredDiamondDefaultGridGeometryTraits<GV>>
using Dumux::FaceCenteredDiamondFVGridGeometry< GV, enableCaching, Traits >::SubControlVolume = typename Traits::SubControlVolume

◆ SubControlVolumeFace

template<class GV , bool enableCaching = true, class Traits = FaceCenteredDiamondDefaultGridGeometryTraits<GV>>
using Dumux::FaceCenteredDiamondFVGridGeometry< GV, enableCaching, Traits >::SubControlVolumeFace = typename Traits::SubControlVolumeFace

◆ SupportsPeriodicity

template<class GV , bool enableCaching = true, class Traits = FaceCenteredDiamondDefaultGridGeometryTraits<GV>>
using Dumux::FaceCenteredDiamondFVGridGeometry< GV, enableCaching, Traits >::SupportsPeriodicity = typename PeriodicGridTraits<typename GV::Grid>::SupportsPeriodicity

◆ VertexMapper

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

Constructor & Destructor Documentation

◆ FaceCenteredDiamondFVGridGeometry()

template<class GV , bool enableCaching = true, class Traits = FaceCenteredDiamondDefaultGridGeometryTraits<GV>>
Dumux::FaceCenteredDiamondFVGridGeometry< GV, enableCaching, Traits >::FaceCenteredDiamondFVGridGeometry ( const GridView &  gridView,
const std::string &  paramGroup = "" 
)
inline

Member Function Documentation

◆ bBoxMax()

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

◆ bBoxMin()

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

◆ boundingBoxTree()

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

◆ dofMapper()

template<class GV , bool enableCaching = true, class Traits = FaceCenteredDiamondDefaultGridGeometryTraits<GV>>
const DofMapper & Dumux::FaceCenteredDiamondFVGridGeometry< GV, enableCaching, Traits >::dofMapper ( ) const
inline

◆ dofOnBoundary()

template<class GV , bool enableCaching = true, class Traits = FaceCenteredDiamondDefaultGridGeometryTraits<GV>>
bool Dumux::FaceCenteredDiamondFVGridGeometry< GV, enableCaching, Traits >::dofOnBoundary ( GridIndexType  dofIdx) const
inline

◆ dofOnPeriodicBoundary()

template<class GV , bool enableCaching = true, class Traits = FaceCenteredDiamondDefaultGridGeometryTraits<GV>>
bool Dumux::FaceCenteredDiamondFVGridGeometry< GV, enableCaching, Traits >::dofOnPeriodicBoundary ( GridIndexType  dofIdx) const
inline

◆ element()

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

◆ elementMap()

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

◆ elementMapper() [1/2]

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

◆ elementMapper() [2/2]

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

◆ feCache()

template<class GV , bool enableCaching = true, class Traits = FaceCenteredDiamondDefaultGridGeometryTraits<GV>>
const FeCache & Dumux::FaceCenteredDiamondFVGridGeometry< GV, enableCaching, Traits >::feCache ( ) const
inline

◆ gridView()

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

◆ isPeriodic()

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

◆ numBoundaryScvf()

template<class GV , bool enableCaching = true, class Traits = FaceCenteredDiamondDefaultGridGeometryTraits<GV>>
std::size_t Dumux::FaceCenteredDiamondFVGridGeometry< GV, enableCaching, Traits >::numBoundaryScvf ( ) const
inline

◆ numDofs()

template<class GV , bool enableCaching = true, class Traits = FaceCenteredDiamondDefaultGridGeometryTraits<GV>>
std::size_t Dumux::FaceCenteredDiamondFVGridGeometry< GV, enableCaching, Traits >::numDofs ( ) const
inline

◆ numScv()

template<class GV , bool enableCaching = true, class Traits = FaceCenteredDiamondDefaultGridGeometryTraits<GV>>
std::size_t Dumux::FaceCenteredDiamondFVGridGeometry< GV, enableCaching, Traits >::numScv ( ) const
inline

◆ numScvf()

template<class GV , bool enableCaching = true, class Traits = FaceCenteredDiamondDefaultGridGeometryTraits<GV>>
std::size_t Dumux::FaceCenteredDiamondFVGridGeometry< GV, enableCaching, Traits >::numScvf ( ) const
inline

◆ periodicallyMappedDof()

template<class GV , bool enableCaching = true, class Traits = FaceCenteredDiamondDefaultGridGeometryTraits<GV>>
GridIndexType Dumux::FaceCenteredDiamondFVGridGeometry< GV, enableCaching, Traits >::periodicallyMappedDof ( GridIndexType  dofIdx) const
inline

◆ periodicDofMap()

template<class GV , bool enableCaching = true, class Traits = FaceCenteredDiamondDefaultGridGeometryTraits<GV>>
const std::unordered_map< GridIndexType, GridIndexType > & Dumux::FaceCenteredDiamondFVGridGeometry< GV, enableCaching, Traits >::periodicDofMap ( ) const
inline

◆ setPeriodic()

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

◆ update() [1/4]

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

◆ update() [2/4]

template<class GV , bool enableCaching = true, class Traits = FaceCenteredDiamondDefaultGridGeometryTraits<GV>>
void Dumux::FaceCenteredDiamondFVGridGeometry< GV, enableCaching, Traits >::update ( const GridView &  gridView)
inline

◆ update() [3/4]

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

◆ update() [4/4]

template<class GV , bool enableCaching = true, class Traits = FaceCenteredDiamondDefaultGridGeometryTraits<GV>>
void Dumux::FaceCenteredDiamondFVGridGeometry< GV, enableCaching, Traits >::update ( GridView &&  gridView)
inline

◆ vertexMapper() [1/2]

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

◆ vertexMapper() [2/2]

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

Member Data Documentation

◆ cachingEnabled

template<class GV , bool enableCaching = true, class Traits = FaceCenteredDiamondDefaultGridGeometryTraits<GV>>
constexpr bool Dumux::FaceCenteredDiamondFVGridGeometry< GV, enableCaching, Traits >::cachingEnabled = true
staticconstexpr

◆ discMethod

template<class GV , bool enableCaching = true, class Traits = FaceCenteredDiamondDefaultGridGeometryTraits<GV>>
constexpr DiscretizationMethod Dumux::FaceCenteredDiamondFVGridGeometry< GV, enableCaching, Traits >::discMethod = DiscretizationMethod{}
staticconstexpr
The documentation for this class was generated from the following file: