Peano

Searching...

No Matches

#include <TreeManagementMessage.h>

Public Types
enum class	Action : int { RequestNewRemoteTree =0 , CreateNewRemoteTree =1 , RemoveChildTreeFromBooksAsChildBecameEmpty =2 , JoinWithWorker =3 , Acknowledgement =4 }

enum	ObjectConstruction { NoData }

Public Member Functions
	TreeManagementMessage ()

	TreeManagementMessage (int __masterSpacetreeId, int __workerSpacetreeId, Action __action)

int	getMasterSpacetreeId () const

void	setMasterSpacetreeId (int value)

int	getWorkerSpacetreeId () const

void	setWorkerSpacetreeId (int value)

peano4::parallel::TreeManagementMessage::Action	getAction () const

void	setAction (Action value)

	TreeManagementMessage (const TreeManagementMessage &copy)=default

int	getSenderRank () const

	TreeManagementMessage (ObjectConstruction)

std::string	toString () const

Static Public Member Functions
static MPI_Datatype	getForkDatatype ()
	Hands out MPI datatype if we work without the LLVM MPI extension.

static MPI_Datatype	getJoinDatatype ()

static MPI_Datatype	getBoundaryExchangeDatatype ()

static MPI_Datatype	getMultiscaleDataExchangeDatatype ()

static MPI_Datatype	getGlobalCommunciationDatatype ()

static void	freeForkDatatype ()

static void	freeJoinDatatype ()

static void	freeBoundaryExchangeDatatype ()

static void	freeMultiscaleDataExchangeDatatype ()

static void	freeGlobalCommunciationDatatype ()

static void	initDatatype ()
	Wrapper around getDatatype() to trigger lazy evaluation if we use the lazy initialisation.

static void	shutdownDatatype ()
	Free the underlying MPI datatype.

