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

Single codim and single geometry type mapper for entities of one level. More...

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

Inheritance diagram for Dune::LevelSingleCodimSingleGeomTypeMapper< G, c >:
Inheritance graph

Public Member Functions

 LevelSingleCodimSingleGeomTypeMapper (const G &grid, int level)
int map (const EntityType &e) const
 Map entity to array index.
int map (const typename G::LevelGridView::template Codim< 0 >::Entity &e, int i, unsigned int codim) 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::LevelGridView::template Codim< 0 >::Entity &e, int i, int cc, 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 subentity is contained in the index set and at the same time the array index is returned.
void update ()
 Recalculates map after mesh adaptation.

Detailed Description

template<typename G, int c>
class Dune::LevelSingleCodimSingleGeomTypeMapper< G, c >

Single codim and single 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. It is assumed (and checked) that the given grid contains only entities of a single geometry type.

Template parameters are:

G
A Dune grid type.
c
A valid codimension.

Constructor & Destructor Documentation

template<typename G , int c>
Dune::LevelSingleCodimSingleGeomTypeMapper< G, c >::LevelSingleCodimSingleGeomTypeMapper ( const G &  grid,
int  level 
)
inline

Member Function Documentation

bool Dune::SingleCodimSingleGeomTypeMapper< G::LevelGridView , c >::contains ( const EntityType &  e,
int &  result 
) const
inherited

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

Reimplemented from Dune::Mapper< G, MapperImp >.

bool Dune::SingleCodimSingleGeomTypeMapper< G::LevelGridView , c >::contains ( const typename G::LevelGridView ::template Codim< 0 >::Entity e,
int  i,
int  cc,
int &  result 
) const
inherited

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
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
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

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

int Dune::SingleCodimSingleGeomTypeMapper< G::LevelGridView , c >::map ( const EntityType &  e) const
inherited

Map entity to array index.

Parameters
eReference 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, MapperImp >.

int Dune::SingleCodimSingleGeomTypeMapper< G::LevelGridView , c >::map ( const typename G::LevelGridView ::template Codim< 0 >::Entity e,
int  i,
unsigned int  codim 
) const
inherited

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.
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
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.
int Dune::SingleCodimSingleGeomTypeMapper< G::LevelGridView , c >::size ( ) const
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, MapperImp >.

void Dune::SingleCodimSingleGeomTypeMapper< G::LevelGridView , c >::update ( )
inlineinherited

Recalculates map after mesh adaptation.

Reimplemented from Dune::Mapper< G, MapperImp >.


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