## On this page

  

 

 # syscconnectf Interface Reference

 Last update: 17.07.2025 

Provide an interface to connect to System Coupling. [More...](interfacefortran_1_1syscconnectf.xhtml#details)

## <a name="pub-methods"></a>Public Member Functions

type([syscerrorf](structfortran_1_1syscerrorf.xhtml)) function [syscconnectf](interfacefortran_1_1syscconnectf.xhtml#af397378cdff4f98ef3c736cdda2dc2a0) (scHost, scPort, participantName, buildInformation) Provide a function to establish connection to System Coupling. [More...](interfacefortran_1_1syscconnectf.xhtml#af397378cdff4f98ef3c736cdda2dc2a0)  
 type([syscerrorf](structfortran_1_1syscerrorf.xhtml)) function [syscconnectparallelf](interfacefortran_1_1syscconnectf.xhtml#a15b29cc1bce67f869dea1b183de9c569) (scHost, scPort, participantName, communicator, buildInformation) Provide a function to establish connection to System Coupling and pass a custom MPI communicator. [More...](interfacefortran_1_1syscconnectf.xhtml#a15b29cc1bce67f869dea1b183de9c569)  
 <a id="details" name="details"></a>## Detailed Description

Provide an interface to connect to System Coupling.

Definition at line [83](syscSystemCouplingF_8fi_source.xhtml#l00083) of file [syscSystemCouplingF.fi](syscSystemCouplingF_8fi_source.xhtml).



## Constructor &amp; Destructor Documentation

<a id="af397378cdff4f98ef3c736cdda2dc2a0"></a>## [◆ ](#af397378cdff4f98ef3c736cdda2dc2a0)syscconnectf()

 type([syscerrorf](structfortran_1_1syscerrorf.xhtml)) function [syscconnectf](interfacefortran_1_1syscconnectf.xhtml)  ( 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\]scHostName of the host on which System Coupling is running.\[in\]scPortPort number on which System Coupling is listening for participant connections.\[in\]participantNameName of this participant (e.g. "MAPDL-1").\[in\]buildInformationInformation about the build of this participant solver.Returnsa `SyscErrorF` type that can be checked for any errors. Definition at line [109](syscSystemCouplingF_8fi_source.xhtml#l00109) of file [syscSystemCouplingF.fi](syscSystemCouplingF_8fi_source.xhtml).

<a name="l00113"></a> 113 !

<a name="l00114"></a> 114 import :: syscerrorf

<a name="l00115"></a> 115 integer(kind=4), intent(in) :: scPort

<a name="l00116"></a> 116 character(\*), intent(in) :: scHost

<a name="l00117"></a> 117 character(\*), intent(in) :: participantName

<a name="l00118"></a> 118 character(\*), optional, intent(in) :: buildInformation

<a name="l00119"></a> 119 type(SyscErrorF) :: ret

<a name="l00120"></a> 120 !

<a name="l00121"></a> 121 !DIR$ IF DEFINED(\_WIN32) .and. ( .not. DEFINED(SYSTEM\_COUPLING\_PARTICIPANT\_PROXY))

<a name="l00122"></a> 122 !DIR$ ATTRIBUTES DLLIMPORT :: syscConnectF

<a name="l00123"></a> 123 !DIR$ ENDIF

<a name="l00124"></a> 124 !







## Member Function/Subroutine Documentation

<a id="a15b29cc1bce67f869dea1b183de9c569"></a>## [◆ ](#a15b29cc1bce67f869dea1b183de9c569)syscconnectparallelf()

 type([syscerrorf](structfortran_1_1syscerrorf.xhtml)) 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\]scHostName of the host on which System Coupling is running.\[in\]scPortPort number on which System Coupling is listening for participant connections.\[in\]participantNameName of this participant (e.g. "MAPDL-1").\[in\]communicatorMPI communicator on which all API calls are made.\[in\]buildInformationInformation about the build of this participant solver.Returnsa `SyscErrorF` type that can be checked for any errors. Definition at line [151](syscSystemCouplingF_8fi_source.xhtml#l00151) of file [syscSystemCouplingF.fi](syscSystemCouplingF_8fi_source.xhtml).

<a name="l00156"></a> 156 !

<a name="l00157"></a> 157 import :: syscerrorf

<a name="l00158"></a> 158 integer(kind=4), intent(in) :: scPort

<a name="l00159"></a> 159 character(\*), intent(in) :: scHost

<a name="l00160"></a> 160 character(\*), intent(in) :: participantName

<a name="l00161"></a> 161 integer(kind=4), intent(in) :: communicator

<a name="l00162"></a> 162 character(\*), optional, intent(in) :: buildInformation

<a name="l00163"></a> 163 type(SyscErrorF) :: ret

<a name="l00164"></a> 164 !

<a name="l00165"></a> 165 !DIR$ IF DEFINED(\_WIN32) .and. ( .not. DEFINED(SYSTEM\_COUPLING\_PARTICIPANT\_PROXY))

<a name="l00166"></a> 166 !DIR$ ATTRIBUTES DLLIMPORT :: syscConnectParallelF

<a name="l00167"></a> 167 !DIR$ ENDIF

<a name="l00168"></a> 168 !