static void	send (const peano4::parallel::TreeManagementMessage &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 (peano4::parallel::TreeManagementMessage &buffer, int source, int tag, MPI_Comm communicator)

static void	send (const peano4::parallel::TreeManagementMessage &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 (peano4::parallel::TreeManagementMessage &buffer, int source, int tag, std::function< void()> startCommunicationFunctor, std::function< void()> waitFunctor, MPI_Comm communicator)

static void	sendAndPollDanglingMessages (const peano4::parallel::TreeManagementMessage &message, int destination, int tag, MPI_Comm communicator=tarch::mpi::Rank::getInstance().getCommunicator())

static void	receiveAndPollDanglingMessages (peano4::parallel::TreeManagementMessage &message, int source, int tag, MPI_Comm communicator=tarch::mpi::Rank::getInstance().getCommunicator())

Private Attributes
int	_masterSpacetreeId

int	_workerSpacetreeId

Action	_action

int	_senderDestinationRank

Static Private Attributes
static MPI_Datatype	Datatype = MPI_DATATYPE_NULL
	Whenever we use LLVM's MPI extension (DaStGe), we rely on lazy initialisation of the datatype.

Detailed Description

Definition at line 27 of file TreeManagementMessage.h.

Member Enumeration Documentation

◆ Action

enum class peano4::parallel::TreeManagementMessage::Action : int

strong

Enumerator
RequestNewRemoteTree
CreateNewRemoteTree
RemoveChildTreeFromBooksAsChildBecameEmpty
JoinWithWorker
Acknowledgement

Definition at line 29 of file TreeManagementMessage.h.

◆ ObjectConstruction

enum peano4::parallel::TreeManagementMessage::ObjectConstruction

Enumerator
NoData

Definition at line 120 of file TreeManagementMessage.h.

Constructor & Destructor Documentation

◆ TreeManagementMessage() [1/4]

peano4::parallel::TreeManagementMessage::TreeManagementMessage ( )

Definition at line 33 of file TreeManagementMessage.h.

◆ TreeManagementMessage() [2/4]

peano4::parallel::TreeManagementMessage::TreeManagementMessage	(	int	__masterSpacetreeId,
		int	__workerSpacetreeId,
		Action	__action )

Definition at line 10 of file TreeManagementMessage.cpp.

References setAction(), setMasterSpacetreeId(), and setWorkerSpacetreeId().

Here is the call graph for this function:

◆ TreeManagementMessage() [3/4]

peano4::parallel::TreeManagementMessage::TreeManagementMessage ( const TreeManagementMessage & copy )

default

◆ TreeManagementMessage() [4/4]

peano4::parallel::TreeManagementMessage::TreeManagementMessage ( ObjectConstruction )

Definition at line 124 of file TreeManagementMessage.h.

Member Function Documentation

◆ freeBoundaryExchangeDatatype()

void peano4::parallel::TreeManagementMessage::freeBoundaryExchangeDatatype ( )

static

Definition at line 133 of file TreeManagementMessage.cpp.

◆ freeForkDatatype()

void peano4::parallel::TreeManagementMessage::freeForkDatatype ( )

static

Definition at line 106 of file TreeManagementMessage.cpp.

◆ freeGlobalCommunciationDatatype()

void peano4::parallel::TreeManagementMessage::freeGlobalCommunciationDatatype ( )

static

Definition at line 115 of file TreeManagementMessage.cpp.

◆ freeJoinDatatype()

void peano4::parallel::TreeManagementMessage::freeJoinDatatype ( )

static

Definition at line 124 of file TreeManagementMessage.cpp.

◆ freeMultiscaleDataExchangeDatatype()

void peano4::parallel::TreeManagementMessage::freeMultiscaleDataExchangeDatatype ( )

static

Definition at line 142 of file TreeManagementMessage.cpp.

◆ getAction()

peano4::parallel::TreeManagementMessage::Action peano4::parallel::TreeManagementMessage::getAction ( ) const

Definition at line 54 of file TreeManagementMessage.cpp.

Referenced by peano4::parallel::SpacetreeSet::addSpacetree(), peano4::parallel::SpacetreeSet::cleanUpTrees(), peano4::parallel::SpacetreeSet::split(), and peano4::parallel::tests::PingPongTest::testDaStGenArrayTreeManagementMessage().

Here is the caller graph for this function:

◆ getBoundaryExchangeDatatype()

MPI_Datatype peano4::parallel::TreeManagementMessage::getBoundaryExchangeDatatype ( )

static

Definition at line 94 of file TreeManagementMessage.cpp.

◆ getForkDatatype()

MPI_Datatype peano4::parallel::TreeManagementMessage::getForkDatatype ( )

static

Hands out MPI datatype if we work without the LLVM MPI extension.

If we work with this additional feature, this is the routine where the lazy initialisation is done and the datatype is also cached.

Definition at line 76 of file TreeManagementMessage.cpp.

◆ getGlobalCommunciationDatatype()

MPI_Datatype peano4::parallel::TreeManagementMessage::getGlobalCommunciationDatatype ( )

static

Definition at line 82 of file TreeManagementMessage.cpp.

◆ getJoinDatatype()

MPI_Datatype peano4::parallel::TreeManagementMessage::getJoinDatatype ( )

static

Definition at line 88 of file TreeManagementMessage.cpp.

◆ getMasterSpacetreeId()

int peano4::parallel::TreeManagementMessage::getMasterSpacetreeId ( ) const

Definition at line 34 of file TreeManagementMessage.cpp.

◆ getMultiscaleDataExchangeDatatype()

MPI_Datatype peano4::parallel::TreeManagementMessage::getMultiscaleDataExchangeDatatype ( )

static

Definition at line 100 of file TreeManagementMessage.cpp.

◆ getSenderRank()

int peano4::parallel::TreeManagementMessage::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.

Definition at line 150 of file TreeManagementMessage.cpp.

◆ getWorkerSpacetreeId()

int peano4::parallel::TreeManagementMessage::getWorkerSpacetreeId ( ) const

Definition at line 44 of file TreeManagementMessage.cpp.

Referenced by peano4::parallel::SpacetreeSet::split().

Here is the caller graph for this function:

◆ initDatatype()

void peano4::parallel::TreeManagementMessage::initDatatype ( )

static

Wrapper around getDatatype() to trigger lazy evaluation if we use the lazy initialisation.

Definition at line 155 of file TreeManagementMessage.cpp.

Referenced by peano4::parallel::Node::initMPIDatatypes().

Here is the caller graph for this function:

◆ receive() [1/2]

void peano4::parallel::TreeManagementMessage::receive	(	peano4::parallel::TreeManagementMessage &	buffer,
		int	source,
		int	tag,
		MPI_Comm	communicator )

static

Definition at line 240 of file TreeManagementMessage.cpp.

References _senderDestinationRank.

Referenced by peano4::parallel::SpacetreeSet::addSpacetree(), peano4::parallel::SpacetreeSet::cleanUpTrees(), receiveAndPollDanglingMessages(), peano4::parallel::SpacetreeSet::receiveDanglingMessages(), and peano4::parallel::tests::PingPongTest::testDaStGenArrayTreeManagementMessage().

Here is the caller graph for this function:

◆ receive() [2/2]

void peano4::parallel::TreeManagementMessage::receive	(	peano4::parallel::TreeManagementMessage &	buffer,
		int	source,
		int	tag,
		std::function< void()>	startCommunicationFunctor,
		std::function< void()>	waitFunctor,
		MPI_Comm	communicator )

static

Definition at line 267 of file TreeManagementMessage.cpp.

References _senderDestinationRank.

◆ receiveAndPollDanglingMessages()

void peano4::parallel::TreeManagementMessage::receiveAndPollDanglingMessages	(	peano4::parallel::TreeManagementMessage &	message,
		int	source,
		int	tag,
		MPI_Comm	communicator = tarch::mpi::Rank::getInstance().getCommunicator() )

static

Definition at line 307 of file TreeManagementMessage.cpp.

References tarch::mpi::Rank::getInstance(), tarch::services::ServiceRepository::getInstance(), receive(), tarch::services::ServiceRepository::receiveDanglingMessages(), tarch::mpi::Rank::setDeadlockTimeOutTimeStamp(), tarch::mpi::Rank::setDeadlockWarningTimeStamp(), tarch::mpi::Rank::triggerDeadlockTimeOut(), and tarch::mpi::Rank::writeTimeOutWarning().

Referenced by peano4::parallel::SpacetreeSet::split().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ send() [1/2]

void peano4::parallel::TreeManagementMessage::send	(	const peano4::parallel::TreeManagementMessage &	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.

Definition at line 235 of file TreeManagementMessage.cpp.

Referenced by peano4::parallel::SpacetreeSet::answerQuestions(), peano4::parallel::SpacetreeSet::cleanUpTrees(), sendAndPollDanglingMessages(), and peano4::parallel::tests::PingPongTest::testDaStGenArrayTreeManagementMessage().

Here is the caller graph for this function:

◆ send() [2/2]

void peano4::parallel::TreeManagementMessage::send	(	const peano4::parallel::TreeManagementMessage &	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.

Definition at line 247 of file TreeManagementMessage.cpp.

◆ sendAndPollDanglingMessages()

void peano4::parallel::TreeManagementMessage::sendAndPollDanglingMessages	(	const peano4::parallel::TreeManagementMessage &	message,
		int	destination,
		int	tag,
		MPI_Comm	communicator = tarch::mpi::Rank::getInstance().getCommunicator() )

static

Definition at line 290 of file TreeManagementMessage.cpp.

References tarch::mpi::Rank::getInstance(), tarch::services::ServiceRepository::getInstance(), tarch::services::ServiceRepository::receiveDanglingMessages(), send(), tarch::mpi::Rank::setDeadlockTimeOutTimeStamp(), tarch::mpi::Rank::setDeadlockWarningTimeStamp(), tarch::mpi::Rank::triggerDeadlockTimeOut(), and tarch::mpi::Rank::writeTimeOutWarning().

Referenced by peano4::parallel::SpacetreeSet::addSpacetree(), and peano4::parallel::SpacetreeSet::split().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setAction()

void peano4::parallel::TreeManagementMessage::setAction ( Action value )

Definition at line 59 of file TreeManagementMessage.cpp.

Referenced by peano4::parallel::SpacetreeSet::addSpacetree(), peano4::parallel::SpacetreeSet::answerQuestions(), peano4::parallel::SpacetreeSet::split(), peano4::parallel::tests::PingPongTest::testDaStGenArrayTreeManagementMessage(), and TreeManagementMessage().

Here is the caller graph for this function:

◆ setMasterSpacetreeId()

void peano4::parallel::TreeManagementMessage::setMasterSpacetreeId ( int value )

Definition at line 39 of file TreeManagementMessage.cpp.

Referenced by peano4::parallel::SpacetreeSet::addSpacetree(), peano4::parallel::SpacetreeSet::split(), and TreeManagementMessage().

Here is the caller graph for this function:

◆ setWorkerSpacetreeId()

void peano4::parallel::TreeManagementMessage::setWorkerSpacetreeId ( int value )

Definition at line 49 of file TreeManagementMessage.cpp.

Referenced by peano4::parallel::SpacetreeSet::addSpacetree(), peano4::parallel::SpacetreeSet::answerQuestions(), peano4::parallel::SpacetreeSet::split(), and TreeManagementMessage().

Here is the caller graph for this function:

◆ shutdownDatatype()

void peano4::parallel::TreeManagementMessage::shutdownDatatype ( )

static

Free the underlying MPI datatype.

Definition at line 221 of file TreeManagementMessage.cpp.

Referenced by peano4::parallel::Node::shutdownMPIDatatypes().

Here is the caller graph for this function:

◆ toString()

std::string peano4::parallel::TreeManagementMessage::toString ( ) const

Definition at line 18 of file TreeManagementMessage.cpp.

Referenced by peano4::parallel::SpacetreeSet::addSpacetree(), peano4::parallel::SpacetreeSet::cleanUpTrees(), peano4::parallel::SpacetreeSet::receiveDanglingMessages(), peano4::parallel::SpacetreeSet::split(), and peano4::parallel::tests::PingPongTest::testDaStGenArrayTreeManagementMessage().

Here is the caller graph for this function:

Field Documentation

◆ _action

Action peano4::parallel::TreeManagementMessage::_action

private

Definition at line 137 of file TreeManagementMessage.h.

◆ _masterSpacetreeId

int peano4::parallel::TreeManagementMessage::_masterSpacetreeId

private

Definition at line 135 of file TreeManagementMessage.h.

◆ _senderDestinationRank

int peano4::parallel::TreeManagementMessage::_senderDestinationRank

private

Definition at line 141 of file TreeManagementMessage.h.

Referenced by receive(), and receive().

◆ _workerSpacetreeId

int peano4::parallel::TreeManagementMessage::_workerSpacetreeId

private

Definition at line 136 of file TreeManagementMessage.h.

◆ Datatype

MPI_Datatype peano4::parallel::TreeManagementMessage::Datatype = MPI_DATATYPE_NULL

staticprivate

Whenever we use LLVM's MPI extension (DaStGe), we rely on lazy initialisation of the datatype.

However, Peano calls init explicitly in most cases. Without the LLVM extension which caches the MPI datatype once constructed, this field stores the type.

Definition at line 150 of file TreeManagementMessage.h.

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

src/peano4/parallel/TreeManagementMessage.h
src/peano4/parallel/TreeManagementMessage.cpp

Public Types

Public Member Functions

Static Public Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Enumeration Documentation

◆ Action

◆ ObjectConstruction

Constructor & Destructor Documentation

◆ TreeManagementMessage() [1/4]

◆ TreeManagementMessage() [2/4]

◆ TreeManagementMessage() [3/4]

◆ TreeManagementMessage() [4/4]

Member Function Documentation

◆ freeBoundaryExchangeDatatype()

◆ freeForkDatatype()

◆ freeGlobalCommunciationDatatype()

◆ freeJoinDatatype()

◆ freeMultiscaleDataExchangeDatatype()

◆ getAction()

◆ getBoundaryExchangeDatatype()

◆ getForkDatatype()

◆ getGlobalCommunciationDatatype()

◆ getJoinDatatype()

◆ getMasterSpacetreeId()

◆ getMultiscaleDataExchangeDatatype()

◆ getSenderRank()

◆ getWorkerSpacetreeId()

◆ initDatatype()

◆ receive() [1/2]

◆ receive() [2/2]

◆ receiveAndPollDanglingMessages()

◆ send() [1/2]

◆ send() [2/2]

◆ sendAndPollDanglingMessages()

◆ setAction()

◆ setMasterSpacetreeId()

◆ setWorkerSpacetreeId()

◆ shutdownDatatype()

◆ toString()

Field Documentation

◆ _action

◆ _masterSpacetreeId

◆ _senderDestinationRank

◆ _workerSpacetreeId

◆ Datatype