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 >:

Public Types
typedef CommunicationDescriptor::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.
bool	contains (int dim, int codim) const
	returns true if data for this codim should be communicated
bool	fixedSize (int dim, int codim) const
	returns true if size per entity of given dim and codim is a constant
size_type	size (const Entity &e) const
	how many objects of type DataType have to be sent for a given entity
size_t	size (const EntityType &e) const
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
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
void	gather (MessageBufferImp &buff, const EntityType &e) const
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
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
void	scatter (MessageBufferImp &buff, const EntityType &e, size_t n)
int	fixedsize (int dim, int codim) const
bool	overloaded_deprecated_fixedsize (int dim, int codim) const

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

DataType

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

inherited

size_type

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

inherited

Constructor & Destructor Documentation

GhostDataHandle()

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_vector	Flag to control whether the result vector will be initialized.

Member Function Documentation

contains()

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

fixedSize()

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

gather() [1/2]

std::enable_if< CommunicationDescriptor::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

gather() [2/2]

std::enable_if<!CommunicationDescriptor::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

scatter() [1/2]

std::enable_if< CommunicationDescriptor::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

scatter() [2/2]

std::enable_if<!CommunicationDescriptor::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()

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

leaf_count

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:

• genericdatahandle.hh