Dune Core Modules (unstable)

Dune::SingleCodimSingleGeomTypeMapper< GV, c > Class Template Reference

Implementation class for a single codim and single geometry type mapper. More...

#include <dune/grid/common/scsgmapper.hh>

Public Types

typedef GV::IndexSet::IndexType Index
 Number type used for indices.
 
using size_type = decltype(std::declval< typename GV::IndexSet >().size(0))
 Number type used for the overall size (the return value of the 'size' method) More...
 

Public Member Functions

 SingleCodimSingleGeomTypeMapper (const GV &gridView)
 Construct mapper from grid and one of its index sets. More...
 
template<class EntityType >
Index index (const EntityType &e) const
 Map entity to array index. More...
 
Index subIndex (const typename GV::template Codim< 0 >::Entity &e, int i, unsigned int codim) const
 Map subentity of codim 0 entity to array index. More...
 
size_type size () const
 Return total number of entities in the entity set managed by the mapper. More...
 
template<class EntityType >
bool contains (const EntityType &e, Index &result) const
 Returns true if the entity is contained in the index set. More...
 
bool contains (const typename GV::template Codim< 0 >::Entity &e, int i, int cc, Index &result) const
 Returns true if the entity is contained in the index set. More...
 
void update (const GV &gridView)
 Recalculates indices after grid adaptation. More...
 
void update (GV &&gridView)
 Recalculates indices after grid adaptation. More...
 
Index subIndex (const typename G::Traits::template Codim< 0 >::Entity &e, int i, unsigned int codim) const
 Map subentity i of codim cc of a codim 0 entity to array index. More...
 
bool contains (const typename G::Traits::template Codim< 0 >::Entity &e, int i, int cc, GV::IndexSet::IndexType &result) const
 Returns true if the subentity is contained in the index set and at the same time the array index is returned. More...
 
void update (GridView &&gridView)
 Reinitialize mapper after grid has been modified.
 

Detailed Description

template<typename GV, int c>
class Dune::SingleCodimSingleGeomTypeMapper< GV, c >

Implementation class for a single codim and single geometry type mapper.

In this implementation of a mapper the entity set used as domain for the map consists of the entities of a given codimension c for all entities in the given index set. The index set may only contain entities of a single geometry type, otherwise an exception is thrown.

Template Parameters
GVA Dune grid view type
cA valid codimension

Member Typedef Documentation

◆ size_type

template<typename GV , int c>
using Dune::SingleCodimSingleGeomTypeMapper< GV, c >::size_type = decltype(std::declval<typename GV::IndexSet>().size(0))

Number type used for the overall size (the return value of the 'size' method)

The type used here is set to be the corresponding type used by the GridView's index set.

Constructor & Destructor Documentation

◆ SingleCodimSingleGeomTypeMapper()

template<typename GV , int c>
Dune::SingleCodimSingleGeomTypeMapper< GV, c >::SingleCodimSingleGeomTypeMapper ( const GV &  gridView)
inline

Construct mapper from grid and one of its index sets.

Parameters
gridViewA Dune GridView object.

References DUNE_THROW.

Member Function Documentation

◆ contains() [1/3]

template<typename GV , int c>
template<class EntityType >
bool Dune::SingleCodimSingleGeomTypeMapper< GV, c >::contains ( const EntityType &  e,
Index result 
) const
inline

Returns true if the entity is contained in the index set.

Parameters
eReference to entity
resultinteger reference where corresponding index is stored if true
Returns
true if entity is in entity set of the mapper

References Dune::SingleCodimSingleGeomTypeMapper< GV, c >::index().

◆ contains() [2/3]

bool Dune::Mapper< GV::Grid , SingleCodimSingleGeomTypeMapper< GV, c > , GV::IndexSet::IndexType >::contains ( const typename G::Traits::template Codim< 0 >::Entity e,
int  i,
int  cc,
GV::IndexSet::IndexType &  result 
) const
inlineinherited

Returns true if the subentity is contained in the index set and at the same time the array index is returned.

Parameters
[in]eReference to codim 0 entity
[in]isubentity number
[in]ccsubentity codim
[out]resultFilled with array index if entity is contained
Returns
true if entity is in entity set of the mapper

◆ contains() [3/3]

template<typename GV , int c>
bool Dune::SingleCodimSingleGeomTypeMapper< GV, c >::contains ( const typename GV::template Codim< 0 >::Entity e,
int  i,
int  cc,
Index result 
) const
inline

Returns true if the entity is contained in the index set.

Parameters
eReference to codim 0 entity
isubentity number
ccsubentity codim
resultinteger reference where corresponding index is stored if true
Returns
true if entity is in entity set of the mapper

References Dune::SingleCodimSingleGeomTypeMapper< GV, c >::subIndex().

◆ index()

template<typename GV , int c>
template<class EntityType >
Index Dune::SingleCodimSingleGeomTypeMapper< GV, c >::index ( const EntityType &  e) const
inline

Map entity to array index.

\param e Reference to codim cc entity, where cc is the template parameter of the function.
\return An index in the range 0 ... Max number of entities in set - 1.

Referenced by Dune::SingleCodimSingleGeomTypeMapper< GV, c >::contains().

◆ size()

template<typename GV , int c>
size_type Dune::SingleCodimSingleGeomTypeMapper< GV, c >::size ( ) const
inline

Return total number of entities in the entity set managed by the mapper.

This number can be used to allocate a vector of data elements associated with the entities of the set. In the parallel case this number is per process (i.e. it may be different in different processes).

Returns
Size of the entity set.

◆ subIndex() [1/2]

Index Dune::Mapper< GV::Grid , SingleCodimSingleGeomTypeMapper< GV, c > , GV::IndexSet::IndexType >::subIndex ( const typename G::Traits::template Codim< 0 >::Entity e,
int  i,
unsigned int  codim 
) const
inlineinherited

Map subentity i of codim cc of a codim 0 entity to array index.

Parameters
eReference to codim 0 entity.
iNumber of codim cc subentity of e, where cc is the template parameter of the function.
codimcodimension of subentity of e
Returns
An index in the range 0 ... Max number of entities in set - 1.

◆ subIndex() [2/2]

template<typename GV , int c>
Index Dune::SingleCodimSingleGeomTypeMapper< GV, c >::subIndex ( const typename GV::template Codim< 0 >::Entity e,
int  i,
unsigned int  codim 
) const
inline

Map subentity of codim 0 entity to array index.

Parameters
eReference to codim 0 entity.
iNumber of the subentity of e, where cc is the template parameter of the function.
codimCodimension of the subentity of e
Returns
An index in the range 0 ... Max number of entities in set - 1.

References DUNE_THROW.

Referenced by Dune::SingleCodimSingleGeomTypeMapper< GV, c >::contains().

◆ update() [1/2]

template<typename GV , int c>
void Dune::SingleCodimSingleGeomTypeMapper< GV, c >::update ( const GV &  gridView)
inline

Recalculates indices after grid adaptation.

After grid adaptation you need to call this to update the stored gridview and recalculate the indices.

◆ update() [2/2]

template<typename GV , int c>
void Dune::SingleCodimSingleGeomTypeMapper< GV, c >::update ( GV &&  gridView)
inline

Recalculates indices after grid adaptation.

After grid adaptation you need to call this to update the stored gridview and recalculate the indices.


The documentation for this class was generated from the following file:
Creative Commons License   |  Legal Statements / Impressum  |  Hosted by TU Dresden  |  generated with Hugo v0.80.0 (Mar 27, 23:31, 2024)