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
int	fixedsize (int dim, int codim) const
	returns true if size of data per entity of given dim and codim is a constant More...
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

fixedsize()

int Dune::CommDataHandleIF< GFSNeighborDataHandle< GFS, RankIndex > , RankIndex >::fixedsize ( int  dim, int  codim  ) const

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()

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

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()

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

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()

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

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