dune-functions  2.5.0
Classes | Public Types | Public Member Functions | Protected Types | Protected Attributes | Static Protected Attributes | List of all members
Dune::Functions::CompositeNodeFactory< MI, IMS, SF > Class Template Reference

A factory for composite bases. More...

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

Classes

struct  FixedTP
 

Public Types

using SubFactories = std::tuple< SF... >
 Tuple of child factories. More...
 
using GridView = typename std::tuple_element< 0, SubFactories >::type::GridView
 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...
 
using IndexMergingStrategy = IMS
 Strategy used to merge the global indices of the child factories. More...
 
template<std::size_t k>
using SubFactory = typename std::tuple_element< k, std::tuple< SF... >>::type
 Template mapping index of child to its factory type. More...
 
template<class TP >
using Node = typename FixedTP< TP >::Node
 Template mapping root tree path to type of created tree node. More...
 
template<class TP >
using IndexSet = CompositeNodeIndexSet< MI, TP, IMS, SF... >
 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, MultiIndex::max_size()+1 >
 Type used for prefixes handed to the size() method. More...
 

Public Member Functions

template<class... SFArgs, disableCopyMove< CompositeNodeFactory, SFArgs... > = 0, enableIfConstructible< std::tuple< SF... >, SFArgs... > = 0>
 CompositeNodeFactory (SFArgs &&... sfArgs)
 Constructor for given child factory objects. 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 Types

using ChildIndexTuple = IntegerSequenceTuple< Imp::index_sequence_for< SF... >>
 

Protected Attributes

std::tuple< SF... > subFactories_
 

Static Protected Attributes

static const std::size_t children = sizeof...(SF)
 

Detailed Description

template<class MI, class IMS, class... SF>
class Dune::Functions::CompositeNodeFactory< MI, IMS, SF >

A factory for composite bases.

This node factory represente a composition of several given node factories. Its node type is a CompositeBasisNodes for the given subnodes.

Template Parameters
MIType to be used for global multi-indices
IMSAn IndexMergingStrategy used to merge the global indices of the child factories
SFThe child factories

Member Typedef Documentation

§ ChildIndexTuple

template<class MI , class IMS , class... SF>
using Dune::Functions::CompositeNodeFactory< MI, IMS, SF >::ChildIndexTuple = IntegerSequenceTuple<Imp::index_sequence_for<SF...>>
protected

§ GridView

template<class MI , class IMS , class... SF>
using Dune::Functions::CompositeNodeFactory< MI, IMS, SF >::GridView = typename std::tuple_element<0, SubFactories>::type::GridView

The grid view that the FE basis is defined on.

§ IndexMergingStrategy

template<class MI , class IMS , class... SF>
using Dune::Functions::CompositeNodeFactory< MI, IMS, SF >::IndexMergingStrategy = IMS

Strategy used to merge the global indices of the child factories.

§ IndexSet

template<class MI , class IMS , class... SF>
template<class TP >
using Dune::Functions::CompositeNodeFactory< MI, IMS, SF >::IndexSet = CompositeNodeIndexSet<MI, TP, IMS, SF...>

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

§ MultiIndex

template<class MI , class IMS , class... SF>
using Dune::Functions::CompositeNodeFactory< MI, IMS, SF >::MultiIndex = MI

Type used for global numbering of the basis vectors.

§ Node

template<class MI , class IMS , class... SF>
template<class TP >
using Dune::Functions::CompositeNodeFactory< MI, IMS, SF >::Node = typename FixedTP<TP>::Node

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

§ size_type

template<class MI , class IMS , class... SF>
using Dune::Functions::CompositeNodeFactory< MI, IMS, SF >::size_type = std::size_t

Type used for indices and size information.

§ SizePrefix

template<class MI , class IMS , class... SF>
using Dune::Functions::CompositeNodeFactory< MI, IMS, SF >::SizePrefix = Dune::ReservedVector<size_type, MultiIndex::max_size()+1>

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

§ SubFactories

template<class MI , class IMS , class... SF>
using Dune::Functions::CompositeNodeFactory< MI, IMS, SF >::SubFactories = std::tuple<SF...>

Tuple of child factories.

§ SubFactory

template<class MI , class IMS , class... SF>
template<std::size_t k>
using Dune::Functions::CompositeNodeFactory< MI, IMS, SF >::SubFactory = typename std::tuple_element<k, std::tuple<SF...>>::type

Template mapping index of child to its factory type.

Constructor & Destructor Documentation

§ CompositeNodeFactory()

template<class MI , class IMS , class... SF>
template<class... SFArgs, disableCopyMove< CompositeNodeFactory, SFArgs... > = 0, enableIfConstructible< std::tuple< SF... >, SFArgs... > = 0>
Dune::Functions::CompositeNodeFactory< MI, IMS, SF >::CompositeNodeFactory ( SFArgs &&...  sfArgs)
inline

Constructor for given child factory objects.

The child factories will be stored as copies

Member Function Documentation

§ dimension()

template<class MI , class IMS , class... SF>
size_type Dune::Functions::CompositeNodeFactory< MI, IMS, SF >::dimension ( ) const
inline

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

§ gridView()

template<class MI , class IMS , class... SF>
const GridView& Dune::Functions::CompositeNodeFactory< MI, IMS, SF >::gridView ( ) const
inline

Obtain the grid view that the basis is defined on.

§ indexSet()

template<class MI , class IMS , class... SF>
template<class TP >
IndexSet<TP> Dune::Functions::CompositeNodeFactory< MI, IMS, SF >::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<class MI , class IMS , class... SF>
void Dune::Functions::CompositeNodeFactory< MI, IMS, SF >::initializeIndices ( )
inline

Initialize the global indices.

§ maxNodeSize()

template<class MI , class IMS , class... SF>
size_type Dune::Functions::CompositeNodeFactory< MI, IMS, SF >::maxNodeSize ( ) const
inline

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

§ node()

template<class MI , class IMS , class... SF>
template<class TP >
Node<TP> Dune::Functions::CompositeNodeFactory< MI, IMS, SF >::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<class MI , class IMS , class... SF>
size_type Dune::Functions::CompositeNodeFactory< MI, IMS, SF >::size ( ) const
inline

Same as size(prefix) with empty prefix.

§ size() [2/2]

template<class MI , class IMS , class... SF>
size_type Dune::Functions::CompositeNodeFactory< MI, IMS, SF >::size ( const SizePrefix prefix) const
inline

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

§ update()

template<class MI , class IMS , class... SF>
void Dune::Functions::CompositeNodeFactory< MI, IMS, SF >::update ( const GridView gv)
inline

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

Member Data Documentation

§ children

template<class MI , class IMS , class... SF>
const std::size_t Dune::Functions::CompositeNodeFactory< MI, IMS, SF >::children = sizeof...(SF)
staticprotected

§ subFactories_

template<class MI , class IMS , class... SF>
std::tuple<SF...> Dune::Functions::CompositeNodeFactory< MI, IMS, SF >::subFactories_
protected

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