dune-pdelab  2.4-dev
Classes | Public Types | Public Member Functions | Static Public Attributes | Friends | List of all members
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_depthTreeIndex
 
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 ()
 
EntityIDentityID ()
 Returns the index of the grid entity associated with the DOF. More...
 
const EntityIDentityID () const
 
TreeIndextreeIndex ()
 
const TreeIndextreeIndex () 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...
 

Friends

std::ostream & operator<< (std::ostream &s, const GlobalDOFIndex &di)
 Writes a pretty representation of the MultiIndex to the given std::ostream. More...
 

Member Typedef Documentation

template<typename T, std::size_t tree_n, typename ID>
typedef ID Dune::PDELab::GlobalDOFIndex< T, tree_n, ID >::EntityID
template<typename T, std::size_t tree_n, typename ID>
typedef TreeIndex::size_type Dune::PDELab::GlobalDOFIndex< T, tree_n, ID >::size_type
template<typename T, std::size_t tree_n, typename ID>
typedef MultiIndex<T,max_depth> Dune::PDELab::GlobalDOFIndex< T, tree_n, ID >::TreeIndex
template<typename T, std::size_t tree_n, typename ID>
typedef T Dune::PDELab::GlobalDOFIndex< T, tree_n, ID >::value_type

Constructor & Destructor Documentation

template<typename T, std::size_t tree_n, typename ID>
Dune::PDELab::GlobalDOFIndex< T, tree_n, ID >::GlobalDOFIndex ( )
inline

Default constructor.

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

template<typename T, std::size_t tree_n, typename ID>
void Dune::PDELab::GlobalDOFIndex< T, tree_n, ID >::clear ( )
inline
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.

Referenced by Dune::PDELab::hash_value().

template<typename T, std::size_t tree_n, typename ID>
const EntityID& Dune::PDELab::GlobalDOFIndex< T, tree_n, ID >::entityID ( ) const
inline
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.

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
template<typename T, std::size_t tree_n, typename ID>
std::size_t Dune::PDELab::GlobalDOFIndex< T, tree_n, ID >::size ( ) const
inline
template<typename T, std::size_t tree_n, typename ID>
TreeIndex& Dune::PDELab::GlobalDOFIndex< T, tree_n, ID >::treeIndex ( )
inline
template<typename T, std::size_t tree_n, typename ID>
const TreeIndex& Dune::PDELab::GlobalDOFIndex< T, tree_n, ID >::treeIndex ( ) const
inline
template<typename T, std::size_t tree_n, typename ID>
View Dune::PDELab::GlobalDOFIndex< T, tree_n, ID >::view ( ) const
inline
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

Friends And Related Function Documentation

template<typename T, std::size_t tree_n, typename ID>
std::ostream& operator<< ( std::ostream &  s,
const GlobalDOFIndex< T, tree_n, ID > &  di 
)
friend

Writes a pretty representation of the MultiIndex to the given std::ostream.

Member Data Documentation

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: