dune-pdelab  2.7-git
Classes | Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Dune::PDELab::PowerGridFunctionSpace< T, k, Backend, OrderingTag > 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/powergridfunctionspace.hh>

Inheritance diagram for Dune::PDELab::PowerGridFunctionSpace< T, k, Backend, OrderingTag >:
Inheritance graph

Classes

struct  ConstraintsContainer
 extract type for storing constraints More...
 

Public Types

typedef PowerGridFunctionSpaceTag ImplementationTag
 
typedef TypeTree::PowerNode< T, k > BaseT
 
typedef ordering_transformation::Type Ordering
 
typedef ImplementationBase::Traits Traits
 export traits class More...
 
typedef LexicographicOrderingTag OrderingTag
 
typedef std::size_t size_type
 

Public Member Functions

 PowerGridFunctionSpace (const std::array< std::shared_ptr< T >, k > &container, const Backend &backend=Backend(), const OrderingTag ordering_tag=OrderingTag())
 Construct a new Power Grid Function Space object. More...
 
 PowerGridFunctionSpace (T &c, const Backend &backend=Backend(), const OrderingTag ordering_tag=OrderingTag())
 
 PowerGridFunctionSpace (T &c0, T &c1, const Backend &backend=Backend(), const OrderingTag ordering_tag=OrderingTag())
 
 PowerGridFunctionSpace (T &c0, T &c1, T &c2, const Backend &backend=Backend(), const OrderingTag ordering_tag=OrderingTag())
 
 PowerGridFunctionSpace (T &c0, T &c1, T &c2, T &c3, const Backend &backend=Backend(), const OrderingTag ordering_tag=OrderingTag())
 
 PowerGridFunctionSpace (T &c0, T &c1, T &c2, T &c3, T &c4, const Backend &backend=Backend(), const OrderingTag ordering_tag=OrderingTag())
 
 PowerGridFunctionSpace (T &c0, T &c1, T &c2, T &c3, T &c4, T &c5, const Backend &backend=Backend(), const OrderingTag ordering_tag=OrderingTag())
 
 PowerGridFunctionSpace (T &c0, T &c1, T &c2, T &c3, T &c4, T &c5, T &c6, const Backend &backend=Backend(), const OrderingTag ordering_tag=OrderingTag())
 
 PowerGridFunctionSpace (T &c0, T &c1, T &c2, T &c3, T &c4, T &c5, T &c6, T &c7, const Backend &backend=Backend(), const OrderingTag ordering_tag=OrderingTag())
 
 PowerGridFunctionSpace (T &c0, T &c1, T &c2, T &c3, T &c4, T &c5, T &c6, T &c7, T &c8, const Backend &backend=Backend(), const OrderingTag ordering_tag=OrderingTag())
 
 PowerGridFunctionSpace (T &c0, T &c1, T &c2, T &c3, T &c4, T &c5, T &c6, T &c7, T &c8, T &c9, const Backend &backend=Backend(), const OrderingTag ordering_tag=OrderingTag())
 
