Implementation class for a multiple codim and multiple geometry type mapper. More...

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

Inheritance diagram for Dune::MultipleCodimMultipleGeomTypeMapper< GV >:

Public Types
typedef GV	GridView
	Underlying GridView. More...

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

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
	MultipleCodimMultipleGeomTypeMapper (const GV &gridView, const MCMGLayout &layout)
	construct mapper from grid and layout description More...

template<class EntityType >
Index	index (const EntityType &e) const
	Map entity to starting index in array for dof block. More...

Index	subIndex (const typename GV::template Codim< 0 >::Entity &e, int i, unsigned int codim) const
	Map subentity of codim 0 entity to starting index in array for dof block. More...

size_type	size () const
	Return total number of entities in the entity set managed by the mapper. More...

size_type	size (GeometryType gt) const
	return number of entries for a given geometry type More...

const std::vector< GeometryType > &	types (int codim) const
	return the geometry types with entries More...

template<class EntityType >
IntegralRange< Index >	indices (const EntityType &e) const
	Returns a pair with the starting point in the dof vector and the number of degrees of freedom if the entity is contained in the index set otherwise {0,0} is returned. More...

IntegralRange< Index >	indices (const typename GV::template Codim< 0 >::Entity &e, int i, int cc) const
	Returns a pair with the starting point in the dof vector and the number of degrees of freedom if the entity is contained in the index set otherwise {0,0} is returned. More...

template<class EntityType >
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...

void	update (const GV &gridView)
	Recalculates indices after grid adaptation. More...

void	update (GV &&gridView)
	Recalculates indices after grid adaptation. More...

void	update ()
	Recalculates indices after grid adaptation. More...

const MCMGLayout &	layout () const

const GridView &	gridView () const

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

bool	contains (const typename G::Traits::template Codim< 0 >::Entity &e, int i, int cc, GV::IndexSet::IndexType &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 (GridView &&gridView)
	Reinitialize mapper after grid has been modified. More...

Detailed Description

template<typename GV>
class Dune::MultipleCodimMultipleGeomTypeMapper< GV >

Implementation class for a multiple codim and multiple geometry type mapper.

In this implementation of a mapper the entity set used as domain for the map consists of the entities of a subset of codimensions in the given index set. The index set may contain entities of several geometry types.

The geometry types to be included in the mapper are selected using a layout functional (MCMGLayout) that is passed to the constructor.

Member Typedef Documentation

◆ GridView

template<typename GV >

typedef GV Dune::MultipleCodimMultipleGeomTypeMapper< GV >::GridView

Underlying GridView.

◆ Index

template<typename GV >

typedef GV::IndexSet::IndexType Dune::MultipleCodimMultipleGeomTypeMapper< GV >::Index

Number type used for indices.

◆ size_type

template<typename GV >

using Dune::MultipleCodimMultipleGeomTypeMapper< GV >::size_type = decltype(std::declval<typename GV::IndexSet>().size(0))

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

◆ MultipleCodimMultipleGeomTypeMapper()

template<typename GV >

Dune::MultipleCodimMultipleGeomTypeMapper< GV >::MultipleCodimMultipleGeomTypeMapper	(	const GV &	gridView,
		const MCMGLayout &	layout
	)

inline

construct mapper from grid and layout description

The layout parameter is a functional describing entities of which geometry types are included in the mapper. For commonly used cases, convenience functions are provided. See the MCMGLayout type documentation for details.

Parameters

gridView	grid view whose entities should be included in the mapper
layout	functional describing how many dof to store on each entity (fixed per geometry type)

Member Function Documentation

◆ contains() [1/3]

template<typename GV >

template<class EntityType >

bool Dune::MultipleCodimMultipleGeomTypeMapper< GV >::contains	(	const EntityType &	e,
		Index &	result
	)		const

inline

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/3]

