Dune::PDELab::gfs::GridFunctionSubSpace< GFS, TreePath > Class Template Reference

Non-nesting implementation of GridFunctionSubSpace. More...

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

Public Types
typedef GFS	BaseGridFunctionSpace
	The base GridFunctionSpace that this GridFunctionSubSpace is based on.
using	ChildGridFunctionSpace = TypeTree::ChildForTreePath< GFS, TreePath >
	The type of the original GridFunctionSpace that is the root of this GridFunctionSpace.
typedef ChildGridFunctionSpace::Traits	Traits
	Re-exported Traits from the original GridFunctionSpace.
typedef GridFunctionSubSpaceTag< TypeTree::ImplementationTag< ChildGridFunctionSpace > >	ImplementationTag
	Our ImplementationTag is derived from the tag of the original GridFunctionSpace.

Public Member Functions
	GridFunctionSubSpace (std::shared_ptr< const GFS > gfs_storage)
	Construct a GridFunctionSubSpace from the storage object of a root space.
	GridFunctionSubSpace (const GFS &gfs)
	Construct a GridFunctionSubSpace from a root space.
template<typename TP >
	GridFunctionSubSpace (std::shared_ptr< const GridFunctionSubSpace< GFS, TP > > gfs_storage, typename std::enable_if<!std::is_same< TP, TreePath >::value, void * >::type=nullptr)
	Construct a GridFunctionSubSpace from the storage of another GridFunctionSubSpace. More...
template<typename TP >
	GridFunctionSubSpace (const GridFunctionSubSpace< GFS, TP > &gfs, typename std::enable_if<!std::is_same< TP, TreePath >::value, void * >::type=nullptr)
	Construct a GridFunctionSubSpace from another GridFunctionSubSpace. More...
const BaseGridFunctionSpace &	baseGridFunctionSpace () const
	Returns the root GridFunctionSpace that this subspace view is based on.
std::shared_ptr< const BaseGridFunctionSpace >	baseGridFunctionSpaceStorage () const
	Returns the storage object of the root GridFunctionSpace that this subspace view is based on.
const ChildGridFunctionSpace &	childGridFunctionSpace () const
	Returns the original GridFunctionSpace that we provide a view for. More...
std::shared_ptr< const ChildGridFunctionSpace >	childGridFunctionSpaceStorage () const
	Returns the storage object of the original GridFunctionSpace that we provide a view for. 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.
static const std::size_t	CHILDREN
	The number of children.

Default Functionality for all GridFunctionSpaces
typedef TreePath	SubSpacePath
	The TreePath from the root of the space hierarchy to this subspace.
typedef ChildGridFunctionSpace::OrderingTag	OrderingTag
	Re-exported OrderingTag from the original GridFunctionSpace.
using	Constraintscontainer = typename GFS::template ConstraintsContainer< E >
	Re-exported constraints container from the original GridFunctionSpace.
typedef SubOrdering< typename GFS::Ordering, typename find_ordering_treepath_for_sub_gfs< typename GFS::Ordering, GFS, TreePath >::type >	Ordering
	The ordering used by this GridFunctionSubSpace.
std::size_t	subSpaceDepth () const
const Ordering &	ordering () const
	Returns the ordering associated with this GridFunctionSubSpace.
const Traits::EntitySet &	entitySet () const
	Returns the underlying EntitySet.
const Traits::GridViewType &	gridView () const
	Returns the underlying GridView.
Traits::SizeType	globalSize () const
	Returns the global size of the root space.
Traits::SizeType	size () const
	Returns the global size of the root space. More...
Traits::SizeType	maxLocalSize () const
	Returns the maximum number of DOFs per cells in this subspace.

Additional Functionality for Leaf Spaces
const Traits::FiniteElementMap &	finiteElementMap () const
	Returns the finite element map of this space.
std::shared_ptr< const typename Traits::FiniteElementMap >	finiteElementMapStorage () const
	Returns the storage object for the finite element map of this space.
const Traits::ConstraintsType &	constraints () const
	Returns the constraints engine of this space.

Access to the proxied node
std::enable_if< enabled, const TypeTree::ChildForTreePath< GFS, TreePath > & >::type	proxiedNode ()
	Returns the proxied node.
const const TypeTree::ChildForTreePath< GFS, TreePath > &	proxiedNode () const
	Returns the proxied node (const version).
std::enable_if< enabled, std::shared_ptr< const TypeTree::ChildForTreePath< GFS, TreePath > > >::type	proxiedNodeStorage ()
	Returns the storage of the proxied node.
std::shared_ptr< const const TypeTree::ChildForTreePath< GFS, TreePath > >	proxiedNodeStorage () const
	Returns the storage of the proxied node (const version).

Detailed Description

template<typename GFS, typename TreePath>
class Dune::PDELab::gfs::GridFunctionSubSpace< GFS, TreePath >

Non-nesting implementation of GridFunctionSubSpace.

