Dune::SingleCodimSingleGeomTypeMapper< GV, c > Class Template Reference
[Mappers]

Implementation class for a single codim and single geometry type mapper. More...

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

Inheritance diagram for Dune::SingleCodimSingleGeomTypeMapper< GV, c >:
Inheritance graph

List of all members.

Public Member Functions

 SingleCodimSingleGeomTypeMapper (const typename GV::Grid &grid, const typename GV::IndexSet &indexset)
 Construct mapper from grid and one fo its index sets.
 SingleCodimSingleGeomTypeMapper (const GV &gridView)
 Construct mapper from grid and one of its index sets.
template<class EntityType >
int map (const EntityType &e) const
 Map entity to array index.
int map (const typename GV::template Codim< 0 >::Entity &e, int i, unsigned int codim) const
 Map subentity of 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.
bool contains (const typename GV::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.
int map (const typename GV::Grid::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.
bool contains (const typename GV::Grid::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.

Detailed Description

template<typename GV, int c>
class Dune::SingleCodimSingleGeomTypeMapper< GV, c >

Implementation class for a single codim and single geometry type mapper.

In this implementation of a mapper the entity set used as domain for the map consists of the entities of a given codimension c for all entities in the given index set. The index set may only contain entities of a single geometry type, otherwise an exception is thrown. This version is usually not used directly but is used to implement versions for leafwise and levelwise entity sets.

Template Parameters:
GV A Dune grid view type
c A valid codimension

Constructor & Destructor Documentation

template<typename GV, int c>
Dune::SingleCodimSingleGeomTypeMapper< GV, c >::SingleCodimSingleGeomTypeMapper ( const typename GV::Grid &  grid,
const typename GV::IndexSet &  indexset 
)

Construct mapper from grid and one fo its index sets.

Parameters:
grid A Dune grid object.
indexset IndexSet object returned by grid.
Deprecated:
template<typename GV, int c>
Dune::SingleCodimSingleGeomTypeMapper< GV, c >::SingleCodimSingleGeomTypeMapper ( const GV &  gridView  ) 

Construct mapper from grid and one of its index sets.

Parameters:
gridView A Dune GridView object.

Member Function Documentation

template<typename GV , int c>
template<class EntityType >
bool Dune::SingleCodimSingleGeomTypeMapper< GV, c >::contains ( const EntityType &  e,
int &  result 
) const [inline]

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

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< GV::Grid, SingleCodimSingleGeomTypeMapper< GV, c > >.

References Dune::SingleCodimSingleGeomTypeMapper< GV, c >::map().

template<typename GV, int c>
bool Dune::SingleCodimSingleGeomTypeMapper< GV, c >::contains ( const typename GV::template Codim< 0 >::Entity e,
int  i,
int  cc,
int &  result 
) const [inline]

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

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

References Dune::SingleCodimSingleGeomTypeMapper< GV, c >::map().

bool Dune::Mapper< GV::Grid , SingleCodimSingleGeomTypeMapper< GV, c > >::contains ( const typename GV::Grid ::Traits::template Codim< 0 >::Entity e,
int  i,
int  cc,
int &  result 
) const [inline, inherited]

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

Parameters:
[in] e Reference to codim 0 entity
[in] i subentity number
[in] cc subentity codim
[out] result Filled with array index if entity is contained
Returns:
true if entity is in entity set of the mapper
template<typename GV, int c>
int Dune::SingleCodimSingleGeomTypeMapper< GV, c >::map ( const typename GV::template Codim< 0 >::Entity e,
int  i,
unsigned int  codim 
) const [inline]

Map subentity of codim 0 entity to array index.

Parameters:
e Reference to codim 0 entity.
i Number of the subentity of e, where cc is the template parameter of the function.
codim Codimension of the subentity of e
Returns:
An index in the range 0 ... Max number of entities in set - 1.
template<typename GV , int c>
template<class EntityType >
int Dune::SingleCodimSingleGeomTypeMapper< GV, c >::map ( const EntityType &  e  )  const [inline]

Map entity to array index.

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< GV::Grid, SingleCodimSingleGeomTypeMapper< GV, c > >.

Referenced by Dune::SingleCodimSingleGeomTypeMapper< GV, c >::contains().

int Dune::Mapper< GV::Grid , SingleCodimSingleGeomTypeMapper< GV, c > >::map ( const typename GV::Grid ::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.
template<typename GV , int c>
int Dune::SingleCodimSingleGeomTypeMapper< GV, c >::size (  )  const [inline]

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< GV::Grid, SingleCodimSingleGeomTypeMapper< GV, c > >.

template<typename GV, int c>
void Dune::SingleCodimSingleGeomTypeMapper< GV, c >::update (  )  [inline]

Recalculates map after mesh adaptation.

Reimplemented from Dune::Mapper< GV::Grid, SingleCodimSingleGeomTypeMapper< GV, c > >.


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