walberla::field::communication::PackInfo< GhostLayerField_T > Class Template Reference

Detailed Description

template<typename GhostLayerField_T>
class walberla::field::communication::PackInfo< GhostLayerField_T >

Data packing/unpacking for ghost layer based communication of a single walberla::field::Field

Template parameters are equivalent of the parameters of GhostLayerField that is communicated.

#include <PackInfo.h>

+ Inheritance diagram for walberla::field::communication::PackInfo< GhostLayerField_T >:

Public Types

typedef GhostLayerField_T::value_type T
 

Public Member Functions

 PackInfo (const BlockDataID &bdId)
 
 PackInfo (const BlockDataID &bdId, const uint_t numberOfGhostLayers)
 
virtual ~PackInfo ()
 
bool constantDataExchange () const
 Should return true if the amount of data that is packed for a given block in direction "dir" is guaranteed to remain constant over time. More...
 
bool threadsafeReceiving () const
 Must return false if calling unpackData and/or communicateLocal is not thread-safe. More...
 
void unpackData (IBlock *receiver, stencil::Direction dir, mpi::RecvBuffer &buffer)
 Unpacks received Data. More...
 
void communicateLocal (const IBlock *sender, IBlock *receiver, stencil::Direction dir)
 Function to copy data from one local block to another local block. More...
 
- Public Member Functions inherited from walberla::communication::UniformPackInfo
void packData (const IBlock *sender, stencil::Direction dir, mpi::SendBuffer &buffer) const
 Packs data from a block into a send buffer. More...
 
virtual void beforeStartCommunication ()
 This function is called once before the communication is started by the UniformBufferedScheme. More...
 
virtual void afterStartCommunication ()
 This function is called once after the communication has been started by the UniformBufferedScheme. More...
 
virtual void beforeWait ()
 This function is called once before the UniformBufferedScheme waits for the communication to finish. More...
 
virtual void afterWait ()
 This function is called once after the communication has been finished by the UniformBufferedScheme. More...
 
 UniformPackInfo ()
 
virtual ~UniformPackInfo ()
 

Protected Member Functions

void packDataImpl (const IBlock *sender, stencil::Direction dir, mpi::SendBuffer &outBuffer) const
 Packs data from a block into a send buffer. More...
 
uint_t numberOfGhostLayersToCommunicate (const GhostLayerField_T *const field) const
 

Protected Attributes

const BlockDataID bdId_
 
bool communicateAllGhostLayers_
 
uint_t numberOfGhostLayers_
 
- Protected Attributes inherited from walberla::communication::UniformPackInfo
std::map< const IBlock *, std::map< stencil::Direction, size_t > > bufferSize_
 

Member Typedef Documentation

template<typename GhostLayerField_T >
typedef GhostLayerField_T::value_type walberla::field::communication::PackInfo< GhostLayerField_T >::T

Constructor & Destructor Documentation

template<typename GhostLayerField_T >
walberla::field::communication::PackInfo< GhostLayerField_T >::PackInfo ( const BlockDataID &  bdId)
inline
template<typename GhostLayerField_T >
walberla::field::communication::PackInfo< GhostLayerField_T >::PackInfo ( const BlockDataID &  bdId,
const uint_t  numberOfGhostLayers 
)
inline
template<typename GhostLayerField_T >
virtual walberla::field::communication::PackInfo< GhostLayerField_T >::~PackInfo ( )
inlinevirtual

Member Function Documentation

template<typename GhostLayerField_T >
void walberla::field::communication::PackInfo< GhostLayerField_T >::communicateLocal ( const IBlock *  sender,
IBlock *  receiver,
stencil::Direction  dir 
)
virtual

Function to copy data from one local block to another local block.

Both blocks are allocated on the current process. If NOT thread-safe, threadsafeReceiving must return false!

Parameters
senderid of block where the data should be copied from
receiverid of block where the data should be copied to
dirthe direction of the communication ( from sender to receiver )

Implements walberla::communication::UniformPackInfo.

template<typename GhostLayerField_T >
bool walberla::field::communication::PackInfo< GhostLayerField_T >::constantDataExchange ( ) const
inlinevirtual

Should return true if the amount of data that is packed for a given block in direction "dir" is guaranteed to remain constant over time.

False otherwise. If you are not sure what to return, return false! Returning false is always save. Falsely return true will lead to errors! However, if the data can be guaranteed to remain constant over time, returning true enables performance optimizations during the communication.

Implements walberla::communication::UniformPackInfo.

template<typename GhostLayerField_T >
uint_t walberla::field::communication::PackInfo< GhostLayerField_T >::numberOfGhostLayersToCommunicate ( const GhostLayerField_T *const  field) const
protected
template<typename GhostLayerField_T >
void walberla::field::communication::PackInfo< GhostLayerField_T >::packDataImpl ( const IBlock *  sender,
stencil::Direction  dir,
mpi::SendBuffer buffer 
) const
protectedvirtual

Packs data from a block into a send buffer.

Must be thread-safe!

Parameters
senderthe block whose data should be packed into a buffer
dirpack data for neighbor in this direction
bufferbuffer for writing the data into

Implements walberla::communication::UniformPackInfo.

template<typename GhostLayerField_T >
bool walberla::field::communication::PackInfo< GhostLayerField_T >::threadsafeReceiving ( ) const
inlinevirtual

Must return false if calling unpackData and/or communicateLocal is not thread-safe.

True otherwise. If you are not sure what to return, return false! Returning false is always save. Falsely return true will most likely lead to errors! However, if both unpackData AND communicateLocal are thread-safe, returning true can lead to performance improvements.

Implements walberla::communication::UniformPackInfo.

template<typename GhostLayerField_T >
void walberla::field::communication::PackInfo< GhostLayerField_T >::unpackData ( IBlock *  receiver,
stencil::Direction  dir,
mpi::RecvBuffer buffer 
)
virtual

Unpacks received Data.

If NOT thread-safe, threadsafeReceiving must return false!

Parameters
receiverthe block where the unpacked data should be stored into
dirreceive data from neighbor in this direction
buffer

Implements walberla::communication::UniformPackInfo.

Member Data Documentation

template<typename GhostLayerField_T >
const BlockDataID walberla::field::communication::PackInfo< GhostLayerField_T >::bdId_
protected
template<typename GhostLayerField_T >
bool walberla::field::communication::PackInfo< GhostLayerField_T >::communicateAllGhostLayers_
protected
template<typename GhostLayerField_T >
uint_t walberla::field::communication::PackInfo< GhostLayerField_T >::numberOfGhostLayers_
protected

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