dune-pdelab  2.5-dev
Public Types | Public Member Functions | Protected Member Functions | List of all members
Dune::PDELab::VectorGridFunctionSpace< GV, FEM, k, Backend, LeafBackend, Constraints, OrderingTag, LeafOrderingTag > Class Template Reference

base class for tuples of grid function spaces product of identical grid function spaces base class that holds implementation of the methods More...

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

Inheritance diagram for Dune::PDELab::VectorGridFunctionSpace< GV, FEM, k, Backend, LeafBackend, Constraints, OrderingTag, LeafOrderingTag >:
Inheritance graph

Public Types

typedef VectorGridFunctionSpaceTag ImplementationTag
 
typedef TypeTree::PowerNode< LeafGFS, k > BaseT
 
typedef PowerCompositeGridFunctionSpaceBase< VectorGridFunctionSpace, impl::EntitySet< GV >, Backend, OrderingTag, k > ImplementationBase
 
typedef TypeTree::TransformTree< VectorGridFunctionSpace, gfs_to_ordering< VectorGridFunctionSpace > > ordering_transformation
 
typedef ordering_transformation::Type Ordering
 
typedef ImplementationBase::Traits Traits
 export traits class More...
 
typedef OrderingTag OrderingTag
 
typedef std::size_t size_type
 

Public Member Functions

 VectorGridFunctionSpace (const typename Traits::GridView &gv, const FEM &fem, const Backend &backend=Backend(), const LeafBackend &leaf_backend=LeafBackend(), const OrderingTag &ordering_tag=OrderingTag(), const LeafOrderingTag &leaf_ordering_tag=LeafOrderingTag())
 
std::string name () const
 
void name (std::string name)
 
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...
 
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...
 
Output::DataSetType dataSetType () const
 Return the data set type of this function. More...
 
void setDataSetType (Output::DataSetType dataSetType)
 Set the data set type of this function. More...
 

Protected Member Functions

void update (Ordering &ordering) const
 
const VectorGridFunctionSpace< GV, FEM, k, Backend, LeafBackend, Constraints, OrderingTag, LeafOrderingTag > & gfs () const
 

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 >

base class for tuples of grid function spaces product of identical grid function spaces base class that holds implementation of the methods

PGFS(T,k) = {T}^k

Template Parameters
Tthe underlying are all grid function spaces
kpower factor
Mapperis the ordering parameter. Use e.g. GridFunctionSpaceLexicographicMapper or GridFunctionSpaceComponentBlockwiseMapper or GridFunctionSpaceBlockwiseMapper or GridFunctionSpaceDynamicBlockwiseMapper

Member Typedef Documentation

◆ BaseT

template<typename GV , typename FEM , std::size_t k, typename Backend , typename LeafBackend , typename Constraints = NoConstraints, typename OrderingTag = LexicographicOrderingTag, typename LeafOrderingTag = DefaultLeafOrderingTag>
typedef TypeTree::PowerNode<LeafGFS,k> Dune::PDELab::VectorGridFunctionSpace< GV, FEM, k, Backend, LeafBackend, Constraints, OrderingTag, LeafOrderingTag >::BaseT

◆ ImplementationBase

template<typename GV , typename FEM , std::size_t k, typename Backend , typename LeafBackend , typename Constraints = NoConstraints, typename OrderingTag = LexicographicOrderingTag, typename LeafOrderingTag = DefaultLeafOrderingTag>
typedef PowerCompositeGridFunctionSpaceBase< VectorGridFunctionSpace, impl::EntitySet<GV>, Backend, OrderingTag, k> Dune::PDELab::VectorGridFunctionSpace< GV, FEM, k, Backend, LeafBackend, Constraints, OrderingTag, LeafOrderingTag >::ImplementationBase

◆ ImplementationTag

