dune-pdelab  2.7-git
Classes | Public Types | Public Member Functions | Protected Member Functions | List of all members
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>

Inheritance diagram for Dune::PDELab::CompositeGridFunctionSpace< Backend, OrderingTag, Children >:
Inheritance graph

Classes

struct  ConstraintsContainer
 extract type for storing constraints More...
 

Public Types

typedef CompositeGridFunctionSpaceTag ImplementationTag
 
typedef ordering_transformation::Type Ordering
 
typedef ImplementationBase::Traits Traits
 
typedef OrderingTag OrderingTag
 
typedef std::size_t size_type
 

Public Member Functions

 CompositeGridFunctionSpace (const Backend &backend, Children &... children)
 
 CompositeGridFunctionSpace (const OrderingTag &ordering_tag, Children &... children)
 
 CompositeGridFunctionSpace (const Backend &backend, const OrderingTag &ordering_tag, Children &... children)
 
 CompositeGridFunctionSpace (Children &... children)
 
 CompositeGridFunctionSpace (const Backend &backend, std::shared_ptr< Children >... children)
 
 CompositeGridFunctionSpace (const OrderingTag &ordering_tag, std::shared_ptr< Children >... children)
 
 CompositeGridFunctionSpace (const Backend &backend, const OrderingTag &ordering_tag, std::shared_ptr< Children >... children)
 
 CompositeGridFunctionSpace (std::shared_ptr< Children >... children)
 
const Orderingordering () const
 Direct access to the DOF ordering. More...
 
Orderingordering ()
 Direct access to the DOF ordering. More...
 
std::shared_ptr< const OrderingorderingStorage () const
 Direct access to the storage of the DOF ordering. More...
 
std::shared_ptr< OrderingorderingStorage ()
 Direct access to the storage of the DOF ordering. More...
 
const Traits::GridViewgridView () const
 get grid view More...
 
const Traits::EntitySetentitySet () const
 get grid view partition More...
 
Traits::SizeType size () const
 
Traits::SizeType blockCount () const
 
Traits::SizeType globalSize () const
 
Traits::SizeType maxLocalSize () const
 get max dimension of shape function space More...
 
void update (bool force=false)
 Update the indexing information of the GridFunctionSpace. More...
 
const std::string & name () const
 
void name (const std::string &name)
 
Traits::Backendbackend ()
 
const Traits::Backendbackend () const
 
Traits::OrderingTagorderingTag ()
 
const Traits::OrderingTagorderingTag () const
 
bool isRootSpace () const
 
bool dataHandleContains (int codim) const
 returns true if data for this codim should be communicated More...
 
bool dataHandleFixedSize (int codim) const
 returns true if size per entity of given dim and codim is a constant More...
 
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...
 
size_type dataHandleSize (const Entity &e) const
 
void setup_dof_indices (V &v, size_type n, const EntityIndex &ei, std::integral_constant< bool, true >) const
 
void setup_dof_indices (V &v, size_type n, const EntityIndex &ei, std::integral_constant< bool, false >) const
 
V::iterator dof_indices_begin (V &v, std::integral_constant< bool, true >) const
 
DummyDOFIndexIterator dof_indices_begin (V &v, std::integral_constant< bool, false >) const
 
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 More...
 

Protected Member Functions

void update (Ordering &ordering) const
 
const CompositeGridFunctionSpace< Backend, OrderingTag, Children... > & gfs () const
 

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
Mapperis the ordering parameter. Use e.g. GridFunctionSpaceLexicographicMapper or GridFunctionSpaceComponentBlockwiseMapper or GridFunctionSpaceBlockwiseMapper or GridFunctionSpaceDynamicBlockwiseMapper
Tiare all grid function spaces
Examples
recipe-blocking.cc.

Member Typedef Documentation

◆ ImplementationTag

template<typename Backend , typename OrderingTag , typename... Children>
typedef CompositeGridFunctionSpaceTag Dune::PDELab::CompositeGridFunctionSpace< Backend, OrderingTag, Children >::ImplementationTag

◆ Ordering

template<typename Backend , typename OrderingTag , typename... Children>
typedef ordering_transformation::Type Dune::PDELab::CompositeGridFunctionSpace< Backend, OrderingTag, Children >::Ordering

◆ OrderingTag

