preCICE v3.2.0
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
MPISinglePortsCommunication.hpp
Go to the documentation of this file.
1#pragma once
2#ifndef PRECICE_NO_MPI
3
4#include <map>
5#include <mpi.h>
6#include <set>
7#include <stddef.h>
8#include <string>
9
11#include "logging/Logger.hpp"
13
14namespace precice::com {
36public:
37 explicit MPISinglePortsCommunication(std::string addressDirectory = ".");
38
40
41 size_t getRemoteCommunicatorSize() override;
42
43 void acceptConnection(std::string const &acceptorName,
44 std::string const &requesterName,
45 std::string const &tag,
46 int acceptorRank,
47 int rankOffset = 0) override;
48
49 void acceptConnectionAsServer(std::string const &acceptorName,
50 std::string const &requesterName,
51 std::string const &tag,
52 int acceptorRank,
53 int requesterCommunicatorSize) override;
54
55 void requestConnection(std::string const &acceptorName,
56 std::string const &requesterName,
57 std::string const &tag,
58 int requesterRank,
59 int requesterCommunicatorSize) override;
60
61 void requestConnectionAsClient(std::string const &acceptorName,
62 std::string const &requesterName,
63 std::string const &tag,
64 std::set<int> const &acceptorRanks,
65 int requesterRank) override;
66
67 void prepareEstablishment(std::string const &acceptorName,
68 std::string const &requesterName) override;
69
70 void cleanupEstablishment(std::string const &acceptorName,
71 std::string const &requesterName) override;
72
73 void closeConnection() override;
74
75private:
76 MPI_Comm &communicator(Rank rank) override;
77
78 Rank rank(int rank) override;
79
80 logging::Logger _log{"com::MPISinglePortsCommunication"};
81
83
94
103 MPI_Comm _global = MPI_COMM_NULL;
104
107
109 std::string _portName = std::string(MPI_MAX_PORT_NAME, '\0');
110
111 bool _isAcceptor = false;
112};
113} // namespace precice::com
114
115#endif // not PRECICE_NO_MPI
Provides implementation for basic MPI point-to-point communication.
Provides connection methods based on MPI ports (part of MPI 2.0).
void prepareEstablishment(std::string const &acceptorName, std::string const &requesterName) override
Prepare environment used to establish the communication.
void requestConnection(std::string const &acceptorName, std::string const &requesterName, std::string const &tag, int requesterRank, int requesterCommunicatorSize) override
Connects to another communicator, which has to call acceptConnection().
MPI_Comm _global
The global inter-communicator that connects all ranks.
void requestConnectionAsClient(std::string const &acceptorName, std::string const &requesterName, std::string const &tag, std::set< int > const &acceptorRanks, int requesterRank) override
Connects to another communicator, which has to call acceptConnectionAsServer().
MPI_Comm & communicator(Rank rank) override
Returns the communicator.
std::string _portName
Name of the port used for connection.
size_t getRemoteCommunicatorSize() override
Returns the number of processes in the remote communicator.
int _initialCommSize
The communicator size known from acceptConnection and requestConnection.
void closeConnection() override
Disconnects from communication space, i.e. participant.
void acceptConnectionAsServer(std::string const &acceptorName, std::string const &requesterName, std::string const &tag, int acceptorRank, int requesterCommunicatorSize) override
requesterCommunicatorSize is not used, since connection is always made on the entire communicator
std::map< int, MPI_Comm > _direct
A map of direct communication channels based on MPI_COMM_SELF on both sides.
void acceptConnection(std::string const &acceptorName, std::string const &requesterName, std::string const &tag, int acceptorRank, int rankOffset=0) override
Accepts connection from another communicator, which has to call requestConnection().
void cleanupEstablishment(std::string const &acceptorName, std::string const &requesterName) override
Clean-up environment used to establish the communication.
MPISinglePortsCommunication(std::string addressDirectory=".")
This class provides a lightweight logger.
Definition Logger.hpp:17
contains the data communication abstraction layer.
int Rank
Definition Types.hpp:37