hierarchic index set of ALU3dGrid More...

#include <dune/grid/alugrid/3d/indexsets.hh>

Inheritance diagram for Dune::ALU3dGridHierarchicIndexSet< elType, Comm >:

Public Types
typedef GridType::Traits::template Codim< 0 >::Entity	EntityCodim0Type
typedef IndexTypeImp	IndexType
	The type used for the indices.

Public Member Functions
template<class EntityType >
int	index (const EntityType &ep) const
	return hierarchic index of given entity
template<int codim>
int	index (const typename GridType::Traits::template Codim< codim >::Entity &entity) const
	return hierarchic index of given entity
int	subIndex (const EntityCodim0Type &e, int i, unsigned int codim) const
	return subIndex i of given entity for subEntity with codim
int	size (GeometryType type) const
int	size (int codim) const
	return size of indexset, i.e. maxindex+1
const std::vector< GeometryType > &	geomTypes (int codim) const
	deliver all geometry types used in this grid
template<class EntityType >
bool	contains (const EntityType &) const
	return true because all entities are contained in this set
Index access from entity
IndexType	index (const typename remove_const< ALU3dGrid< elType, Comm > >::type::Traits::template Codim< cc >::Entity &e) const
	Map entity to index. The result of calling this method with an entity that is not in the index set is undefined.
IndexType	subIndex (const typename Traits::template Codim< cc >::Entity &e, int i, unsigned int codim) const
	Map a subentity to an index.
IndexType	subIndex (const Entity &e, int i, unsigned int codim) const
	Map a subentity to an index.

Static Public Attributes
static const int	dimension
	dimension of the grid (maximum allowed codimension)

Friends
class	ALU3dGrid< elType, Comm >

Detailed Description

template<ALU3dGridElementType elType, class Comm>
class Dune::ALU3dGridHierarchicIndexSet< elType, Comm >

hierarchic index set of ALU3dGrid

Member Typedef Documentation

template<ALU3dGridElementType elType, class Comm >

typedef GridType::Traits::template Codim<0>::Entity Dune::ALU3dGridHierarchicIndexSet< elType, Comm >::EntityCodim0Type

typedef IndexTypeImp Dune::IndexSet< ALU3dGrid< elType, Comm > , ALU3dGridHierarchicIndexSet< elType, Comm > , IndexTypeImp >::IndexType

inherited

The type used for the indices.

Member Function Documentation

template<ALU3dGridElementType elType, class Comm >

template<class EntityType >

bool Dune::ALU3dGridHierarchicIndexSet< elType, Comm >::contains ( const EntityType & ) const

inline

return true because all entities are contained in this set

Reimplemented from Dune::IndexSet< ALU3dGrid< elType, Comm >, ALU3dGridHierarchicIndexSet< elType, Comm > >.

template<ALU3dGridElementType elType, class Comm >

const std::vector<GeometryType>& Dune::ALU3dGridHierarchicIndexSet< elType, Comm >::geomTypes ( int codim ) const

inline

deliver all geometry types used in this grid

Reimplemented from Dune::IndexSet< ALU3dGrid< elType, Comm >, ALU3dGridHierarchicIndexSet< elType, Comm > >.

References Dune::ALU3dGrid< elType, Comm >::geomTypes().

template<ALU3dGridElementType elType, class Comm >

template<class EntityType >

int Dune::ALU3dGridHierarchicIndexSet< elType, Comm >::index ( const EntityType & ep ) const

inline

return hierarchic index of given entity

Reimplemented from Dune::IndexSet< ALU3dGrid< elType, Comm >, ALU3dGridHierarchicIndexSet< elType, Comm > >.

Referenced by Dune::ALU3dGridGlobalIdSet< elType, Comm >::id().

template<ALU3dGridElementType elType, class Comm >

template<int codim>

int Dune::ALU3dGridHierarchicIndexSet< elType, Comm >::index ( const typename GridType::Traits::template Codim< codim >::Entity & entity ) const

inline

return hierarchic index of given entity

References Dune::GridDefaultImplementation< 3, 3, alu3d_ctype, ALU3dGridFamily< elType, Comm > >::getRealImplementation().

