dune-pdelab  2.7-git
Public Types | Public Member Functions | Static Public Attributes | List of all members
Dune::PDELab::SharedDOFDataHandle< GFS, V > Class Template Reference

Data handle for marking shared DOFs. More...

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

Inheritance diagram for Dune::PDELab::SharedDOFDataHandle< GFS, V >:
Inheritance graph

Public Types

typedef CommunicationDescriptor::DataType DataType
 
typedef GFS::Traits::SizeType size_type
 

Public Member Functions

 SharedDOFDataHandle (const GFS &gfs_, V &v_, bool init_vector=true)
 Creates a new SharedDOFDataHandle. More...
 
bool contains (int dim, int codim) const
 returns true if data for this codim should be communicated More...
 
bool fixedSize (int dim, int codim) const
 returns true if size per entity of given dim and codim is a constant More...
 
size_type size (const Entity &e) const
 how many objects of type DataType have to be sent for a given entity More...
 
std::enable_if< CommunicationDescriptor::wrap_buffer &&AlwaysTrue< Entity >::value >::type gather (MessageBuffer &buff, const Entity &e) const
 pack data from user to message buffer - version with support for sending leaf ordering sizes More...
 
std::enable_if< !CommunicationDescriptor::wrap_buffer &&AlwaysTrue< Entity >::value >::type gather (MessageBuffer &buff, const Entity &e) const
 pack data from user to message buffer - version without support for sending leaf ordering sizes More...
 
std::enable_if< CommunicationDescriptor::wrap_buffer &&AlwaysTrue< Entity >::value >::type scatter (MessageBuffer &buff, const Entity &e, size_type n)
 unpack data from message buffer to user More...
 
std::enable_if< !CommunicationDescriptor::wrap_buffer &&AlwaysTrue< Entity >::value >::type scatter (MessageBuffer &buff, const Entity &e, size_type n)
 unpack data from message buffer to user More...
 

Static Public Attributes

static const size_type leaf_count
 

Detailed Description

template<class GFS, class V>
class Dune::PDELab::SharedDOFDataHandle< GFS, V >

Data handle for marking shared DOFs.

This data handle will mark all DOFs that exist on multiple processes.

Note
In order to work correctly, the data handle must be communicated on the Dune::All_All_Interface and the result vector must be initialized with false.

Member Typedef Documentation

◆ DataType

typedef CommunicationDescriptor::DataType Dune::PDELab::GFSDataHandle< GFS, V, SharedDOFGatherScatter , EntityDataCommunicationDescriptor< bool > >::DataType
inherited

◆ size_type

typedef GFS::Traits::SizeType Dune::PDELab::GFSDataHandle< GFS, V, SharedDOFGatherScatter , EntityDataCommunicationDescriptor< bool > >::size_type
inherited

Constructor & Destructor Documentation

◆ SharedDOFDataHandle()

template<class GFS , class V >
Dune::PDELab::SharedDOFDataHandle< GFS, V >::SharedDOFDataHandle ( const GFS &  gfs_,
V &  v_,
bool  init_vector = true 
)
inline

Creates a new SharedDOFDataHandle.

Creates a new SharedDOFDataHandle and by default initializes the result vector with the correct value of false. If you have already done that externally, you can skip the initialization.

Parameters
gfs_The GridFunctionSpace to operate on.
v_The result vector.
init_vectorFlag to control whether the result vector will be initialized.

Member Function Documentation

◆ contains()

bool Dune::PDELab::GFSDataHandle< GFS, V, SharedDOFGatherScatter , EntityDataCommunicationDescriptor< bool > >::contains ( int  dim,
int  codim 
) const
inlineinherited

returns true if data for this codim should be communicated

◆ fixedSize()

bool Dune::PDELab::GFSDataHandle< GFS, V, SharedDOFGatherScatter , EntityDataCommunicationDescriptor< bool > >::fixedSize ( int  dim,
int  codim 
) const
inlineinherited

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

◆ gather() [1/2]

std::enable_if< CommunicationDescriptor::wrap_buffer && AlwaysTrue<Entity>::value >::type Dune::PDELab::GFSDataHandle< GFS, V, SharedDOFGatherScatter , EntityDataCommunicationDescriptor< bool > >::gather ( MessageBuffer &  buff,
const Entity &  e 
) const
inlineinherited

pack data from user to message buffer - version with support for sending leaf ordering sizes

◆ gather() [2/2]

std::enable_if< !CommunicationDescriptor::wrap_buffer && AlwaysTrue<Entity>::value >::type Dune::PDELab::GFSDataHandle< GFS, V, SharedDOFGatherScatter , EntityDataCommunicationDescriptor< bool > >::gather ( MessageBuffer &  buff,
const Entity &  e 
) const
inlineinherited

pack data from user to message buffer - version without support for sending leaf ordering sizes

◆ scatter() [1/2]

std::enable_if< CommunicationDescriptor::wrap_buffer && AlwaysTrue<Entity>::value >::type Dune::PDELab::GFSDataHandle< GFS, V, SharedDOFGatherScatter , EntityDataCommunicationDescriptor< bool > >::scatter ( MessageBuffer &  buff,
const Entity &  e,
size_type  n 
)
inlineinherited

unpack data from message buffer to user

n is the number of objects sent by the sender

This is the version with support for receiving leaf ordering sizes

◆ scatter() [2/2]

std::enable_if< !CommunicationDescriptor::wrap_buffer && AlwaysTrue<Entity>::value >::type Dune::PDELab::GFSDataHandle< GFS, V, SharedDOFGatherScatter , EntityDataCommunicationDescriptor< bool > >::scatter ( MessageBuffer &  buff,
const Entity &  e,
size_type  n 
)
inlineinherited

unpack data from message buffer to user

n is the number of objects sent by the sender

This is the version without support for receiving leaf ordering sizes

◆ size()

size_type Dune::PDELab::GFSDataHandle< GFS, V, SharedDOFGatherScatter , EntityDataCommunicationDescriptor< bool > >::size ( 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.

Member Data Documentation

◆ leaf_count


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