DUNE PDELab (git)

Dune::PDELab::GFSNeighborDataHandle< GFS, RankIndex > Class Template Reference

Data handle for collecting set of neighboring MPI ranks. More...

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

Public Member Functions

size_t size (const EntityType &e) const
 how many objects of type DataType have to be sent for a given entity More...
 
void gather (MessageBufferImp &buff, const EntityType &e) const
 pack data from user to message buffer More...
 
void scatter (MessageBufferImp &buff, const EntityType &e, size_t n)
 unpack data from message buffer to user. More...
 

Detailed Description

template<typename GFS, typename RankIndex>
class Dune::PDELab::GFSNeighborDataHandle< GFS, RankIndex >

Data handle for collecting set of neighboring MPI ranks.

This data handle collects the MPI ranks of all processes that share grid entities with attached DOFs.

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

Member Function Documentation

◆ gather()

void Dune::CommDataHandleIF< GFSNeighborDataHandle< GFS, RankIndex > , RankIndex >::gather ( MessageBufferImp &  buff,
const EntityType &  e 
) const
inlineinherited

pack data from user to message buffer

Parameters
buffmessage buffer provided by the grid
eentity for which date should be packed to buffer

◆ scatter()

void Dune::CommDataHandleIF< GFSNeighborDataHandle< GFS, RankIndex > , RankIndex >::scatter ( MessageBufferImp &  buff,
const EntityType &  e,
size_t  n 
)
inlineinherited

unpack data from message buffer to user.

Parameters
buffmessage buffer provided by the grid. This is not const, because the buffer has an internal iterator that gets advanced when reading from the buffer.
eentity for which date should be unpacked from buffer
nnumber of data written to buffer for this entity before

◆ size()

size_t Dune::CommDataHandleIF< GFSNeighborDataHandle< GFS, RankIndex > , RankIndex >::size ( const EntityType &  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.
Parameters
eentity for which the size should be determined

The documentation for this class was generated from the following file:
Creative Commons License   |  Legal Statements / Impressum  |  Hosted by TU Dresden  |  generated with Hugo v0.111.3 (Nov 12, 23:30, 2024)