IndexType Dune::IndexSet< ALU3dGrid< elType, Comm > , ALU3dGridHierarchicIndexSet< elType, Comm > , IndexTypeImp >::index ( const typename remove_const< ALU3dGrid< elType, Comm > >::type::Traits::template Codim< cc >::Entity & e ) const

inlineinherited

Map entity to index. The result of calling this method with an entity that is not in the index set is undefined.

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.

template<ALU3dGridElementType elType, class Comm >

int Dune::ALU3dGridHierarchicIndexSet< elType, Comm >::size ( GeometryType type ) const

inline

return size of indexset, i.e. maxindex+1 for given type, if type is not exisiting within grid 0 is returned

Reimplemented from Dune::IndexSet< ALU3dGrid< elType, Comm >, ALU3dGridHierarchicIndexSet< elType, Comm > >.

References Dune::ALU3dGrid< elType, Comm >::dimension, Dune::hexa, and Dune::tetra.

template<ALU3dGridElementType elType, class Comm >

int Dune::ALU3dGridHierarchicIndexSet< elType, Comm >::size ( int codim ) const

inline

return size of indexset, i.e. maxindex+1

Reimplemented from Dune::IndexSet< ALU3dGrid< elType, Comm >, ALU3dGridHierarchicIndexSet< elType, Comm > >.

References Dune::ALU3dGrid< elType, Comm >::hierSetSize().

template<ALU3dGridElementType elType, class Comm >

int Dune::ALU3dGridHierarchicIndexSet< elType, Comm >::subIndex	(	const EntityCodim0Type &	e,
		int	i,
		unsigned int	codim
	)		const

inline

return subIndex i of given entity for subEntity with codim

References Dune::GridDefaultImplementation< 3, 3, alu3d_ctype, ALU3dGridFamily< elType, Comm > >::getRealImplementation().

Referenced by Dune::ALU3dGridGlobalIdSet< elType, Comm >::subId().

IndexType Dune::IndexSet< ALU3dGrid< elType, Comm > , ALU3dGridHierarchicIndexSet< elType, Comm > , IndexTypeImp >::subIndex	(	const typename Traits::template Codim< cc >::Entity &	e,
		int	i,
		unsigned int	codim
	)		const

inlineinherited

Map a subentity to an index.

The result of calling this method with an entity that is not in the index set is undefined.

Template Parameters:

cc	codimension of the entity

Parameters:

[in]	e	reference to codimsion cc entity
[in]	i	number subentity of e within the codimension
[in]	codim	codimension of the subentity we're interested in (must satisfy cc <= codim <= dimension)

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

IndexType Dune::IndexSet< ALU3dGrid< elType, Comm > , ALU3dGridHierarchicIndexSet< elType, Comm > , IndexTypeImp >::subIndex	(	const Entity &	e,
		int	i,
		unsigned int	codim
	)		const

inlineinherited

Map a subentity to an index.

The result of calling this method with an entity that is not in the index set is undefined.

Note:: This method exists for convenience only. It extracts the codimension from the type of the entity, which can be guessed by the compiler.

Template Parameters:

Entity type of entity (must be GridImp::Codim< cc >::Entity for some cc)

Parameters:

[in]	e	reference to entity
[in]	i	number subentity of e within the codimension
[in]	codim	codimension of the subentity we're interested in

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

Friends And Related Function Documentation

template<ALU3dGridElementType elType, class Comm >

friend class ALU3dGrid< elType, Comm >

friend

Member Data Documentation

const int Dune::IndexSet< ALU3dGrid< elType, Comm > , ALU3dGridHierarchicIndexSet< elType, Comm > , IndexTypeImp >::dimension

staticinherited

dimension of the grid (maximum allowed codimension)

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

alugrid/3d/indexsets.hh

Public Types

Public Member Functions

Static Public Attributes

Friends

Detailed Description

template<ALU3dGridElementType elType, class Comm> class Dune::ALU3dGridHierarchicIndexSet< elType, Comm >

Member Typedef Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation

template<ALU3dGridElementType elType, class Comm>
class Dune::ALU3dGridHierarchicIndexSet< elType, Comm >