Dune::PDELab::Experimental::GridFunctionSpace< DFBasis, VBE, CE >::Ordering Struct Reference

Root of the ordering tree. More...

#include <dune/pdelab/gridfunctionspace/dunefunctionsgridfunctionspace.hh>

Public Types
typedef CompositeNodeTag	NodeTag
	The type tag that describes a CompositeNode.
typedef std::tuple< std::shared_ptr< Children >... >	NodeStorage
	The type used for storing the children.
typedef std::tuple< Children... >	ChildTypes
	A tuple storing the types of all children.

Public Member Functions
size_type	blockCount () const
	Same as size(), because block size is always 1.
bool	contains (typename Traits::SizeType codim) const
	Returns true if there is at least one entity of the given codim for which data needs to be communicated.
bool	fixedSize (typename Traits::SizeType codim) const
	True if for all entities of the given codim the same number of data items has to be communicated.
Child Access
Child< k >::Type &	child (index_constant< k >={})
	Returns the k-th child. More...
const Child< k >::Type &	child (index_constant< k >={}) const
	Returns the k-th child (const version). More...
std::shared_ptr< typename Child< k >::Type >	childStorage (index_constant< k >={})
	Returns the storage of the k-th child. More...
std::shared_ptr< const typename Child< k >::Type >	childStorage (index_constant< k >={}) const
	Returns the storage of the k-th child (const version). More...
void	setChild (typename Child< k >::Type &child, index_constant< k >={})
	Sets the k-th child to the passed-in value.
void	setChild (typename Child< k >::Type &&child, index_constant< k >={})
	Store the passed value in k-th child.
void	setChild (std::shared_ptr< typename Child< k >::Type > child, index_constant< k >={})
	Sets the storage of the k-th child to the passed-in value.
const NodeStorage &	nodeStorage () const
Nested Child Access
ImplementationDefined &	child (Indices... indices)
	Returns the child given by the list of indices. More...
const ImplementationDefined &	child (Indices... indices)
	Returns the child given by the list of indices. More...

Static Public Attributes
static const bool	isLeaf
	Mark this class as non leaf in the dune-typetree.
static const bool	isPower
	Mark this class as a non power in the dune-typetree.
static const bool	isComposite
	Mark this class as a composite in the dune-typetree.

Detailed Description

template<typename DFBasis, typename VBE, typename CE>
struct Dune::PDELab::Experimental::GridFunctionSpace< DFBasis, VBE, CE >::Ordering

Root of the ordering tree.

PDELab requires ordering trees to have at least two nodes even if the corresponding basis tree consists of a single node only. So here is an artificial root node to please PDELab. All it does is forward all method calls to its single child.

Member Function Documentation

child() [1/4]

Child< k >::Type & Dune::TypeTree::CompositeNode< Children >::child ( index_constant< k >  = {} )

inlineinherited

Returns the k-th child.

Returns

a reference to the k-th child.

child() [2/4]

const Child< k >::Type & Dune::TypeTree::CompositeNode< Children >::child ( index_constant< k >  = {} ) const

inlineinherited

Returns the k-th child (const version).

Returns

a const reference to the k-th child.

child() [3/4]

ImplementationDefined & Dune::TypeTree::CompositeNode< Children >::child ( Indices...  indices )

inlineinherited

Returns the child given by the list of indices.

This method simply forwards to the freestanding function child(). See that function for further information.

child() [4/4]

const ImplementationDefined & Dune::TypeTree::CompositeNode< Children >::child ( Indices...  indices )

inlineinherited

Returns the child given by the list of indices.

This method simply forwards to the freestanding function child(). See that function for further information.

childStorage() [1/2]

std::shared_ptr< typename Child< k >::Type > Dune::TypeTree::CompositeNode< Children >::childStorage ( index_constant< k >  = {} )

inlineinherited

Returns the storage of the k-th child.

Returns

a copy of the object storing the k-th child.

childStorage() [2/2]

std::shared_ptr< const typename Child< k >::Type > Dune::TypeTree::CompositeNode< Children >::childStorage ( index_constant< k >  = {} ) const

inlineinherited

Returns the storage of the k-th child (const version).

Returns

a copy of the object storing the k-th child.

---

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

• dune/pdelab/gridfunctionspace/dunefunctionsgridfunctionspace.hh