bool Dune::Mapper< GV::Grid , MultipleCodimMultipleGeomTypeMapper< GV > , GV::IndexSet::IndexType >::contains	(	const typename G::Traits::template Codim< 0 >::Entity &	e,
		int	i,
		int	cc,
		GV::IndexSet::IndexType &	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() [3/3]

template<typename GV >

bool Dune::MultipleCodimMultipleGeomTypeMapper< GV >::contains	(	const typename GV::template Codim< 0 >::Entity &	e,
		int	i,
		int	cc,
		Index &	result
	)		const

inline

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

◆ gridView()

template<typename GV >

const GridView & Dune::MultipleCodimMultipleGeomTypeMapper< GV >::gridView ( ) const

inline

◆ index()

template<typename GV >

template<class EntityType >

Index Dune::MultipleCodimMultipleGeomTypeMapper< GV >::index ( const EntityType & e ) const

inline

Map entity to starting index in array for dof block.

Template Parameters

EntityType

Parameters

e	Reference to codim EntityType entity.

Returns: An index in the range 0 ... (Max number of entities in set)*blockSize - 1.

◆ indices() [1/2]

template<typename GV >

template<class EntityType >

IntegralRange< Index > Dune::MultipleCodimMultipleGeomTypeMapper< GV >::indices ( const EntityType & e ) const

inline

Returns a pair with the starting point in the dof vector and the number of degrees of freedom if the entity is contained in the index set otherwise {0,0} is returned.

Parameters

e	Reference to entity
result	integer reference to the start of the block

Returns: pair with first entry equal to index for that entity and the second entry the number of degrees of freedom (zero if entity is not in entity set of the mapper)

◆ indices() [2/2]

template<typename GV >

IntegralRange< Index > Dune::MultipleCodimMultipleGeomTypeMapper< GV >::indices	(	const typename GV::template Codim< 0 >::Entity &	e,
		int	i,
		int	cc
	)		const

inline

Returns a pair with the starting point in the dof vector and the number of degrees of freedom if the entity is contained in the index set otherwise {0,0} is returned.

Parameters

e	Reference to codim 0 entity
i	subentity number
cc	subentity codim
result	integer reference to the start of the block

Returns: pair with first entry equal to index for that entity and the second entry the number of degrees of freedom (zero if sub entity is not in entity set of the mapper)

◆ layout()

template<typename GV >

const MCMGLayout & Dune::MultipleCodimMultipleGeomTypeMapper< GV >::layout ( ) const

inline

◆ size() [1/2]

template<typename GV >

size_type Dune::MultipleCodimMultipleGeomTypeMapper< GV >::size ( ) const

inline

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.

◆ size() [2/2]

template<typename GV >

size_type Dune::MultipleCodimMultipleGeomTypeMapper< GV >::size ( GeometryType gt ) const

inline

return number of entries for a given geometry type

◆ subIndex() [1/2]

Index Dune::Mapper< GV::Grid , MultipleCodimMultipleGeomTypeMapper< GV > , 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]

template<typename GV >

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

inline

Map subentity of codim 0 entity to starting index in array for dof block.

Parameters

e	Reference to codim 0 entity.
i	Number of subentity of e
codim	Codimension of the subentity

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

◆ types()

template<typename GV >

const std::vector< GeometryType > & Dune::MultipleCodimMultipleGeomTypeMapper< GV >::types ( int codim ) const

inline

return the geometry types with entries

◆ update() [1/4]

template<typename GV >

void Dune::MultipleCodimMultipleGeomTypeMapper< GV >::update ( )

inline

Recalculates indices after grid adaptation.

◆ update() [2/4]

template<typename GV >

void Dune::MultipleCodimMultipleGeomTypeMapper< GV >::update ( const GV & gridView )

inline

Recalculates indices after grid adaptation.

After grid adaptation you need to call this to update the stored gridview and recalculate the indices.

◆ update() [3/4]

void Dune::Mapper< GV::Grid , MultipleCodimMultipleGeomTypeMapper< GV > , GV::IndexSet::IndexType >::update ( GridView && gridView )

inlineinherited

Reinitialize mapper after grid has been modified.

◆ update() [4/4]

template<typename GV >

void Dune::MultipleCodimMultipleGeomTypeMapper< GV >::update ( GV && gridView )

inline

Recalculates indices after grid adaptation.

After grid adaptation you need to call this to update the stored gridview and recalculate the indices.

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

mcmgmapper.hh

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ GridView

◆ Index

◆ size_type

Constructor & Destructor Documentation

◆ MultipleCodimMultipleGeomTypeMapper()

Member Function Documentation

◆ contains() [1/3]

◆ contains() [2/3]

◆ contains() [3/3]

◆ gridView()

◆ index()

◆ indices() [1/2]

◆ indices() [2/2]

◆ layout()

◆ size() [1/2]

◆ size() [2/2]

◆ subIndex() [1/2]

◆ subIndex() [2/2]

◆ types()

◆ update() [1/4]

◆ update() [2/4]

◆ update() [3/4]

◆ update() [4/4]