Dune::LocalKey Class Reference

Describe position of one degree of freedom. More...

#include <dune/localfunctions/common/localkey.hh>

Public Types
enum	{ intersectionCodim =666 }
	Enumerate 'special values' for the codimension method. More...

Public Member Functions
	LocalKey ()
	Standard constructor for uninitialized local index. More...
	LocalKey (unsigned int s, unsigned int c, unsigned int i)
	Initialize all components. More...
unsigned int	subEntity () const
	Return number of associated subentity. More...
unsigned int	codim () const
	Return codim of associated entity. More...
unsigned int	index () const
	Return offset within subentity. More...
void	index (unsigned int i)
	Set index component. More...
bool	operator< (const LocalKey &other) const
	Less-than operator so we can use this class as a key type in stl containers. More...

Friends
std::ostream &	operator<< (std::ostream &s, const LocalKey &localKey)
	Write LocalKey object to output stream. More...

Detailed Description

Describe position of one degree of freedom.

A LocalKey associates a degree of freedom with an index of a local basis function.

Member Enumeration Documentation

anonymous enum

Enumerate 'special values' for the codimension method.

Enumerator

intersectionCodim

Codimension returned by LocalKey::codim() for degrees of freedom attached to an intersection. The standard interface of dune-localfunctions assumes that degrees of freedom are attached to subentities of an element. This subentities can be described by a codimension and a subentity number. However some elements, like the mimetic finite elements, attach their degrees of freedom to intersections. While intersections do have a codimension, namely 1, having the method codim() return 1 in this case would be ambiguous. Hence 'intersectionCodim' is returned instead.

Constructor & Destructor Documentation

Dune::LocalKey::LocalKey ( )

inline

Standard constructor for uninitialized local index.

Dune::LocalKey::LocalKey ( unsigned int  s, unsigned int  c, unsigned int  i  )

inline

Initialize all components.

Parameters

s	Local number of the associated subentity
c	Codimension of the associated subentity
i	Index in the set of all functions associated to this subentity

Member Function Documentation

unsigned int Dune::LocalKey::codim ( ) const

inline

Return codim of associated entity.

Referenced by Dune::PowerCoefficients::PowerCoefficients().

unsigned int Dune::LocalKey::index ( ) const

inline

Return offset within subentity.

Referenced by Dune::PowerCoefficients::PowerCoefficients(), Dune::EquidistantPointSetImpl< GenericGeometry::Prism< BaseTopology >, F >::setup(), and Dune::EquidistantPointSetImpl< GenericGeometry::Pyramid< BaseTopology >, F >::setup().

void Dune::LocalKey::index ( unsigned int  i )

inline

Set index component.

bool Dune::LocalKey::operator< ( const LocalKey &  other ) const

inline

Less-than operator so we can use this class as a key type in stl containers.

unsigned int Dune::LocalKey::subEntity ( ) const

inline

Return number of associated subentity.

Referenced by Dune::PowerCoefficients::PowerCoefficients(), Dune::EquidistantPointSetImpl< GenericGeometry::Prism< BaseTopology >, F >::setup(), and Dune::EquidistantPointSetImpl< GenericGeometry::Pyramid< BaseTopology >, F >::setup().

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  s, const LocalKey &  localKey  )

friend

Write LocalKey object to output stream.

---

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

• localkey.hh