syscconnectf Interface Reference
Last update: 17.07.2025Provide an interface to connect to System Coupling. More...
Public Member Functions | |
| type(syscerrorf) function | syscconnectf (scHost, scPort, participantName, buildInformation) |
| Provide a function to establish connection to System Coupling. More... | |
| type(syscerrorf) function | syscconnectparallelf (scHost, scPort, participantName, communicator, buildInformation) |
| Provide a function to establish connection to System Coupling and pass a custom MPI communicator. More... | |
Detailed Description
Provide an interface to connect to System Coupling.
Definition at line 83 of file syscSystemCouplingF.fi.
Constructor & Destructor Documentation
◆ syscconnectf()
| type(syscerrorf) function syscconnectf | ( | character(*), intent(in) | scHost, |
| integer(kind=4), intent(in) | scPort, | ||
| character(*), intent(in) | participantName, | ||
| character(*), intent(in), optional | buildInformation | ||
| ) |
Provide a function to establish connection to System Coupling.
A participant must have obtained the host and port information from System Coupling prior to calling this function (e.g. via an input argument when participant application was started).
If using a support MPI distribution, this function should be called on all ranks that belong to the MPI_COMM_WORLD communicator.
- Parameters
-
[in] scHost Name of the host on which System Coupling is running. [in] scPort Port number on which System Coupling is listening for participant connections. [in] participantName Name of this participant (e.g. "MAPDL-1"). [in] buildInformation Information about the build of this participant solver.
- Returns
- a
SyscErrorFtype that can be checked for any errors.
Definition at line 109 of file syscSystemCouplingF.fi.
Member Function/Subroutine Documentation
◆ syscconnectparallelf()
| type(syscerrorf) function syscconnectparallelf | ( | character(*), intent(in) | scHost, |
| integer(kind=4), intent(in) | scPort, | ||
| character(*), intent(in) | participantName, | ||
| integer(kind=4), intent(in) | communicator, | ||
| character(*), intent(in), optional | buildInformation | ||
| ) |
Provide a function to establish connection to System Coupling and pass a custom MPI communicator.
A participant must have obtained the host and port information from System Coupling prior to calling this function (e.g. via an input argument when participant application was started).
- Parameters
-
[in] scHost Name of the host on which System Coupling is running. [in] scPort Port number on which System Coupling is listening for participant connections. [in] participantName Name of this participant (e.g. "MAPDL-1"). [in] communicator MPI communicator on which all API calls are made. [in] buildInformation Information about the build of this participant solver.
- Returns
- a
SyscErrorFtype that can be checked for any errors.
Definition at line 151 of file syscSystemCouplingF.fi.
