dune-grid  2.4.1
Public Types | Public Member Functions | List of all members
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 >:
Dune::MultipleCodimMultipleGeomTypeMapper< G::LeafGridView, Layout > Dune::Mapper< G::LeafGridView::Grid, MultipleCodimMultipleGeomTypeMapper< G::LeafGridView, Layout >, G::LeafGridView::IndexSet::IndexType >

Public Types

typedef
G::LeafGridView::IndexSet::IndexType 
Index
 Number type used for indices. More...
 

Public Member Functions

 LeafMultipleCodimMultipleGeomTypeMapper (const G &grid)
 The constructor. More...
 
 LeafMultipleCodimMultipleGeomTypeMapper (const G &grid, const Layout< G::dimension > layout)
 The constructor. More...
 
Index map (const EntityType &e) const
 Map entity to array index. More...
 
Index 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. More...
 
Index 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. More...
 
Index index (const EntityType &e) const
 Map entity to array index. More...
 
Index subIndex (const typename G::LeafGridView::template Codim< 0 >::Entity &e, int i, unsigned int codim) const
 Map subentity of codim 0 entity to array index. More...
 
Index subIndex (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. More...
 
int size () const
 Return total number of entities in the entity set managed by the mapper. More...
 
bool contains (const EntityType &e, Index &result) const
 Returns true if the entity is contained in the index set. More...
 
bool contains (const typename G::LeafGridView::template Codim< 0 >::Entity &e, int i, int cc, Index &result) const
 Returns true if the entity is contained in the index set. More...
 
bool contains (const EntityType &e, int &result) const
 Returns true if the entity is contained in the index set and at the same time the array index is returned. More...
 
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. More...
 
void update ()
 Recalculates map after mesh adaptation. More...
 

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.

Member Typedef Documentation

typedef G::LeafGridView ::IndexSet::IndexType Dune::MultipleCodimMultipleGeomTypeMapper< G::LeafGridView , Layout >::Index
inherited

Number type used for indices.

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

bool Dune::Mapper< G, MultipleCodimMultipleGeomTypeMapper< G::LeafGridView, Layout > , G::LeafGridView::IndexSet::IndexType >::contains ( const EntityType &  e,
int &  result 
) const
inlineinherited

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

Parameters
[in]eReference to entity
[out]resultFilled with array index if entity is contained
Returns
true if entity is in entity set of the mapper
bool Dune::Mapper< G, MultipleCodimMultipleGeomTypeMapper< G::LeafGridView, Layout > , G::LeafGridView::IndexSet::IndexType >::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
bool Dune::MultipleCodimMultipleGeomTypeMapper< G::LeafGridView , Layout >::contains ( const EntityType &  e,
Index result 
) const
inlineinherited

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
bool Dune::MultipleCodimMultipleGeomTypeMapper< G::LeafGridView , Layout >::contains ( const typename G::LeafGridView ::template Codim< 0 >::Entity e,
int  i,
int  cc,
Index result 
) const
inlineinherited

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
Index Dune::MultipleCodimMultipleGeomTypeMapper< G::LeafGridView , Layout >::index ( const EntityType &  e) const
inlineinherited

Map entity to array index.

Template Parameters
EntityType
Parameters
eReference to codim EntityType entity.
Returns
An index in the range 0 ... Max number of entities in set - 1.
Index Dune::MultipleCodimMultipleGeomTypeMapper< G::LeafGridView , Layout >::map ( const EntityType &  e) const
inlineinherited

Map entity to array index.

Template Parameters
EntityType
Parameters
eReference to codim EntityType entity.
Returns
An index in the range 0 ... Max number of entities in set - 1.
Deprecated:
"Will be removed after dune-grid-2.4. Use method 'index' instead!"
Index Dune::Mapper< G, MultipleCodimMultipleGeomTypeMapper< G::LeafGridView, Layout > , G::LeafGridView::IndexSet::IndexType >::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.
Deprecated:
"Will be removed after dune-grid-2.4. Use method 'index' instead!"
Index Dune::MultipleCodimMultipleGeomTypeMapper< G::LeafGridView , Layout >::map ( const typename G::LeafGridView ::template Codim< 0 >::Entity e,
int  i,
unsigned int  codim 
) const
inlineinherited

Map subentity of codim 0 entity to array index.

Parameters
eReference to codim 0 entity.
iNumber of subentity of e
codimCodimension of the subentity
Returns
An index in the range 0 ... Max number of entities in set - 1.
Deprecated:
"Will be removed after dune-grid-2.4. Use method 'subIndex' instead!"
int Dune::MultipleCodimMultipleGeomTypeMapper< G::LeafGridView , Layout >::size ( ) const
inlineinherited

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.
Index Dune::Mapper< G, MultipleCodimMultipleGeomTypeMapper< G::LeafGridView, Layout > , G::LeafGridView::IndexSet::IndexType >::subIndex ( 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.
Index Dune::MultipleCodimMultipleGeomTypeMapper< G::LeafGridView , Layout >::subIndex ( const typename G::LeafGridView ::template Codim< 0 >::Entity e,
int  i,
unsigned int  codim 
) const
inlineinherited

Map subentity of codim 0 entity to array index.

Parameters
eReference to codim 0 entity.
iNumber of subentity of e
codimCodimension of the subentity
Returns
An index in the range 0 ... Max number of entities in set - 1.
void Dune::MultipleCodimMultipleGeomTypeMapper< G::LeafGridView , Layout >::update ( )
inlineinherited

Recalculates map after mesh adaptation.


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