Dune::LocalUniversalMapper< G > Class Template Reference
[Mappers]

Universal mapper based on local ids. More...

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

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

List of all members.

Public Member Functions

 LocalUniversalMapper (const G &grid)
int map (const EntityType &e) const
 Map entity to array index.
int map (const typename G::Traits::template Codim< 0 >::Entity &e, int i, int cc) const
 Map subentity of codim 0 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.
bool contains (const EntityType &e, int &result) const
 Returns true if the entity is contained in the index set.
bool contains (const typename G::Traits::template Codim< 0 >::Entity &e, int i, int cc, int &result) const
 Returns true if the entity is contained in the index set.
void update ()
 Recalculates map after mesh adaptation.
void clear ()

Detailed Description

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

Universal mapper based on local ids.

Template parameters are:

G
A Dune grid type.

Constructor & Destructor Documentation

template<typename G >
Dune::LocalUniversalMapper< G >::LocalUniversalMapper ( const G &  grid  )  [inline]

Member Function Documentation

void Dune::UniversalMapper< G, G::Traits::LocalIdSet >::clear (  )  [inline, inherited]
bool Dune::UniversalMapper< G, G::Traits::LocalIdSet >::contains ( const EntityType &  e,
int &  result 
) const [inline, inherited]

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:
e Reference to entity
result integer reference where corresponding index is stored if true
Returns:
true if entity is in entity set of the mapper

Reimplemented from Dune::Mapper< G, UniversalMapper< G, G::Traits::LocalIdSet > >.

bool Dune::UniversalMapper< G, G::Traits::LocalIdSet >::contains ( const typename G::Traits::template Codim< 0 >::Entity e,
int  i,
int  cc,
int &  result 
) const [inline, inherited]

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

Parameters:
[in] e Reference to codim 0 entity
[in] i subentity number
[in] cc subentity codim
[out] result integer reference where corresponding index is stored if true
Returns:
true if entity is in entity set of the mapper

Reimplemented from Dune::Mapper< G, UniversalMapper< G, G::Traits::LocalIdSet > >.

int Dune::UniversalMapper< G, G::Traits::LocalIdSet >::map ( const EntityType &  e  )  const [inline, inherited]

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.

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

Reimplemented from Dune::Mapper< G, UniversalMapper< G, G::Traits::LocalIdSet > >.

int Dune::UniversalMapper< G, G::Traits::LocalIdSet >::map ( const typename G::Traits::template Codim< 0 >::Entity e,
int  i,
int  cc 
) const [inline, inherited]

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:
e Reference to codim 0 entity.
i Number of codim cc subentity of e, where cc is the template parameter of the function.
cc codim of the subentity
Returns:
An index in the range 0 ... Max number of entities in set - 1.
int Dune::Mapper< G, UniversalMapper< G, G::Traits::LocalIdSet > >::map ( const typename G::Traits::template Codim< 0 >::Entity e,
int  i,
unsigned int  codim 
) const [inline, inherited]

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

Parameters:
e Reference to codim 0 entity.
i Number of codim cc subentity of e, where cc is the template parameter of the function.
codim codimension of subenetity of e
Returns:
An index in the range 0 ... Max number of entities in set - 1.
int Dune::UniversalMapper< G, G::Traits::LocalIdSet >::size (  )  const [inline, inherited]

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.

Reimplemented from Dune::Mapper< G, UniversalMapper< G, G::Traits::LocalIdSet > >.

void Dune::UniversalMapper< G, G::Traits::LocalIdSet >::update (  )  [inline, inherited]

Recalculates map after mesh adaptation.

Reimplemented from Dune::Mapper< G, UniversalMapper< G, G::Traits::LocalIdSet > >.


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

Generated on Fri Apr 29 2011 with Doxygen (ver 1.7.1) [doxygen-log,error-log].