Dune::LeafSingleCodimSingleGeomTypeMapper< G, c > Class Template Reference

Single codim and single geometry type mapper for leaf entities. More...

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

Public Types
typedef GV::IndexSet::IndexType	Index
	Number type used for indices.
using	size_type = decltype(std::declval< typename GV::IndexSet >().size(0))
	Number type used for the overall size (the return value of the 'size' method) More...

Public Member Functions
	LeafSingleCodimSingleGeomTypeMapper (const G &grid)
	The constructor. More...
Index	index (const EntityType &e) const
	Map entity to array index. More...
Index	subIndex (const typename GV::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...
size_type	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 GV::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.

Detailed Description

template<typename G, int c>
class Dune::LeafSingleCodimSingleGeomTypeMapper< G, c >

Single codim and single geometry type mapper for leaf entities.

This mapper uses all leaf entities of a certain codimension as its entity set. It is assumed (and checked) that the given grid contains only entities of a single geometry type.

Template parameters are:

Template Parameters

G	A Dune grid type.
c	A valid codimension.

Member Typedef Documentation

size_type

using Dune::SingleCodimSingleGeomTypeMapper< G::LeafGridView , c >::size_type = decltype(std::declval<typename GV::IndexSet>().size(0))

inherited

Number type used for the overall size (the return value of the 'size' method)

The type used here is set to be the corresponding type used by the GridView's index set.

Constructor & Destructor Documentation

LeafSingleCodimSingleGeomTypeMapper()

template<typename G , int c>

Dune::LeafSingleCodimSingleGeomTypeMapper< G, c >::LeafSingleCodimSingleGeomTypeMapper ( const G &  grid )

inline

The constructor.

Parameters

grid	A reference to a grid.

Member Function Documentation

contains() [1/4]

bool Dune::SingleCodimSingleGeomTypeMapper< G::LeafGridView , c >::contains ( const EntityType &  e, Index &  result  ) const

inlineinherited

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

contains() [2/4]

bool Dune::Mapper< GV::Grid , SingleCodimSingleGeomTypeMapper< G::LeafGridView, c > , GV::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]	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() [3/4]

bool Dune::Mapper< GV::Grid , SingleCodimSingleGeomTypeMapper< G::LeafGridView, c > , GV::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]	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

contains() [4/4]

bool Dune::SingleCodimSingleGeomTypeMapper< G::LeafGridView , c >::contains ( const typename GV::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

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

index()

Index Dune::SingleCodimSingleGeomTypeMapper< G::LeafGridView , c >::index ( const EntityType &  e ) const

inlineinherited

Map entity to array index.

\param e Reference to codim cc entity, where cc is the template parameter of the function.
\return An index in the range 0 ... Max number of entities in set - 1.

size()

size_type Dune::SingleCodimSingleGeomTypeMapper< G::LeafGridView , c >::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.

subIndex() [1/2]

Index Dune::Mapper< GV::Grid , SingleCodimSingleGeomTypeMapper< G::LeafGridView, c > , GV::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

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.

subIndex() [2/2]

Index Dune::SingleCodimSingleGeomTypeMapper< G::LeafGridView , c >::subIndex ( const typename GV::template Codim< 0 >::Entity &  e, int  i, unsigned int  codim  ) const

inlineinherited

Map subentity of codim 0 entity to array index.

Parameters

e	Reference to codim 0 entity.
i	Number of the subentity of e, where cc is the template parameter of the function.
codim	Codimension of the subentity of e

Returns

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

---

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

• dune/grid/common/scsgmapper.hh