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

Data handle for marking ghost DOFs. More...

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

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

Public Types

typedef EntityDataCommunicationDescriptor< bool >::DataType DataType
 
typedef GFS::Traits::SizeType size_type
 

Public Member Functions

 GhostDataHandle (const GFS &gfs_, V &v_, bool init_vector=true)
 Creates a new GhostDataHandle. 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...
 
enable_if< EntityDataCommunicationDescriptor< bool >::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...
 
enable_if< !EntityDataCommunicationDescriptor< bool >::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...
 
enable_if< EntityDataCommunicationDescriptor< bool >::wrap_buffer &&AlwaysTrue< Entity >::value >::type scatter (MessageBuffer &buff, const Entity &e, size_type n)
 unpack data from message buffer to user More...
 
enable_if< !EntityDataCommunicationDescriptor< bool >::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::GhostDataHandle< GFS, V >

Data handle for marking ghost DOFs.

This data handle will mark all ghost DOFs (more precisely, all DOFs associated with entities not part of either the interior or the border partition).

Note
In order to work correctly, the data handle must be communicated on the Dune::InteriorBorder_All_Interface.

Member Typedef Documentation

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

Constructor & Destructor Documentation

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

Creates a new GhostDataHandle.

Creates a new GhostDataHandle 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

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

returns true if data for this codim should be communicated

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

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

enable_if< EntityDataCommunicationDescriptor< bool > ::wrap_buffer && AlwaysTrue<Entity>::value >::type Dune::PDELab::GFSDataHandle< GFS, V, GhostGatherScatter , 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

enable_if< !EntityDataCommunicationDescriptor< bool > ::wrap_buffer && AlwaysTrue<Entity>::value >::type Dune::PDELab::GFSDataHandle< GFS, V, GhostGatherScatter , 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

enable_if< EntityDataCommunicationDescriptor< bool > ::wrap_buffer && AlwaysTrue<Entity>::value >::type Dune::PDELab::GFSDataHandle< GFS, V, GhostGatherScatter , 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

enable_if< !EntityDataCommunicationDescriptor< bool > ::wrap_buffer && AlwaysTrue<Entity>::value >::type Dune::PDELab::GFSDataHandle< GFS, V, GhostGatherScatter , 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_type Dune::PDELab::GFSDataHandle< GFS, V, GhostGatherScatter , 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

const size_type Dune::PDELab::GFSDataHandle< GFS, V, GhostGatherScatter , EntityDataCommunicationDescriptor< bool > >::leaf_count
staticinherited

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