version 3.8
Dumux::FEGridGeometry< FEB, Traits > Class Template Reference

The grid geometry class for models using finite element schemes. This is basically a wrapper around a function space basis. More...

#include <dumux/discretization/fem/fegridgeometry.hh>

Inheritance diagram for Dumux::FEGridGeometry< FEB, Traits >:

Description

template<class FEB, class Traits = DefaultFEGridGeometryTraits<FEB>>
class Dumux::FEGridGeometry< FEB, Traits >
Template Parameters
FEBThe finite element function space basis
MapperTraitsTraits class containing data types for mappers

Public Types

using DiscretizationMethod = DiscretizationMethods::FEM
 export the discretization method this geometry belongs to More...
 
using GridView = typename FEB::GridView
 export the grid view type More...
 
using Extrusion = Extrusion_t< Traits >
 export the type of extrusion More...
 
using FEBasis = FEB
 export the type of finite element basis More...
 
using LocalView = typename Traits::template LocalView< ThisType >
 export local 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

 FEGridGeometry (std::shared_ptr< FEBasis > feBasis)
 Constructor. More...
 
auto numDofs () const
 The total number of degrees of freedom. More...
 
const FEBasisfeBasis () const
 The total number of degrees of freedom. More...
 
bool dofOnPeriodicBoundary (GridIndexType dofIdx) const
 If a vertex / d.o.f. is on a periodic boundary. More...
 
GridIndexType periodicallyMappedDof (GridIndexType dofIdx) const
 The index of the vertex / d.o.f. on the other side of the periodic boundary. More...
 
const std::unordered_map< GridIndexType, GridIndexType > & periodicVertexMap () 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 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 {}
 

Protected Member Functions

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

Member Typedef Documentation

◆ DiscretizationMethod

template<class FEB , class Traits = DefaultFEGridGeometryTraits<FEB>>
using Dumux::FEGridGeometry< FEB, Traits >::DiscretizationMethod = DiscretizationMethods::FEM

◆ ElementMapper

using Dumux::BaseGridGeometry< FEB::GridView , DefaultFEGridGeometryTraits< FEB > >::ElementMapper = typename BaseImplementation::ElementMapper
inherited

◆ Extrusion

template<class FEB , class Traits = DefaultFEGridGeometryTraits<FEB>>
using Dumux::FEGridGeometry< FEB, Traits >::Extrusion = Extrusion_t<Traits>

◆ FEBasis

template<class FEB , class Traits = DefaultFEGridGeometryTraits<FEB>>
using Dumux::FEGridGeometry< FEB, Traits >::FEBasis = FEB

◆ GlobalCoordinate

using Dumux::BaseGridGeometry< FEB::GridView , DefaultFEGridGeometryTraits< FEB > >::GlobalCoordinate = typename BaseImplementation::GlobalCoordinate
inherited

◆ Grid

using Dumux::BaseGridGeometry< FEB::GridView , DefaultFEGridGeometryTraits< FEB > >::Grid = typename BaseImplementation::Grid
inherited

◆ GridView

template<class FEB , class Traits = DefaultFEGridGeometryTraits<FEB>>
using Dumux::FEGridGeometry< FEB, Traits >::GridView = typename FEB::GridView

◆ LocalView

template<class FEB , class Traits = DefaultFEGridGeometryTraits<FEB>>
using Dumux::FEGridGeometry< FEB, Traits >::LocalView = typename Traits::template LocalView<ThisType>

◆ VertexMapper

using Dumux::BaseGridGeometry< FEB::GridView , DefaultFEGridGeometryTraits< FEB > >::VertexMapper = typename BaseImplementation::VertexMapper
inherited

Constructor & Destructor Documentation

◆ FEGridGeometry()

template<class FEB , class Traits = DefaultFEGridGeometryTraits<FEB>>
Dumux::FEGridGeometry< FEB, Traits >::FEGridGeometry ( std::shared_ptr< FEBasis feBasis)
inline

Member Function Documentation

◆ bBoxMax()

const GlobalCoordinate & Dumux::BaseGridGeometry< FEB::GridView , DefaultFEGridGeometryTraits< FEB > >::bBoxMax ( ) const
inlineinherited

