extended interface for consecutive index sets More...

#include <dune/fem/gridpart/common/indexset.hh>

Inheritance diagram for Dune::Fem::ConsecutiveIndexSet< Traits >:

Public Types
typedef Traits::IndexType	IndexType
	index type

typedef Traits::Types	Types
	geometry type range type

Public Member Functions
Types	types (int codim) const
	return range of geometry types

template<class Entity >
bool	contains (const Entity &entity) const
	return true if entity has index

IndexType	size (GeometryType type) const
	return number of entities of given type

IndexType	size (int codim) const
	return number of entities of given codimension

template<class Entity >
IndexType	index (const Entity &entity) const
	return index for given entity

template<int codim>
IndexType	index (const typename Codim< codim >::Entity &entity) const
	return index for given entity

template<class Entity >
IndexType	subIndex (const Entity &entity, int i, unsigned int cd) const
	return index for given subentity

template<int codim>
IndexType	subIndex (const typename Codim< codim >::Entity &entity, int i, unsigned int cd) const
	return index for given subentity

void	requestCodimensions (const std::vector< int > &codimensions) const
	receive request for codimension support in case index set is adaptive

Adaptation
void	resize ()
	please doc me

bool	compress ()
	please doc me

void	insertEntity (const typename BaseType::template Codim< 0 >::Entity &entity)
	please doc me

void	removeEntity (const typename BaseType::template Codim< 0 >::Entity &entity)
	please doc me

void	backup () const
	please doc me

void	restore ()
	please doc me

template<class T >
void	write (OutStreamInterface< T > &stream) const
	please doc me

template<class T >
void	read (InStreamInterface< T > &stream)
	please doc me

Static Public Attributes
static const int	dimension = Traits::dimension
	grid dimension

Protected Member Functions
	ConsecutiveIndexSet ()=default

Traits::IndexSetType &	impl ()

const Traits::IndexSetType &	impl () const

Detailed Description

template<class Traits>
class Dune::Fem::ConsecutiveIndexSet< Traits >

extended interface for consecutive index sets

Note: IndexSets implementing this extended interface can be managed by the DofManager

Member Typedef Documentation

◆ IndexType

template<class Traits >

typedef Traits::IndexType Dune::Fem::IndexSet< Traits >::IndexType

inherited

index type

◆ Types

template<class Traits >

typedef Traits::Types Dune::Fem::IndexSet< Traits >::Types

inherited

geometry type range type

Constructor & Destructor Documentation

◆ ConsecutiveIndexSet()

template<class Traits >

Dune::Fem::ConsecutiveIndexSet< Traits >::ConsecutiveIndexSet ( )

protecteddefault

Member Function Documentation

◆ backup()

template<class Traits >

void Dune::Fem::ConsecutiveIndexSet< Traits >::backup ( ) const

inline

please doc me

◆ compress()

template<class Traits >

bool Dune::Fem::ConsecutiveIndexSet< Traits >::compress ( )

inline

please doc me

◆ contains()

template<class Traits >

template<class Entity >

bool Dune::Fem::IndexSet< Traits >::contains ( const Entity & entity ) const

inlineinherited

return true if entity has index

◆ impl() [1/2]

template<class Traits >

Traits::IndexSetType & Dune::Fem::ConsecutiveIndexSet< Traits >::impl ( )

inlineprotected

◆ impl() [2/2]

template<class Traits >

const Traits::IndexSetType & Dune::Fem::IndexSet< Traits >::impl ( ) const

inlineprotected

◆ index() [1/2]

template<class Traits >

template<class Entity >

IndexType Dune::Fem::IndexSet< Traits >::index ( const Entity & entity ) const

inlineinherited

return index for given entity

◆ index() [2/2]

template<class Traits >

template<int codim>

IndexType Dune::Fem::IndexSet< Traits >::index ( const typename Codim< codim >::Entity & entity ) const

inlineinherited

return index for given entity

◆ insertEntity()

template<class Traits >

void Dune::Fem::ConsecutiveIndexSet< Traits >::insertEntity ( const typename BaseType::template Codim< 0 >::Entity & entity )

inline

please doc me

◆ read()

template<class Traits >

template<class T >

void Dune::Fem::ConsecutiveIndexSet< Traits >::read ( InStreamInterface< T > & stream )

inline

please doc me

◆ removeEntity()

template<class Traits >

void Dune::Fem::ConsecutiveIndexSet< Traits >::removeEntity ( const typename BaseType::template Codim< 0 >::Entity & entity )

inline

please doc me

◆ requestCodimensions()

template<class Traits >

void Dune::Fem::IndexSet< Traits >::requestCodimensions ( const std::vector< int > & codimensions ) const

inlineinherited

receive request for codimension support in case index set is adaptive

◆ resize()

template<class Traits >

void Dune::Fem::ConsecutiveIndexSet< Traits >::resize ( )

inline

please doc me

◆ restore()

template<class Traits >

void Dune::Fem::ConsecutiveIndexSet< Traits >::restore ( )

inline

please doc me

◆ size() [1/2]

template<class Traits >

IndexType Dune::Fem::IndexSet< Traits >::size ( GeometryType type ) const

inlineinherited

return number of entities of given type

◆ size() [2/2]

template<class Traits >

IndexType Dune::Fem::IndexSet< Traits >::size ( int codim ) const

inlineinherited

return number of entities of given codimension

◆ subIndex() [1/2]

template<class Traits >

template<class Entity >

IndexType Dune::Fem::IndexSet< Traits >::subIndex	(	const Entity &	entity,
		int	i,
		unsigned int	cd
	)		const

inlineinherited

return index for given subentity

◆ subIndex() [2/2]

template<class Traits >

template<int codim>

IndexType Dune::Fem::IndexSet< Traits >::subIndex	(	const typename Codim< codim >::Entity &	entity,
		int	i,
		unsigned int	cd
	)		const

inlineinherited

return index for given subentity

◆ types()

template<class Traits >

Types Dune::Fem::IndexSet< Traits >::types ( int codim ) const

inlineinherited

return range of geometry types

◆ write()

template<class Traits >

template<class T >

void Dune::Fem::ConsecutiveIndexSet< Traits >::write ( OutStreamInterface< T > & stream ) const

inline

please doc me

Member Data Documentation

◆ dimension

template<class Traits >

const int Dune::Fem::IndexSet< Traits >::dimension = Traits::dimension

staticinherited

grid dimension

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

common/indexset.hh

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Detailed Description

Member Typedef Documentation

◆ IndexType

◆ Types

Constructor & Destructor Documentation

◆ ConsecutiveIndexSet()

Member Function Documentation

◆ backup()

◆ compress()

◆ contains()

◆ impl() [1/2]

◆ impl() [2/2]

◆ index() [1/2]

◆ index() [2/2]

◆ insertEntity()

◆ read()

◆ removeEntity()

◆ requestCodimensions()

◆ resize()

◆ restore()

◆ size() [1/2]

◆ size() [2/2]

◆ subIndex() [1/2]

◆ subIndex() [2/2]

◆ types()

◆ write()

Member Data Documentation

◆ dimension