Skip to main content

System Coupling Fortran library 2023 R2

syscCouplingInterfaceF

Last update: 17.07.2025
1module fortran
2!
3! Copyright 2023 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! *********************************************************************
33! *********************************************************************
35 character(len=SyscStrLen) :: name
37!
38!**********************************************************************
39!
42!
43!**********************************************************************
48!**********************************************************************
49function syscgetcouplinginterfacef(name) result(ret)
50!
52 character(len=*), intent(in) :: name
53 type(sysccouplinginterfacef) :: ret
54!
55!DIR$ IF DEFINED(_WIN32)
56!DIR$ ATTRIBUTES DLLIMPORT :: syscGetCouplingInterfaceF
57!DIR$ ENDIF
58!
60!
61!**********************************************************************
62!
63end interface syscgetcouplinginterfacef
64!
67!
68!**********************************************************************
87!**********************************************************************
88!
89function syscaddsideoneregionf(interface, region) result (ret)
90!
92 import :: syscregionf
93 import :: syscerrorf
94 type(sysccouplinginterfacef), intent(in) :: interface
95 type(syscregionf), intent(in) :: region
96 type(syscerrorf) :: ret
97!
98!DIR$ IF DEFINED(_WIN32)
99!DIR$ ATTRIBUTES DLLIMPORT :: syscAddSideOneRegionF
100!DIR$ ENDIF
101!
102end function syscaddsideoneregionf
103!
104end interface syscaddsideoneregionf
105!
106!**********************************************************************
107!
110!
111!**********************************************************************
130!**********************************************************************
131!
132function syscaddsidetworegionf(interface, region) result (ret)
133!
134 import :: sysccouplinginterfacef
135 import :: syscregionf
136 import :: syscerrorf
137 type(sysccouplinginterfacef), intent(in) :: interface
138 type(syscregionf), intent(in) :: region
139 type(syscerrorf) :: ret
140!
141!DIR$ IF DEFINED(_WIN32)
142!DIR$ ATTRIBUTES DLLIMPORT :: syscAddSideTwoRegionF
143!DIR$ ENDIF
144!
145end function syscaddsidetworegionf
146!
147end interface syscaddsidetworegionf
148!
149!**********************************************************************
150!
153!
154!**********************************************************************
156!**********************************************************************
157!
158function syscadddatatransferf(couplingInterface, dataTransfer)&
159 result(ret)
160!
161 import :: sysccouplinginterfacef
162 import :: syscdatatransferf
163 import :: syscerrorf
164 type(sysccouplinginterfacef), intent(in) :: couplinginterface
165 type(syscdatatransferf), intent(in) :: datatransfer
166 type(syscerrorf) :: ret
167!
168!DIR$ IF DEFINED(_WIN32)
169!DIR$ ATTRIBUTES DLLIMPORT :: syscAddDataTransferF
170!DIR$ ENDIF
171!
172end function syscadddatatransferf
173!
174end interface syscadddatatransferf
175!
176!**********************************************************************
177!
180!
181!**********************************************************************
183!**********************************************************************
184!
186 couplingInterface) result (ret)
187!
188 import :: sysccouplinginterfacef
189 type(sysccouplinginterfacef), intent(in) :: couplinginterface
190 integer(kind=8) :: ret
191!
192!DIR$ IF DEFINED(_WIN32)
193!DIR$ ATTRIBUTES DLLIMPORT :: syscCouplingInterfaceGetNumDataTransfersF
194!DIR$ ENDIF
195!
197!
199!
200!**********************************************************************
201!
204!
205!**********************************************************************
207!**********************************************************************
208!
210 couplingInterface) result (ret)
211!
212 import :: sysccouplinginterfacef
213 type(sysccouplinginterfacef), intent(in) :: couplinginterface
214 integer(kind=8) :: ret
215!
216!DIR$ IF DEFINED(_WIN32)
217!DIR$ ATTRIBUTES DLLIMPORT :: syscCouplingInterfaceGetNumSideOneRegionsF
218!DIR$ ENDIF
219!
221!
223!
224!**********************************************************************
225!
228!
229!**********************************************************************
231!**********************************************************************
232!
234 couplingInterface) result (ret)
235!
236 import :: sysccouplinginterfacef
237 type(sysccouplinginterfacef), intent(in) :: couplinginterface
238 integer(kind=8) :: ret
239!
240!DIR$ IF DEFINED(_WIN32)
241!DIR$ ATTRIBUTES DLLIMPORT :: syscCouplingInterfaceGetNumSideTwoRegionsF
242!DIR$ ENDIF
243!
245!
247!
248!**********************************************************************
249!
252!
254!
255!**********************************************************************
257!**********************************************************************
258!
260 couplingInterface, index) result (ret)
261!
263 type(sysccouplinginterfacef), intent(in) :: couplinginterface
264 integer(kind=8), intent(in) :: index
265 type(syscdatatransferf) :: ret
266!
267!DIR$ IF DEFINED(_WIN32)
268!DIR$ ATTRIBUTES DLLIMPORT :: syscCouplingInterfaceGetDataTransferF
269!DIR$ ENDIF
270!
272!
274!
275!**********************************************************************
276!
279!
281!
282!**********************************************************************
284!**********************************************************************
285!
287 couplingInterface, index) result (ret)
288!
290 type(sysccouplinginterfacef), intent(in) :: couplinginterface
291 integer(kind=8), intent(in) :: index
292 type(syscregionf) :: ret
293!
294!DIR$ IF DEFINED(_WIN32)
295!DIR$ ATTRIBUTES DLLIMPORT :: syscCouplingInterfaceGetSideOneRegionF
296!DIR$ ENDIF
297!
299!
301!
302!**********************************************************************
303!
306!
308!
309!**********************************************************************
311!**********************************************************************
312!
314 couplingInterface, index) result (ret)
315!
317 type(sysccouplinginterfacef), intent(in) :: couplinginterface
318 integer(kind=8), intent(in) :: index
319 type(syscregionf) :: ret
320!
321!DIR$ IF DEFINED(_WIN32)
322!DIR$ ATTRIBUTES DLLIMPORT :: syscCouplingInterfaceGetSideTwoRegionF
323!DIR$ ENDIF
324!
326!
328!
329end module fortran
Provide an interface to add data transfer.
Provide an interface to add side one region.
Provide an interface to add side two region.
Provide an interface to get a data transfer from a coupling interface.
Provide an interface to get number of data transfers.
Provide an interface to get number of side one regions.
Provide an interface to get number of side two regions.
Provide an interface to get side one region from a coupling interface.
Provide an interface to get side two region from a coupling interface.
Provide an interface to get a coupling interface.
Provide a struct for a coupling interface.
Provide a struct for a data transfer.
Provide an error type returned by the Fortran interface calls.
Provide a struct for a System Coupling region.
Definition: syscRegionF.fi:29

Connect with Ansys