typedef OrderingTag Dune::PDELab::PowerCompositeGridFunctionSpaceBase< CompositeGridFunctionSpace< Backend, OrderingTag, Children... > , TypeTree::Child< TypeTree::CompositeNode< Children... >, 0 >::Traits::EntitySet , Backend , OrderingTag , k >::OrderingTag
inherited

◆ size_type

typedef std::size_t Dune::PDELab::DataHandleProvider< CompositeGridFunctionSpace< Backend, OrderingTag, Children... > >::size_type
inherited

◆ Traits

template<typename Backend , typename OrderingTag , typename... Children>
typedef ImplementationBase::Traits Dune::PDELab::CompositeGridFunctionSpace< Backend, OrderingTag, Children >::Traits

Constructor & Destructor Documentation

◆ CompositeGridFunctionSpace() [1/8]

template<typename Backend , typename OrderingTag , typename... Children>
Dune::PDELab::CompositeGridFunctionSpace< Backend, OrderingTag, Children >::CompositeGridFunctionSpace ( const Backend &  backend,
Children &...  children 
)
inline

◆ CompositeGridFunctionSpace() [2/8]

template<typename Backend , typename OrderingTag , typename... Children>
Dune::PDELab::CompositeGridFunctionSpace< Backend, OrderingTag, Children >::CompositeGridFunctionSpace ( const OrderingTag ordering_tag,
Children &...  children 
)
inline

◆ CompositeGridFunctionSpace() [3/8]

template<typename Backend , typename OrderingTag , typename... Children>
Dune::PDELab::CompositeGridFunctionSpace< Backend, OrderingTag, Children >::CompositeGridFunctionSpace ( const Backend &  backend,
const OrderingTag ordering_tag,
Children &...  children 
)
inline

◆ CompositeGridFunctionSpace() [4/8]

template<typename Backend , typename OrderingTag , typename... Children>
Dune::PDELab::CompositeGridFunctionSpace< Backend, OrderingTag, Children >::CompositeGridFunctionSpace ( Children &...  children)
inline

◆ CompositeGridFunctionSpace() [5/8]

template<typename Backend , typename OrderingTag , typename... Children>
Dune::PDELab::CompositeGridFunctionSpace< Backend, OrderingTag, Children >::CompositeGridFunctionSpace ( const Backend &  backend,
std::shared_ptr< Children >...  children 
)
inline

◆ CompositeGridFunctionSpace() [6/8]

template<typename Backend , typename OrderingTag , typename... Children>
Dune::PDELab::CompositeGridFunctionSpace< Backend, OrderingTag, Children >::CompositeGridFunctionSpace ( const OrderingTag ordering_tag,
std::shared_ptr< Children >...  children 
)
inline

◆ CompositeGridFunctionSpace() [7/8]

template<typename Backend , typename OrderingTag , typename... Children>
Dune::PDELab::CompositeGridFunctionSpace< Backend, OrderingTag, Children >::CompositeGridFunctionSpace ( const Backend &  backend,
const OrderingTag ordering_tag,
std::shared_ptr< Children >...  children 
)
inline

◆ CompositeGridFunctionSpace() [8/8]

template<typename Backend , typename OrderingTag , typename... Children>
Dune::PDELab::CompositeGridFunctionSpace< Backend, OrderingTag, Children >::CompositeGridFunctionSpace ( std::shared_ptr< Children >...  children)
inline

Member Function Documentation

◆ backend() [1/2]

Traits::Backend& Dune::PDELab::GridFunctionSpaceBase< CompositeGridFunctionSpace< Backend, OrderingTag, Children... > , PowerCompositeGridFunctionSpaceTraits< TypeTree::Child< TypeTree::CompositeNode< Children... >, 0 >::Traits::EntitySet, Backend, OrderingTag, k > >::backend
inlineinherited

◆ backend() [2/2]

const Traits::Backend& Dune::PDELab::GridFunctionSpaceBase< CompositeGridFunctionSpace< Backend, OrderingTag, Children... > , PowerCompositeGridFunctionSpaceTraits< TypeTree::Child< TypeTree::CompositeNode< Children... >, 0 >::Traits::EntitySet, Backend, OrderingTag, k > >::backend
inlineinherited

◆ blockCount()

Traits::SizeType Dune::PDELab::GridFunctionSpaceBase< CompositeGridFunctionSpace< Backend, OrderingTag, Children... > , PowerCompositeGridFunctionSpaceTraits< TypeTree::Child< TypeTree::CompositeNode< Children... >, 0 >::Traits::EntitySet, Backend, OrderingTag, k > >::blockCount
inlineinherited

