Interface fortran::syscconnectf
Definition: syscSystemCouplingF.fi (line 83)
Provide an interface to connect to System Coupling.
Members
Public functions
Function syscconnectf
type(syscerrorf) function syscconnectf(scHost, scPort, participantName, 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:
- scHost: Name of the host on which System Coupling is running.
- scPort: Port number on which System Coupling is listening for participant connections.
- participantName: Name of this participant (e.g. "MAPDL-1").
- buildInformation: Information about the build of this participant solver.
Returns:
a SyscErrorF type that can be checked for any errors.
Parameters:
- scHostscHost
- scPortscPort
- participantNameparticipantName
- buildInformationbuildInformation
Return type: type(syscerrorf) function
Function syscconnectparallelf
type(syscerrorf) function syscconnectparallelf(scHost, scPort, participantName, communicator, 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:
- scHost: Name of the host on which System Coupling is running.
- scPort: Port number on which System Coupling is listening for participant connections.
- participantName: Name of this participant (e.g. "MAPDL-1").
- communicator: MPI communicator on which all API calls are made.
- buildInformation: Information about the build of this participant solver.
Returns:
a SyscErrorF type that can be checked for any errors.
Parameters:
- scHostscHost
- scPortscPort
- participantNameparticipantName
- communicatorcommunicator
- buildInformationbuildInformation
Return type: type(syscerrorf) function