dune-grid  2.1.1
Public Member Functions
Dune::LeafMultipleCodimMultipleGeomTypeMapper< G, Layout > Class Template Reference

Multiple codim and multiple geometry type mapper for leaf entities. More...

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

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

List of all members.

Public Member Functions

 LeafMultipleCodimMultipleGeomTypeMapper (const G &grid)
 The constructor.
 LeafMultipleCodimMultipleGeomTypeMapper (const G &grid, const Layout< G::dimension > layout)
 The constructor.
int map (const EntityType &e) const
 Map entity to array index.
int map (const typename G::LeafGridView::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::LeafGridView::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, 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:
GA Dune grid type.
LayoutA helper class template which determines which types of entities are mapped by this mapper. See MultipleCodimMultipleGeomTypeMapper for how exactly this template should look.

Constructor & Destructor Documentation

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

The constructor.

Parameters:
gridA reference to a grid.
template<typename G , template< int > class Layout>
Dune::LeafMultipleCodimMultipleGeomTypeMapper< G, Layout >::LeafMultipleCodimMultipleGeomTypeMapper ( const G &  grid,
const Layout< G::dimension >  layout 
) [inline]

The constructor.

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

Parameters:
gridA reference to a grid.
layoutA layout object

Member Function Documentation

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

bool Dune::MultipleCodimMultipleGeomTypeMapper< G::LeafGridView , Layout >::contains ( const EntityType &  e,
int &  result 
) const [inline, 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::MultipleCodimMultipleGeomTypeMapper< G::LeafGridView , Layout >::contains ( const typename G::LeafGridView ::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:
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>
int Dune::Mapper< G, MapperImp >::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:
eReference to codim 0 entity.
iNumber of codim cc subentity of e, where cc is the template parameter of the function.
codimcodimension of subenetity of e
Returns:
An index in the range 0 ... Max number of entities in set - 1.
int Dune::MultipleCodimMultipleGeomTypeMapper< G::LeafGridView , Layout >::map ( const EntityType &  e) const [inline, 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::MultipleCodimMultipleGeomTypeMapper< G::LeafGridView , Layout >::map ( const typename G::LeafGridView ::template Codim< 0 >::Entity e,
int  i,
unsigned int  codim 
) const [inline, inherited]

Map subentity of codim 0 entity to array index.

Parameters:
eReference to codim 0 entity.
iNumber of subentity of e
codimCodimension of the subendity
Returns:
An index in the range 0 ... Max number of entities in set - 1.
int Dune::MultipleCodimMultipleGeomTypeMapper< G::LeafGridView , 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 >.

void Dune::MultipleCodimMultipleGeomTypeMapper< G::LeafGridView , Layout >::update ( ) [inline, inherited]

Recalculates map after mesh adaptation.

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


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