dune-grid  2.4.1
Public Types | Public Member Functions | List of all members
Dune::GlobalUniversalMapper< G > Class Template Reference

Universal mapper based on global ids. More...

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

Inheritance diagram for Dune::GlobalUniversalMapper< G >:
Inheritance graph

Public Types

typedef IndexType Index
 Number type used for indices. More...
 

Public Member Functions

 GlobalUniversalMapper (const G &grid)
 
Index map (const EntityType &e) const
 Map entity to array index. More...
 
Index map (const typename G::Traits::template Codim< 0 >::Entity &e, int i, int cc) const
 Map subentity of codim 0 entity to array index. More...
 
Index map (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...
 
Index index (const EntityType &e) const
 Map entity to array index. More...
 
Index subIndex (const typename G::Traits::template Codim< 0 >::Entity &e, int i, int cc) const
 Map subentity of codim 0 entity to array index. 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...
 
int size () const
 Return total number of entities in the entity set managed by the mapper. More...
 
bool contains (const EntityType &e, Index &result) const
 Returns true if the entity is contained in the index set. More...
 
bool contains (const typename G::Traits::template Codim< 0 >::Entity &e, int i, int cc, Index &result) const
 Returns true if the entity is contained in the index set. More...
 
bool contains (const EntityType &e, int &result) const
 Returns true if the entity is contained in the index set and at the same time the array index is returned. More...
 
bool contains (const typename G::Traits::template Codim< 0 >::Entity &e, int i, int cc, int &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 ()
 Recalculates map after mesh adaptation. More...
 
void clear ()
 

Detailed Description

template<typename G>
class Dune::GlobalUniversalMapper< G >

Universal mapper based on global ids.

Template parameters are:

Template Parameters
GA Dune grid type.

Member Typedef Documentation

typedef IndexType Dune::UniversalMapper< G, G::Traits::GlobalIdSet , IndexType >::Index
inherited

Number type used for indices.

Constructor & Destructor Documentation

template<typename G >
Dune::GlobalUniversalMapper< G >::GlobalUniversalMapper ( const G &  grid)
inline

Member Function Documentation

void Dune::UniversalMapper< G, G::Traits::GlobalIdSet , IndexType >::clear ( )
inlineinherited
bool Dune::UniversalMapper< G, G::Traits::GlobalIdSet , IndexType >::contains ( const EntityType &  e,
Index result 
) const
inlineinherited

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

The method contains only return true, if the entites was queried via map already.

Parameters
eReference to entity
resultinteger reference where corresponding index is stored if true
Returns
true if entity is in entity set of the mapper
bool Dune::UniversalMapper< G, G::Traits::GlobalIdSet , IndexType >::contains ( const typename G::Traits::template Codim< 0 >::Entity e,
int  i,
int  cc,
Index result 
) const
inlineinherited

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

Parameters
[in]eReference to codim 0 entity
[in]isubentity number
[in]ccsubentity codim
[out]resultinteger reference where corresponding index is stored if true
Returns
true if entity is in entity set of the mapper
bool Dune::Mapper< G, UniversalMapper< G, G::Traits::GlobalIdSet > , IndexType >::contains ( const EntityType &  e,
int &  result 
) const
inlineinherited

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

References Dune::Mapper< G, MapperImp, IndexType >::contains().

bool Dune::Mapper< G, UniversalMapper< G, G::Traits::GlobalIdSet > , IndexType >::contains ( const typename G::Traits::template Codim< 0 >::Entity e,
int  i,
int  cc,
int &  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

References Dune::Mapper< G, MapperImp, IndexType >::contains().

Index Dune::UniversalMapper< G, G::Traits::GlobalIdSet , IndexType >::index ( const EntityType &  e) const
inlineinherited

Map entity to array index.

If an entity is queried with map, the known index is returned or a new index is created. A call to map can never fail.

 \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.
Index Dune::UniversalMapper< G, G::Traits::GlobalIdSet , IndexType >::map ( const EntityType &  e) const
inlineinherited

Map entity to array index.

If an entity is queried with map, the known index is returned or a new index is created. A call to map can never fail.

 \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.
Deprecated:
"Will be removed after dune-grid-2.4. Use method 'index' instead!"
Index Dune::UniversalMapper< G, G::Traits::GlobalIdSet , IndexType >::map ( const typename G::Traits::template Codim< 0 >::Entity e,
int  i,
int  cc 
) const
inlineinherited

Map subentity of codim 0 entity to array index.

If an entity is queried with map, the known index is returned or a new index is created. A call to map can never fail.

Parameters
eReference to codim 0 entity.
iNumber of codim cc subentity of e, where cc is the template parameter of the function.
cccodim of the subentity
Returns
An index in the range 0 ... Max number of entities in set - 1.
Deprecated:
"Will be removed after dune-grid-2.4. Use method 'subIndex' instead!"
Index Dune::Mapper< G, UniversalMapper< G, G::Traits::GlobalIdSet > , IndexType >::map ( 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.
Deprecated:
"Will be removed after dune-grid-2.4. Use method 'index' instead!"

References Dune::Mapper< G, MapperImp, IndexType >::map().

int Dune::UniversalMapper< G, G::Traits::GlobalIdSet , IndexType >::size ( ) const
inlineinherited

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.
Index Dune::UniversalMapper< G, G::Traits::GlobalIdSet , IndexType >::subIndex ( const typename G::Traits::template Codim< 0 >::Entity e,
int  i,
int  cc 
) const
inlineinherited

Map subentity of codim 0 entity to array index.

If an entity is queried with map, the known index is returned or a new index is created. A call to map can never fail.

Parameters
eReference to codim 0 entity.
iNumber of codim cc subentity of e, where cc is the template parameter of the function.
cccodim of the subentity
Returns
An index in the range 0 ... Max number of entities in set - 1.
Index Dune::Mapper< G, UniversalMapper< G, G::Traits::GlobalIdSet > , 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.

References Dune::Mapper< G, MapperImp, IndexType >::map().

void Dune::UniversalMapper< G, G::Traits::GlobalIdSet , IndexType >::update ( )
inlineinherited

Recalculates map after mesh adaptation.


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