dune-grid  2.1.1
Classes | Public Types | Public Member Functions
Dune::GeoGrid::CommDataHandle< Grid, WrappedHandle > Class Template Reference

#include <dune/grid/geometrygrid/datahandle.hh>

Inheritance diagram for Dune::GeoGrid::CommDataHandle< Grid, WrappedHandle >:
Inheritance graph

List of all members.

Classes

class  EntityProxy

Public Types

typedef WrappedHandle::DataType DataType
 data type of data to communicate

Public Member Functions

 CommDataHandle (const Grid &grid, WrappedHandle &handle)
bool contains (int dim, int codim) const
 returns true if data for given valid codim should be communicated
bool fixedsize (int dim, int codim) const
 returns true if size of data per entity of given dim and codim is a constant
template<class HostEntity >
size_t size (const HostEntity &hostEntity) const
template<class MessageBuffer , class HostEntity >
void gather (MessageBuffer &buffer, const HostEntity &hostEntity) const
template<class MessageBuffer , class HostEntity >
void scatter (MessageBuffer &buffer, const HostEntity &hostEntity, size_t size)
size_t size (const EntityType &e) const
 how many objects of type DataType have to be sent for a given entity
void gather (MessageBufferImp &buff, const EntityType &e) const
 pack data from user to message buffer
void scatter (MessageBufferImp &buff, const EntityType &e, size_t n)

template<class Grid, class WrappedHandle>
class Dune::GeoGrid::CommDataHandle< Grid, WrappedHandle >


Member Typedef Documentation

typedef WrappedHandle::DataType Dune::CommDataHandleIF< CommDataHandle< Grid, WrappedHandle > , WrappedHandle::DataType >::DataType [inherited]

data type of data to communicate


Constructor & Destructor Documentation

template<class Grid , class WrappedHandle >
Dune::GeoGrid::CommDataHandle< Grid, WrappedHandle >::CommDataHandle ( const Grid grid,
WrappedHandle &  handle 
) [inline]

Member Function Documentation

template<class Grid , class WrappedHandle >
bool Dune::GeoGrid::CommDataHandle< Grid, WrappedHandle >::contains ( int  dim,
int  codim 
) const [inline]

returns true if data for given valid codim should be communicated

Parameters:
dimvalid dimension (i.e. the grids dimension)
codimvalid codimension of the entity set for which data should be communicated

Reimplemented from Dune::CommDataHandleIF< CommDataHandle< Grid, WrappedHandle >, WrappedHandle::DataType >.

template<class Grid , class WrappedHandle >
bool Dune::GeoGrid::CommDataHandle< Grid, WrappedHandle >::fixedsize ( int  dim,
int  codim 
) const [inline]

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

Parameters:
dimvalid dimension (i.e. the grids dimension)
codimvalid codimension of the entity set for which data should be communicated

Reimplemented from Dune::CommDataHandleIF< CommDataHandle< Grid, WrappedHandle >, WrappedHandle::DataType >.

template<class Grid , class WrappedHandle >
template<class MessageBuffer , class HostEntity >
void Dune::GeoGrid::CommDataHandle< Grid, WrappedHandle >::gather ( MessageBuffer &  buffer,
const HostEntity &  hostEntity 
) const [inline]
void Dune::CommDataHandleIF< CommDataHandle< Grid, WrappedHandle > , WrappedHandle::DataType >::gather ( MessageBufferImp &  buff,
const EntityType &  e 
) const [inline, inherited]

pack data from user to message buffer

Parameters:
buffmessage buffer provided by the grid
eentity for which date should be packed to buffer
template<class Grid , class WrappedHandle >
template<class MessageBuffer , class HostEntity >
void Dune::GeoGrid::CommDataHandle< Grid, WrappedHandle >::scatter ( MessageBuffer &  buffer,
const HostEntity &  hostEntity,
size_t  size 
) [inline]
void Dune::CommDataHandleIF< CommDataHandle< Grid, WrappedHandle > , WrappedHandle::DataType >::scatter ( MessageBufferImp &  buff,
const EntityType &  e,
size_t  n 
) [inline, inherited]

unpack data from message buffer to user n is the number of objects sent by the sender

Parameters:
buffmessage buffer provided by the grid
eentity for which date should be unpacked from buffer
nnumber of data written to buffer for this entity before
template<class Grid , class WrappedHandle >
template<class HostEntity >
size_t Dune::GeoGrid::CommDataHandle< Grid, WrappedHandle >::size ( const HostEntity &  hostEntity) const [inline]
size_t Dune::CommDataHandleIF< CommDataHandle< Grid, WrappedHandle > , WrappedHandle::DataType >::size ( const EntityType &  e) const [inline, inherited]

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 dertermined

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