dune-geometry  2.6-git
Classes | Public Types | Public Member Functions | Static Public Attributes | List of all members
Dune::Geo::ReferenceElement Class Reference

This class provides access to geometric and topological properties of a reference element. More...

#include <dune/geometry/affinegeometry.hh>

Inheritance diagram for Dune::Geo::ReferenceElement:
Inheritance graph

Classes

struct  Codim
 Collection of types depending on the codimension. More...
 

Public Types

using ctype = typename Implementation::ctype
 The coordinate field type. More...
 
using CoordinateField = ctype
 The coordinate field type. More...
 
using Coordinate = typename Implementation::Coordinate
 The coordinate type. More...
 

Public Member Functions

int size (int c) const
 number of subentities of codimension c More...
 
int size (int i, int c, int cc) const
 number of subentities of codimension cc of subentity (i,c) More...
 
int subEntity (int i, int c, int ii, int cc) const
 obtain number of ii-th subentity with codim cc of (i,c) More...
 
decltype(auto) type (int i, int c) const
 obtain the type of subentity (i,c) More...
 
decltype(auto) type () const
 obtain the type of this reference element More...
 
decltype(auto) position (int i, int c) const
 position of the barycenter of entity (i,c) More...
 
bool checkInside (const Coordinate &local) const
 check if a coordinate is in the reference element More...
 
template<int codim>
Codim< codim >::Geometry geometry (int i) const
 obtain the embedding of subentity (i,codim) into the reference element More...
 
CoordinateField volume () const
 obtain the volume of the reference element More...
 
decltype(auto) integrationOuterNormal (int face) const
 obtain the integration outer normal of the reference element More...
 
 ReferenceElement ()
 Constructs an empty reference element. More...
 
const Implementation & impl () const
 Returns a reference to the internal implementation object. More...
 
bool operator== (const ReferenceElement &r) const
 Compares for equality with another reference element. More...
 
bool operator!= (const ReferenceElement &r) const
 Compares for inequality with another reference element. More...
 

Static Public Attributes

static constexpr int dimension = Implementation::dimension
 The dimension of the reference element. More...
 

Detailed Description

This class provides access to geometric and topological properties of a reference element.

This includes its type, the number of subentities, the volume, and a method for checking if a point is contained in the reference element. The embedding of each subentity into the reference element is also provided.

This class has value semantics, i.e. you can (and should) pass it around by value and not by reference and store a copy of it.

Instances of this object for a given geometry type can be retrieved from the ReferenceElements class.

Member Typedef Documentation

◆ Coordinate

using Dune::Geo::ReferenceElement::Coordinate = typename Implementation::Coordinate

The coordinate type.

◆ CoordinateField

using Dune::Geo::ReferenceElement::CoordinateField = ctype

The coordinate field type.

◆ ctype

using Dune::Geo::ReferenceElement::ctype = typename Implementation::ctype

The coordinate field type.

Constructor & Destructor Documentation

◆ ReferenceElement()

Dune::Geo::ReferenceElement::ReferenceElement ( )
inline

Constructs an empty reference element.

This constructor creates an empty (invalid) reference element. This element may not be used in any way except for assigning other reference elements to it. After assigning a valid reference element (obtained from ReferenceElements), it may be used without restrictions.

Member Function Documentation

◆ checkInside()

bool Dune::Geo::ReferenceElement::checkInside ( const Coordinate local) const
inline

check if a coordinate is in the reference element

This method returns true if the given local coordinate is within this reference element.

Parameters
[in]localcoordinates of the point

◆ geometry()

template<int codim>
Codim<codim>::Geometry Dune::Geo::ReferenceElement::geometry ( int  i) const
inline

obtain the embedding of subentity (i,codim) into the reference element

Denote by E the i-th subentity of codimension codim of the current reference element. This method returns a Dune::AffineGeometry that maps the reference element of E into the current reference element.

Template Parameters
codimcodimension of subentity E
Parameters
[in]inumber of subentity E (0 <= i < size( codim ))