template<typename GV , typename FEM , std::size_t k, typename Backend , typename LeafBackend , typename Constraints = NoConstraints, typename OrderingTag = LexicographicOrderingTag, typename LeafOrderingTag = DefaultLeafOrderingTag>
typedef VectorGridFunctionSpaceTag Dune::PDELab::VectorGridFunctionSpace< GV, FEM, k, Backend, LeafBackend, Constraints, OrderingTag, LeafOrderingTag >::ImplementationTag

◆ Ordering

template<typename GV , typename FEM , std::size_t k, typename Backend , typename LeafBackend , typename Constraints = NoConstraints, typename OrderingTag = LexicographicOrderingTag, typename LeafOrderingTag = DefaultLeafOrderingTag>
typedef ordering_transformation::Type Dune::PDELab::VectorGridFunctionSpace< GV, FEM, k, Backend, LeafBackend, Constraints, OrderingTag, LeafOrderingTag >::Ordering

◆ ordering_transformation

template<typename GV , typename FEM , std::size_t k, typename Backend , typename LeafBackend , typename Constraints = NoConstraints, typename OrderingTag = LexicographicOrderingTag, typename LeafOrderingTag = DefaultLeafOrderingTag>
typedef TypeTree::TransformTree<VectorGridFunctionSpace, gfs_to_ordering<VectorGridFunctionSpace> > Dune::PDELab::VectorGridFunctionSpace< GV, FEM, k, Backend, LeafBackend, Constraints, OrderingTag, LeafOrderingTag >::ordering_transformation

◆ OrderingTag

typedef OrderingTag Dune::PDELab::PowerCompositeGridFunctionSpaceBase< VectorGridFunctionSpace< GV, FEM, k, Backend, LeafBackend, Constraints, OrderingTag, LeafOrderingTag > , impl::EntitySet< GV > , Backend , OrderingTag , k >::OrderingTag
inherited

◆ size_type

typedef std::size_t Dune::PDELab::DataHandleProvider< VectorGridFunctionSpace< GV, FEM, k, Backend, LeafBackend, Constraints, OrderingTag, LeafOrderingTag > >::size_type
inherited

◆ Traits

template<typename GV , typename FEM , std::size_t k, typename Backend , typename LeafBackend , typename Constraints = NoConstraints, typename OrderingTag = LexicographicOrderingTag, typename LeafOrderingTag = DefaultLeafOrderingTag>
typedef ImplementationBase::Traits Dune::PDELab::VectorGridFunctionSpace< GV, FEM, k, Backend, LeafBackend, Constraints, OrderingTag, LeafOrderingTag >::Traits

export traits class

Constructor & Destructor Documentation

◆ VectorGridFunctionSpace()

template<typename GV , typename FEM , std::size_t k, typename Backend , typename LeafBackend , typename Constraints = NoConstraints, typename OrderingTag = LexicographicOrderingTag, typename LeafOrderingTag = DefaultLeafOrderingTag>
Dune::PDELab::VectorGridFunctionSpace< GV, FEM, k, Backend, LeafBackend, Constraints, OrderingTag, LeafOrderingTag >::VectorGridFunctionSpace ( const typename Traits::GridView gv,
const FEM &  fem,
const Backend &  backend = Backend(),
const LeafBackend &  leaf_backend = LeafBackend(),
const OrderingTag ordering_tag = OrderingTag(),
const LeafOrderingTag leaf_ordering_tag = LeafOrderingTag() 
)
inline

Member Function Documentation

◆ backend() [1/2]

Traits::Backend& Dune::PDELab::GridFunctionSpaceBase< VectorGridFunctionSpace< GV, FEM, k, Backend, LeafBackend, Constraints, OrderingTag, LeafOrderingTag > , PowerCompositeGridFunctionSpaceTraits< impl::EntitySet< GV >, Backend, OrderingTag, k > >::backend ( )
inlineinherited

◆ backend() [2/2]

