Skip to main content

System Coupling C++ library 2024 R2

FunctionTypes

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/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
39 const RegionName &, const VariableName &);
40
49 OpaqueDataAccess, const RegionName &, const VariableName &);
50
58 const RegionName &, const VariableName &);
59
68 OpaqueDataAccess, const RegionName &, const VariableName &);
69
77 const RegionName &, const VariableName &);
78
87 OpaqueDataAccess, const RegionName &, const VariableName &);
88
96 const RegionName &, const VariableName &);
97
106 OpaqueDataAccess, const RegionName &, const VariableName &);
107
115 const RegionName &, const VariableName &);
116
125 OpaqueDataAccess, const RegionName &, const VariableName &);
126
134 const RegionName &, const VariableName &);
135
144 OpaqueDataAccess, const RegionName &, const VariableName &);
145
153 const RegionName &, const VariableName &);
154
163 OpaqueDataAccess, const RegionName &, const VariableName &);
164
172 const RegionName &, const VariableName &);
173
182 OpaqueDataAccess, const RegionName &, const VariableName &);
183
191
201
209
219
226
235
242
243/* Advanced callbacks. */
244
247using ZoneCountAccess = std::uint16_t(OpaqueDataAccess, const RegionName &);
248
255 OpaqueDataAccess, const RegionName &, std::uint16_t zoneIndex);
256
264 OpaqueDataAccess, const RegionName &, std::uint16_t zoneIndex);
265
273 const RegionName &,
274 std::uint16_t zoneIndex);
275
280 const RegionName &,
281 const VariableName &,
282 std::uint16_t zoneIndex);
283
288 const RegionName &,
289 const VariableName &,
290 std::uint16_t zoneIndex);
291
296 const RegionName &,
297 const VariableName &,
298 std::uint16_t zoneIndex);
299
304 const RegionName &,
305 const VariableName &,
306 std::uint16_t zoneIndex);
307
308/* Deprecated types */
309
311using InputScalarVariableAccess = InputScalarData(const std::string &, const std::string &);
312
314using InputVectorVariableAccess = InputVectorData(const std::string &, const std::string &);
315
317using OutputScalarVariableAccess = OutputScalarData(const std::string &, const std::string &);
318
320using OutputVectorVariableAccess = OutputVectorData(const std::string &, const std::string &);
321
324} // namespace sysc
Provide a class for input complex scalar data.
Provide a class for input complex vector data.
Provide a class for input scalar data.
Provide a class for input vector data.
Provide a class for output complex scalar data.
Provide a class for output complex vector data.
Provide a class for output scalar data.
Provide a class for output vector data.
Provide a point cloud access class.
Provide a surface mesh access class.
Provide a volume mesh access class.
std::uint16_t(OpaqueDataAccess, const RegionName &) ZoneCountAccess
Function prototype to get the number of zones for a given region.
VolumeMesh(OpaqueDataAccess, const RegionName &) VolumeMeshAccessWithPointer
Provide alias for function that provides access to volume mesh.
SurfaceMesh(const RegionName &) SurfaceMeshAccess
Provide alias for function that provides access to surface mesh.
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.
void * OpaqueDataAccess
VolumeMesh(OpaqueDataAccess, const RegionName &, std::uint16_t zoneIndex) VolumeMeshMultiZoneAccess
Function prototype to get the mesh zone, given region name and zone index.
InputComplexScalarData(OpaqueDataAccess, const RegionName &, const VariableName &) InputComplexScalarDataAccessWithPointer
Provide function prototype for access to input complex scalar data.
InputScalarData(const std::string &, const std::string &) InputScalarVariableAccess
This alias will be deprecated - use InputScalarDataAccess instead.
OutputComplexScalarData(OpaqueDataAccess, const RegionName &, const VariableName &) OutputComplexScalarDataAccessWithPointer
Provide function prototype for access to output complex scalar data.
PointCloud(const RegionName &) PointCloudAccess
Provide alias for function that provides access to point cloud.
SurfaceMesh(OpaqueDataAccess, const RegionName &, std::uint16_t zoneIndex) SurfaceMeshMultiZoneAccess
Function prototype to get the mesh zone, given region name and zone index.
std::string VariableName
SurfaceMesh(OpaqueDataAccess, const RegionName &) SurfaceMeshAccessWithPointer
Provide alias for function that provides access to surface mesh.
PointCloud(OpaqueDataAccess, const RegionName &) PointCloudAccessWithPointer
Provide alias for function that provides access to point cloud.
OutputVectorData(OpaqueDataAccess, const RegionName &, const VariableName &) OutputVectorDataAccessWithPointer
Provide function prototype for access to output vector data.
OutputScalarData(const RegionName &, const VariableName &) OutputScalarDataAccess
Provide function prototype for access to output scalar data.
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.
OutputComplexVectorData(OpaqueDataAccess, const RegionName &, const VariableName &) OutputComplexVectorDataAccessWithPointer
Provide function prototype for access to output complex vector data.
InputComplexScalarData(const RegionName &, const VariableName &) InputComplexScalarDataAccess
Provide function prototype for access to input complex scalar data.
OutputComplexScalarData(const RegionName &, const VariableName &) OutputComplexScalarDataAccess
Provide function prototype for access to output complex scalar data.
InputScalarData(OpaqueDataAccess, const RegionName &, const VariableName &) InputScalarDataAccessWithPointer
Provide function prototype for access to input scalar data.
RestartPoint() RestartPointCreation
Provide an alias for function prototype that creates restart points.
InputScalarData(const RegionName &, const VariableName &) InputScalarDataAccess
Provide function prototype for access to input scalar data.
InputComplexVectorData(const RegionName &, const VariableName &) InputComplexVectorDataAccess
Provide function prototype for access to input complex vector data.
InputComplexVectorData(OpaqueDataAccess, const RegionName &, const VariableName &) InputComplexVectorDataAccessWithPointer
Provide function prototype for access to input complex vector data.
InputVectorData(const RegionName &, const VariableName &) InputVectorDataAccess
Provide function prototype for access to input vector data.
OutputVectorData(const RegionName &, const VariableName &) OutputVectorDataAccess
Provide function prototype for access to output vector data.
OutputScalarData(const std::string &, const std::string &) OutputScalarVariableAccess
This alias will be deprecated - use OutputScalarDataAccess instead.
VolumeMesh(const RegionName &) VolumeMeshAccess
Provide alias for function that provides access to volume mesh.
OutputVectorData(const std::string &, const std::string &) OutputVectorVariableAccess
This alias will be deprecated - use OutputVectorDataAccess instead.
OutputComplexVectorData(const RegionName &, const VariableName &) OutputComplexVectorDataAccess
Provide function prototype for access to output complex vector data.
InputVectorData(const std::string &, const std::string &) InputVectorVariableAccess
This alias will be deprecated - use InputVectorDataAccess instead.
std::string RegionName
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.
PointCloud(OpaqueDataAccess, const RegionName &, std::uint16_t zoneIndex) PointCloudMultiZoneAccess
Provide alias for function that provides access to point cloud.
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.
InputVectorData(OpaqueDataAccess, const RegionName &, const VariableName &) InputVectorDataAccessWithPointer
Provide function prototype for access to input vector data.
OutputScalarData(OpaqueDataAccess, const RegionName &, const VariableName &) OutputScalarDataAccessWithPointer
Provide function prototype for access to output scalar data.
std::string RestartPoint

Connect with Ansys