dune-functions  2.6-dev
Public Types | Public Member Functions | Protected Attributes | List of all members
Dune::Functions::PQkPreBasis< GV, k, MI > Class Template Reference

A pre-basis for PQ-lagrange bases with given order. More...

#include <dune/functions/functionspacebases/pqknodalbasis.hh>

Inheritance diagram for Dune::Functions::PQkPreBasis< GV, k, MI >:
Inheritance graph

Public Types

using GridView = GV
 The grid view that the FE basis is defined on. More...
 
using size_type = std::size_t
 Type used for indices and size information. More...
 
template<class TP >
using Node = PQkNode< GV, k, TP >
 Template mapping root tree path to type of created tree node. More...
 
template<class TP >
using IndexSet = PQkNodeIndexSet< GV, k, MI, TP >
 Template mapping root tree path to type of created tree node index set. More...
 
using MultiIndex = MI
 Type used for global numbering of the basis vectors. More...
 
using SizePrefix = Dune::ReservedVector< size_type, 1 >
 Type used for prefixes handed to the size() method. More...
 

Public Member Functions

 PQkPreBasis (const GridView &gv)
 Constructor for a given grid view object. More...
 
void initializeIndices ()
 Initialize the global indices. More...
 
const GridViewgridView () const
 Obtain the grid view that the basis is defined on. More...
 
void update (const GridView &gv)
 Update the stored grid view, to be called if the grid has changed. More...
 
template<class TP >
Node< TP > node (const TP &tp) const
 Create tree node with given root tree path. More...
 
template<class TP >
IndexSet< TP > indexSet () const
 Create tree node index set with given root tree path. More...
 
size_type size () const
 Same as size(prefix) with empty prefix. More...
 
size_type size (const SizePrefix prefix) const
 Return number of possible values for next position in multi index. More...
 
size_type dimension () const
 Get the total dimension of the space spanned by this basis. More...
 
size_type maxNodeSize () const
 Get the maximal number of DOFs associated to node for any element. More...
 

Protected Attributes

GridView gridView_
 
size_type vertexOffset_
 
size_type edgeOffset_
 
size_type triangleOffset_
 
size_type quadrilateralOffset_
 
size_type tetrahedronOffset_
 
size_type pyramidOffset_
 
size_type prismOffset_
 
size_type hexahedronOffset_
 

Detailed Description

template<typename GV, int k, class MI>
class Dune::Functions::PQkPreBasis< GV, k, MI >

A pre-basis for PQ-lagrange bases with given order.

Template Parameters
GVThe grid view that the FE basis is defined on
kThe polynomial order of ansatz functions
MIType to be used for multi-indices
Note
This only works for certain grids. The following restrictions hold
  • If k is no larger than 2, then the grids can have any dimension
  • If k is larger than 3 then the grid must be two-dimensional
  • If k is 3, then the grid can be 3d if it is a simplex grid

Member Typedef Documentation

◆ GridView

template<typename GV , int k, class MI >
using Dune::Functions::PQkPreBasis< GV, k, MI >::GridView = GV

The grid view that the FE basis is defined on.

◆ IndexSet

template<typename GV , int k, class MI >
template<class TP >
using Dune::Functions::PQkPreBasis< GV, k, MI >::IndexSet = PQkNodeIndexSet<GV, k, MI, TP>

Template mapping root tree path to type of created tree node index set.

◆ MultiIndex

template<typename GV , int k, class MI >
using Dune::Functions::PQkPreBasis< GV, k, MI >::MultiIndex = MI

Type used for global numbering of the basis vectors.

◆ Node

template<typename GV , int k, class MI >
template<class TP >
using Dune::Functions::PQkPreBasis< GV, k, MI >::Node = PQkNode<GV, k, TP>

Template mapping root tree path to type of created tree node.

◆ size_type

template<typename GV , int k, class MI >
using Dune::Functions::PQkPreBasis< GV, k, MI >::size_type = std::size_t

Type used for indices and size information.

◆ SizePrefix

template<typename GV , int k, class MI >
using Dune::Functions::PQkPreBasis< GV, k, MI >::SizePrefix = Dune::ReservedVector<size_type, 1>