template<typename Child0 , typename... Children>
 PowerGridFunctionSpace (std::shared_ptr< Child0 > child0, 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::EntitySetentitySet () const
 get grid view partition More...
 
Traits::EntitySetentitySet ()
 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
 
const Traits::GridViewgridView () const
 get grid view More...
 
void setEntitySet (typename Traits::EntitySet entity_set)
 Set the Entity Set object to this grid function space. More...
 
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

template<typename Ordering >
void update (Ordering &ordering) const
 
const PowerGridFunctionSpace< T, k, Backend, LexicographicOrderingTag > & gfs () const
 

Protected Attributes

std::optional< typename Traits::EntitySet_entity_set
 

Detailed Description

template<typename T, std::size_t k, typename Backend, typename OrderingTag = LexicographicOrderingTag>
class Dune::PDELab::PowerGridFunctionSpace< T, k, Backend, OrderingTag >

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
Examples
recipe-blocking.cc, and recipe-operator-splitting.cc.

Member Typedef Documentation

◆ BaseT

template<typename T , std::size_t k, typename Backend , typename OrderingTag = LexicographicOrderingTag>
typedef TypeTree::PowerNode<T,k> Dune::PDELab::PowerGridFunctionSpace< T, k, Backend, OrderingTag >::BaseT

◆ ImplementationTag

template<typename T , std::size_t k, typename Backend , typename OrderingTag = LexicographicOrderingTag>
typedef PowerGridFunctionSpaceTag Dune::PDELab::PowerGridFunctionSpace< T, k, Backend, OrderingTag >::ImplementationTag

◆ Ordering

template<typename T , std::size_t k, typename Backend , typename OrderingTag = LexicographicOrderingTag>
typedef ordering_transformation::Type Dune::PDELab::PowerGridFunctionSpace< T, k, Backend, OrderingTag >::Ordering

◆ OrderingTag

◆ size_type

◆ Traits

template<typename T , std::size_t k, typename Backend , typename OrderingTag = LexicographicOrderingTag>
typedef ImplementationBase::Traits Dune::PDELab::PowerGridFunctionSpace< T, k, Backend, OrderingTag >::Traits

export traits class

Constructor & Destructor Documentation

◆ PowerGridFunctionSpace() [1/12]

template<typename T , std::size_t k, typename Backend , typename OrderingTag = LexicographicOrderingTag>
Dune::PDELab::PowerGridFunctionSpace< T, k, Backend, OrderingTag >::PowerGridFunctionSpace ( const std::array< std::shared_ptr< T >, k > &  container,
const Backend &  backend = Backend(),
const OrderingTag  ordering_tag = OrderingTag() 
)
inline

Construct a new Power Grid Function Space object.

Parameters
containerarray with pointers to child spaces
backendbackend object
ordering_tagordering tag object

◆ PowerGridFunctionSpace() [2/12]

template<typename T , std::size_t k, typename Backend , typename OrderingTag = LexicographicOrderingTag>
Dune::PDELab::PowerGridFunctionSpace< T, k, Backend, OrderingTag >::PowerGridFunctionSpace ( T &  c,
const Backend &  backend = Backend(),
const OrderingTag  ordering_tag = OrderingTag() 
)
inline

◆ PowerGridFunctionSpace() [3/12]

template<typename T , std::size_t k, typename Backend , typename OrderingTag = LexicographicOrderingTag>
Dune::PDELab::PowerGridFunctionSpace< T, k, Backend, OrderingTag >::PowerGridFunctionSpace ( T &  c0,
T &  c1,
const Backend &  backend = Backend(),
const OrderingTag  ordering_tag = OrderingTag() 
)
inline

◆ PowerGridFunctionSpace() [4/12]

template<typename T , std::size_t k, typename Backend , typename OrderingTag = LexicographicOrderingTag>
Dune::PDELab::PowerGridFunctionSpace< T, k, Backend, OrderingTag >::PowerGridFunctionSpace ( T &  c0,
T &  c1,
T &  c2,
const Backend &  backend = Backend(),
const OrderingTag  ordering_tag = OrderingTag() 
)
inline

◆ PowerGridFunctionSpace() [5/12]

template<typename T , std::size_t k, typename Backend , typename OrderingTag = LexicographicOrderingTag>
Dune::PDELab::PowerGridFunctionSpace< T, k, Backend, OrderingTag >::PowerGridFunctionSpace ( T &  c0,
T &  c1,
T &  c2,
T &  c3,
const Backend &  backend = Backend(),
const OrderingTag  ordering_tag = OrderingTag() 
)
inline

◆ PowerGridFunctionSpace() [6/12]

template<typename T , std::size_t k, typename Backend , typename OrderingTag = LexicographicOrderingTag>
Dune::PDELab::PowerGridFunctionSpace< T, k, Backend, OrderingTag >::PowerGridFunctionSpace ( T &  c0,
T &  c1,
T &  c2,
T &  c3,
T &  c4,
const Backend &  backend = Backend(),
const OrderingTag  ordering_tag = OrderingTag() 
)
inline

◆ PowerGridFunctionSpace() [7/12]

template<typename T , std::size_t k, typename Backend , typename OrderingTag = LexicographicOrderingTag>
Dune::PDELab::PowerGridFunctionSpace< T, k, Backend, OrderingTag >::PowerGridFunctionSpace ( T &  c0,
T &  c1,
T &  c2,
T &  c3,
T &  c4,
T &  c5,
const Backend &  backend = Backend(),
const OrderingTag  ordering_tag = OrderingTag() 
)
inline

◆ PowerGridFunctionSpace() [8/12]

template<typename T , std::size_t k, typename Backend , typename OrderingTag = LexicographicOrderingTag>
Dune::PDELab::PowerGridFunctionSpace< T, k, Backend, OrderingTag >::PowerGridFunctionSpace ( T &  c0,
T &  c1,
T &  c2,
T &  c3,
T &  c4,
T &  c5,
T &  c6,
const Backend &  backend = Backend(),
const OrderingTag  ordering_tag = OrderingTag() 
)
inline

◆ PowerGridFunctionSpace() [9/12]

template<typename T , std::size_t k, typename Backend , typename OrderingTag = LexicographicOrderingTag>
Dune::PDELab::PowerGridFunctionSpace< T, k, Backend, OrderingTag >::PowerGridFunctionSpace ( T &  c0,
T &  c1,
T &  c2,
T &  c3,
T &  c4,
T &  c5,
T &  c6,
T &  c7,
const Backend &  backend = Backend(),
const OrderingTag  ordering_tag = OrderingTag() 
)
inline

◆ PowerGridFunctionSpace() [10/12]

template<typename T , std::size_t k, typename Backend , typename OrderingTag = LexicographicOrderingTag>
Dune::PDELab::PowerGridFunctionSpace< T, k, Backend, OrderingTag >::PowerGridFunctionSpace ( T &  c0,
T &  c1,
T &  c2,
T &  c3,
T &  c4,
T &  c5,
T &  c6,
T &  c7,
T &  c8,
const Backend &  backend = Backend(),
const OrderingTag  ordering_tag = OrderingTag() 
)
inline

◆ PowerGridFunctionSpace() [11/12]

template<typename T , std::size_t k, typename Backend , typename OrderingTag = LexicographicOrderingTag>
Dune::PDELab::PowerGridFunctionSpace< T, k, Backend, OrderingTag >::PowerGridFunctionSpace ( T &  c0,
T &  c1,
T &  c2,
T &  c3,
T &  c4,
T &  c5,
T &  c6,
T &  c7,
T &  c8,
T &  c9,
const Backend &  backend = Backend(),
const OrderingTag  ordering_tag = OrderingTag() 
)
inline

◆ PowerGridFunctionSpace() [12/12]

template<typename T , std::size_t k, typename Backend , typename OrderingTag = LexicographicOrderingTag>
template<typename Child0 , typename... Children>
Dune::PDELab::PowerGridFunctionSpace< T, k, Backend, OrderingTag >::PowerGridFunctionSpace ( std::shared_ptr< Child0 >  child0,
std::shared_ptr< Children >...  children 
)
inline

Member Function Documentation

◆ dataHandleContains()

bool Dune::PDELab::DataHandleProvider< PowerGridFunctionSpace< T, k, Backend, LexicographicOrderingTag > >::dataHandleContains ( int  codim) const
inlineinherited

returns true if data for this codim should be communicated

◆ dataHandleFixedSize()

bool Dune::PDELab::DataHandleProvider< PowerGridFunctionSpace< T, k, Backend, LexicographicOrderingTag > >::dataHandleFixedSize ( int  codim) const
inlineinherited

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

◆ dataHandleIndices()

void Dune::PDELab::DataHandleProvider< PowerGridFunctionSpace< T, k, Backend, LexicographicOrderingTag > >::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< PowerGridFunctionSpace< T, k, Backend, LexicographicOrderingTag > >::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< PowerGridFunctionSpace< T, k, Backend, LexicographicOrderingTag > >::dof_indices_begin ( V &  v,
std::integral_constant< bool, false >   
) const
inlineinherited

◆ dof_indices_begin() [2/2]

V::iterator Dune::PDELab::DataHandleProvider< PowerGridFunctionSpace< T, k, Backend, LexicographicOrderingTag > >::dof_indices_begin ( V &  v,
std::integral_constant< bool, true >   
) const
inlineinherited

◆ entitySet() [1/2]

Traits::EntitySet& Dune::PDELab::PowerCompositeGridFunctionSpaceBase< PowerGridFunctionSpace< T, k, Backend, LexicographicOrderingTag > , T::Traits::EntitySet , Backend , LexicographicOrderingTag , k >::entitySet ( )
inlineinherited

get grid view partition

◆ entitySet() [2/2]

const Traits::EntitySet& Dune::PDELab::PowerCompositeGridFunctionSpaceBase< PowerGridFunctionSpace< T, k, Backend, LexicographicOrderingTag > , T::Traits::EntitySet , Backend , LexicographicOrderingTag , k >::entitySet ( ) const
inlineinherited

get grid view partition

◆ gfs()

const PowerGridFunctionSpace< T, k, Backend, LexicographicOrderingTag > & Dune::PDELab::DataHandleProvider< PowerGridFunctionSpace< T, k, Backend, LexicographicOrderingTag > >::gfs ( ) const
inlineprotectedinherited

◆ ordering() [1/2]

template<typename T , std::size_t k, typename Backend , typename OrderingTag = LexicographicOrderingTag>
Ordering& Dune::PDELab::PowerGridFunctionSpace< T, k, Backend, OrderingTag >::ordering ( )
inline

Direct access to the DOF ordering.

◆ ordering() [2/2]

template<typename T , std::size_t k, typename Backend , typename OrderingTag = LexicographicOrderingTag>
const Ordering& Dune::PDELab::PowerGridFunctionSpace< T, k, Backend, OrderingTag >::ordering ( ) const
inline

Direct access to the DOF ordering.

◆ orderingStorage() [1/2]

template<typename T , std::size_t k, typename Backend , typename OrderingTag = LexicographicOrderingTag>
std::shared_ptr<Ordering> Dune::PDELab::PowerGridFunctionSpace< T, k, Backend, OrderingTag >::orderingStorage ( )
inline

Direct access to the storage of the DOF ordering.

◆ orderingStorage() [2/2]

template<typename T , std::size_t k, typename Backend , typename OrderingTag = LexicographicOrderingTag>
std::shared_ptr<const Ordering> Dune::PDELab::PowerGridFunctionSpace< T, k, Backend, OrderingTag >::orderingStorage ( ) const
inline

Direct access to the storage of the DOF ordering.

◆ sendLeafSizes()

constexpr bool Dune::PDELab::DataHandleProvider< PowerGridFunctionSpace< T, k, Backend, LexicographicOrderingTag > >::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.

◆ setup_dof_indices() [1/2]

void Dune::PDELab::DataHandleProvider< PowerGridFunctionSpace< T, k, Backend, LexicographicOrderingTag > >::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< PowerGridFunctionSpace< T, k, Backend, LexicographicOrderingTag > >::setup_dof_indices ( V &  v,
size_type  n,
const EntityIndex &  ei,
std::integral_constant< bool, true >   
) const
inlineinherited

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