dune-grid 2.9.0
Public Types | Public Member Functions | List of all members
Dune::GeoGrid::CommDataHandle< Grid, WrappedHandle > Class Template Reference

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

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

Public Types

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

Public Member Functions

 CommDataHandle (const Grid &grid, WrappedHandle &handle)
 
bool contains (int dim, int codim) const
 
bool fixedSize (int dim, int codim) const
 
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_)
 
int fixedsize (int dim, int codim) const
 returns true if size of data per entity of given dim and codim is a constant More...
 
bool overloaded_deprecated_fixedsize (int dim, int codim) const
 
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...
 

Member Typedef Documentation

◆ DataType

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

data type of data to communicate

Constructor & Destructor Documentation

◆ CommDataHandle()

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

Member Function Documentation

◆ contains()

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

◆ fixedsize()

int Dune::CommDataHandleIF< CommDataHandle< Grid, WrappedHandle > , WrappedHandle::DataType >::fixedsize ( int  dim,
int  codim 
) const
inlineinherited

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

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!

◆ fixedSize()

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

◆ gather() [1/2]

template<class Grid , class WrappedHandle >
template<class MessageBuffer , class HostEntity >
void Dune::GeoGrid::CommDataHandle< Grid, WrappedHandle >::gather ( MessageBuffer &  buffer,
const HostEntity &  hostEntity 
) const
inline

◆ gather() [2/2]

void Dune::CommDataHandleIF< CommDataHandle< Grid, WrappedHandle > , WrappedHandle::DataType >::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

◆ overloaded_deprecated_fixedsize()

bool Dune::CommDataHandleIF< CommDataHandle< Grid, WrappedHandle > , WrappedHandle::DataType >::overloaded_deprecated_fixedsize ( int  dim,
int  codim 
) const
inlineinherited

◆ scatter() [1/2]

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

◆ scatter() [2/2]

void Dune::CommDataHandleIF< CommDataHandle< Grid, WrappedHandle > , WrappedHandle::DataType >::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() [1/2]

size_t Dune::CommDataHandleIF< CommDataHandle< Grid, WrappedHandle > , WrappedHandle::DataType >::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

◆ size() [2/2]

template<class Grid , class WrappedHandle >
template<class HostEntity >
size_t Dune::GeoGrid::CommDataHandle< Grid, WrappedHandle >::size ( const HostEntity &  hostEntity) const
inline

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