Describe position of one degree of freedom.
More...
#include <dune/localfunctions/common/localkey.hh>
|
constexpr | LocalKey () noexcept |
| Standard constructor for uninitialized local index.
|
|
constexpr | LocalKey (unsigned int s, unsigned int c, unsigned int i) noexcept |
| Initialize all components.
|
|
constexpr unsigned int | subEntity () const noexcept |
| Return number of associated subentity.
|
|
constexpr unsigned int | codim () const noexcept |
| Return codim of associated entity.
|
|
constexpr unsigned int | index () const noexcept |
| Return offset within subentity.
|
|
constexpr void | index (unsigned int i) noexcept |
| Set index component.
|
|
bool | operator< (const LocalKey &other) const noexcept |
| Less-than operator so we can use this class as a key type in stl containers.
|
|
Describe position of one degree of freedom.
A LocalKey associates a degree of freedom with an index of a local basis function.
◆ 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.
|
◆ LocalKey() [1/2]
constexpr Dune::LocalKey::LocalKey |
( |
| ) |
|
|
inlineconstexprnoexcept |
Standard constructor for uninitialized local index.
◆ LocalKey() [2/2]
constexpr Dune::LocalKey::LocalKey |
( |
unsigned int |
s, |
|
|
unsigned int |
c, |
|
|
unsigned int |
i |
|
) |
| |
|
inlineconstexprnoexcept |
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 |
◆ codim()
constexpr unsigned int Dune::LocalKey::codim |
( |
| ) |
const |
|
inlineconstexprnoexcept |
Return codim of associated entity.
◆ index() [1/2]
constexpr unsigned int Dune::LocalKey::index |
( |
| ) |
const |
|
inlineconstexprnoexcept |
Return offset within subentity.
◆ index() [2/2]
constexpr void Dune::LocalKey::index |
( |
unsigned int |
i | ) |
|
|
inlineconstexprnoexcept |
◆ operator<()
bool Dune::LocalKey::operator< |
( |
const LocalKey & |
other | ) |
const |
|
inlinenoexcept |
Less-than operator so we can use this class as a key type in stl containers.
◆ subEntity()
constexpr unsigned int Dune::LocalKey::subEntity |
( |
| ) |
const |
|
inlineconstexprnoexcept |
Return number of associated subentity.
The documentation for this class was generated from the following file: