Dune::LeafMultipleCodimMultipleGeomTypeMapper< G, LayoutClass > Class Template Reference

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

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

Public Types
typedef IndexType	Index
	Number type used for indices.

Public Member Functions
	LeafMultipleCodimMultipleGeomTypeMapper (const G &grid, const LayoutClass< G::dimension > layout={})
	The constructor. More...
	LeafMultipleCodimMultipleGeomTypeMapper (const G &grid, const MCMGLayout &layout)
	constructor More...
template<class EntityType >
Index	index (const EntityType &e) const
	Map 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...
auto	size () const
	Return total number of entities in the entity set managed by the mapper. More...
template<class EntityType >
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 ()
	Reinitialize mapper after grid has been modified.

Detailed Description

template<typename G, template< int > class LayoutClass = Impl::MCMGFailLayout>
class Dune::LeafMultipleCodimMultipleGeomTypeMapper< G, LayoutClass >

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

G	A Dune grid type.
LayoutClass	(deprecated) A 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

LeafMultipleCodimMultipleGeomTypeMapper() [1/2]

template<typename G , template< int > class LayoutClass = Impl::MCMGFailLayout>

Dune::LeafMultipleCodimMultipleGeomTypeMapper< G, LayoutClass >::LeafMultipleCodimMultipleGeomTypeMapper ( const G &  grid, const LayoutClass< G::dimension >  layout = {}  )

inline

The constructor.

Parameters

grid	A reference to a grid.
layout	A layout object

Deprecated:

Use the constructor taking a MCMGLayout instead.

Deprecated:

"Use the constructor taking a `MCMGLayout` functional instead"

LeafMultipleCodimMultipleGeomTypeMapper() [2/2]

template<typename G , template< int > class LayoutClass = Impl::MCMGFailLayout>

Dune::LeafMultipleCodimMultipleGeomTypeMapper< G, LayoutClass >::LeafMultipleCodimMultipleGeomTypeMapper ( const G &  grid, const MCMGLayout &  layout  )

inline

constructor

Parameters

grid	reference to the grid
layout	layout functional describing which geometry types to include in the map.

Member Function Documentation

contains() [1/2]

template<typename G , typename MapperImp , typename IndexType = int>

template<class EntityType >

bool Dune::Mapper< G, MapperImp, 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]	e	Reference to entity
[out]	result	Filled with array index if entity is contained

Returns

true if entity is in entity set of the mapper

contains() [2/2]

template<typename G , typename MapperImp , typename IndexType = int>

bool Dune::Mapper< G, MapperImp, 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]	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

index()

template<typename G , typename MapperImp , typename IndexType = int>

template<class EntityType >

Index Dune::Mapper< G, MapperImp, IndexType >::index ( const EntityType &  e ) const

inlineinherited

Map entity to array index.

\param e Reference to codim cc entity. The codim is extracted from the entity.
\return An index in the range 0 ... Max number of entities in set - 1.

Referenced by checkElementDataMapper().

size()

template<typename G , typename MapperImp , typename IndexType = int>

auto Dune::Mapper< G, MapperImp, IndexType >::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.

Referenced by checkMixedDataMapper().

subIndex()

template<typename G , typename MapperImp , typename IndexType = int>

Index Dune::Mapper< G, MapperImp, 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

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 subentity of e

Returns

An index in the range 0 ... Max number of entities in set - 1.

Referenced by checkVertexDataMapper().

---

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

• dune/grid/common/mcmgmapper.hh