Dune Core Modules (2.9.0)

Dune::Pk1DFiniteElementFactory< Geometry, RF, k > Struct Template Reference

Factory for Pk1DFiniteElement objects. More...

#include <dune/localfunctions/lagrange/pk1d.hh>

Public Member Functions

template<class VertexOrder >
const FiniteElement make (const Geometry &geometry, const VertexOrder &vertexOrder)
 construct Pk1DFiniteElementFactory More...
 
Finite element creation methods

Each finite element factory implementation must provide at least one of these methods. The signatures may be extended by additional parameters, but the parameters that are specified here should be given first and in the order specified here.

The return value of these functions is suitable for binding to a const reference – it will either be an rvalue (in which case binding to a const reference will create a copy whose lifetime is the same as the reference itself), or it will be an lvalue (in which case the factory must guarantee that it will be valid until the factory is destroyed or something else happens that explicitly invalidates all created finite elements).

In any case, since global-valued finite element objects are copy-constructible, it is also possible to use the returned value to initialize a finite element object instead of a const reference.

const FiniteElement make (const Geometry &, const VertexOrder &,...)
 create a finite element from a geometry and a vertex ordering
 
const FiniteElement make (const Geometry &,...)
 create a finite element from a geometry
 
const FiniteElement make (const VertexOrder &,...)
 create a finite element from a vertex ordering
 
const FiniteElement make (const GeometryType &,...)
 create a finite element from a geometry type More...
 
const FiniteElement make (...)
 create a finite element
 

Detailed Description

template<class Geometry, class RF, std::size_t k>
struct Dune::Pk1DFiniteElementFactory< Geometry, RF, k >

Factory for Pk1DFiniteElement objects.

Constructs Pk1DFiniteElement objects given a geometry and a vertex ordering.

Template Parameters
GeometryGeometry for the local to global transformation.
RFField type of the range.
kMaximum polynomial order of the base functions.

Member Function Documentation

◆ make() [1/2]

template<class Geometry , class RF , std::size_t k>
template<class VertexOrder >
const FiniteElement Dune::Pk1DFiniteElementFactory< Geometry, RF, k >::make ( const Geometry geometry,
const VertexOrder &  vertexOrder 
)
inline

construct Pk1DFiniteElementFactory

Parameters
geometryThe geometry object to use for adaption.
vertexOrderThe global ordering of the vertices within the grid, used to determine orientation of the edges. This vertexOrder object must support codim=0.
Note
The returned object stores the reference to the geometry passed here. Any use of the returned value after this references has become invalid results in undefined behaviour. The exception is that the destructor of this class may still be called. The information contained in the vertexOrder object is extracted and the object is no longer needed after the constructor returns. No reference to internal data of the factory is stored.

◆ make() [2/2]

template<class Geometry , class VertexOrder >
const FiniteElement Dune::FiniteElementFactoryInterface< Geometry, VertexOrder >::make ( const GeometryType ,
  ... 
)
inherited

create a finite element from a geometry type

Note
This signature should only be used when only the geometry type but not the full geometry or vertex ordering are needed.

The documentation for this struct was generated from the following file:
  • dune/localfunctions/lagrange/pk1d.hh
Creative Commons License   |  Legal Statements / Impressum  |  Hosted by TU Dresden  |  generated with Hugo v0.80.0 (Mar 28, 23:30, 2024)