Dune::PDELab::GlobalDOFIndex< T, tree_n, ID > Class Template Reference

#include <dune/pdelab/common/globaldofindex.hh>

Classes
class	View

Public Types
typedef ID	EntityID
typedef MultiIndex< T, max_depth >	TreeIndex
typedef TreeIndex::size_type	size_type
typedef T	value_type

Public Member Functions
	GlobalDOFIndex ()
	Default constructor. More...
	GlobalDOFIndex (const EntityID &entity_id, const TreeIndex &tree_index)
View	view () const
View	view (std::size_t size) const
void	clear ()
EntityID &	entityID ()
	Returns the index of the grid entity associated with the DOF. More...
const EntityID &	entityID () const
TreeIndex &	treeIndex ()
const TreeIndex &	treeIndex () const
bool	operator== (const GlobalDOFIndex &r) const
	Tests whether two MultiIndices are equal. More...
bool	operator!= (const GlobalDOFIndex &r) const
	Tests whether two MultiIndices are not equal. More...
std::size_t	size () const

Static Public Attributes
static const std::size_t	max_depth = tree_n
	The maximum possible depth of the MultiIndex. More...

Member Typedef Documentation

EntityID

template<typename T , std::size_t tree_n, typename ID >

typedef ID Dune::PDELab::GlobalDOFIndex< T, tree_n, ID >::EntityID

size_type

template<typename T , std::size_t tree_n, typename ID >

typedef TreeIndex::size_type Dune::PDELab::GlobalDOFIndex< T, tree_n, ID >::size_type

TreeIndex

template<typename T , std::size_t tree_n, typename ID >

typedef MultiIndex<T,max_depth> Dune::PDELab::GlobalDOFIndex< T, tree_n, ID >::TreeIndex

value_type

template<typename T , std::size_t tree_n, typename ID >

typedef T Dune::PDELab::GlobalDOFIndex< T, tree_n, ID >::value_type

Constructor & Destructor Documentation

GlobalDOFIndex() [1/2]

template<typename T , std::size_t tree_n, typename ID >

Dune::PDELab::GlobalDOFIndex< T, tree_n, ID >::GlobalDOFIndex ( )

inline

Default constructor.

GlobalDOFIndex() [2/2]

template<typename T , std::size_t tree_n, typename ID >

Dune::PDELab::GlobalDOFIndex< T, tree_n, ID >::GlobalDOFIndex ( const EntityID &  entity_id, const TreeIndex &  tree_index  )

inline

Member Function Documentation

clear()

template<typename T , std::size_t tree_n, typename ID >

void Dune::PDELab::GlobalDOFIndex< T, tree_n, ID >::clear ( )

inline

entityID() [1/2]

template<typename T , std::size_t tree_n, typename ID >

EntityID& Dune::PDELab::GlobalDOFIndex< T, tree_n, ID >::entityID ( )

inline

Returns the index of the grid entity associated with the DOF.

entityID() [2/2]

template<typename T , std::size_t tree_n, typename ID >

const EntityID& Dune::PDELab::GlobalDOFIndex< T, tree_n, ID >::entityID ( ) const

inline

operator!=()

template<typename T , std::size_t tree_n, typename ID >

bool Dune::PDELab::GlobalDOFIndex< T, tree_n, ID >::operator!= ( const GlobalDOFIndex< T, tree_n, ID > &  r ) const

inline

Tests whether two MultiIndices are not equal.

operator==()

template<typename T , std::size_t tree_n, typename ID >

bool Dune::PDELab::GlobalDOFIndex< T, tree_n, ID >::operator== ( const GlobalDOFIndex< T, tree_n, ID > &  r ) const

inline

Tests whether two MultiIndices are equal.

Note

Only MultiIndices of identical max_depth are comparable

size()

template<typename T , std::size_t tree_n, typename ID >

std::size_t Dune::PDELab::GlobalDOFIndex< T, tree_n, ID >::size ( ) const

inline

treeIndex() [1/2]

template<typename T , std::size_t tree_n, typename ID >

TreeIndex& Dune::PDELab::GlobalDOFIndex< T, tree_n, ID >::treeIndex ( )

inline

treeIndex() [2/2]

template<typename T , std::size_t tree_n, typename ID >

const TreeIndex& Dune::PDELab::GlobalDOFIndex< T, tree_n, ID >::treeIndex ( ) const

inline

view() [1/2]

template<typename T , std::size_t tree_n, typename ID >

View Dune::PDELab::GlobalDOFIndex< T, tree_n, ID >::view ( ) const

inline

view() [2/2]

template<typename T , std::size_t tree_n, typename ID >

View Dune::PDELab::GlobalDOFIndex< T, tree_n, ID >::view ( std::size_t  size ) const

inline

Member Data Documentation

max_depth

template<typename T , std::size_t tree_n, typename ID >

const std::size_t Dune::PDELab::GlobalDOFIndex< T, tree_n, ID >::max_depth = tree_n

static

The maximum possible depth of the MultiIndex.

---

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

• globaldofindex.hh