Skip to main content

System Coupling C library 2024 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
26extern "C" {
27#endif
28
34/* ***************** Data access functions prototypes ********************** */
35
36/* *** input scalar data *** */
37
40 const char *regionName,
41 const char *variableName);
42
47 SyscOpaqueDataAccess opaqueDataAccess,
48 const char *regionName,
49 const char *variableName);
50
55 SyscOpaqueDataAccess opaqueDataAccess,
56 const char *regionName,
57 const char *variableName,
58 uint16_t zoneIndex);
59
60/* *** input vector data *** */
61
64 const char *regionName,
65 const char *variableName);
66
71 SyscOpaqueDataAccess opaqueDataAccess,
72 const char *regionName,
73 const char *variableName);
74
79 SyscOpaqueDataAccess opaqueDataAccess,
80 const char *regionName,
81 const char *variableName,
82 uint16_t zoneIndex);
83
84/* *** output scalar data *** */
85
88 const char *regionName,
89 const char *variableName);
90
95 SyscOpaqueDataAccess opaqueDataAccess,
96 const char *regionName,
97 const char *variableName);
98
103 SyscOpaqueDataAccess opaqueDataAccess,
104 const char *regionName,
105 const char *variableName,
106 uint16_t zoneIndex);
107
108/* *** output vector data *** */
109
112 const char *regionName,
113 const char *variableName);
114
119 SyscOpaqueDataAccess opaqueDataAccess,
120 const char *regionName,
121 const char *variableName);
122
127 SyscOpaqueDataAccess opaqueDataAccess,
128 const char *regionName,
129 const char *variableName,
130 uint16_t zoneIndex);
131
132/* *** input complex scalar data *** */
133
136 const char *regionName,
137 const char *variableName);
138
143 SyscOpaqueDataAccess opaqueDataAccess,
144 const char *regionName,
145 const char *variableName);
146
147/* *** input complex vector data *** */
148
151 const char *regionName,
152 const char *variableName);
153
158 SyscOpaqueDataAccess opaqueDataAccess,
159 const char *regionName,
160 const char *variableName);
161
162/* *** output complex scalar data *** */
163
166 const char *regionName,
167 const char *variableName);
168
173 SyscOpaqueDataAccess opaqueDataAccess,
174 const char *regionName,
175 const char *variableName);
176
177/* *** output complex vector data *** */
178
181 const char *regionName,
182 const char *variableName);
183
188 SyscOpaqueDataAccess opaqueDataAccess,
189 const char *regionName,
190 const char *variableName);
191
192/* *** surface mesh *** */
193
196 const char *regionName);
197
202 SyscOpaqueDataAccess opaqueDataAccess,
203 const char *regionName);
204
207 SyscOpaqueDataAccess opaqueDataAccess,
208 const char *regionName,
209 uint16_t zoneIndex);
210
211/* *** volume mesh *** */
212
215 const char *regionName);
216
221 SyscOpaqueDataAccess opaqueDataAccess,
222 const char *regionName);
223
226 SyscOpaqueDataAccess opaqueDataAccess,
227 const char *regionName,
228 uint16_t zoneIndex);
229
230/* *** point cloud *** */
231
234 const char *regionName);
235
240 SyscOpaqueDataAccess opaqueDataAccess,
241 const char *regionName);
242
245 SyscOpaqueDataAccess opaqueDataAccess,
246 const char *regionName,
247 uint16_t zoneIndex);
248
249/* *** zone count *** */
250
252typedef uint16_t (*SyscZoneCountAccess)(
253 SyscOpaqueDataAccess opaqueDataAccess,
254 const char *regionName);
255
256/* *** restart points *** */
257
263typedef const char *(*SyscRestartPointCreation)();
264
267#ifdef __cplusplus
268}
269#endif
SyscOutputComplexScalarData(* SyscOutputComplexScalarDataAccess)(const char *regionName, const char *variableName)
Provide function prototype for access to output complex scalar data.
void * SyscOpaqueDataAccess
SyscOutputComplexVectorData(* SyscOutputComplexVectorDataAccessWithPointer)(SyscOpaqueDataAccess opaqueDataAccess, const char *regionName, const char *variableName)
Provide function prototype for access to output complex vector data with opaque pointer.
SyscOutputVectorData(* SyscOutputVectorDataMultiZoneAccess)(SyscOpaqueDataAccess opaqueDataAccess, const char *regionName, const char *variableName, uint16_t zoneIndex)
Provide function prototype for access to multi-zone output vector data.
SyscOutputComplexVectorData(* SyscOutputComplexVectorDataAccess)(const char *regionName, const char *variableName)
Provide function prototype for access to output complex vector data.
SyscInputComplexVectorData(* SyscInputComplexVectorDataAccessWithPointer)(SyscOpaqueDataAccess opaqueDataAccess, const char *regionName, const char *variableName)
Provide function prototype for access to input complex vector data with opaque pointer.
SyscOutputComplexScalarData(* SyscOutputComplexScalarDataAccessWithPointer)(SyscOpaqueDataAccess opaqueDataAccess, const char *regionName, const char *variableName)
Provide function prototype for access to output complex scalar data with opaque pointer.
SyscSurfaceMesh(* SyscSurfMeshAccess)(const char *regionName)
Provide function prototype for access to surface mesh.
SyscOutputScalarData(* SyscOutputScalarDataMultiZoneAccess)(SyscOpaqueDataAccess opaqueDataAccess, const char *regionName, const char *variableName, uint16_t zoneIndex)
Provide function prototype for access to multi-zone output scalar data.
SyscInputComplexScalarData(* SyscInputComplexScalarDataAccessWithPointer)(SyscOpaqueDataAccess opaqueDataAccess, const char *regionName, const char *variableName)
Provide function prototype for access to input complex scalar data with opaque pointer.
SyscInputScalarData(* SyscInputScalarDataMultiZoneAccess)(SyscOpaqueDataAccess opaqueDataAccess, const char *regionName, const char *variableName, uint16_t zoneIndex)
Provide function prototype for access to multi-zone input scalar data.
SyscInputVectorData(* SyscInputVectorDataAccess)(const char *regionName, const char *variableName)
Provide function prototype for access to input vector data.
SyscSurfaceMesh(* SyscSurfaceMeshMultiZoneAccess)(SyscOpaqueDataAccess opaqueDataAccess, const char *regionName, uint16_t zoneIndex)
Provide function prototype for access to multi-zone surface mesh.
uint16_t(* SyscZoneCountAccess)(SyscOpaqueDataAccess opaqueDataAccess, const char *regionName)
Provide function prototype for access to zone count.
SyscInputScalarData(* SyscInputScalarDataAccess)(const char *regionName, const char *variableName)
Provide function prototype for access to input scalar data.
SyscOutputVectorData(* SyscOutputVectorDataAccessWithPointer)(SyscOpaqueDataAccess opaqueDataAccess, const char *regionName, const char *variableName)
Provide function prototype for access to output vector data with opaque pointer.
SyscOutputScalarData(* SyscOutputScalarDataAccessWithPointer)(SyscOpaqueDataAccess opaqueDataAccess, const char *regionName, const char *variableName)
Provide function prototype for access to output scalar data with opaque pointer.
SyscInputComplexScalarData(* SyscInputComplexScalarDataAccess)(const char *regionName, const char *variableName)
Provide function prototype for access to input complex scalar data.
SyscOutputScalarData(* SyscOutputScalarDataAccess)(const char *regionName, const char *variableName)
Provide function prototype for access to output scalar data.
SyscPointCloud(* SyscPointCloudMultiZoneAccess)(SyscOpaqueDataAccess opaqueDataAccess, const char *regionName, uint16_t zoneIndex)
Provide function prototype for access to multi-zone point cloud.
SyscInputComplexVectorData(* SyscInputComplexVectorDataAccess)(const char *regionName, const char *variableName)
Provide function prototype for access to input complex vector data.
SyscVolumeMesh(* SyscVolumeMeshAccess)(const char *regionName)
Provide function prototype for access to volume mesh.
SyscInputScalarData(* SyscInputScalarDataAccessWithPointer)(SyscOpaqueDataAccess opaqueDataAccess, const char *regionName, const char *variableName)
Provide function prototype for access to input scalar data with opaque pointer.
SyscVolumeMesh(* SyscVolumeMeshAccessWithPointer)(SyscOpaqueDataAccess opaqueDataAccess, const char *regionName)
Provide function prototype for access to volume mesh with opaque pointer.
SyscInputVectorData(* SyscInputVectorDataMultiZoneAccess)(SyscOpaqueDataAccess opaqueDataAccess, const char *regionName, const char *variableName, uint16_t zoneIndex)
Provide function prototype for access to multi-zone input vector data.
SyscInputVectorData(* SyscInputVectorDataAccessWithPointer)(SyscOpaqueDataAccess opaqueDataAccess, const char *regionName, const char *variableName)
Provide function prototype for access to input vector data with opaque pointer.
SyscPointCloud(* SyscPointCloudAccess)(const char *regionName)
Provide function prototype for access to point cloud.
SyscOutputVectorData(* SyscOutputVectorDataAccess)(const char *regionName, const char *variableName)
Provide function prototype for access to output vector data.
SyscVolumeMesh(* SyscVolumeMeshMultiZoneAccess)(SyscOpaqueDataAccess opaqueDataAccess, const char *regionName, uint16_t zoneIndex)
Provide function prototype for access to multi-zone volume mesh.
SyscPointCloud(* SyscPointCloudAccessWithPointer)(SyscOpaqueDataAccess opaqueDataAccess, const char *regionName)
Provide function prototype for access to point cloud with an opaque pointer.
SyscSurfaceMesh(* SyscSurfaceMeshAccessWithPointer)(SyscOpaqueDataAccess opaqueDataAccess, const char *regionName)
Provide function prototype for access to surface mesh with opaque pointer.
Struct for input complex scalar data.
Struct for input complex vector data.
Provide a struct for input scalar data.
Provide a struct for input vector data.
Struct for output complex scalar data.
Struct for output complex vector data.
Provide a struct for output scalar data.
Create an output vector data access struct.
Provide a point cloud access struct.
Provide a surface mesh access struct.
Provide a volume mesh access struct.

Connect with Ansys