DUNE PDELab (git)

Dune::PDELab::VectorGridFunctionSpace< GV, FEM, k, Backend, LeafBackend, Constraints, OrderingTag, LeafOrderingTag > Class Template Reference

tensorproduct space representing a vector valued function space More...

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

Classes

struct  ConstraintsContainer
 extract type for storing constraints More...
 

Public Types

typedef ImplementationBase::Traits Traits
 export traits class
 
typedef PowerNodeTag NodeTag
 The type tag that describes a PowerNode.
 
typedef GridFunctionSpace< impl::EntitySet< GV >, FEM, NoConstraints, LeafBackend, DefaultLeafOrderingTagChildType
 The type of each child.
 
typedef std::array< std::shared_ptr< GridFunctionSpace< impl::EntitySet< GV >, FEM, NoConstraints, LeafBackend, DefaultLeafOrderingTag > >, k > NodeStorage
 The type used for storing the 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
 
Output::DataSetType dataSetType () const
 Return the data set type of this function.
 
void setDataSetType (Output::DataSetType dataSetType)
 Set the data set type of this function.
 
Child Access (templated methods)
GridFunctionSpace< impl::EntitySet< GV >, FEM, NoConstraints, LeafBackend, DefaultLeafOrderingTag > & child (index_constant< i >={})
 Returns the i-th child. More...
 
const GridFunctionSpace< impl::EntitySet< GV >, FEM, NoConstraints, LeafBackend, DefaultLeafOrderingTag > & child (index_constant< i >={}) const
 Returns the i-th child (const version). More...
 
std::shared_ptr< GridFunctionSpace< impl::EntitySet< GV >, FEM, NoConstraints, LeafBackend, DefaultLeafOrderingTag > > childStorage (index_constant< i >={})
 Returns the storage of the i-th child. More...
 
std::shared_ptr< const GridFunctionSpace< impl::EntitySet< GV >, FEM, NoConstraints, LeafBackend, DefaultLeafOrderingTag > > childStorage (index_constant< i >={}) const
 Returns the storage of the i-th child (const version). More...
 
void setChild (GridFunctionSpace< impl::EntitySet< GV >, FEM, NoConstraints, LeafBackend, DefaultLeafOrderingTag > &t, index_constant< i >={})
 Sets the i-th child to the passed-in value.
 
void setChild (GridFunctionSpace< impl::EntitySet< GV >, FEM, NoConstraints, LeafBackend, DefaultLeafOrderingTag > &&t, index_constant< i >={})
 Store the passed value in i-th child.
 
void setChild (std::shared_ptr< GridFunctionSpace< impl::EntitySet< GV >, FEM, NoConstraints, LeafBackend, DefaultLeafOrderingTag > > st, index_constant< i >={})
 Sets the stored value representing the i-th child to the passed-in value.
 
Child Access (Dynamic methods)
GridFunctionSpace< impl::EntitySet< GV >, FEM, NoConstraints, LeafBackend, DefaultLeafOrderingTag > & child (std::size_t i)
 Returns the i-th child. More...
 
const GridFunctionSpace< impl::EntitySet< GV >, FEM, NoConstraints, LeafBackend, DefaultLeafOrderingTag > & child (std::size_t i) const
 Returns the i-th child (const version). More...
 
std::shared_ptr< GridFunctionSpace< impl::EntitySet< GV >, FEM, NoConstraints, LeafBackend, DefaultLeafOrderingTag > > childStorage (std::size_t i)
 Returns the storage of the i-th child. More...
 
std::shared_ptr< const GridFunctionSpace< impl::EntitySet< GV >, FEM, NoConstraints, LeafBackend, DefaultLeafOrderingTag > > childStorage (std::size_t i) const
 Returns the storage of the i-th child (const version). More...
 
void setChild (std::size_t i, GridFunctionSpace< impl::EntitySet< GV >, FEM, NoConstraints, LeafBackend, DefaultLeafOrderingTag > &t)
 Sets the i-th child to the passed-in value.
 
void setChild (std::size_t i, GridFunctionSpace< impl::EntitySet< GV >, FEM, NoConstraints, LeafBackend, DefaultLeafOrderingTag > &&t)
 Store the passed value in i-th child.
 
void setChild (std::size_t i, std::shared_ptr< GridFunctionSpace< impl::EntitySet< GV >, FEM, NoConstraints, LeafBackend, DefaultLeafOrderingTag > > st)
 Sets the stored value representing the i-th child to the passed-in value.
 
const NodeStoragenodeStorage () const
 
Nested Child Access
ImplementationDefinedchild (Indices... indices)
 Returns the child given by the list of indices. More...
 