const Traits::Backend& Dune::PDELab::GridFunctionSpaceBase< VectorGridFunctionSpace< GV, FEM, k, Backend, LeafBackend, Constraints, OrderingTag, LeafOrderingTag > , PowerCompositeGridFunctionSpaceTraits< impl::EntitySet< GV >, Backend, OrderingTag, k > >::backend ( ) const
inlineinherited

◆ blockCount()

Traits::SizeType Dune::PDELab::GridFunctionSpaceBase< VectorGridFunctionSpace< GV, FEM, k, Backend, LeafBackend, Constraints, OrderingTag, LeafOrderingTag > , PowerCompositeGridFunctionSpaceTraits< impl::EntitySet< GV >, Backend, OrderingTag, k > >::blockCount ( ) const
inlineinherited

◆ dataHandleContains()

bool Dune::PDELab::DataHandleProvider< VectorGridFunctionSpace< GV, FEM, k, Backend, LeafBackend, Constraints, OrderingTag, LeafOrderingTag > >::dataHandleContains ( int  codim) const
inlineinherited

returns true if data for this codim should be communicated

◆ dataHandleFixedSize()

bool Dune::PDELab::DataHandleProvider< VectorGridFunctionSpace< GV, FEM, k, Backend, LeafBackend, Constraints, OrderingTag, LeafOrderingTag > >::dataHandleFixedSize ( int  codim) const
inlineinherited

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

◆ dataHandleIndices()

void Dune::PDELab::DataHandleProvider< VectorGridFunctionSpace< GV, FEM, k, Backend, LeafBackend, Constraints, OrderingTag, LeafOrderingTag > >::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< VectorGridFunctionSpace< GV, FEM, k, Backend, LeafBackend, Constraints, OrderingTag, LeafOrderingTag > >::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.

◆ dataSetType()

Output::DataSetType Dune::PDELab::GridFunctionOutputParameters::dataSetType ( ) const
inlineinherited

Return the data set type of this function.

◆ dof_indices_begin() [1/2]

V::iterator Dune::PDELab::DataHandleProvider< VectorGridFunctionSpace< GV, FEM, k, Backend, LeafBackend, Constraints, OrderingTag, LeafOrderingTag > >::dof_indices_begin ( V &  v,
std::integral_constant< bool, true >   
) const
inlineinherited

◆ dof_indices_begin() [2/2]

DummyDOFIndexIterator Dune::PDELab::DataHandleProvider< VectorGridFunctionSpace< GV, FEM, k, Backend, LeafBackend, Constraints, OrderingTag, LeafOrderingTag > >::dof_indices_begin ( V &  v,
std::integral_constant< bool, false >   
) const
inlineinherited

◆ entitySet()

const Traits::EntitySet& Dune::PDELab::PowerCompositeGridFunctionSpaceBase< VectorGridFunctionSpace< GV, FEM, k, Backend, LeafBackend, Constraints, OrderingTag, LeafOrderingTag > , impl::EntitySet< GV > , Backend , OrderingTag , k >::entitySet ( ) const
inlineinherited

get grid view partition

◆ gfs()

const VectorGridFunctionSpace< GV, FEM, k, Backend, LeafBackend, Constraints, OrderingTag, LeafOrderingTag > & Dune::PDELab::DataHandleProvider< VectorGridFunctionSpace< GV, FEM, k, Backend, LeafBackend, Constraints, OrderingTag, LeafOrderingTag > >::gfs ( ) const
inlineprotectedinherited

◆ globalSize()

Traits::SizeType Dune::PDELab::GridFunctionSpaceBase< VectorGridFunctionSpace< GV, FEM, k, Backend, LeafBackend, Constraints, OrderingTag, LeafOrderingTag > , PowerCompositeGridFunctionSpaceTraits< impl::EntitySet< GV >, Backend, OrderingTag, k > >::globalSize ( ) const
inlineinherited

◆ gridView()

