dune-grid  2.3beta2
Public Member Functions | List of all members
Dune::Mapper< G, MapperImp > Class Template Reference

Mapper interface. More...

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

Inheritance diagram for Dune::Mapper< G, MapperImp >:
Inheritance graph

Public Member Functions

template<class EntityType >
int map (const EntityType &e) const
 Map entity to array index.
int 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.
int size () const
 Return total number of entities in the entity set managed by the mapper.
template<class EntityType >
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.
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.
void update ()
 Reinitialize mapper after grid has been modified.

Detailed Description

template<typename G, typename MapperImp>
class Dune::Mapper< G, MapperImp >

Mapper interface.

This class template is used as a base class for all mapper implementations. It uses the Barton-Nackman trick to ensure conformity to the interface.

Template parameters are:

Member Function Documentation

template<typename G, typename MapperImp>
template<class EntityType >
bool Dune::Mapper< G, MapperImp >::contains ( const EntityType &  e,
int &  result 
) const
inline
template<typename G, typename MapperImp>
bool Dune::Mapper< G, MapperImp >::contains ( const typename G::Traits::template Codim< 0 >::Entity e,
int  i,
int  cc,
int &  result 
) const
inline

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

Reimplemented in Dune::UniversalMapper< G, IDS >, Dune::UniversalMapper< G, G::Traits::GlobalIdSet >, and Dune::UniversalMapper< G, G::Traits::LocalIdSet >.

template<typename G, typename MapperImp>
template<class EntityType >
int Dune::Mapper< G, MapperImp >::map ( const EntityType &  e) const
inline
template<typename G, typename MapperImp>
int Dune::Mapper< G, MapperImp >::map ( const typename G::Traits::template Codim< 0 >::Entity e,
int  i,
unsigned int  codim 
) const
inline

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.
template<typename G, typename MapperImp>
int Dune::Mapper< G, MapperImp >::size ( ) const
inline
template<typename G, typename MapperImp>
void Dune::Mapper< G, MapperImp >::update ( )
inline

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