TreeManagementMessage.h

Go to the documentation of this file.

// This file is part of the Peano project. For conditions of distribution and
// use, please see the copyright notice at www.peano-framework.org
#pragma once
 
#include <string>
 
#ifdef Parallel
  #include <mpi.h>
  #include <functional>
#endif
 
#include "tarch/la/Vector.h"
#include "tarch/mpi/Rank.h"
#include "tarch/services/ServiceRepository.h"
#include "peano4/grid/LoadStoreComputeFlag.h"
#include "peano4/utils/Globals.h"
#include "peano4/grid/TraversalObserver.h"
 
 
  
namespace peano4{
namespace parallel{
  struct TreeManagementMessage;
}
}
 
struct peano4::parallel::TreeManagementMessage {
  public:
    enum class Action: int {
      RequestNewRemoteTree=0, CreateNewRemoteTree=1, RemoveChildTreeFromBooksAsChildBecameEmpty=2, JoinWithWorker=3, Acknowledgement=4    
    };
 
    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;
 
 
    #ifdef Parallel
    [[clang::map_mpi_datatype]]
    static MPI_Datatype  getForkDatatype();
 
    [[clang::map_mpi_datatype]]
    static MPI_Datatype  getJoinDatatype();
 
    [[clang::map_mpi_datatype]]
    static MPI_Datatype  getBoundaryExchangeDatatype();
 
    [[clang::map_mpi_datatype]]
    static MPI_Datatype  getMultiscaleDataExchangeDatatype();
 
    [[clang::map_mpi_datatype]]
    static MPI_Datatype  getGlobalCommunciationDatatype();
 
    [[clang::map_mpi_datatype]]
    static void  freeForkDatatype();
 
    [[clang::map_mpi_datatype]]
    static void  freeJoinDatatype();
 
    [[clang::map_mpi_datatype]]
    static void  freeBoundaryExchangeDatatype();
 
    [[clang::map_mpi_datatype]]
    static void  freeMultiscaleDataExchangeDatatype();
 
    [[clang::map_mpi_datatype]]
    static void  freeGlobalCommunciationDatatype();
 
    int getSenderRank() const;
 
    static void initDatatype();
 
    static void shutdownDatatype();
 
    static void send(const peano4::parallel::TreeManagementMessage& buffer, int destination, int tag, MPI_Comm communicator );
    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 );
    static void receive(   peano4::parallel::TreeManagementMessage& buffer, int source,      int tag, std::function<void()> startCommunicationFunctor, std::function<void()> waitFunctor, MPI_Comm communicator );
    #endif
 
 
    enum ObjectConstruction {
      NoData
    };
 
    TreeManagementMessage( ObjectConstruction ):
    TreeManagementMessage() {}
 
#ifdef Parallel
    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() );
#endif
 
    std::string toString() const;
 
  private:
    [[clang::pack_range(-1,std::numeric_limits<int>::max())]]  int   _masterSpacetreeId;
    [[clang::pack_range(0,std::numeric_limits<int>::max())]]  int   _workerSpacetreeId;
    [[clang::pack]]  Action   _action;
 
    #ifdef Parallel
    private:
      int _senderDestinationRank;
 
      #if !defined(__MPI_ATTRIBUTES_LANGUAGE_EXTENSION__)
      static MPI_Datatype  Datatype;
      #endif
    #endif
};