DistributedCommunication.hpp

Go to the documentation of this file.

#pragma once
 
#include <map>
#include <vector>
#include "mesh/Mesh.hpp"
#include "mesh/SharedPointer.hpp"
#include "precice/span.hpp"
 
namespace precice::m2n {

class DistributedCommunication {
public:
  using SharedPointer = std::shared_ptr<DistributedCommunication>;
 
  explicit DistributedCommunication(mesh::PtrMesh mesh)
      : _mesh(mesh)
  {
  }

  virtual ~DistributedCommunication() = default;

  virtual bool isConnected() const = 0;

  virtual void acceptConnection(
      const std::string &acceptorName,
      const std::string &requesterName) = 0;

  virtual void requestConnection(
      const std::string &acceptorName,
      const std::string &requesterName) = 0;

  virtual void acceptPreConnection(
      std::string const &acceptorName,
      std::string const &requesterName) = 0;

  virtual void requestPreConnection(
      std::string const &acceptorName,
      std::string const &requesterName) = 0;
 
  /* @brief Completes the secondary connections for both acceptor and requester by updating
   * the vertex list in _mappings.
   *
   * @pre acceptPreConnection or requestPreConnection has been called.
   * @pre accept/requestConnection has not been called
   * @post the m2n connection is ready to use
   */
  virtual void completeSecondaryRanksConnection() = 0;

  virtual void closeConnection() = 0;

  virtual void send(precice::span<double const> itemsToSend, int valueDimension) = 0;

  virtual void receive(precice::span<double> itemsToReceive, int valueDimension) = 0;
 
  /*
   * A mapping from remote local ranks to the IDs that must be communicated
   */
  using CommunicationMap = std::map<int, std::vector<int>>;

  virtual void broadcastSend(int itemToSend) = 0;

  virtual void broadcastReceiveAll(std::vector<int> &itemToReceive) = 0;

  virtual void broadcastSendMesh() = 0;

  virtual void broadcastReceiveAllMesh() = 0;

  virtual void scatterAllCommunicationMap(CommunicationMap &localCommunicationMap) = 0;

  virtual void gatherAllCommunicationMap(CommunicationMap &localCommunicationMap) = 0;
 
protected:
  mesh::PtrMesh _mesh;
};
 
} // namespace precice::m2n