tarch::mpi::StringMessage Struct Reference

The string message looks like the other messages which I generate through DaStGen 2, but I actually wrote it myself manually to support dynamic string lengths. More...

#include <StringMessage.h>

Collaboration diagram for tarch::mpi::StringMessage:

Public Member Functions
	StringMessage ()
	StringMessage (const std::string &value)
std::string	getData () const
void	setData (const std::string &value)
int	getSenderRank () const
std::string	toString () const

Static Public Member Functions
static void	sendAndPollDanglingMessages (const tarch::mpi::StringMessage &message, int destination, int tag)
static void	receiveAndPollDanglingMessages (tarch::mpi::StringMessage &message, int source, int tag)
static void	send (const tarch::mpi::StringMessage &buffer, int destination, int tag, MPI_Comm communicator)
	In DaStGen (the first version), I had a non-static version of the send as well as the receive.
static void	receive (tarch::mpi::StringMessage &buffer, int source, int tag, MPI_Comm communicator)
static void	send (const tarch::mpi::StringMessage &buffer, int destination, int tag, std::function< void()> startCommunicationFunctor, std::function< void()> waitFunctor, MPI_Comm communicator)
	Alternative to the other send() where I trigger a non-blocking send an then invoke the functor until the corresponding MPI_Test tells me that the message went through.
static void	receive (tarch::mpi::StringMessage &buffer, int source, int tag, std::function< void()> startCommunicationFunctor, std::function< void()> waitFunctor, MPI_Comm communicator)
static bool	isMessageInQueue (int tag, MPI_Comm communicator)
	In older DaStGen version, I tried to find out whether a particular message type is in the MPI queue.

Private Attributes
std::string	_data
int	_senderDestinationRank

Detailed Description

The string message looks like the other messages which I generate through DaStGen 2, but I actually wrote it myself manually to support dynamic string lengths.

Author

Tobias Weinzierl

Definition at line 34 of file StringMessage.h.

Constructor & Destructor Documentation

StringMessage() [1/2]

tarch::mpi::StringMessage::StringMessage

(

)

Definition at line 36 of file StringMessage.h.

StringMessage() [2/2]

tarch::mpi::StringMessage::StringMessage

(

const std::string &

value

)

Member Function Documentation

getData()

std::string tarch::mpi::StringMessage::getData

(

)

const

getSenderRank()

int tarch::mpi::StringMessage::getSenderRank

(

)

const

Returns

The rank of the sender of an object. It only make ssense to call this routine after you've invoked receive with MPI_ANY_SOURCE.

isMessageInQueue()

static bool tarch::mpi::StringMessage::isMessageInQueue ( int tag, MPI_Comm communicator )

static

In older DaStGen version, I tried to find out whether a particular message type is in the MPI queue.

That is, I looked whether a message on this tag does exist, and then I looked whether the memory footprint matches via count. I think this is invalid. MPI really looks only into the number of bytes, so you have to know which type drops in once there is a message on a tag.

receive() [1/2]

static void tarch::mpi::StringMessage::receive ( tarch::mpi::StringMessage & buffer, int source, int tag, MPI_Comm communicator )

static

receive() [2/2]

static void tarch::mpi::StringMessage::receive ( tarch::mpi::StringMessage & buffer, int source, int tag, std::function< void()> startCommunicationFunctor, std::function< void()> waitFunctor, MPI_Comm communicator )

static

receiveAndPollDanglingMessages()

static void tarch::mpi::StringMessage::receiveAndPollDanglingMessages ( tarch::mpi::StringMessage & message, int source, int tag )

static

send() [1/2]

static void tarch::mpi::StringMessage::send ( const tarch::mpi::StringMessage & buffer, int destination, int tag, MPI_Comm communicator )

static

In DaStGen (the first version), I had a non-static version of the send as well as the receive.

However, this did not work with newer C++11 versions, as a member function using this as pointer usually doesn't see the vtable while the init sees the object from outside, i.e. including a vtable. So this routine now is basically an alias for a blocking MPI_Send.

send() [2/2]

static void tarch::mpi::StringMessage::send ( const tarch::mpi::StringMessage & buffer, int destination, int tag, std::function< void()> startCommunicationFunctor, std::function< void()> waitFunctor, MPI_Comm communicator )

static

Alternative to the other send() where I trigger a non-blocking send an then invoke the functor until the corresponding MPI_Test tells me that the message went through.

In systems with heavy MPI usage, this can help to avoid deadlocks.

sendAndPollDanglingMessages()

static void tarch::mpi::StringMessage::sendAndPollDanglingMessages ( const tarch::mpi::StringMessage & message, int destination, int tag )

static

setData()

void tarch::mpi::StringMessage::setData

(

const std::string &

value

)

toString()

std::string tarch::mpi::StringMessage::toString

(

)

const

Field Documentation

_data

std::string tarch::mpi::StringMessage::_data

private

Definition at line 106 of file StringMessage.h.

Referenced by peano4.datamodel.DaStGen2.DaStGen2Generator::construct_output(), peano4.datamodel.DaStGen2.DaStGen2GeneratorForObjectsWithSmartPointers::construct_output(), peano4.toolbox.particles.ParticleSet.ParticleSetGenerator_ScatteredOnHeap_IndexByList::construct_output(), peano4.toolbox.particles.ParticleSet.ParticleSetGenerator_ScatteredOnHeap_IndexByVector::construct_output(), peano4.toolbox.particles.ParticleSet.ParticleSetGenerator_ContinuousPerVertex::construct_output(), peano4.toolbox.particles.ParticleSet.ParticleSetGenerator_GlobalContinuous::construct_output(), peano4.datamodel.DaStGen2.DaStGen2Generator::get_header_file_include(), peano4.datamodel.DaStGen2.DaStGen2GeneratorForObjectsWithSmartPointers::get_header_file_include(), peano4.toolbox.particles.ParticleSet.AbstractParticleSetGenerator::get_header_file_include(), peano4.datamodel.DaStGen2.DaStGen2Generator::get_stack_container(), peano4.datamodel.DaStGen2.DaStGen2GeneratorForObjectsWithSmartPointers::get_stack_container(), peano4.datamodel.DynamicArrayOverPrimitivesToStdVector.DynamicArrayOverPrimitivesToStdVector::get_stack_container(), and peano4.toolbox.particles.ParticleSet.AbstractParticleSetGenerator::get_stack_container().

_senderDestinationRank

int tarch::mpi::StringMessage::_senderDestinationRank

private

Definition at line 108 of file StringMessage.h.

---

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

• src/tarch/mpi/StringMessage.h