Dune::LeafMultipleCodimMultipleGeomTypeMapper< G, Layout > Class Template Reference
[Mappers]

#include <mcmgmapper.hh>

Inheritance diagram for Dune::LeafMultipleCodimMultipleGeomTypeMapper< G, Layout >:

Dune::MultipleCodimMultipleGeomTypeMapper< G, G::Traits::LeafIndexSet, Layout > Dune::Mapper< G, MapperImp >

List of all members.


Detailed Description

template<typename G, template< int > class Layout>
class Dune::LeafMultipleCodimMultipleGeomTypeMapper< G, Layout >

Multiple codim and multiple geometry type mapper for leaf entities.

This mapper uses all leaf entities of a certain codimension as its entity set.

Template parameters are:

G
A Dune grid type.
Layout
A helper class with a method contains(), that returns true for all geometry types that are in the domain of the map. The class should be of the following shape
    template<int dim>
    struct LayoutClass {
        bool contains (Dune::GeometryType gt) {
            // Return true if gt is in the domain of the map
        }
    };

Public Member Functions

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

Constructor & Destructor Documentation

template<typename G, template< int > class Layout>
Dune::LeafMultipleCodimMultipleGeomTypeMapper< G, Layout >::LeafMultipleCodimMultipleGeomTypeMapper ( const G &  grid  )  [inline]

The constructor.

Parameters:
grid A reference to a grid.


Member Function Documentation

int Dune::MultipleCodimMultipleGeomTypeMapper< G , G::Traits::LeafIndexSet , Layout >::map ( const EntityType &  e  )  const [inline, inherited]

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< G, MapperImp >.

int Dune::MultipleCodimMultipleGeomTypeMapper< G , G::Traits::LeafIndexSet , Layout >::map ( const typename G ::Traits::template Codim< 0 >::Entity e,
int  i 
) const [inline, inherited]

Map subentity of 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.
Returns:
An index in the range 0 ... Max number of entities in set - 1.

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

int Dune::MultipleCodimMultipleGeomTypeMapper< G , G::Traits::LeafIndexSet , Layout >::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, MapperImp >.

bool Dune::MultipleCodimMultipleGeomTypeMapper< G , G::Traits::LeafIndexSet , Layout >::contains ( const EntityType &  e,
int &  result 
) const [inline, inherited]

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< G, MapperImp >.

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

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

Parameters:
e Reference to codim 0 entity
i subentity number
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, MapperImp >.


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

Generated on 6 Nov 2008 with Doxygen (ver 1.5.6) [logfile].