Type used for prefixes handed to the size() method.

Constructor & Destructor Documentation

◆ PQkPreBasis()

template<typename GV , int k, class MI >
Dune::Functions::PQkPreBasis< GV, k, MI >::PQkPreBasis ( const GridView gv)
inline

Constructor for a given grid view object.

Member Function Documentation

◆ dimension()

template<typename GV , int k, class MI >
size_type Dune::Functions::PQkPreBasis< GV, k, MI >::dimension ( ) const
inline

Get the total dimension of the space spanned by this basis.

◆ gridView()

template<typename GV , int k, class MI >
const GridView& Dune::Functions::PQkPreBasis< GV, k, MI >::gridView ( ) const
inline

Obtain the grid view that the basis is defined on.

◆ indexSet()

template<typename GV , int k, class MI >
template<class TP >
IndexSet<TP> Dune::Functions::PQkPreBasis< GV, k, MI >::indexSet ( ) const
inline

Create tree node index set with given root tree path.

Template Parameters
TPType of root tree path
Parameters
tpRoot tree path

Create an index set suitable for the tree node obtained by node(tp).

◆ initializeIndices()

template<typename GV , int k, class MI >
void Dune::Functions::PQkPreBasis< GV, k, MI >::initializeIndices ( )
inline

Initialize the global indices.

◆ maxNodeSize()

template<typename GV , int k, class MI >
size_type Dune::Functions::PQkPreBasis< GV, k, MI >::maxNodeSize ( ) const
inline

Get the maximal number of DOFs associated to node for any element.

◆ node()

template<typename GV , int k, class MI >
template<class TP >
Node<TP> Dune::Functions::PQkPreBasis< GV, k, MI >::node ( const TP &  tp) const
inline

Create tree node with given root tree path.

Template Parameters
TPType of root tree path
Parameters
tpRoot tree path

By passing a non-trivial root tree path this can be used to create a node suitable for being placed in a tree at the position specified by the root tree path.

◆ size() [1/2]

template<typename GV , int k, class MI >
size_type Dune::Functions::PQkPreBasis< GV, k, MI >::size ( ) const
inline

Same as size(prefix) with empty prefix.

◆ size() [2/2]

template<typename GV , int k, class MI >
size_type Dune::Functions::PQkPreBasis< GV, k, MI >::size ( const SizePrefix  prefix) const
inline

Return number of possible values for next position in multi index.

◆ update()

template<typename GV , int k, class MI >
void Dune::Functions::PQkPreBasis< GV, k, MI >::update ( const GridView gv)
inline

Update the stored grid view, to be called if the grid has changed.

Member Data Documentation

◆ edgeOffset_

template<typename GV , int k, class MI >
size_type Dune::Functions::PQkPreBasis< GV, k, MI >::edgeOffset_
protected

◆ gridView_

template<typename GV , int k, class MI >
GridView Dune::Functions::PQkPreBasis< GV, k, MI >::gridView_
protected

◆ hexahedronOffset_

template<typename GV , int k, class MI >
size_type Dune::Functions::PQkPreBasis< GV, k, MI >::hexahedronOffset_
protected

◆ prismOffset_

template<typename GV , int k, class MI >
size_type Dune::Functions::PQkPreBasis< GV, k, MI >::prismOffset_
protected

◆ pyramidOffset_

template<typename GV , int k, class MI >
size_type Dune::Functions::PQkPreBasis< GV, k, MI >::pyramidOffset_
protected

◆ quadrilateralOffset_

template<typename GV , int k, class MI >
size_type Dune::Functions::PQkPreBasis< GV, k, MI >::quadrilateralOffset_
protected

◆ tetrahedronOffset_

template<typename GV , int k, class MI >
size_type Dune::Functions::PQkPreBasis< GV, k, MI >::tetrahedronOffset_
protected

◆ triangleOffset_

template<typename GV , int k, class MI >
size_type Dune::Functions::PQkPreBasis< GV, k, MI >::triangleOffset_
protected

◆ vertexOffset_

template<typename GV , int k, class MI >
size_type Dune::Functions::PQkPreBasis< GV, k, MI >::vertexOffset_
protected

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