System Coupling C++ library 2023 R2

FunctionTypes

Last update: 17.07.2025
1/*
2* Copyright 2023 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited.
3*/
4
5#pragma once
6
7#include "SystemCouplingParticipant/LibraryType.hpp"
8
9#include "SystemCouplingParticipant/CommonTypes.hpp"
10#include "SystemCouplingParticipant/InputScalarData.hpp"
11#include "SystemCouplingParticipant/InputVectorData.hpp"
12#include "SystemCouplingParticipant/InputComplexScalarData.hpp"
13#include "SystemCouplingParticipant/InputComplexVectorData.hpp"
14#include "SystemCouplingParticipant/OutputScalarData.hpp"
15#include "SystemCouplingParticipant/OutputVectorData.hpp"
16#include "SystemCouplingParticipant/OutputComplexScalarData.hpp"
17#include "SystemCouplingParticipant/OutputComplexVectorData.hpp"
18#include "SystemCouplingParticipant/PointCloud.hpp"
19#include "SystemCouplingParticipant/Region.hpp"
20#include "SystemCouplingParticipant/SurfaceMesh.hpp"
21#include "SystemCouplingParticipant/Variable.hpp"
22#include "SystemCouplingParticipant/VolumeMesh.hpp"
23
24#include <string>
25
26namespace sysc {
27
38using InputScalarDataAccess = InputScalarData(
39 const RegionName&, const VariableName&);
40
48using InputScalarDataAccessWithPointer = InputScalarData(
49 OpaqueDataAccess, const RegionName&, const VariableName&);
50
57using InputVectorDataAccess = InputVectorData(
58 const RegionName&, const VariableName&);
59
67using InputVectorDataAccessWithPointer = InputVectorData(
68 OpaqueDataAccess, const RegionName&, const VariableName&);
69
76using OutputScalarDataAccess = OutputScalarData(
77 const RegionName&, const VariableName&);
78
86using OutputScalarDataAccessWithPointer = OutputScalarData(
87 OpaqueDataAccess, const RegionName&, const VariableName&);
88
95using OutputVectorDataAccess = OutputVectorData(
96 const RegionName&, const VariableName&);
97
105using OutputVectorDataAccessWithPointer = OutputVectorData(
106 OpaqueDataAccess, const RegionName&, const VariableName&);
107
114using InputComplexScalarDataAccess = InputComplexScalarData(
115 const RegionName&, const VariableName&);
116
124using InputComplexScalarDataAccessWithPointer = InputComplexScalarData(
125 OpaqueDataAccess, const RegionName&, const VariableName&);
126
133using InputComplexVectorDataAccess = InputComplexVectorData(
134 const RegionName&, const VariableName&);
135
143using InputComplexVectorDataAccessWithPointer = InputComplexVectorData(
144 OpaqueDataAccess, const RegionName&, const VariableName&);
145
152using OutputComplexScalarDataAccess = OutputComplexScalarData(
153 const RegionName&, const VariableName&);
154
162using OutputComplexScalarDataAccessWithPointer = OutputComplexScalarData(
163 OpaqueDataAccess, const RegionName&, const VariableName&);
164
171using OutputComplexVectorDataAccess = OutputComplexVectorData(
172 const RegionName&, const VariableName&);
173
181using OutputComplexVectorDataAccessWithPointer = OutputComplexVectorData(
182 OpaqueDataAccess, const RegionName&, const VariableName&);
183
190using SurfaceMeshAccess = SurfaceMesh(const RegionName&);
191
199using SurfaceMeshAccessWithPointer = SurfaceMesh(
200 OpaqueDataAccess, const RegionName&);
201
208using VolumeMeshAccess = VolumeMesh(const RegionName&);
209
217using VolumeMeshAccessWithPointer = VolumeMesh(
218 OpaqueDataAccess, const RegionName&);
219
225using PointCloudAccess = PointCloud(const RegionName&);
226
233using PointCloudAccessWithPointer = PointCloud(
234 OpaqueDataAccess, const RegionName&);
235
241using RestartPointCreation = RestartPoint(void);
242
243/* Advanced callbacks. */
244
247using ZoneCountAccess = std::uint16_t(OpaqueDataAccess, const RegionName&);
248
254using SurfaceMeshMultiZoneAccess = SurfaceMesh(
255 OpaqueDataAccess, const RegionName&, std::uint16_t zoneIndex);
256
263using VolumeMeshMultiZoneAccess = VolumeMesh(
264 OpaqueDataAccess, const RegionName&, std::uint16_t zoneIndex);
265
271using PointCloudMultiZoneAccess = PointCloud(
272 OpaqueDataAccess,
273 const RegionName&,
274 std::uint16_t zoneIndex);
275
278using InputScalarDataMultiZoneAccess = InputScalarData(
279 OpaqueDataAccess,
280 const RegionName&,
281 const VariableName&,
282 std::uint16_t zoneIndex);
283
286using OutputScalarDataMultiZoneAccess = OutputScalarData(
287 OpaqueDataAccess,
288 const RegionName&,
289 const VariableName&,
290 std::uint16_t zoneIndex);
291
294using InputVectorDataMultiZoneAccess = InputVectorData(
295 OpaqueDataAccess,
296 const RegionName&,
297 const VariableName&,
298 std::uint16_t zoneIndex);
299
302using OutputVectorDataMultiZoneAccess = OutputVectorData(
303 OpaqueDataAccess,
304 const RegionName&,
305 const VariableName&,
306 std::uint16_t zoneIndex);
307
308/* Deprecated types */
309
311typedef InputScalarData InputScalarVariableAccess(const std::string&, const std::string&);
312
314typedef InputVectorData InputVectorVariableAccess(const std::string&, const std::string&);
315
317typedef OutputScalarData OutputScalarVariableAccess(const std::string&, const std::string&);
318
320typedef OutputVectorData OutputVectorVariableAccess(const std::string&, const std::string&);
321
324} // namespace sysc
sysc::InputComplexScalarData
Provide a class for input complex scalar data.
Definition: InputComplexScalarData.hpp:24
sysc::InputComplexVectorData
Provide a class for input complex vector data.
Definition: InputComplexVectorData.hpp:29
sysc::InputScalarData
Provide a class for input scalar data.
Definition: InputScalarData.hpp:23
sysc::InputVectorData
Provide a class for input vector data.
Definition: InputVectorData.hpp:27
sysc::OutputComplexScalarData
Provide a class for output complex scalar data.
Definition: OutputComplexScalarData.hpp:24
sysc::OutputComplexVectorData
Provide a class for output complex vector data.
Definition: OutputComplexVectorData.hpp:29
sysc::OutputScalarData
Provide a class for output scalar data.
Definition: OutputScalarData.hpp:24
sysc::OutputVectorData
Provide a class for output vector data.
Definition: OutputVectorData.hpp:27
sysc::PointCloud
Provide a point cloud access class.
Definition: PointCloud.hpp:25
sysc::SurfaceMesh
Provide a surface mesh access class.
Definition: SurfaceMesh.hpp:27
sysc::VolumeMesh
Provide a volume mesh access class.
Definition: VolumeMesh.hpp:26
sysc::OutputScalarDataAccessWithPointer
OutputScalarData(OpaqueDataAccess, const RegionName &, const VariableName &) OutputScalarDataAccessWithPointer
Provide function prototype for access to output scalar data.
Definition: FunctionTypes.hpp:87
sysc::InputComplexVectorDataAccess
InputComplexVectorData(const RegionName &, const VariableName &) InputComplexVectorDataAccess
Provide function prototype for access to input complex vector data.
Definition: FunctionTypes.hpp:134
sysc::InputVectorDataAccessWithPointer
InputVectorData(OpaqueDataAccess, const RegionName &, const VariableName &) InputVectorDataAccessWithPointer
Provide function prototype for access to input vector data.
Definition: FunctionTypes.hpp:68
sysc::OutputScalarVariableAccess
OutputScalarData OutputScalarVariableAccess(const std::string &, const std::string &)
This alias will be deprecated - use OutputScalarDataAccess instead.
Definition: FunctionTypes.hpp:317
sysc::PointCloudAccess
PointCloud(const RegionName &) PointCloudAccess
Provide alias for function that provides access to point cloud.
Definition: FunctionTypes.hpp:225
sysc::PointCloudAccessWithPointer
PointCloud(OpaqueDataAccess, const RegionName &) PointCloudAccessWithPointer
Provide alias for function that provides access to point cloud.
Definition: FunctionTypes.hpp:234
sysc::PointCloudMultiZoneAccess
PointCloud(OpaqueDataAccess, const RegionName &, std::uint16_t zoneIndex) PointCloudMultiZoneAccess
Provide alias for function that provides access to point cloud.
Definition: FunctionTypes.hpp:274
sysc::OpaqueDataAccess
void * OpaqueDataAccess
Definition: CommonTypes.hpp:220
sysc::SurfaceMeshAccess
SurfaceMesh(const RegionName &) SurfaceMeshAccess
Provide alias for function that provides access to surface mesh.
Definition: FunctionTypes.hpp:190
sysc::InputScalarDataAccessWithPointer
InputScalarData(OpaqueDataAccess, const RegionName &, const VariableName &) InputScalarDataAccessWithPointer
Provide function prototype for access to input scalar data.
Definition: FunctionTypes.hpp:49
sysc::OutputVectorDataAccess
OutputVectorData(const RegionName &, const VariableName &) OutputVectorDataAccess
Provide function prototype for access to output vector data.
Definition: FunctionTypes.hpp:96
sysc::InputScalarDataMultiZoneAccess
InputScalarData(OpaqueDataAccess, const RegionName &, const VariableName &, std::uint16_t zoneIndex) InputScalarDataMultiZoneAccess
Function prototype to get the input scalar data, given region name and zone index.
Definition: FunctionTypes.hpp:282
sysc::OutputVectorDataMultiZoneAccess
OutputVectorData(OpaqueDataAccess, const RegionName &, const VariableName &, std::uint16_t zoneIndex) OutputVectorDataMultiZoneAccess
Function prototype to get the input vector data, given region name and zone index.
Definition: FunctionTypes.hpp:306
sysc::VariableName
std::string VariableName
Definition: CommonTypes.hpp:223
sysc::InputVectorDataMultiZoneAccess
InputVectorData(OpaqueDataAccess, const RegionName &, const VariableName &, std::uint16_t zoneIndex) InputVectorDataMultiZoneAccess
Function prototype to get the input vector data, given region name and zone index.
Definition: FunctionTypes.hpp:298
sysc::ZoneCountAccess
std::uint16_t(OpaqueDataAccess, const RegionName &) ZoneCountAccess
Function prototype to get the number of zones for a given region.
Definition: FunctionTypes.hpp:247
sysc::VolumeMeshAccessWithPointer
VolumeMesh(OpaqueDataAccess, const RegionName &) VolumeMeshAccessWithPointer
Provide alias for function that provides access to volume mesh.
Definition: FunctionTypes.hpp:218
sysc::OutputComplexScalarDataAccessWithPointer
OutputComplexScalarData(OpaqueDataAccess, const RegionName &, const VariableName &) OutputComplexScalarDataAccessWithPointer
Provide function prototype for access to output complex scalar data.
Definition: FunctionTypes.hpp:163
sysc::SurfaceMeshMultiZoneAccess
SurfaceMesh(OpaqueDataAccess, const RegionName &, std::uint16_t zoneIndex) SurfaceMeshMultiZoneAccess
Function prototype to get the mesh zone, given region name and zone index.
Definition: FunctionTypes.hpp:255
sysc::VolumeMeshAccess
VolumeMesh(const RegionName &) VolumeMeshAccess
Provide alias for function that provides access to volume mesh.
Definition: FunctionTypes.hpp:208
sysc::InputScalarVariableAccess
InputScalarData InputScalarVariableAccess(const std::string &, const std::string &)
This alias will be deprecated - use InputScalarDataAccess instead.
Definition: FunctionTypes.hpp:311
sysc::InputScalarDataAccess
InputScalarData(const RegionName &, const VariableName &) InputScalarDataAccess
Provide function prototype for access to input scalar data.
Definition: FunctionTypes.hpp:39
sysc::OutputVectorDataAccessWithPointer
OutputVectorData(OpaqueDataAccess, const RegionName &, const VariableName &) OutputVectorDataAccessWithPointer
Provide function prototype for access to output vector data.
Definition: FunctionTypes.hpp:106
sysc::InputComplexScalarDataAccessWithPointer
InputComplexScalarData(OpaqueDataAccess, const RegionName &, const VariableName &) InputComplexScalarDataAccessWithPointer
Provide function prototype for access to input complex scalar data.
Definition: FunctionTypes.hpp:125
sysc::RestartPointCreation
RestartPoint(void) RestartPointCreation
Provide an alias for function prototype that creates restart points.
Definition: FunctionTypes.hpp:241
sysc::InputVectorVariableAccess
InputVectorData InputVectorVariableAccess(const std::string &, const std::string &)
This alias will be deprecated - use InputVectorDataAccess instead.
Definition: FunctionTypes.hpp:314
sysc::OutputVectorVariableAccess
OutputVectorData OutputVectorVariableAccess(const std::string &, const std::string &)
This alias will be deprecated - use OutputVectorDataAccess instead.
Definition: FunctionTypes.hpp:320
sysc::OutputComplexVectorDataAccessWithPointer
OutputComplexVectorData(OpaqueDataAccess, const RegionName &, const VariableName &) OutputComplexVectorDataAccessWithPointer
Provide function prototype for access to output complex vector data.
Definition: FunctionTypes.hpp:182
sysc::OutputScalarDataMultiZoneAccess
OutputScalarData(OpaqueDataAccess, const RegionName &, const VariableName &, std::uint16_t zoneIndex) OutputScalarDataMultiZoneAccess
Function prototype to get the output scalar data, given region name and zone index.
Definition: FunctionTypes.hpp:290
sysc::InputVectorDataAccess
InputVectorData(const RegionName &, const VariableName &) InputVectorDataAccess
Provide function prototype for access to input vector data.
Definition: FunctionTypes.hpp:58
sysc::InputComplexScalarDataAccess
InputComplexScalarData(const RegionName &, const VariableName &) InputComplexScalarDataAccess
Provide function prototype for access to input complex scalar data.
Definition: FunctionTypes.hpp:115
sysc::RegionName
std::string RegionName
Definition: CommonTypes.hpp:222
sysc::OutputComplexScalarDataAccess
OutputComplexScalarData(const RegionName &, const VariableName &) OutputComplexScalarDataAccess
Provide function prototype for access to output complex scalar data.
Definition: FunctionTypes.hpp:153
sysc::OutputComplexVectorDataAccess
OutputComplexVectorData(const RegionName &, const VariableName &) OutputComplexVectorDataAccess
Provide function prototype for access to output complex vector data.
Definition: FunctionTypes.hpp:172
sysc::SurfaceMeshAccessWithPointer
SurfaceMesh(OpaqueDataAccess, const RegionName &) SurfaceMeshAccessWithPointer
Provide alias for function that provides access to surface mesh.
Definition: FunctionTypes.hpp:200
sysc::InputComplexVectorDataAccessWithPointer
InputComplexVectorData(OpaqueDataAccess, const RegionName &, const VariableName &) InputComplexVectorDataAccessWithPointer
Provide function prototype for access to input complex vector data.
Definition: FunctionTypes.hpp:144
sysc::RestartPoint
std::string RestartPoint
Definition: CommonTypes.hpp:225
sysc::VolumeMeshMultiZoneAccess
VolumeMesh(OpaqueDataAccess, const RegionName &, std::uint16_t zoneIndex) VolumeMeshMultiZoneAccess
Function prototype to get the mesh zone, given region name and zone index.
Definition: FunctionTypes.hpp:264
sysc::OutputScalarDataAccess
OutputScalarData(const RegionName &, const VariableName &) OutputScalarDataAccess
Provide function prototype for access to output scalar data.
Definition: FunctionTypes.hpp:77

Connect with Ansys