System Coupling C library 2025 R1

syscFunctionTypes

Last update: 17.07.2025
1 /*
2 * Copyright ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited.
3 */
4 
5 #pragma once
6 
7 #include "SystemCouplingParticipant/LibraryType.hpp"
8 
9 #include "SystemCouplingParticipant/syscInputScalarData.h"
10 #include "SystemCouplingParticipant/syscInputVectorData.h"
11 #include "SystemCouplingParticipant/syscOutputIntegerData.h"
12 #include "SystemCouplingParticipant/syscOutputScalarData.h"
13 #include "SystemCouplingParticipant/syscOutputVectorData.h"
14 #include "SystemCouplingParticipant/syscInputComplexScalarData.h"
15 #include "SystemCouplingParticipant/syscInputComplexVectorData.h"
16 #include "SystemCouplingParticipant/syscOutputComplexScalarData.h"
17 #include "SystemCouplingParticipant/syscOutputComplexVectorData.h"
18 #include "SystemCouplingParticipant/syscPointCloud.h"
19 #include "SystemCouplingParticipant/syscSurfaceMesh.h"
20 #include "SystemCouplingParticipant/syscVolumeMesh.h"
21 
22 #include <stddef.h>
23 #include <stdint.h>
24 
25 #ifdef __cplusplus
26 extern "C" {
27 #endif
28 
34 /* ***************** Data access functions prototypes ********************** */
35 
36 /* *** input scalar data *** */
37 
39 typedef SyscInputScalarData (*SyscInputScalarDataAccess)(
40  const char* regionName,
41  const char* variableName);
42 
46 typedef SyscInputScalarData (*SyscInputScalarDataAccessWithPointer)(
47  SyscOpaqueDataAccess opaqueDataAccess,
48  const char* regionName,
49  const char* variableName);
50 
54 typedef SyscInputScalarData (*SyscInputScalarDataMultiZoneAccess)(
55  SyscOpaqueDataAccess opaqueDataAccess,
56  const char* regionName,
57  const char* variableName,
58  uint16_t zoneIndex);
59 
60 /* *** input vector data *** */
61 
63 typedef SyscInputVectorData (*SyscInputVectorDataAccess)(
64  const char* regionName,
65  const char* variableName);
66 
70 typedef SyscInputVectorData (*SyscInputVectorDataAccessWithPointer)(
71  SyscOpaqueDataAccess opaqueDataAccess,
72  const char* regionName,
73  const char* variableName);
74 
78 typedef SyscInputVectorData (*SyscInputVectorDataMultiZoneAccess)(
79  SyscOpaqueDataAccess opaqueDataAccess,
80  const char* regionName,
81  const char* variableName,
82  uint16_t zoneIndex);
83 
84 /* *** output scalar data *** */
85 
87 typedef SyscOutputScalarData (*SyscOutputScalarDataAccess)(
88  const char* regionName,
89  const char* variableName);
90 
94 typedef SyscOutputScalarData (*SyscOutputScalarDataAccessWithPointer)(
95  SyscOpaqueDataAccess opaqueDataAccess,
96  const char* regionName,
97  const char* variableName);
98 
102 typedef SyscOutputScalarData (*SyscOutputScalarDataMultiZoneAccess)(
103  SyscOpaqueDataAccess opaqueDataAccess,
104  const char* regionName,
105  const char* variableName,
106  uint16_t zoneIndex);
107 
108 /* *** output vector data *** */
109 
111 typedef SyscOutputVectorData (*SyscOutputVectorDataAccess)(
112  const char* regionName,
113  const char* variableName);
114 
118 typedef SyscOutputVectorData (*SyscOutputVectorDataAccessWithPointer)(
119  SyscOpaqueDataAccess opaqueDataAccess,
120  const char* regionName,
121  const char* variableName);
122 
126 typedef SyscOutputVectorData (*SyscOutputVectorDataMultiZoneAccess)(
127  SyscOpaqueDataAccess opaqueDataAccess,
128  const char* regionName,
129  const char* variableName,
130  uint16_t zoneIndex);
131 
132 /* *** input complex scalar data *** */
133 
135 typedef SyscInputComplexScalarData (*SyscInputComplexScalarDataAccess)(
136  const char* regionName,
137  const char* variableName);
138 
142 typedef SyscInputComplexScalarData (*SyscInputComplexScalarDataAccessWithPointer)(
143  SyscOpaqueDataAccess opaqueDataAccess,
144  const char* regionName,
145  const char* variableName);
146 
147 /* *** input complex vector data *** */
148 
150 typedef SyscInputComplexVectorData (*SyscInputComplexVectorDataAccess)(
151  const char* regionName,
152  const char* variableName);
153 
157 typedef SyscInputComplexVectorData (*SyscInputComplexVectorDataAccessWithPointer)(
158  SyscOpaqueDataAccess opaqueDataAccess,
159  const char* regionName,
160  const char* variableName);
161 
162 /* *** output complex scalar data *** */
163 
165 typedef SyscOutputComplexScalarData (*SyscOutputComplexScalarDataAccess)(
166  const char* regionName,
167  const char* variableName);
168 
172 typedef SyscOutputComplexScalarData (*SyscOutputComplexScalarDataAccessWithPointer)(
173  SyscOpaqueDataAccess opaqueDataAccess,
174  const char* regionName,
175  const char* variableName);
176 
177 /* *** output complex vector data *** */
178 
180 typedef SyscOutputComplexVectorData (*SyscOutputComplexVectorDataAccess)(
181  const char* regionName,
182  const char* variableName);
183 
187 typedef SyscOutputComplexVectorData (*SyscOutputComplexVectorDataAccessWithPointer)(
188  SyscOpaqueDataAccess opaqueDataAccess,
189  const char* regionName,
190  const char* variableName);
191 
192 /* *** surface mesh *** */
193 
195 typedef SyscSurfaceMesh (*SyscSurfMeshAccess)(
196  const char* regionName);
197 
201 typedef SyscSurfaceMesh (*SyscSurfaceMeshAccessWithPointer)(
202  SyscOpaqueDataAccess opaqueDataAccess,
203  const char* regionName);
204 
206 typedef SyscSurfaceMesh (*SyscSurfaceMeshMultiZoneAccess)(
207  SyscOpaqueDataAccess opaqueDataAccess,
208  const char* regionName,
209  uint16_t zoneIndex);
210 
211 /* *** volume mesh *** */
212 
214 typedef SyscVolumeMesh (*SyscVolumeMeshAccess)(
215  const char* regionName);
216 
220 typedef SyscVolumeMesh (*SyscVolumeMeshAccessWithPointer)(
221  SyscOpaqueDataAccess opaqueDataAccess,
222  const char* regionName);
223 
225 typedef SyscVolumeMesh (*SyscVolumeMeshMultiZoneAccess)(
226  SyscOpaqueDataAccess opaqueDataAccess,
227  const char* regionName,
228  uint16_t zoneIndex);
229 
230 /* *** point cloud *** */
231 
233 typedef SyscPointCloud (*SyscPointCloudAccess)(
234  const char* regionName);
235 
239 typedef SyscPointCloud (*SyscPointCloudAccessWithPointer)(
240  SyscOpaqueDataAccess opaqueDataAccess,
241  const char* regionName);
242 
244 typedef SyscPointCloud (*SyscPointCloudMultiZoneAccess)(
245  SyscOpaqueDataAccess opaqueDataAccess,
246  const char* regionName,
247  uint16_t zoneIndex);
248 
249 /* *** zone count *** */
250 
252 typedef uint16_t (*SyscZoneCountAccess)(
253  SyscOpaqueDataAccess opaqueDataAccess,
254  const char* regionName);
255 
256 /* *** restart points *** */
257 
263 typedef const char* (*SyscRestartPointCreation)();
264 
267 #ifdef __cplusplus
268 }
269 #endif
SyscOutputComplexScalarDataAccess
SyscOutputComplexScalarData(* SyscOutputComplexScalarDataAccess)(const char *regionName, const char *variableName)
Provide function prototype for access to output complex scalar data.
Definition: syscFunctionTypes.h:165
SyscOpaqueDataAccess
void * SyscOpaqueDataAccess
Definition: syscCommonTypes.h:156
SyscOutputComplexVectorDataAccessWithPointer
SyscOutputComplexVectorData(* SyscOutputComplexVectorDataAccessWithPointer)(SyscOpaqueDataAccess opaqueDataAccess, const char *regionName, const char *variableName)
Provide function prototype for access to output complex vector data with opaque pointer.
Definition: syscFunctionTypes.h:187
SyscOutputVectorDataMultiZoneAccess
SyscOutputVectorData(* SyscOutputVectorDataMultiZoneAccess)(SyscOpaqueDataAccess opaqueDataAccess, const char *regionName, const char *variableName, uint16_t zoneIndex)
Provide function prototype for access to multi-zone output vector data.
Definition: syscFunctionTypes.h:126
SyscOutputComplexVectorDataAccess
SyscOutputComplexVectorData(* SyscOutputComplexVectorDataAccess)(const char *regionName, const char *variableName)
Provide function prototype for access to output complex vector data.
Definition: syscFunctionTypes.h:180
SyscInputComplexVectorDataAccessWithPointer
SyscInputComplexVectorData(* SyscInputComplexVectorDataAccessWithPointer)(SyscOpaqueDataAccess opaqueDataAccess, const char *regionName, const char *variableName)
Provide function prototype for access to input complex vector data with opaque pointer.
Definition: syscFunctionTypes.h:157
SyscOutputComplexScalarDataAccessWithPointer
SyscOutputComplexScalarData(* SyscOutputComplexScalarDataAccessWithPointer)(SyscOpaqueDataAccess opaqueDataAccess, const char *regionName, const char *variableName)
Provide function prototype for access to output complex scalar data with opaque pointer.
Definition: syscFunctionTypes.h:172
SyscSurfMeshAccess
SyscSurfaceMesh(* SyscSurfMeshAccess)(const char *regionName)
Provide function prototype for access to surface mesh.
Definition: syscFunctionTypes.h:195
SyscOutputScalarDataMultiZoneAccess
SyscOutputScalarData(* SyscOutputScalarDataMultiZoneAccess)(SyscOpaqueDataAccess opaqueDataAccess, const char *regionName, const char *variableName, uint16_t zoneIndex)
Provide function prototype for access to multi-zone output scalar data.
Definition: syscFunctionTypes.h:102
SyscInputComplexScalarDataAccessWithPointer
SyscInputComplexScalarData(* SyscInputComplexScalarDataAccessWithPointer)(SyscOpaqueDataAccess opaqueDataAccess, const char *regionName, const char *variableName)
Provide function prototype for access to input complex scalar data with opaque pointer.
Definition: syscFunctionTypes.h:142
SyscInputScalarDataMultiZoneAccess
SyscInputScalarData(* SyscInputScalarDataMultiZoneAccess)(SyscOpaqueDataAccess opaqueDataAccess, const char *regionName, const char *variableName, uint16_t zoneIndex)
Provide function prototype for access to multi-zone input scalar data.
Definition: syscFunctionTypes.h:54
SyscInputVectorDataAccess
SyscInputVectorData(* SyscInputVectorDataAccess)(const char *regionName, const char *variableName)
Provide function prototype for access to input vector data.
Definition: syscFunctionTypes.h:63
SyscSurfaceMeshMultiZoneAccess
SyscSurfaceMesh(* SyscSurfaceMeshMultiZoneAccess)(SyscOpaqueDataAccess opaqueDataAccess, const char *regionName, uint16_t zoneIndex)
Provide function prototype for access to multi-zone surface mesh.
Definition: syscFunctionTypes.h:206
SyscZoneCountAccess
uint16_t(* SyscZoneCountAccess)(SyscOpaqueDataAccess opaqueDataAccess, const char *regionName)
Provide function prototype for access to zone count.
Definition: syscFunctionTypes.h:252
SyscInputScalarDataAccess
SyscInputScalarData(* SyscInputScalarDataAccess)(const char *regionName, const char *variableName)
Provide function prototype for access to input scalar data.
Definition: syscFunctionTypes.h:39
SyscOutputVectorDataAccessWithPointer
SyscOutputVectorData(* SyscOutputVectorDataAccessWithPointer)(SyscOpaqueDataAccess opaqueDataAccess, const char *regionName, const char *variableName)
Provide function prototype for access to output vector data with opaque pointer.
Definition: syscFunctionTypes.h:118
SyscOutputScalarDataAccessWithPointer
SyscOutputScalarData(* SyscOutputScalarDataAccessWithPointer)(SyscOpaqueDataAccess opaqueDataAccess, const char *regionName, const char *variableName)
Provide function prototype for access to output scalar data with opaque pointer.
Definition: syscFunctionTypes.h:94
SyscInputComplexScalarDataAccess
SyscInputComplexScalarData(* SyscInputComplexScalarDataAccess)(const char *regionName, const char *variableName)
Provide function prototype for access to input complex scalar data.
Definition: syscFunctionTypes.h:135
SyscOutputScalarDataAccess
SyscOutputScalarData(* SyscOutputScalarDataAccess)(const char *regionName, const char *variableName)
Provide function prototype for access to output scalar data.
Definition: syscFunctionTypes.h:87
SyscPointCloudMultiZoneAccess
SyscPointCloud(* SyscPointCloudMultiZoneAccess)(SyscOpaqueDataAccess opaqueDataAccess, const char *regionName, uint16_t zoneIndex)
Provide function prototype for access to multi-zone point cloud.
Definition: syscFunctionTypes.h:244
SyscInputComplexVectorDataAccess
SyscInputComplexVectorData(* SyscInputComplexVectorDataAccess)(const char *regionName, const char *variableName)
Provide function prototype for access to input complex vector data.
Definition: syscFunctionTypes.h:150
SyscVolumeMeshAccess
SyscVolumeMesh(* SyscVolumeMeshAccess)(const char *regionName)
Provide function prototype for access to volume mesh.
Definition: syscFunctionTypes.h:214
SyscInputScalarDataAccessWithPointer
SyscInputScalarData(* SyscInputScalarDataAccessWithPointer)(SyscOpaqueDataAccess opaqueDataAccess, const char *regionName, const char *variableName)
Provide function prototype for access to input scalar data with opaque pointer.
Definition: syscFunctionTypes.h:46
SyscVolumeMeshAccessWithPointer
SyscVolumeMesh(* SyscVolumeMeshAccessWithPointer)(SyscOpaqueDataAccess opaqueDataAccess, const char *regionName)
Provide function prototype for access to volume mesh with opaque pointer.
Definition: syscFunctionTypes.h:220
SyscInputVectorDataMultiZoneAccess
SyscInputVectorData(* SyscInputVectorDataMultiZoneAccess)(SyscOpaqueDataAccess opaqueDataAccess, const char *regionName, const char *variableName, uint16_t zoneIndex)
Provide function prototype for access to multi-zone input vector data.
Definition: syscFunctionTypes.h:78
SyscInputVectorDataAccessWithPointer
SyscInputVectorData(* SyscInputVectorDataAccessWithPointer)(SyscOpaqueDataAccess opaqueDataAccess, const char *regionName, const char *variableName)
Provide function prototype for access to input vector data with opaque pointer.
Definition: syscFunctionTypes.h:70
SyscPointCloudAccess
SyscPointCloud(* SyscPointCloudAccess)(const char *regionName)
Provide function prototype for access to point cloud.
Definition: syscFunctionTypes.h:233
SyscOutputVectorDataAccess
SyscOutputVectorData(* SyscOutputVectorDataAccess)(const char *regionName, const char *variableName)
Provide function prototype for access to output vector data.
Definition: syscFunctionTypes.h:111
SyscVolumeMeshMultiZoneAccess
SyscVolumeMesh(* SyscVolumeMeshMultiZoneAccess)(SyscOpaqueDataAccess opaqueDataAccess, const char *regionName, uint16_t zoneIndex)
Provide function prototype for access to multi-zone volume mesh.
Definition: syscFunctionTypes.h:225
SyscPointCloudAccessWithPointer
SyscPointCloud(* SyscPointCloudAccessWithPointer)(SyscOpaqueDataAccess opaqueDataAccess, const char *regionName)
Provide function prototype for access to point cloud with an opaque pointer.
Definition: syscFunctionTypes.h:239
SyscSurfaceMeshAccessWithPointer
SyscSurfaceMesh(* SyscSurfaceMeshAccessWithPointer)(SyscOpaqueDataAccess opaqueDataAccess, const char *regionName)
Provide function prototype for access to surface mesh with opaque pointer.
Definition: syscFunctionTypes.h:201
SyscInputComplexScalarData
Struct for input complex scalar data.
Definition: syscInputComplexScalarData.h:29
SyscInputComplexVectorData
Struct for input complex vector data.
Definition: syscInputComplexVectorData.h:29
SyscInputScalarData
Provide a struct for input scalar data.
Definition: syscInputScalarData.h:40
SyscInputVectorData
Provide a struct for input vector data.
Definition: syscInputVectorData.h:42
SyscOutputComplexScalarData
Struct for output complex scalar data.
Definition: syscOutputComplexScalarData.h:29
SyscOutputComplexVectorData
Struct for output complex vector data.
Definition: syscOutputComplexVectorData.h:28
SyscOutputScalarData
Provide a struct for output scalar data.
Definition: syscOutputScalarData.h:37
SyscOutputVectorData
Create an output vector data access struct.
Definition: syscOutputVectorData.h:42
SyscPointCloud
Provide a point cloud access struct.
Definition: syscPointCloud.h:41
SyscSurfaceMesh
Provide a surface mesh access struct.
Definition: syscSurfaceMesh.h:31
SyscVolumeMesh
Provide a volume mesh access struct.
Definition: syscVolumeMesh.h:42

Connect with Ansys