◆ dataHandleContains()

bool Dune::PDELab::DataHandleProvider< CompositeGridFunctionSpace< Backend, OrderingTag, Children... > >::dataHandleContains ( int  codim) const
inlineinherited

returns true if data for this codim should be communicated

◆ dataHandleFixedSize()

bool Dune::PDELab::DataHandleProvider< CompositeGridFunctionSpace< Backend, OrderingTag, Children... > >::dataHandleFixedSize ( int  codim) const
inlineinherited

returns true if size per entity of given dim and codim is a constant

◆ dataHandleIndices()

void Dune::PDELab::DataHandleProvider< CompositeGridFunctionSpace< Backend, OrderingTag, Children... > >::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
inlineinherited

return vector of global indices associated with the given entity

◆ dataHandleSize()

size_type Dune::PDELab::DataHandleProvider< CompositeGridFunctionSpace< Backend, OrderingTag, Children... > >::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.

◆ dof_indices_begin() [1/2]

DummyDOFIndexIterator Dune::PDELab::DataHandleProvider< CompositeGridFunctionSpace< Backend, OrderingTag, Children... > >::dof_indices_begin ( V &  v,
std::integral_constant< bool, false >   
) const
inlineinherited

◆ dof_indices_begin() [2/2]

V::iterator Dune::PDELab::DataHandleProvider< CompositeGridFunctionSpace< Backend, OrderingTag, Children... > >::dof_indices_begin ( V &  v,
std::integral_constant< bool, true >   
) const
inlineinherited

◆ entitySet()

const Traits::EntitySet& Dune::PDELab::PowerCompositeGridFunctionSpaceBase< CompositeGridFunctionSpace< Backend, OrderingTag, Children... > , TypeTree::Child< TypeTree::CompositeNode< Children... >, 0 >::Traits::EntitySet , Backend , OrderingTag , k >::entitySet
inlineinherited

get grid view partition

◆ gfs()

const CompositeGridFunctionSpace< Backend, OrderingTag, Children... > & Dune::PDELab::DataHandleProvider< CompositeGridFunctionSpace< Backend, OrderingTag, Children... > >::gfs
inlineprotectedinherited

◆ globalSize()

Traits::SizeType Dune::PDELab::GridFunctionSpaceBase< CompositeGridFunctionSpace< Backend, OrderingTag, Children... > , PowerCompositeGridFunctionSpaceTraits< TypeTree::Child< TypeTree::CompositeNode< Children... >, 0 >::Traits::EntitySet, Backend, OrderingTag, k > >::globalSize
inlineinherited

◆ gridView()

const Traits::GridView& Dune::PDELab::PowerCompositeGridFunctionSpaceBase< CompositeGridFunctionSpace< Backend, OrderingTag, Children... > , TypeTree::Child< TypeTree::CompositeNode< Children... >, 0 >::Traits::EntitySet , Backend , OrderingTag , k >::gridView
inlineinherited

get grid view

◆ isRootSpace()

bool Dune::PDELab::GridFunctionSpaceBase< CompositeGridFunctionSpace< Backend, OrderingTag, Children... > , PowerCompositeGridFunctionSpaceTraits< TypeTree::Child< TypeTree::CompositeNode< Children... >, 0 >::Traits::EntitySet, Backend, OrderingTag, k > >::isRootSpace
inlineinherited

◆ maxLocalSize()

Traits::SizeType Dune::PDELab::GridFunctionSpaceBase< CompositeGridFunctionSpace< Backend, OrderingTag, Children... > , PowerCompositeGridFunctionSpaceTraits< TypeTree::Child< TypeTree::CompositeNode< Children... >, 0 >::Traits::EntitySet, Backend, OrderingTag, k > >::maxLocalSize
inlineinherited

get max dimension of shape function space

◆ name() [1/2]

const std::string& Dune::PDELab::GridFunctionSpaceBase< CompositeGridFunctionSpace< Backend, OrderingTag, Children... > , PowerCompositeGridFunctionSpaceTraits< TypeTree::Child< TypeTree::CompositeNode< Children... >, 0 >::Traits::EntitySet, Backend, OrderingTag, k > >::name
inlineinherited

◆ name() [2/2]

void Dune::PDELab::GridFunctionSpaceBase< CompositeGridFunctionSpace< Backend, OrderingTag, Children... > , PowerCompositeGridFunctionSpaceTraits< TypeTree::Child< TypeTree::CompositeNode< Children... >, 0 >::Traits::EntitySet, Backend, OrderingTag, k > >::name ( const std::string &  name)
inlineinherited

