Skip to main content

System Coupling Fortran library 2025 R1

syscVariableF

Last update: 17.07.2025
1 module fortran
2 !
3 ! Copyright ANSYS, Inc.
4 ! Unauthorized use, distribution, or duplication is prohibited.
5 !
6 ! Provide free-form Fortran interface for
7 ! System Coupling Participant Library.
8 !
9 ! *********************************************************************
22 ! *********************************************************************
25  character(len=SyscStrLen) :: variablename
27  integer(kind=4) :: quantitytype
29  integer(kind=4) :: location
31  character(len=SyscStrLen) :: displayname
33  integer(kind=4) :: tensortype
35  logical :: isextensive
37  integer(kind=4) :: datatype
38 end type syscvariablef
39 !
40 !**********************************************************************
42 !**********************************************************************
43 !
45 !
46 !**********************************************************************
63 !**********************************************************************
64 function syscgetvariablef(variableName) result(ret)
65 !
66  import :: syscvariablef
67  character(len=*), intent(in) :: variablename
68  type(syscvariablef) :: ret
69 !
70 !DIR$ IF DEFINED(_WIN32) .and. ( .not. DEFINED(SYSTEM_COUPLING_PARTICIPANT_PROXY))
71 !DIR$ ATTRIBUTES DLLIMPORT :: syscGetVariableF
72 !DIR$ ENDIF
73 !
74 end function syscgetvariablef
75 !
76 !**********************************************************************
94 !**********************************************************************
95 function syscgetvariablef_te(&
96  variableName, tensorType, isExtensive,&
97  location) result(ret)
98 !
99  import :: syscvariablef
100  character(len=*), intent(in) :: variablename
101  integer(kind=4), intent(in) :: tensortype
102  logical, intent(in) :: isextensive
103  integer(kind=4), intent(in) :: location
104  type(syscvariablef) :: ret
105 !
106 !DIR$ IF DEFINED(_WIN32) .and. ( .not. DEFINED(SYSTEM_COUPLING_PARTICIPANT_PROXY))
107 !DIR$ ATTRIBUTES DLLIMPORT :: syscGetVariableF_TE
108 !DIR$ ENDIF
109 !
110 end function syscgetvariablef_te
111 !
112 !**********************************************************************
143 !**********************************************************************
144 function syscgetvariablef_q(&
145  variableName, displayName, location, quantityType) result(ret)
146 !
147  import :: syscvariablef
148  character(len=*), intent(in) :: variablename
149  character(len=*), intent(in) :: displayname
150  integer(kind=4), intent(in) :: location
151  integer(kind=4), intent(in) :: quantitytype
152  type(syscvariablef) :: ret
153 !
154 !DIR$ IF DEFINED(_WIN32) .and. ( .not. DEFINED(SYSTEM_COUPLING_PARTICIPANT_PROXY))
155 !DIR$ ATTRIBUTES DLLIMPORT :: syscGetVariableF_Q
156 !DIR$ ENDIF
157 !
158 end function syscgetvariablef_q
159 !
160 !**********************************************************************
179 !**********************************************************************
180 function syscgetvariablef_teq(&
181  variableName, displayName, tensorType, isExtensive,&
182  location, quantityType) result(ret)
183 !
184  import :: syscvariablef
185  character(len=*), intent(in) :: variablename
186  character(len=*), intent(in) :: displayname
187  integer(kind=4), intent(in) :: tensortype
188  logical, intent(in) :: isextensive
189  integer(kind=4), intent(in) :: location
190  integer(kind=4), intent(in) :: quantitytype
191  type(syscvariablef) :: ret
192 !
193 !DIR$ IF DEFINED(_WIN32) .and. ( .not. DEFINED(SYSTEM_COUPLING_PARTICIPANT_PROXY))
194 !DIR$ ATTRIBUTES DLLIMPORT :: syscGetVariableF_TEQ
195 !DIR$ ENDIF
196 !
197 end function syscgetvariablef_teq
198 !
199 !**********************************************************************
221 function syscgetvariablef_dtelqd(&
222  variableName, displayName, tensorType, isExtensive,&
223  location, quantityType, dataType) result(ret)
224 !
225 import :: syscvariablef
226 character(len=*), intent(in) :: variablename
227 character(len=*), intent(in) :: displayname
228 integer(kind=4), intent(in) :: tensortype
229 logical, intent(in) :: isextensive
230 integer(kind=4), intent(in) :: location
231 integer(kind=4), intent(in) :: quantitytype
232 integer(kind=4), intent(in) :: datatype
233 type(syscvariablef) :: ret
234 !
235 !DIR$ IF DEFINED(_WIN32) .and. ( .not. DEFINED(SYSTEM_COUPLING_PARTICIPANT_PROXY))
236 !DIR$ ATTRIBUTES DLLIMPORT :: syscGetVariableF_DTELQD
237 !DIR$ ENDIF
238 !
239 end function syscgetvariablef_dtelqd
240 !
241 !**********************************************************************
242 !
243 end interface syscgetvariablef
244 !
245 !**********************************************************************
248 !
249 function syscvariableaddrealattributef(variable, attribute) result(ret)
250 !
252 type(SyscVariableF) :: variable
253 type(SyscRealAttributeF) :: attribute
254 type(SyscErrorF) :: ret
255 !
256 !DIR$ IF DEFINED(_WIN32) .and. ( .not. DEFINED(SYSTEM_COUPLING_PARTICIPANT_PROXY))
257 !DIR$ ATTRIBUTES DLLIMPORT :: syscVariableAddRealAttributeF
258 !DIR$ ENDIF
259 !
261 !
262 !**********************************************************************
263 !
264 end interface syscvariableaddrealattributef
265 !
266 !**********************************************************************
269 !
270 function syscvariableaddintegerattributef(variable, attribute) &
271  result(ret)
272 !
274 type(SyscVariableF) :: variable
275 type(SyscIntegerAttributeF) :: attribute
276 type(SyscErrorF) :: ret
277 !
278 !DIR$ IF DEFINED(_WIN32) .and. ( .not. DEFINED(SYSTEM_COUPLING_PARTICIPANT_PROXY))
279 !DIR$ ATTRIBUTES DLLIMPORT :: syscVariableAddIntegerAttributeF
280 !DIR$ ENDIF
281 !
283 !
284 !**********************************************************************
285 !
287 !
288 !**********************************************************************
291 !
292 function syscvariablegetnumrealattributesf(variable) result(ret)
293 !
294 import :: syscvariablef
295 type(SyscVariableF) :: variable
296 integer(kind=8) :: ret
297 !
298 !DIR$ IF DEFINED(_WIN32) .and. ( .not. DEFINED(SYSTEM_COUPLING_PARTICIPANT_PROXY))
299 !DIR$ ATTRIBUTES DLLIMPORT :: syscVariableGetNumRealAttributesF
300 !DIR$ ENDIF
301 !
303 !
305 !
306 !**********************************************************************
309 !
310 function syscvariablegetnumintegerattributesf(variable) result(ret)
311 !
312 import :: syscvariablef
313 type(SyscVariableF) :: variable
314 integer(kind=8) :: ret
315 !
316 !DIR$ IF DEFINED(_WIN32) .and. ( .not. DEFINED(SYSTEM_COUPLING_PARTICIPANT_PROXY))
317 !DIR$ ATTRIBUTES DLLIMPORT :: syscVariableGetNumIntegerAttributesF
318 !DIR$ ENDIF
319 !
321 !
323 !
324 !**********************************************************************
327 !
328 function syscvariablegetrealattributef(variable, index) result(ret)
329 !
331 type(SyscVariableF) :: variable
332 integer(kind=8) :: index
333 type(SyscRealAttributeF) :: ret
334 !
335 !DIR$ IF DEFINED(_WIN32) .and. ( .not. DEFINED(SYSTEM_COUPLING_PARTICIPANT_PROXY))
336 !DIR$ ATTRIBUTES DLLIMPORT :: syscVariableGetRealAttributeF
337 !DIR$ ENDIF
338 !
340 !
341 end interface syscvariablegetrealattributef
342 !
343 !**********************************************************************
346 !
347 function syscvariablegetintegerattributef(variable, index) result(ret)
348 !
350 type(SyscVariableF) :: variable
351 integer(kind=8) :: index
352 type(SyscIntegerAttributeF) :: ret
353 !
354 !DIR$ IF DEFINED(_WIN32) .and. ( .not. DEFINED(SYSTEM_COUPLING_PARTICIPANT_PROXY))
355 !DIR$ ATTRIBUTES DLLIMPORT :: syscVariableGetIntegerAttributeF
356 !DIR$ ENDIF
357 !
359 !
361 !
362 end module fortran
Provide an interface to get a System Coupling variable.
Provide an interface to add integer attribute to a variable.
Provide an interface to add real attribute to a variable.
Provide an interface to get integer attribute from variable.
Provide an interface to get number of real attributes.
Provide an interface to get number of real attributes.
Provide an interface to get real attribute from variable.
Provide an error type returned by the Fortran interface calls.
Provide a struct for an integer-valued attribute.
Provide a struct for a real-valued attribute.
Provide a struct for a System Coupling variable.

Connect with Ansys