Single codim and single geometry type mapper for entities of one level. More...

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

Inheritance diagram for Dune::LevelSingleCodimSingleGeomTypeMapper< G, c >:

Public Types
typedef G::LevelGridView::IndexSet::IndexType	Index
	Number type used for indices. More...

Public Member Functions
	LevelSingleCodimSingleGeomTypeMapper (const G &grid, int level)

Index	map (const EntityType &e) const
	Map entity to array index. More...

Index	map (const typename G::LevelGridView::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::LevelGridView::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::LevelGridView::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, int c>
class Dune::LevelSingleCodimSingleGeomTypeMapper< G, c >

Single codim and single geometry type mapper for entities of one level.

This mapper uses all entities of a certain codimension on a given level 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

typedef G::LevelGridView ::IndexSet::IndexType Dune::SingleCodimSingleGeomTypeMapper< G::LevelGridView , c >::Index

inherited

Number type used for indices.

Constructor & Destructor Documentation

template<typename G , int c>

Dune::LevelSingleCodimSingleGeomTypeMapper< G, c >::LevelSingleCodimSingleGeomTypeMapper	(	const G &	grid,
		int	level
	)

inline

Member Function Documentation

bool Dune::SingleCodimSingleGeomTypeMapper< G::LevelGridView , 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

References Dune::SingleCodimSingleGeomTypeMapper< GV, c >::index().

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

References Dune::SingleCodimSingleGeomTypeMapper< GV, c >::subIndex().

bool Dune::Mapper< G, SingleCodimSingleGeomTypeMapper< G::LevelGridView, c > , G::LevelGridView::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

bool Dune::Mapper< G, SingleCodimSingleGeomTypeMapper< G::LevelGridView, c > , G::LevelGridView::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

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

inlineinherited

Map entity to array index.

Parameters

e	Reference 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.

Index Dune::SingleCodimSingleGeomTypeMapper< G::LevelGridView , c >::map ( const EntityType & e ) const

inlineinherited

Map entity to array index.

Parameters

e	Reference 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.

Deprecated:: "Will be removed after dune-grid-2.4. Use method 'index' instead!"

Index Dune::SingleCodimSingleGeomTypeMapper< G::LevelGridView , c >::map	(	const typename G::LevelGridView ::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.

Deprecated:: "Will be removed after dune-grid-2.4. Use method 'subIndex' instead!"

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

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.

Deprecated:: "Will be removed after dune-grid-2.4. Use method 'index' instead!"

int Dune::SingleCodimSingleGeomTypeMapper< G::LevelGridView , 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.

Index Dune::SingleCodimSingleGeomTypeMapper< G::LevelGridView , c >::subIndex	(	const typename G::LevelGridView ::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.

Index Dune::Mapper< G, SingleCodimSingleGeomTypeMapper< G::LevelGridView, c > , G::LevelGridView::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.

void Dune::SingleCodimSingleGeomTypeMapper< G::LevelGridView , c >::update ( )

inlineinherited

Recalculates map after mesh adaptation.

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

scsgmapper.hh

Public Types

Public Member Functions

Detailed Description

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

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

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