◆ ordering() [1/2]

template<typename Backend , typename OrderingTag , typename... Children>
Ordering& Dune::PDELab::CompositeGridFunctionSpace< Backend, OrderingTag, Children >::ordering ( )
inline

Direct access to the DOF ordering.

◆ ordering() [2/2]

template<typename Backend , typename OrderingTag , typename... Children>
const Ordering& Dune::PDELab::CompositeGridFunctionSpace< Backend, OrderingTag, Children >::ordering ( ) const
inline

Direct access to the DOF ordering.

◆ orderingStorage() [1/2]

template<typename Backend , typename OrderingTag , typename... Children>
std::shared_ptr<Ordering> Dune::PDELab::CompositeGridFunctionSpace< Backend, OrderingTag, Children >::orderingStorage ( )
inline

Direct access to the storage of the DOF ordering.

◆ orderingStorage() [2/2]

template<typename Backend , typename OrderingTag , typename... Children>
std::shared_ptr<const Ordering> Dune::PDELab::CompositeGridFunctionSpace< Backend, OrderingTag, Children >::orderingStorage ( ) const
inline

Direct access to the storage of the DOF ordering.

◆ orderingTag() [1/2]

Traits::OrderingTag& Dune::PDELab::GridFunctionSpaceBase< CompositeGridFunctionSpace< Backend, OrderingTag, Children... > , PowerCompositeGridFunctionSpaceTraits< TypeTree::Child< TypeTree::CompositeNode< Children... >, 0 >::Traits::EntitySet, Backend, OrderingTag, k > >::orderingTag
inlineinherited

◆ orderingTag() [2/2]

const Traits::OrderingTag& Dune::PDELab::GridFunctionSpaceBase< CompositeGridFunctionSpace< Backend, OrderingTag, Children... > , PowerCompositeGridFunctionSpaceTraits< TypeTree::Child< TypeTree::CompositeNode< Children... >, 0 >::Traits::EntitySet, Backend, OrderingTag, k > >::orderingTag
inlineinherited

◆ sendLeafSizes()

constexpr bool Dune::PDELab::DataHandleProvider< CompositeGridFunctionSpace< Backend, OrderingTag, Children... > >::sendLeafSizes
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.

◆ setup_dof_indices() [1/2]

void Dune::PDELab::DataHandleProvider< CompositeGridFunctionSpace< Backend, OrderingTag, Children... > >::setup_dof_indices ( V &  v,
size_type  n,
const EntityIndex &  ei,
std::integral_constant< bool, false >   
) const
inlineinherited

◆ setup_dof_indices() [2/2]

void Dune::PDELab::DataHandleProvider< CompositeGridFunctionSpace< Backend, OrderingTag, Children... > >::setup_dof_indices ( V &  v,
size_type  n,
const EntityIndex &  ei,
std::integral_constant< bool, true >   
) const
inlineinherited

◆ size()

Traits::SizeType Dune::PDELab::GridFunctionSpaceBase< CompositeGridFunctionSpace< Backend, OrderingTag, Children... > , PowerCompositeGridFunctionSpaceTraits< TypeTree::Child< TypeTree::CompositeNode< Children... >, 0 >::Traits::EntitySet, Backend, OrderingTag, k > >::size
inlineinherited

◆ update() [1/2]

void Dune::PDELab::GridFunctionSpaceBase< CompositeGridFunctionSpace< Backend, OrderingTag, Children... > , PowerCompositeGridFunctionSpaceTraits< TypeTree::Child< TypeTree::CompositeNode< Children... >, 0 >::Traits::EntitySet, Backend, OrderingTag, k > >::update ( bool  force = false)
inlineinherited

Update the indexing information of the GridFunctionSpace.

\ param force Set to true if the underlying grid has changed (e.g. due to adaptivity) to force an update of the embedded EntitySet.

◆ update() [2/2]

void Dune::PDELab::GridFunctionSpaceBase< CompositeGridFunctionSpace< Backend, OrderingTag, Children... > , PowerCompositeGridFunctionSpaceTraits< TypeTree::Child< TypeTree::CompositeNode< Children... >, 0 >::Traits::EntitySet, Backend, OrderingTag, k > >::update ( Ordering &  ordering) const
inlineprotectedinherited

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