preCICE v3.1.2
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Private Member Functions | Private Attributes | List of all members
precice::m2n::BoundM2N Class Reference

An M2N between participants with a configured direction. More...

#include <BoundM2N.hpp>

Collaboration diagram for precice::m2n::BoundM2N:
[legend]

Public Member Functions

void prepareEstablishment ()
 Prepare to establish the connection.
 
void connectPrimaryRanks ()
 Connect the Primary Ranks of the M2N.
 
void connectSecondaryRanks ()
 Connect the Secondary ranks of the M2N.
 
void preConnectSecondaryRanks ()
 pre-connect the Secondary ranks of the M2N
 
void cleanupEstablishment ()
 Cleanup after having established the connection.
 

Public Attributes

PtrM2N m2n
 
std::string localName
 
std::string remoteName
 
bool isRequesting = false
 

Private Member Functions

void waitForSecondaryRanks ()
 

Private Attributes

logging::Logger _log {"impl::ParticipantImpl"}
 

Detailed Description

An M2N between participants with a configured direction.

Definition at line 11 of file BoundM2N.hpp.

Member Function Documentation

◆ cleanupEstablishment()

void precice::m2n::BoundM2N::cleanupEstablishment ( )

Cleanup after having established the connection.

Definition at line 70 of file BoundM2N.cpp.

Here is the call graph for this function:

◆ connectPrimaryRanks()

void precice::m2n::BoundM2N::connectPrimaryRanks ( )

Connect the Primary Ranks of the M2N.

Definition at line 23 of file BoundM2N.cpp.

◆ connectSecondaryRanks()

void precice::m2n::BoundM2N::connectSecondaryRanks ( )

Connect the Secondary ranks of the M2N.

Definition at line 34 of file BoundM2N.cpp.

◆ preConnectSecondaryRanks()

void precice::m2n::BoundM2N::preConnectSecondaryRanks ( )

pre-connect the Secondary ranks of the M2N

Definition at line 52 of file BoundM2N.cpp.

◆ prepareEstablishment()

void precice::m2n::BoundM2N::prepareEstablishment ( )

Prepare to establish the connection.

Definition at line 14 of file BoundM2N.cpp.

◆ waitForSecondaryRanks()

void precice::m2n::BoundM2N::waitForSecondaryRanks ( )
private

Instructs the Primary rank wait for SecondaryRanks.

Performs a collective operation which forces every secondary rank to sync with the Primary.

Note
this does nothing if the participant is running serially.

Definition at line 81 of file BoundM2N.cpp.

Here is the call graph for this function:

Member Data Documentation

◆ _log

logging::Logger precice::m2n::BoundM2N::_log {"impl::ParticipantImpl"}
mutableprivate

Definition at line 34 of file BoundM2N.hpp.

◆ isRequesting

bool precice::m2n::BoundM2N::isRequesting = false

Definition at line 31 of file BoundM2N.hpp.

◆ localName

std::string precice::m2n::BoundM2N::localName

Definition at line 29 of file BoundM2N.hpp.

◆ m2n

PtrM2N precice::m2n::BoundM2N::m2n

Definition at line 28 of file BoundM2N.hpp.

◆ remoteName

std::string precice::m2n::BoundM2N::remoteName

Definition at line 30 of file BoundM2N.hpp.


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