const Traits::GridView& Dune::PDELab::PowerCompositeGridFunctionSpaceBase< VectorGridFunctionSpace< GV, FEM, k, Backend, LeafBackend, Constraints, OrderingTag, LeafOrderingTag > , impl::EntitySet< GV > , Backend , OrderingTag , k >::gridView ( ) const
inlineinherited

get grid view

◆ isRootSpace()

bool Dune::PDELab::GridFunctionSpaceBase< VectorGridFunctionSpace< GV, FEM, k, Backend, LeafBackend, Constraints, OrderingTag, LeafOrderingTag > , PowerCompositeGridFunctionSpaceTraits< impl::EntitySet< GV >, Backend, OrderingTag, k > >::isRootSpace ( ) const
inlineinherited

◆ maxLocalSize()

Traits::SizeType Dune::PDELab::GridFunctionSpaceBase< VectorGridFunctionSpace< GV, FEM, k, Backend, LeafBackend, Constraints, OrderingTag, LeafOrderingTag > , PowerCompositeGridFunctionSpaceTraits< impl::EntitySet< GV >, Backend, OrderingTag, k > >::maxLocalSize ( ) const
inlineinherited

get max dimension of shape function space

◆ name() [1/3]

template<typename GV , typename FEM , std::size_t k, typename Backend , typename LeafBackend , typename Constraints = NoConstraints, typename OrderingTag = LexicographicOrderingTag, typename LeafOrderingTag = DefaultLeafOrderingTag>
std::string Dune::PDELab::VectorGridFunctionSpace< GV, FEM, k, Backend, LeafBackend, Constraints, OrderingTag, LeafOrderingTag >::name ( ) const
inline

◆ name() [2/3]

template<typename GV , typename FEM , std::size_t k, typename Backend , typename LeafBackend , typename Constraints = NoConstraints, typename OrderingTag = LexicographicOrderingTag, typename LeafOrderingTag = DefaultLeafOrderingTag>
void Dune::PDELab::VectorGridFunctionSpace< GV, FEM, k, Backend, LeafBackend, Constraints, OrderingTag, LeafOrderingTag >::name ( std::string  name)
inline

◆ name() [3/3]

void Dune::PDELab::GridFunctionSpaceBase< VectorGridFunctionSpace< GV, FEM, k, Backend, LeafBackend, Constraints, OrderingTag, LeafOrderingTag > , PowerCompositeGridFunctionSpaceTraits< impl::EntitySet< GV >, Backend, OrderingTag, k > >::name ( const std::string &  name)
inlineinherited

◆ ordering() [1/2]

template<typename GV , typename FEM , std::size_t k, typename Backend , typename LeafBackend , typename Constraints = NoConstraints, typename OrderingTag = LexicographicOrderingTag, typename LeafOrderingTag = DefaultLeafOrderingTag>
const Ordering& Dune::PDELab::VectorGridFunctionSpace< GV, FEM, k, Backend, LeafBackend, Constraints, OrderingTag, LeafOrderingTag >::ordering ( ) const
inline

Direct access to the DOF ordering.

◆ ordering() [2/2]

template<typename GV , typename FEM , std::size_t k, typename Backend , typename LeafBackend , typename Constraints = NoConstraints, typename OrderingTag = LexicographicOrderingTag, typename LeafOrderingTag = DefaultLeafOrderingTag>
Ordering& Dune::PDELab::VectorGridFunctionSpace< GV, FEM, k, Backend, LeafBackend, Constraints, OrderingTag, LeafOrderingTag >::ordering ( )
inline

Direct access to the DOF ordering.

◆ orderingStorage() [1/2]

template<typename GV , typename FEM , std::size_t k, typename Backend , typename LeafBackend , typename Constraints = NoConstraints, typename OrderingTag = LexicographicOrderingTag, typename LeafOrderingTag = DefaultLeafOrderingTag>
std::shared_ptr<const Ordering> Dune::PDELab::VectorGridFunctionSpace< GV, FEM, k, Backend, LeafBackend, Constraints, OrderingTag, LeafOrderingTag >::orderingStorage ( ) const
inline

