dune-pdelab  2.0.0
Classes | Public Types | Public Member Functions | Static Public Attributes | Friends | List of all members
Dune::PDELab::DOFIndex< T, tree_n, entity_n > Class Template Reference

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

Classes

class  View
 

Public Types

typedef array< T, entity_capacityEntityIndex
 
typedef MultiIndex< T, max_depthTreeIndex
 
typedef TreeIndex::size_type size_type
 
typedef T value_type
 

Public Member Functions

 DOFIndex ()
 Default constructor. More...
 
 DOFIndex (const View &view)
 
View view () const
 
View view (std::size_t size) const
 
void clear ()
 
EntityIndexentityIndex ()
 Returns the index of the grid entity associated with the DOF. More...
 
const EntityIndexentityIndex () const
 
TreeIndextreeIndex ()
 
const TreeIndextreeIndex () const
 
bool operator== (const DOFIndex &r) const
 Tests whether two MultiIndices are equal. More...
 
bool operator!= (const DOFIndex &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...
 
static const std::size_t entity_capacity = entity_n
 

Friends

std::ostream & operator<< (std::ostream &s, const DOFIndex &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, std::size_t entity_n = 1>
typedef array<T,entity_capacity> Dune::PDELab::DOFIndex< T, tree_n, entity_n >::EntityIndex
template<typename T, std::size_t tree_n, std::size_t entity_n = 1>
typedef TreeIndex::size_type Dune::PDELab::DOFIndex< T, tree_n, entity_n >::size_type
template<typename T, std::size_t tree_n, std::size_t entity_n = 1>
typedef MultiIndex<T,max_depth> Dune::PDELab::DOFIndex< T, tree_n, entity_n >::TreeIndex
template<typename T, std::size_t tree_n, std::size_t entity_n = 1>
typedef T Dune::PDELab::DOFIndex< T, tree_n, entity_n >::value_type

Constructor & Destructor Documentation

template<typename T, std::size_t tree_n, std::size_t entity_n = 1>
Dune::PDELab::DOFIndex< T, tree_n, entity_n >::DOFIndex ( )
inline

Default constructor.

template<typename T, std::size_t tree_n, std::size_t entity_n = 1>
Dune::PDELab::DOFIndex< T, tree_n, entity_n >::DOFIndex ( const View view)
inlineexplicit

Member Function Documentation

template<typename T, std::size_t tree_n, std::size_t entity_n = 1>
void Dune::PDELab::DOFIndex< T, tree_n, entity_n >::clear ( )
inline
template<typename T, std::size_t tree_n, std::size_t entity_n = 1>
EntityIndex& Dune::PDELab::DOFIndex< T, tree_n, entity_n >::entityIndex ( )
inline
template<typename T, std::size_t tree_n, std::size_t entity_n = 1>
const EntityIndex& Dune::PDELab::DOFIndex< T, tree_n, entity_n >::entityIndex ( ) const
inline

References _entity_index.

template<typename T, std::size_t tree_n, std::size_t entity_n = 1>
bool Dune::PDELab::DOFIndex< T, tree_n, entity_n >::operator!= ( const DOFIndex< T, tree_n, entity_n > &  r) const
inline

Tests whether two MultiIndices are not equal.

template<typename T, std::size_t tree_n, std::size_t entity_n = 1>
bool Dune::PDELab::DOFIndex< T, tree_n, entity_n >::operator== ( const DOFIndex< T, tree_n, entity_n > &  r) const
inline

Tests whether two MultiIndices are equal.

Note
Only MultiIndices of identical max_depth are comparable

References _entity_index.

template<typename T, std::size_t tree_n, std::size_t entity_n = 1>
std::size_t Dune::PDELab::DOFIndex< T, tree_n, entity_n >::size ( ) const
inline
template<typename T, std::size_t tree_n, std::size_t entity_n = 1>
TreeIndex& Dune::PDELab::DOFIndex< T, tree_n, entity_n >::treeIndex ( )
inline
template<typename T, std::size_t tree_n, std::size_t entity_n = 1>
const TreeIndex& Dune::PDELab::DOFIndex< T, tree_n, entity_n >::treeIndex ( ) const
inline
template<typename T, std::size_t tree_n, std::size_t entity_n = 1>
View Dune::PDELab::DOFIndex< T, tree_n, entity_n >::view ( ) const
inline
template<typename T, std::size_t tree_n, std::size_t entity_n = 1>
View Dune::PDELab::DOFIndex< T, tree_n, entity_n >::view ( std::size_t  size) const
inline

Friends And Related Function Documentation

template<typename T, std::size_t tree_n, std::size_t entity_n = 1>
std::ostream& operator<< ( std::ostream &  s,
const DOFIndex< T, tree_n, entity_n > &  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, std::size_t entity_n = 1>
const std::size_t Dune::PDELab::DOFIndex< T, tree_n, entity_n >::entity_capacity = entity_n
static
template<typename T, std::size_t tree_n, std::size_t entity_n = 1>
const std::size_t Dune::PDELab::DOFIndex< T, tree_n, entity_n >::max_depth = tree_n
static

The maximum possible depth of the MultiIndex.


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