Dune Core Modules (2.4.2)

Dune::LevelMultipleCodimMultipleGeomTypeMapper< G, Layout > Class Template Reference

Multiple codim and multiple geometry type mapper for entities of one level. More...

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

Public Types

typedef GV::IndexSet::IndexType Index
 Number type used for indices.
 

Public Member Functions

 LevelMultipleCodimMultipleGeomTypeMapper (const G &grid, int level)
 The constructor. More...
 
 LevelMultipleCodimMultipleGeomTypeMapper (const G &grid, int level, const Layout< G::dimension > layout)
 The constructor. More...
 
Index DUNE_DEPRECATED_MSG ("Will be removed after dune-grid-2.4. Use method 'index' instead!") map(const EntityType &e) const
 Map entity to array index. More...
 
Index DUNE_DEPRECATED_MSG ("Will be removed after dune-grid-2.4. Use method 'subIndex' instead!") map(const typename G::LevelGridView
 Map subentity of codim 0 entity to array index. More...
 
Index DUNE_DEPRECATED_MSG ("Will be removed after dune-grid-2.4. Use method 'index' instead!") map(const typename G
 Map subentity i of codim cc of a codim 0 entity to array index. More...
 
Index index (const EntityType &e) const
 Map entity to array index. More...
 

Detailed Description

template<typename G, template< int > class Layout>
class Dune::LevelMultipleCodimMultipleGeomTypeMapper< G, Layout >

Multiple codim and multiple geometry type mapper for entities of one level.

This mapper uses all entities of a certain codimension on a given level as its entity set.

Template Parameters
GA Dune grid type.
LayoutA helper class template which determines which types of entities are mapped by this mapper. See MultipleCodimMultipleGeomTypeMapper for how exactly this template should look.

Constructor & Destructor Documentation

◆ LevelMultipleCodimMultipleGeomTypeMapper() [1/2]

template<typename G , template< int > class Layout>
Dune::LevelMultipleCodimMultipleGeomTypeMapper< G, Layout >::LevelMultipleCodimMultipleGeomTypeMapper ( const G &  grid,
int  level 
)
inline

The constructor.

Parameters
gridA reference to a grid.
levelA valid level of the grid.

◆ LevelMultipleCodimMultipleGeomTypeMapper() [2/2]

template<typename G , template< int > class Layout>
Dune::LevelMultipleCodimMultipleGeomTypeMapper< G, Layout >::LevelMultipleCodimMultipleGeomTypeMapper ( const G &  grid,
int  level,
const Layout< G::dimension >  layout 
)
inline

The constructor.

Use this constructor to provide a custom layout object e.g. not using the default constructor.

Parameters
gridA reference to a grid.
levelA valid level of the grid.
layoutA layout object

Member Function Documentation

◆ DUNE_DEPRECATED_MSG() [1/3]

Index Dune::MultipleCodimMultipleGeomTypeMapper< G::LevelGridView , Layout >::DUNE_DEPRECATED_MSG ( "Will be removed after dune-grid-2.4. Use method 'index' instead!"  ) const &
inlineinherited

Map entity to array index.

Template Parameters
EntityType
Parameters
eReference to codim EntityType entity.
Returns
An index in the range 0 ... Max number of entities in set - 1.

◆ DUNE_DEPRECATED_MSG() [2/3]

template<typename G , typename MapperImp , typename IndexType = int>
Index Dune::Mapper< G, MapperImp, IndexType >::DUNE_DEPRECATED_MSG ( "Will be removed after dune-grid-2.4. Use method 'index' instead!"  ) 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.

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.

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.

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

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

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

Reinitialize mapper after grid has been modified.

◆ DUNE_DEPRECATED_MSG() [3/3]

Index Dune::MultipleCodimMultipleGeomTypeMapper< G::LevelGridView , Layout >::DUNE_DEPRECATED_MSG ( "Will be removed after dune-grid-2.4. Use method 'subIndex' instead!"  ) const
inlineinherited

Map subentity of codim 0 entity to array index.

Parameters
eReference to codim 0 entity.
iNumber of subentity of e
codimCodimension of the subentity
Returns
An index in the range 0 ... Max number of entities in set - 1.

Map subentity of codim 0 entity to array index.

Parameters
eReference to codim 0 entity.
iNumber of subentity of e
codimCodimension of the subentity
Returns
An index in the range 0 ... Max number of entities in set - 1.

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.

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

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

Recalculates map after mesh adaptation

◆ index()

Index Dune::MultipleCodimMultipleGeomTypeMapper< G::LevelGridView , Layout >::index ( const EntityType &  e) const
inlineinherited

Map entity to array index.

Template Parameters
EntityType
Parameters
eReference to codim EntityType entity.
Returns
An index in the range 0 ... Max number of entities in set - 1.

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 (Apr 19, 22:31, 2024)