## 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 id="pub-methods" name="pub-methods"></a>Public Member Functions

type([syscerrorf](structfortran_1_1syscerrorf.xhtml)) function [syscconnectf](interfacefortran_1_1syscconnectf.xhtml#a556dda14cfe0b77561b9deff6e0c9cd5) (schost, scport, participantname, buildinformation) Provide a function to establish connection to System Coupling.   
 type([syscerrorf](structfortran_1_1syscerrorf.xhtml)) function [syscconnectparallelf](interfacefortran_1_1syscconnectf.xhtml#a8d918399632b17dc8e13486058566120) (schost, scport, participantname, communicator, buildinformation) Provide a function to establish connection to System Coupling and pass a custom MPI communicator.   
 <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="a556dda14cfe0b77561b9deff6e0c9cd5" name="a556dda14cfe0b77561b9deff6e0c9cd5"></a>## [◆ ](#a556dda14cfe0b77561b9deff6e0c9cd5)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).

 113!

 114 import :: syscerrorf

 115 integer(kind=4), intent(in) :: scPort

 116 character(\*), intent(in) :: scHost

 117 character(\*), intent(in) :: participantName

 118 character(\*), optional, intent(in) :: buildInformation

 119 type(SyscErrorF) :: ret

 120!

 121!DIR$ IF DEFINED(\_WIN32) .and. ( .not. DEFINED(SYSTEM\_COUPLING\_PARTICIPANT\_PROXY))

 122!DIR$ ATTRIBUTES DLLIMPORT :: syscConnectF

 123!DIR$ ENDIF

 124!







## Member Function/Subroutine Documentation

<a id="a8d918399632b17dc8e13486058566120" name="a8d918399632b17dc8e13486058566120"></a>## [◆ ](#a8d918399632b17dc8e13486058566120)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).

 156!

 157 import :: syscerrorf

 158 integer(kind=4), intent(in) :: scPort

 159 character(\*), intent(in) :: scHost

 160 character(\*), intent(in) :: participantName

 161 integer(kind=4), intent(in) :: communicator

 162 character(\*), optional, intent(in) :: buildInformation

 163 type(SyscErrorF) :: ret

 164!

 165!DIR$ IF DEFINED(\_WIN32) .and. ( .not. DEFINED(SYSTEM\_COUPLING\_PARTICIPANT\_PROXY))

 166!DIR$ ATTRIBUTES DLLIMPORT :: syscConnectParallelF

 167!DIR$ ENDIF

 168!