◆ impl()

const Implementation& Dune::Geo::ReferenceElement::impl ( ) const
inline

Returns a reference to the internal implementation object.

Warning
This method may only be called on valid reference elements.
This method exposes undocumented internals that may change without notice!

◆ integrationOuterNormal()

decltype(auto) Dune::Geo::ReferenceElement::integrationOuterNormal ( int  face) const
inline

obtain the integration outer normal of the reference element

The integration outer normal is the outer normal whose length coincides with the face's integration element.

Deprecated:
After dune-2.6 the return value will no longer be a reference but a copy. Code storing pointers or references to the result must be adjusted.
Parameters
[in]faceindex of the face, whose normal is desired

◆ operator!=()

bool Dune::Geo::ReferenceElement::operator!= ( const ReferenceElement r) const
inline

Compares for inequality with another reference element.

◆ operator==()

bool Dune::Geo::ReferenceElement::operator== ( const ReferenceElement r) const
inline

Compares for equality with another reference element.

◆ position()

decltype(auto) Dune::Geo::ReferenceElement::position ( int  i,
int  c 
) const
inline

position of the barycenter of entity (i,c)

Denote by E the i-th subentity of codimension c of the current reference element. This method returns the coordinates of the center of gravity of E within the current reference element.

Deprecated:
After dune-2.6 the return value will no longer be a reference but a copy. Code storing pointers or references to the result must be adjusted.
Parameters
[in]inumber of subentity E (0 <= i < size( c ))
[in]ccodimension of subentity E

◆ size() [1/2]

int Dune::Geo::ReferenceElement::size ( int  c) const
inline

number of subentities of codimension c

Parameters
[in]ccodimension whose size is desired

◆ size() [2/2]

int Dune::Geo::ReferenceElement::size ( int  i,
int  c,
int  cc 
) const
inline

number of subentities of codimension cc of subentity (i,c)

Denote by E the i-th subentity of codimension c of the current reference element. This method returns the number of subentities of codimension cc of the current reference element, that are also a subentity of E.

Parameters
[in]inumber of subentity E (0 <= i < size( c ))
[in]ccodimension of subentity E
[in]cccodimension whose size is desired (c <= cc <= dim)

◆ subEntity()

int Dune::Geo::ReferenceElement::subEntity ( int  i,
int  c,
int  ii,
int  cc 
) const
inline

obtain number of ii-th subentity with codim cc of (i,c)

Denote by E the i-th subentity of codimension c of the current reference element. And denote by S the ii-th subentity of codimension (cc-c) of E. Then, S is a also a subentity of codimension c of the current reference element. This method returns the number of S with respect to the current reference element.

Parameters
[in]inumber of subentity E (0 <= i < size( c ))
[in]ccodimension of subentity E
[in]iinumber of subentity S (with respect to E)
[in]cccodimension of subentity S (c <= cc <= dim)

◆ type() [1/2]

decltype(auto) Dune::Geo::ReferenceElement::type ( ) const
inline

obtain the type of this reference element

Deprecated:
After dune-2.6 the return value will no longer be a reference but a copy. Code storing pointers or references to the result must be adjusted.

◆ type() [2/2]

decltype(auto) Dune::Geo::ReferenceElement::type ( int  i,
int  c 
) const
inline

obtain the type of subentity (i,c)

Denote by E the i-th subentity of codimension c of the current reference element. This method returns the GeometryType of E.

Deprecated:
After dune-2.6 the return value will no longer be a reference but a copy. Code storing pointers or references to the result must be adjusted.
Parameters
[in]inumber of subentity E (0 <= i < size( c ))
[in]ccodimension of subentity E

◆ volume()

CoordinateField Dune::Geo::ReferenceElement::volume ( ) const
inline

obtain the volume of the reference element

Member Data Documentation

◆ dimension

constexpr int Dune::Geo::ReferenceElement::dimension = Implementation::dimension
staticconstexpr

The dimension of the reference element.


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