## On this page

  

 

 # syscRegionF

 Last update: 17.07.2025 

<a name="l00001"></a> 1 module fortran

<a name="l00002"></a> 2 !

<a name="l00003"></a> 3 ! Copyright ANSYS, Inc. 

<a name="l00004"></a> 4 ! Unauthorized use, distribution, or duplication is prohibited.

<a name="l00005"></a> 5 !

<a name="l00006"></a> 6 ! Provide free-form Fortran interface for

<a name="l00007"></a> 7 ! System Coupling Participant Library.

<a name="l00008"></a> 8 !

<a name="l00009"></a> 9 ! \*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*

<a name="l00029"></a>[ 29](structfortran_1_1syscregionf.xhtml) type :: [syscregionf](structfortran_1_1syscregionf.xhtml)

<a name="l00031"></a>[ 31](structfortran_1_1syscregionf.xhtml#a2366d44a0a98ffcc655dbc9ab4e04784) character(len=SyscStrLen) :: regionname

<a name="l00033"></a>[ 33](structfortran_1_1syscregionf.xhtml#a9740fa1f40245a8491bc24b4c0a6d873) integer(kind=4) :: topology

<a name="l00035"></a>[ 35](structfortran_1_1syscregionf.xhtml#ad2df2db7ce133791a65566cc9201dd5a) integer(kind=4) :: regiondiscretizationtype

<a name="l00037"></a>[ 37](structfortran_1_1syscregionf.xhtml#a9278aae61ed92d3128608932a9d9f464) character(len=SyscStrLen) :: displayname

<a name="l00038"></a> 38 end type [syscregionf](structfortran_1_1syscregionf.xhtml)

<a name="l00039"></a> 39 !

<a name="l00040"></a> 40 !\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*

<a name="l00042"></a> 42 !\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*

<a name="l00043"></a> 43 !

<a name="l00044"></a>[ 44](interfacefortran_1_1syscgetregionf.xhtml) interface [syscgetregionf](interfacefortran_1_1syscgetregionf.xhtml)

<a name="l00045"></a> 45 !

<a name="l00046"></a> 46 !\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*

<a name="l00057"></a> 57 !\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*

<a name="l00058"></a>[ 58](interfacefortran_1_1syscgetregionf.xhtml#a54b1b07b43df89ae124a82bf7b2984b0) function [syscgetregionf](interfacefortran_1_1syscgetregionf.xhtml)(regionName) result(ret)

<a name="l00059"></a> 59 !

<a name="l00060"></a> 60 import :: [syscregionf](structfortran_1_1syscregionf.xhtml)

<a name="l00061"></a> 61 character(len=\*), intent(in) :: regionname

<a name="l00062"></a> 62 type([syscregionf](structfortran_1_1syscregionf.xhtml)) :: ret

<a name="l00063"></a> 63 !

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

<a name="l00065"></a> 65 !DIR$ ATTRIBUTES DLLIMPORT :: syscGetRegionF

<a name="l00066"></a> 66 !DIR$ ENDIF

<a name="l00067"></a> 67 !

<a name="l00068"></a> 68 end function [syscgetregionf](interfacefortran_1_1syscgetregionf.xhtml)

<a name="l00069"></a> 69 !

<a name="l00070"></a> 70 !\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*

<a name="l00081"></a> 81 !\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*

<a name="l00082"></a>[ 82](interfacefortran_1_1syscgetregionf.xhtml#a6ddf1e36616695a0bb954425a1b30896) function syscgetregionf_t(regionName, topology) result(ret)

<a name="l00083"></a> 83 !

<a name="l00084"></a> 84 import :: [syscregionf](structfortran_1_1syscregionf.xhtml)

<a name="l00085"></a> 85 character(len=\*), intent(in) :: regionname

<a name="l00086"></a> 86 integer(kind=4), intent(in) :: topology

<a name="l00087"></a> 87 type([syscregionf](structfortran_1_1syscregionf.xhtml)) :: ret

<a name="l00088"></a> 88 !

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

<a name="l00090"></a> 90 !DIR$ ATTRIBUTES DLLIMPORT :: syscGetRegionF\_T

<a name="l00091"></a> 91 !DIR$ ENDIF

<a name="l00092"></a> 92 !

<a name="l00093"></a> 93 end function syscgetregionf_t

<a name="l00094"></a> 94 !

<a name="l00095"></a> 95 !\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*

<a name="l00107"></a> 107 !\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*

<a name="l00108"></a>[ 108](interfacefortran_1_1syscgetregionf.xhtml#a5195a09454601955d703e0359b40731a) function syscgetregionf_dt(regionName, displayName, &amp;

<a name="l00109"></a> 109 topology) result(ret)

<a name="l00110"></a> 110 !

<a name="l00111"></a> 111 import :: [syscregionf](structfortran_1_1syscregionf.xhtml)

<a name="l00112"></a> 112 character(len=\*), intent(in) :: regionname

<a name="l00113"></a> 113 character(len=\*), intent(in) :: displayname

<a name="l00114"></a> 114 integer(kind=4), intent(in) :: topology

<a name="l00115"></a> 115 type([syscregionf](structfortran_1_1syscregionf.xhtml)) :: ret

<a name="l00116"></a> 116 !

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

<a name="l00118"></a> 118 !DIR$ ATTRIBUTES DLLIMPORT :: syscGetRegionF\_DT

<a name="l00119"></a> 119 !DIR$ ENDIF

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

<a name="l00121"></a> 121 end function syscgetregionf_dt

<a name="l00122"></a> 122 !

<a name="l00123"></a> 123 !\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*

<a name="l00134"></a> 134 !\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*

<a name="l00135"></a>[ 135](interfacefortran_1_1syscgetregionf.xhtml#a314e7f693be1c5c4d7833bfd467de815) function syscgetregionf_tm(regionName, topology, &amp;

<a name="l00136"></a> 136 discretization) result(ret)

<a name="l00137"></a> 137 !

<a name="l00138"></a> 138 import :: [syscregionf](structfortran_1_1syscregionf.xhtml)

<a name="l00139"></a> 139 character(len=\*), intent(in) :: regionname

<a name="l00140"></a> 140 integer(kind=4), intent(in) :: topology

<a name="l00141"></a> 141 integer(kind=4), intent(in) :: discretization

<a name="l00142"></a> 142 type([syscregionf](structfortran_1_1syscregionf.xhtml)) :: ret

<a name="l00143"></a> 143 !

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

<a name="l00145"></a> 145 !DIR$ ATTRIBUTES DLLIMPORT :: syscGetRegionF\_TM

<a name="l00146"></a> 146 !DIR$ ENDIF

<a name="l00147"></a> 147 !

<a name="l00148"></a> 148 end function syscgetregionf_tm

<a name="l00149"></a> 149 !

<a name="l00150"></a> 150 !\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*

<a name="l00151"></a> 151 !

<a name="l00152"></a> 152 end interface [syscgetregionf](interfacefortran_1_1syscgetregionf.xhtml)

<a name="l00153"></a> 153 !

<a name="l00154"></a> 154 !\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*

<a name="l00157"></a> 157 !\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*

<a name="l00158"></a> 158 !

<a name="l00159"></a>[ 159](interfacefortran_1_1syscgetnuminputvariablesf.xhtml) interface [syscgetnuminputvariablesf](interfacefortran_1_1syscgetnuminputvariablesf.xhtml)

<a name="l00160"></a> 160 !

<a name="l00167"></a>[ 167](interfacefortran_1_1syscgetnuminputvariablesf.xhtml#acef7ef4c7fb9317cb07b765e41131484) function [syscgetnuminputvariablesf](interfacefortran_1_1syscgetnuminputvariablesf.xhtml)(region) result (ret)

<a name="l00168"></a> 168 import :: [syscregionf](structfortran_1_1syscregionf.xhtml)

<a name="l00169"></a> 169 type([syscregionf](structfortran_1_1syscregionf.xhtml)), intent(in) :: region

<a name="l00170"></a> 170 integer(kind=8) :: ret

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

<a name="l00172"></a> 172 !DIR$ ATTRIBUTES DLLIMPORT :: syscGetNumInputVariablesF

<a name="l00173"></a> 173 !DIR$ ENDIF

<a name="l00174"></a> 174 end function [syscgetnuminputvariablesf](interfacefortran_1_1syscgetnuminputvariablesf.xhtml)

<a name="l00175"></a> 175 !

<a name="l00176"></a> 176 end interface [syscgetnuminputvariablesf](interfacefortran_1_1syscgetnuminputvariablesf.xhtml)

<a name="l00177"></a> 177 !

<a name="l00178"></a> 178 !\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*

<a name="l00180"></a> 180 !\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*

<a name="l00181"></a> 181 !

<a name="l00182"></a>[ 182](interfacefortran_1_1syscgetinputvariablef.xhtml) interface [syscgetinputvariablef](interfacefortran_1_1syscgetinputvariablef.xhtml)

<a name="l00183"></a> 183 !

<a name="l00192"></a>[ 192](interfacefortran_1_1syscgetinputvariablef.xhtml#a7346cda68038880dbd5f690e5a7f5054) function [syscgetinputvariablef](interfacefortran_1_1syscgetinputvariablef.xhtml)(region, index) result (ret)

<a name="l00193"></a> 193 import :: [syscregionf](structfortran_1_1syscregionf.xhtml), [syscvariablef](structfortran_1_1syscvariablef.xhtml)

<a name="l00194"></a> 194 type([syscregionf](structfortran_1_1syscregionf.xhtml)), intent(in) :: region

<a name="l00195"></a> 195 integer(kind=8) :: index

<a name="l00196"></a> 196 type([syscvariablef](structfortran_1_1syscvariablef.xhtml)) :: ret

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

<a name="l00198"></a> 198 !DIR$ ATTRIBUTES DLLIMPORT :: syscGetInputVariableF

<a name="l00199"></a> 199 !DIR$ ENDIF

<a name="l00200"></a> 200 end function [syscgetinputvariablef](interfacefortran_1_1syscgetinputvariablef.xhtml)

<a name="l00201"></a> 201 !

<a name="l00202"></a> 202 end interface [syscgetinputvariablef](interfacefortran_1_1syscgetinputvariablef.xhtml)

<a name="l00203"></a> 203 !

<a name="l00204"></a> 204 !\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*

<a name="l00207"></a> 207 !\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*

<a name="l00208"></a> 208 !

<a name="l00209"></a>[ 209](interfacefortran_1_1syscgetnumoutputvariablesf.xhtml) interface [syscgetnumoutputvariablesf](interfacefortran_1_1syscgetnumoutputvariablesf.xhtml)

<a name="l00210"></a> 210 !

<a name="l00217"></a>[ 217](interfacefortran_1_1syscgetnumoutputvariablesf.xhtml#a3c431d54510478e7ae11c546a470d69a) function [syscgetnumoutputvariablesf](interfacefortran_1_1syscgetnumoutputvariablesf.xhtml)(region) result (ret)

<a name="l00218"></a> 218 import :: [syscregionf](structfortran_1_1syscregionf.xhtml)

<a name="l00219"></a> 219 type([syscregionf](structfortran_1_1syscregionf.xhtml)), intent(in) :: region

<a name="l00220"></a> 220 integer(kind=8) :: ret

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

<a name="l00222"></a> 222 !DIR$ ATTRIBUTES DLLIMPORT :: syscGetNumOutputVariablesF

<a name="l00223"></a> 223 !DIR$ ENDIF

<a name="l00224"></a> 224 end function [syscgetnumoutputvariablesf](interfacefortran_1_1syscgetnumoutputvariablesf.xhtml)

<a name="l00225"></a> 225 !

<a name="l00226"></a> 226 end interface [syscgetnumoutputvariablesf](interfacefortran_1_1syscgetnumoutputvariablesf.xhtml)

<a name="l00227"></a> 227 !

<a name="l00228"></a> 228 !\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*

<a name="l00230"></a> 230 !\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*

<a name="l00231"></a> 231 !

<a name="l00232"></a>[ 232](interfacefortran_1_1syscgetoutputvariablef.xhtml) interface [syscgetoutputvariablef](interfacefortran_1_1syscgetoutputvariablef.xhtml)

<a name="l00233"></a> 233 !

<a name="l00242"></a>[ 242](interfacefortran_1_1syscgetoutputvariablef.xhtml#a470e9f0eb67dd6b6c733fa76a0f44f3b) function [syscgetoutputvariablef](interfacefortran_1_1syscgetoutputvariablef.xhtml)(region, index) result (ret)

<a name="l00243"></a> 243 import :: [syscregionf](structfortran_1_1syscregionf.xhtml), [syscvariablef](structfortran_1_1syscvariablef.xhtml)

<a name="l00244"></a> 244 type([syscregionf](structfortran_1_1syscregionf.xhtml)), intent(in) :: region

<a name="l00245"></a> 245 integer(kind=8) :: index

<a name="l00246"></a> 246 type([syscvariablef](structfortran_1_1syscvariablef.xhtml)) :: ret

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

<a name="l00248"></a> 248 !DIR$ ATTRIBUTES DLLIMPORT :: syscGetOutputVariableF

<a name="l00249"></a> 249 !DIR$ ENDIF

<a name="l00250"></a> 250 end function [syscgetoutputvariablef](interfacefortran_1_1syscgetoutputvariablef.xhtml)

<a name="l00251"></a> 251 !

<a name="l00252"></a> 252 end interface [syscgetoutputvariablef](interfacefortran_1_1syscgetoutputvariablef.xhtml)

<a name="l00253"></a> 253 !

<a name="l00254"></a> 254 end module fortran

[fortran::syscgetinputvariablef](interfacefortran_1_1syscgetinputvariablef.xhtml)

Provide an interface to return an input variable.

**Definition:** [syscRegionF.fi:182](syscRegionF_8fi_source.xhtml#l00182)



[fortran::syscgetnuminputvariablesf](interfacefortran_1_1syscgetnuminputvariablesf.xhtml)

Provide an interface to return the number of input variables.

**Definition:** [syscRegionF.fi:159](syscRegionF_8fi_source.xhtml#l00159)



[fortran::syscgetnumoutputvariablesf](interfacefortran_1_1syscgetnumoutputvariablesf.xhtml)

Provide an interface to return the number of output variables.

**Definition:** [syscRegionF.fi:209](syscRegionF_8fi_source.xhtml#l00209)



[fortran::syscgetoutputvariablef](interfacefortran_1_1syscgetoutputvariablef.xhtml)

Provide an interface to return an output variable.

**Definition:** [syscRegionF.fi:232](syscRegionF_8fi_source.xhtml#l00232)



[fortran::syscgetregionf](interfacefortran_1_1syscgetregionf.xhtml)

Provide an interface to get a System Coupling region.

**Definition:** [syscRegionF.fi:44](syscRegionF_8fi_source.xhtml#l00044)



[fortran::syscregionf](structfortran_1_1syscregionf.xhtml)

Provide a struct for a System Coupling region.

**Definition:** [syscRegionF.fi:29](syscRegionF_8fi_source.xhtml#l00029)



[fortran::syscvariablef](structfortran_1_1syscvariablef.xhtml)

Provide a struct for a System Coupling variable.

**Definition:** [syscVariableF.fi:23](syscVariableF_8fi_source.xhtml#l00023)