◆ bBoxMin()

const GlobalCoordinate & Dumux::BaseGridGeometry< FEB::GridView , DefaultFEGridGeometryTraits< FEB > >::bBoxMin ( ) const
inlineinherited

◆ boundingBoxTree()

decltype(auto) Dumux::BaseGridGeometry< FEB::GridView , DefaultFEGridGeometryTraits< FEB > >::boundingBoxTree ( ) const
inlineinherited

◆ dofOnPeriodicBoundary()

template<class FEB , class Traits = DefaultFEGridGeometryTraits<FEB>>
bool Dumux::FEGridGeometry< FEB, Traits >::dofOnPeriodicBoundary ( GridIndexType  dofIdx) const
inline

◆ element()

Element Dumux::BaseGridGeometry< FEB::GridView , DefaultFEGridGeometryTraits< FEB > >::element ( GridIndexType  eIdx) const
inlineinherited

◆ elementMap()

decltype(auto) Dumux::BaseGridGeometry< FEB::GridView , DefaultFEGridGeometryTraits< FEB > >::elementMap ( ) const
inlineinherited

◆ elementMapper() [1/2]

ElementMapper & Dumux::BaseGridGeometry< FEB::GridView , DefaultFEGridGeometryTraits< FEB > >::elementMapper ( )
inlineinherited

◆ elementMapper() [2/2]

const ElementMapper & Dumux::BaseGridGeometry< FEB::GridView , DefaultFEGridGeometryTraits< FEB > >::elementMapper ( ) const
inlineinherited

◆ feBasis()

template<class FEB , class Traits = DefaultFEGridGeometryTraits<FEB>>
const FEBasis & Dumux::FEGridGeometry< FEB, Traits >::feBasis ( ) const
inline

◆ gridView()

const GridView & Dumux::BaseGridGeometry< FEB::GridView , DefaultFEGridGeometryTraits< FEB > >::gridView ( ) const
inlineinherited

◆ isPeriodic()

bool Dumux::BaseGridGeometry< FEB::GridView , DefaultFEGridGeometryTraits< FEB > >::isPeriodic ( ) const
inlineinherited

◆ numDofs()

template<class FEB , class Traits = DefaultFEGridGeometryTraits<FEB>>
auto Dumux::FEGridGeometry< FEB, Traits >::numDofs ( ) const
inline

◆ periodicallyMappedDof()

template<class FEB , class Traits = DefaultFEGridGeometryTraits<FEB>>
GridIndexType Dumux::FEGridGeometry< FEB, Traits >::periodicallyMappedDof ( GridIndexType  dofIdx) const
inline

◆ periodicVertexMap()

template<class FEB , class Traits = DefaultFEGridGeometryTraits<FEB>>
const std::unordered_map< GridIndexType, GridIndexType > & Dumux::FEGridGeometry< FEB, Traits >::periodicVertexMap ( ) const
inline

◆ setPeriodic()

void Dumux::BaseGridGeometry< FEB::GridView , DefaultFEGridGeometryTraits< FEB > >::setPeriodic ( bool  value = true)
inlineprotectedinherited

◆ update() [1/2]

void Dumux::BaseGridGeometry< FEB::GridView , DefaultFEGridGeometryTraits< FEB > >::update ( const GridView gridView)
inlineinherited

◆ update() [2/2]

void Dumux::BaseGridGeometry< FEB::GridView , DefaultFEGridGeometryTraits< FEB > >::update ( GridView &&  gridView)
inlineinherited

◆ vertexMapper() [1/2]

VertexMapper & Dumux::BaseGridGeometry< FEB::GridView , DefaultFEGridGeometryTraits< FEB > >::vertexMapper ( )
inlineinherited

◆ vertexMapper() [2/2]

const VertexMapper & Dumux::BaseGridGeometry< FEB::GridView , DefaultFEGridGeometryTraits< FEB > >::vertexMapper ( ) const
inlineinherited

Member Data Documentation

◆ discMethod

template<class FEB , class Traits = DefaultFEGridGeometryTraits<FEB>>
constexpr DiscretizationMethod Dumux::FEGridGeometry< FEB, Traits >::discMethod {}
staticconstexpr

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