This is the actual implementation of GridFunctionSubSpace. It is based around the idea of performing the mapping from the subspace to the rootspace in a single step using a SubOrdering. As SubOrderings cannot be nested, this class needs some helper functionality that constructs a new GridFunctionSubSpace directly on top of the underlying root GridFunctionSpace if the user attempts to nest GridFunctionSubSpaces. On the other hand, this implementation should render such usage mostly unnecessary, as it is now possible to directly construct a subspace for a given leaf space. If the compiler has support for template aliases, the de-nesting infrastructure will be able to completely remove all traces of nesting, letting the type obtained by nesting two GridFunctionSubSpaces look exactly like the type obtained by constructing a single GridFunctionSubSpace. Alternatively, without template aliases, it is only possible to have the actual implementation be non-nested. In this case, the Dune::PDELab::GridFunctionSubSpace classes will still nest.

Note

This class should always be used as Dune::PDELab::GridFunctionSubSpace. Never attempt to directly use the class Dune::PDELab::gfs::GridFunctionSubSpace!

Template Parameters

GFS	The root GridFunctionSpace.
TreePath	Path from the root GridFunctionSpace to the represented subspace.

Examples

recipe-operator-splitting.cc.

Constructor & Destructor Documentation

GridFunctionSubSpace() [1/2]

template<typename GFS , typename TreePath >

template<typename TP >

Dune::PDELab::gfs::GridFunctionSubSpace< GFS, TreePath >::GridFunctionSubSpace ( std::shared_ptr< const GridFunctionSubSpace< GFS, TP > >  gfs_storage, typename std::enable_if<!std::is_same< TP, TreePath >::value, void * >::type  = nullptr  )

inlineexplicit

Construct a GridFunctionSubSpace from the storage of another GridFunctionSubSpace.

This constructor is used to implement the non-nesting behavior by extracting the original root space from the GridFunctionSubSpace and using that space for initialization. In order to work correctly, this relies on a support wrapper that correctly sets up the TreePath for the new space.

Note

The second parameter is a little SFINAE helper that removes the constructor from the overload set if the two spaces are identical to avoid masking the standard copy constructor.

GridFunctionSubSpace() [2/2]

template<typename GFS , typename TreePath >

template<typename TP >

Dune::PDELab::gfs::GridFunctionSubSpace< GFS, TreePath >::GridFunctionSubSpace ( const GridFunctionSubSpace< GFS, TP > &  gfs, typename std::enable_if<!std::is_same< TP, TreePath >::value, void * >::type  = nullptr  )

inlineexplicit

Construct a GridFunctionSubSpace from another GridFunctionSubSpace.

This constructor is used to implement the non-nesting behavior by extracting the original root space from the GridFunctionSubSpace and using that space for initialization. In order to work correctly, this relies on a support wrapper that correctly sets up the TreePath for the new space.

Note

The second parameter is a little SFINAE helper that removes the constructor from the overload set if the two spaces are identical to avoid masking the standard copy constructor.

Member Function Documentation

childGridFunctionSpace()

template<typename GFS , typename TreePath >

const ChildGridFunctionSpace & Dune::PDELab::gfs::GridFunctionSubSpace< GFS, TreePath >::childGridFunctionSpace ( ) const

inline

Returns the original GridFunctionSpace that we provide a view for.

Warning

Users should think at least twice before using this object in their code, as it will usually not do what they want! Due to the way GridFunctionSpaces are constructed, it is not aware of the overall structure of the space!

References Dune::TypeTree::ProxyNode< const TypeTree::ChildForTreePath< GFS, TreePath > >::proxiedNode().

Referenced by Dune::PDELab::gfs::LeafSubSpaceFeatures< GFS, TreePath, Tag >::constraints(), Dune::PDELab::gfs::DefaultSubSpaceFeatures< GFS, TreePath, Tag >::entitySet(), Dune::PDELab::gfs::LeafSubSpaceFeatures< GFS, TreePath, Tag >::finiteElementMap(), Dune::PDELab::gfs::LeafSubSpaceFeatures< GFS, TreePath, Tag >::finiteElementMapStorage(), Dune::PDELab::gfs::DefaultSubSpaceFeatures< GFS, TreePath, Tag >::gridView(), and Dune::PDELab::gfs::LeafSubSpaceFeatures< GFS, TreePath, Tag >::name().

childGridFunctionSpaceStorage()

template<typename GFS , typename TreePath >

std::shared_ptr< const ChildGridFunctionSpace > Dune::PDELab::gfs::GridFunctionSubSpace< GFS, TreePath >::childGridFunctionSpaceStorage ( ) const

inline

Returns the storage object of the original GridFunctionSpace that we provide a view for.

Warning

Users should think at least twice before using this object in their code, as it will usually not do what they want! Due to the way GridFunctionSpaces are constructed, it is not aware of the overall structure of the space!

References Dune::TypeTree::ProxyNode< const TypeTree::ChildForTreePath< GFS, TreePath > >::proxiedNodeStorage().

size()

Traits::SizeType Dune::PDELab::gfs::DefaultSubSpaceFeatures< GFS, TreePath, TypeTree::ImplementationTag< TypeTree::ChildForTreePath< GFS, TreePath > > >::size ( ) const

inlineinherited

Returns the global size of the root space.

Warning

The semantics of this methods have changed with the introduction of Orderings: While this method used to return the size of the subspace only, it now behaves like globalSize() and returns the overall size of the root space! Calculating the size of the subspace might be a very expensive operation depending on the underlying orderings.

---

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

• dune/pdelab/gridfunctionspace/subspace.hh