const ImplementationDefinedchild (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 power in the dune-typetree.
 
static const bool isComposite
 Mark this class as a non composite in the dune-typetree.
 

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 GV, typename FEM, std::size_t k, typename Backend, typename LeafBackend, typename Constraints = NoConstraints, typename OrderingTag = LexicographicOrderingTag, typename LeafOrderingTag = DefaultLeafOrderingTag>
class Dune::PDELab::VectorGridFunctionSpace< GV, FEM, k, Backend, LeafBackend, Constraints, OrderingTag, LeafOrderingTag >

tensorproduct space representing a vector valued function space

In its structure this space is very similar to a PowerGridFunctionSpace:

VGFS(FEM,k) = PGFS(GFS(FEM),k) = {GFS(FEM)}^k

Stating explicitly that a space is a VectorGridFunctionSpace mainly changes the way the data is interpreted. One can immediatelly create a discrete function as a member of a VectorGridFunctionSpace and visualize it via VTK. In this case the output data is automatically tagged as vector valued data, allowing for a better visualization.

Template Parameters
GVType implementing GridView
FEMType implementing FiniteElementMapInterface
kPhysical dimension of the space
BackendLinear algebra backend type at the level of the tensorproduct construction (the same backend one might pass to a PowerGridFunctionSpace)
LeafBackendLinear algebra backend type at the level of the underlying scalar space (GFS(FEM))
ConstraintsType for constraints assembler
OrderingTagordering of DOFs at the level of the tensorproduct construction (usually on will choose either or EntityBlockedOrderingTag) LeafOrderingTag ordering of DOFs at the level of the underlying scalar space (default: DefaultLeafOrderingTag)

Member Function Documentation

◆ child() [1/6]

GridFunctionSpace< impl::EntitySet< GV >, FEM, NoConstraints, LeafBackend, DefaultLeafOrderingTag > & Dune::TypeTree::PowerNode< GridFunctionSpace< impl::EntitySet< GV >, FEM, NoConstraints, LeafBackend, DefaultLeafOrderingTag > , k >::child ( index_constant< i >  = {})
inlineinherited

Returns the i-th child.

Returns
a reference to the i-th child.

◆ child() [2/6]

const GridFunctionSpace< impl::EntitySet< GV >, FEM, NoConstraints, LeafBackend, DefaultLeafOrderingTag > & Dune::TypeTree::PowerNode< GridFunctionSpace< impl::EntitySet< GV >, FEM, NoConstraints, LeafBackend, DefaultLeafOrderingTag > , k >::child ( index_constant< i >  = {}) const
inlineinherited

Returns the i-th child (const version).

Returns
a const reference to the i-th child.

◆ child() [3/6]

ImplementationDefined & Dune::TypeTree::PowerNode< GridFunctionSpace< impl::EntitySet< GV >, FEM, NoConstraints, LeafBackend, DefaultLeafOrderingTag > , k >::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/6]

const ImplementationDefined & Dune::TypeTree::PowerNode< GridFunctionSpace< impl::EntitySet< GV >, FEM, NoConstraints, LeafBackend, DefaultLeafOrderingTag > , k >::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() [5/6]

GridFunctionSpace< impl::EntitySet< GV >, FEM, NoConstraints, LeafBackend, DefaultLeafOrderingTag > & Dune::TypeTree::PowerNode< GridFunctionSpace< impl::EntitySet< GV >, FEM, NoConstraints, LeafBackend, DefaultLeafOrderingTag > , k >::child ( std::size_t  i)
inlineinherited

Returns the i-th child.

Returns
a reference to the i-th child.

◆ child() [6/6]

const GridFunctionSpace< impl::EntitySet< GV >, FEM, NoConstraints, LeafBackend, DefaultLeafOrderingTag > & Dune::TypeTree::PowerNode< GridFunctionSpace< impl::EntitySet< GV >, FEM, NoConstraints, LeafBackend, DefaultLeafOrderingTag > , k >::child ( std::size_t  i) const
inlineinherited

Returns the i-th child (const version).

Returns
a const reference to the i-th child.

◆ childStorage() [1/4]

std::shared_ptr< GridFunctionSpace< impl::EntitySet< GV >, FEM, NoConstraints, LeafBackend, DefaultLeafOrderingTag > > Dune::TypeTree::PowerNode< GridFunctionSpace< impl::EntitySet< GV >, FEM, NoConstraints, LeafBackend, DefaultLeafOrderingTag > , k >::childStorage ( index_constant< i >  = {})
inlineinherited

Returns the storage of the i-th child.

Returns
a copy of the object storing the i-th child.

◆ childStorage() [2/4]

std::shared_ptr< const GridFunctionSpace< impl::EntitySet< GV >, FEM, NoConstraints, LeafBackend, DefaultLeafOrderingTag > > Dune::TypeTree::PowerNode< GridFunctionSpace< impl::EntitySet< GV >, FEM, NoConstraints, LeafBackend, DefaultLeafOrderingTag > , k >::childStorage ( index_constant< i >  = {}) const
inlineinherited

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

Returns
a copy of the object storing the i-th child.

◆ childStorage() [3/4]

std::shared_ptr< GridFunctionSpace< impl::EntitySet< GV >, FEM, NoConstraints, LeafBackend, DefaultLeafOrderingTag > > Dune::TypeTree::PowerNode< GridFunctionSpace< impl::EntitySet< GV >, FEM, NoConstraints, LeafBackend, DefaultLeafOrderingTag > , k >::childStorage ( std::size_t  i)
inlineinherited

Returns the storage of the i-th child.

Returns
a copy of the object storing the i-th child.

◆ childStorage() [4/4]

std::shared_ptr< const GridFunctionSpace< impl::EntitySet< GV >, FEM, NoConstraints, LeafBackend, DefaultLeafOrderingTag > > Dune::TypeTree::PowerNode< GridFunctionSpace< impl::EntitySet< GV >, FEM, NoConstraints, LeafBackend, DefaultLeafOrderingTag > , k >::childStorage ( std::size_t  i) const
inlineinherited

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

Returns
a copy of the object storing the i-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:
Creative Commons License   |  Legal Statements / Impressum  |  Hosted by TU Dresden  |  generated with Hugo v0.111.3 (Nov 23, 23:29, 2024)