Dune::MultipleCodimMultipleGeomTypeMapper< GV, Layout > Class Template Reference
[Mappers]

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

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

Inheritance diagram for Dune::MultipleCodimMultipleGeomTypeMapper< GV, Layout >:
Inheritance graph

List of all members.

Public Member Functions

 MultipleCodimMultipleGeomTypeMapper (const GV &gridView, const Layout< GV::dimension > layout)
 Construct mapper from grid and one of its index sets.
 MultipleCodimMultipleGeomTypeMapper (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, template< int > class Layout>
class Dune::MultipleCodimMultipleGeomTypeMapper< GV, Layout >

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

In this implementation of a mapper the entity set used as domain for the map consists of the entities of a subset of codimensions in the given index set. The index set may contain entities of several geometry types. This version is usually not used directly but is used to implement versions for leafwise and levelwise entity sets.

Template Parameters:
GV A Dune GridView type.
Layout A helper class template 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 dimgrid>
struct LayoutClass {
    bool contains (Dune::GeometryType gt) const {
        // Return true if gt is in the domain of the map
    }
};

The MultipleCodimMultipleGeomTypeMapper will always substitute the dimension of the grid for the template parameter dimgrid.

If you don't want to use the default constructor of the LayoutClass you can construct it yourself and hand it to the respective constructor (with dimgrid=GV::dimension). In this case the layout class should be copy constructible.

Thare are to predefined Layout class templates For the common cases that only elements or only vertices should be mapped: MCMGElementLayout and MCMGVertexLayout.


Constructor & Destructor Documentation

template<typename GV, template< int > class Layout>
Dune::MultipleCodimMultipleGeomTypeMapper< GV, Layout >::MultipleCodimMultipleGeomTypeMapper ( const GV &  gridView,
const Layout< GV::dimension >  layout 
) [inline]

Construct mapper from grid and one of its index sets.

Use this constructor to provide a custom layout object e.g. not using the default constructor.

Parameters:
gridView A Dune GridView object.
layout A layout object.
template<typename GV, template< int > class Layout>
Dune::MultipleCodimMultipleGeomTypeMapper< GV, Layout >::MultipleCodimMultipleGeomTypeMapper ( const GV &  gridView  )  [inline]

Construct mapper from grid and one of its index sets.

Parameters:
gridView A Dune GridView object.

Member Function Documentation

template<typename GV, template< int > class Layout>
template<class EntityType >
bool Dune::MultipleCodimMultipleGeomTypeMapper< GV, Layout >::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, MultipleCodimMultipleGeomTypeMapper< GV, Layout > >.

template<typename GV, template< int > class Layout>
bool Dune::MultipleCodimMultipleGeomTypeMapper< GV, Layout >::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
bool Dune::Mapper< GV::Grid , MultipleCodimMultipleGeomTypeMapper< GV, Layout > >::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, template< int > class Layout>
int Dune::MultipleCodimMultipleGeomTypeMapper< GV, Layout >::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 subentity of e
codim Codimension of the subendity
Returns:
An index in the range 0 ... Max number of entities in set - 1.
template<typename GV, template< int > class Layout>
template<class EntityType >
int Dune::MultipleCodimMultipleGeomTypeMapper< GV, Layout >::map ( const EntityType &  e  )  const [inline]
int Dune::Mapper< GV::Grid , MultipleCodimMultipleGeomTypeMapper< GV, Layout > >::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, template< int > class Layout>
int Dune::MultipleCodimMultipleGeomTypeMapper< GV, Layout >::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, MultipleCodimMultipleGeomTypeMapper< GV, Layout > >.

Referenced by Dune::P0VTKFunction< GV, V >::P0VTKFunction(), and Dune::P1VTKFunction< GV, V >::P1VTKFunction().

template<typename GV, template< int > class Layout>
void Dune::MultipleCodimMultipleGeomTypeMapper< GV, Layout >::update (  )  [inline]

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