Dune::PDELab::CompositeGridFunctionSpace< Backend, OrderingTag, Children > Class Template Reference

base class for tuples of grid function spaces base class that holds implementation of the methods this is the default version with lexicographic ordering More...

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

Classes
struct	ConstraintsContainer
	extract type for storing constraints More...

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
const Ordering &	ordering () const
	Direct access to the DOF ordering.
Ordering &	ordering ()
	Direct access to the DOF ordering.
std::shared_ptr< const Ordering >	orderingStorage () const
	Direct access to the storage of the DOF ordering.
std::shared_ptr< Ordering >	orderingStorage ()
	Direct access to the storage of the DOF ordering.
const Traits::EntitySet &	entitySet () const
	get grid view partition
Traits::EntitySet &	entitySet ()
	get grid view partition
Traits::SizeType	maxLocalSize () const
	get max dimension of shape function space
void	update (bool force=false)
	Update the indexing information of the GridFunctionSpace. More...
const Traits::GridView &	gridView () const
	get grid view
bool	dataHandleContains (int codim) const
	returns true if data for this codim should be communicated
bool	dataHandleFixedSize (int codim) const
	returns true if size per entity of given dim and codim is a constant
constexpr bool	sendLeafSizes () const
	Returns true if the sizes of the leaf orderings in this tree should be sent as part of the communcation. More...
template<typename Entity >
size_type	dataHandleSize (const Entity &e) const
template<typename Entity , typename ContainerIndex , typename DOFIndex , typename OffsetIterator , bool map_dof_indices>
void	dataHandleIndices (const Entity &e, std::vector< ContainerIndex > &container_indices, std::vector< DOFIndex > &dof_indices, OffsetIterator oit, std::integral_constant< bool, map_dof_indices > map_dof_indices_value) const
	return vector of global indices associated with the given entity
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.
static const std::size_t	CHILDREN
	The number of children.

Protected Member Functions
void	setEntitySet (typename Traits::EntitySet entity_set)
	Set the Entity Set object to this grid function space. More...

Detailed Description

template<typename Backend, typename OrderingTag, typename... Children>
class Dune::PDELab::CompositeGridFunctionSpace< Backend, OrderingTag, Children >

base class for tuples of grid function spaces base class that holds implementation of the methods this is the default version with lexicographic ordering

Template Parameters

Mapper	is the ordering parameter. Use e.g. GridFunctionSpaceLexicographicMapper or GridFunctionSpaceComponentBlockwiseMapper or GridFunctionSpaceBlockwiseMapper or GridFunctionSpaceDynamicBlockwiseMapper
Ti	are all grid function spaces

Examples

recipe-blocking.cc.

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.

dataHandleSize()

template<typename GFS >

template<typename Entity >

size_type Dune::PDELab::DataHandleProvider< GFS >::dataHandleSize ( const Entity &  e ) const

inlineinherited

how many objects of type DataType have to be sent for a given entity

Note: Only the sender side needs to know this size.

sendLeafSizes()

template<typename GFS >

constexpr bool Dune::PDELab::DataHandleProvider< GFS >::sendLeafSizes ( ) const

inlineconstexprinherited

Returns true if the sizes of the leaf orderings in this tree should be sent as part of the communcation.

The MultiDomain extensions require knowledge about the size of the individual orderings, which might belong to separate subdomains. Otherwise it is possible to have size mismatches for entities with codim > 0 if there are protruding edges in the parallel mesh partitioning.

By default, this method will always return false. It must be overridden for cases where the data actually needs to be sent.

This flag also modifies the behavior of the generic data handles, which will automatically send, receive and process the additional information. Note that if sendLeafSizes() returns true, the underlying DataHandleIF of the grid will always use the data type char to be able to send different types of data, which will automatically be marshalled to / from a byte stream.

---

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

• dune/pdelab/gridfunctionspace/compositegridfunctionspace.hh