Direct access to the storage of the DOF ordering.

◆ orderingStorage() [2/2]

template<typename GV , typename FEM , std::size_t k, typename Backend , typename LeafBackend , typename Constraints = NoConstraints, typename OrderingTag = LexicographicOrderingTag, typename LeafOrderingTag = DefaultLeafOrderingTag>
std::shared_ptr<Ordering> Dune::PDELab::VectorGridFunctionSpace< GV, FEM, k, Backend, LeafBackend, Constraints, OrderingTag, LeafOrderingTag >::orderingStorage ( )
inline

Direct access to the storage of the DOF ordering.

◆ orderingTag() [1/2]

Traits::OrderingTag& Dune::PDELab::GridFunctionSpaceBase< VectorGridFunctionSpace< GV, FEM, k, Backend, LeafBackend, Constraints, OrderingTag, LeafOrderingTag > , PowerCompositeGridFunctionSpaceTraits< impl::EntitySet< GV >, Backend, OrderingTag, k > >::orderingTag ( )
inlineinherited

◆ orderingTag() [2/2]

const Traits::OrderingTag& Dune::PDELab::GridFunctionSpaceBase< VectorGridFunctionSpace< GV, FEM, k, Backend, LeafBackend, Constraints, OrderingTag, LeafOrderingTag > , PowerCompositeGridFunctionSpaceTraits< impl::EntitySet< GV >, Backend, OrderingTag, k > >::orderingTag ( ) const
inlineinherited

◆ sendLeafSizes()

constexpr bool Dune::PDELab::DataHandleProvider< VectorGridFunctionSpace< GV, FEM, k, Backend, LeafBackend, Constraints, OrderingTag, LeafOrderingTag > >::sendLeafSizes ( ) const
inlineinherited

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.

◆ setDataSetType()

void Dune::PDELab::GridFunctionOutputParameters::setDataSetType ( Output::DataSetType  dataSetType)
inlineinherited

Set the data set type of this function.

◆ setup_dof_indices() [1/2]

void Dune::PDELab::DataHandleProvider< VectorGridFunctionSpace< GV, FEM, k, Backend, LeafBackend, Constraints, OrderingTag, LeafOrderingTag > >::setup_dof_indices ( V &  v,
size_type  n,
const EntityIndex &  ei,
std::integral_constant< bool, true >   
) const
inlineinherited

◆ setup_dof_indices() [2/2]

void Dune::PDELab::DataHandleProvider< VectorGridFunctionSpace< GV, FEM, k, Backend, LeafBackend, Constraints, OrderingTag, LeafOrderingTag > >::setup_dof_indices ( V &  v,
size_type  n,
const EntityIndex &  ei,
std::integral_constant< bool, false >   
) const
inlineinherited

◆ size()

Traits::SizeType Dune::PDELab::GridFunctionSpaceBase< VectorGridFunctionSpace< GV, FEM, k, Backend, LeafBackend, Constraints, OrderingTag, LeafOrderingTag > , PowerCompositeGridFunctionSpaceTraits< impl::EntitySet< GV >, Backend, OrderingTag, k > >::size ( ) const
inlineinherited

◆ update() [1/2]

void Dune::PDELab::GridFunctionSpaceBase< VectorGridFunctionSpace< GV, FEM, k, Backend, LeafBackend, Constraints, OrderingTag, LeafOrderingTag > , PowerCompositeGridFunctionSpaceTraits< impl::EntitySet< GV >, 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< VectorGridFunctionSpace< GV, FEM, k, Backend, LeafBackend, Constraints, OrderingTag, LeafOrderingTag > , PowerCompositeGridFunctionSpaceTraits< impl::EntitySet< GV >, Backend, OrderingTag, k > >::update ( Ordering &  ordering) const
inlineprotectedinherited

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