DUNE PDELab (2.8)
Data handle for marking ghost DOFs. More...
#include <dune/pdelab/gridfunctionspace/genericdatahandle.hh>
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 | |
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 More... | |
size_t | size (const EntityType &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 | |
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 |
pack data from user to message buffer 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... | |
void | scatter (MessageBufferImp &buff, const EntityType &e, size_t n) |
unpack data from message buffer to user. More... | |
int | fixedsize (int dim, int codim) const |
returns true if size of data per entity of given dim and codim is a constant More... | |
Detailed Description
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.
Constructor & Destructor Documentation
◆ GhostDataHandle()
|
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
◆ fixedsize()
|
inlineinherited |
returns true if size of data per entity of given dim and codim is a constant
- Parameters
-
dim valid dimension (i.e. the grids dimension) codim valid codimension of the entity set for which data should be communicated
This method calls 'fixedSize' (with a capital S) of the derived class, if it exists in the derived class. Otherwise, it calls 'fixedsize'.
- Deprecated:
- This method (with the lower-case 's') is deprecated. Use 'fixedSize' instead!
◆ gather()
|
inlineinherited |
pack data from user to message buffer
- Parameters
-
buff message buffer provided by the grid e entity for which date should be packed to buffer
◆ scatter() [1/3]
|
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/3]
|
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
◆ scatter() [3/3]
|
inlineinherited |
unpack data from message buffer to user.
- Parameters
-
buff message buffer provided by the grid. This is not const, because the buffer has an internal iterator that gets advanced when reading from the buffer. e entity for which date should be unpacked from buffer n number of data written to buffer for this entity before
◆ size() [1/2]
|
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.
◆ size() [2/2]
|
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.
- Parameters
-
e entity for which the size should be determined
The documentation for this class was generated from the following file:
- dune/pdelab/gridfunctionspace/genericdatahandle.hh