Dune Core Modules (2.4.1)

Dune::VertexOrderByIdFactory< IdSet, Index > Class Template Reference

Factory for GeneralVertexOrder objects using an IdSet. More...

#include <dune/grid/utility/vertexorderfactory.hh>

Classes

struct  VertexOrder
 type of vertex order object may depend on the dimension of the element More...
 

Public Member Functions

 VertexOrderByIdFactory (const IdSet &idset_)
 construct a factory object More...
 
template<typename Element >
VertexOrder< Element::mydimension >::type make (const Element &e) const
 construct a vertex ordering object More...
 

Detailed Description

template<class IdSet, class Index = std::size_t>
class Dune::VertexOrderByIdFactory< IdSet, Index >

Factory for GeneralVertexOrder objects using an IdSet.

Template Parameters
IdSetType used to get the ids of the vertices.
IndexType of the indices provided by the vertex ordering object. Must be integral, may be non-negative.
Warning
The Interface of the VertexOrder stuff is subject to change. It is currently needed to use some global-valued finite elements from dune-localfunctions.
See also
GeneralVertexOrder, reduceOrder()

Constructor & Destructor Documentation

◆ VertexOrderByIdFactory()

template<class IdSet , class Index = std::size_t>
Dune::VertexOrderByIdFactory< IdSet, Index >::VertexOrderByIdFactory ( const IdSet idset_)
inline

construct a factory object

Template Parameters
idset_IdSet to use to extract the vertex ids.

This factory object stores a reference to the IdSet object. The factory object's value will become singular when the stored reference becomes invalid. The only valid operation on a factory with singular value is destruction, all other operations will result in undefined behaviour.

Member Function Documentation

◆ make()

template<class IdSet , class Index = std::size_t>
template<typename Element >
VertexOrder< Element::mydimension >::type Dune::VertexOrderByIdFactory< IdSet, Index >::make ( const Element &  e) const
inline

construct a vertex ordering object

Parameters
eGrid element to create the vertex ordering object for.

The returned object will remain valid even after the factory has become singular or has been destroyed.


The documentation for this class was generated from the following file:
Creative Commons License   |  Legal Statements / Impressum  |  Hosted by TU Dresden  |  generated with Hugo v0.111.3 (Dec 22, 23:30, 2024)