Skip to main content

File syscFunctionTypes.h

Location: syscFunctionTypes.h

Includes​

  • SystemCouplingParticipant/LibraryType.hpp
  • SystemCouplingParticipant/syscInputScalarData.h
  • SystemCouplingParticipant/syscInputVectorData.h
  • SystemCouplingParticipant/syscOutputIntegerData.h
  • SystemCouplingParticipant/syscOutputScalarData.h
  • SystemCouplingParticipant/syscOutputVectorData.h
  • SystemCouplingParticipant/syscInputComplexScalarData.h
  • SystemCouplingParticipant/syscInputComplexVectorData.h
  • SystemCouplingParticipant/syscOutputComplexScalarData.h
  • SystemCouplingParticipant/syscOutputComplexVectorData.h
  • SystemCouplingParticipant/syscPointCloud.h
  • SystemCouplingParticipant/syscSurfaceMesh.h
  • SystemCouplingParticipant/syscVolumeMesh.h
  • <stddef.h>
  • <stdint.h>
graph LR
1["syscFunctionTypes.h"]
click 1 "syscFunctionTypes_8h.md#syscFunctionTypes_8h"
1 --> 2
1 --> 3
1 --> 4
1 --> 5
1 --> 6
1 --> 7
1 --> 8
1 --> 9
1 --> 10
1 --> 11
1 --> 12
1 --> 13
1 --> 14
1 --> 15
1 --> 16

16["stdint.h"]

4["SystemCouplingParticipant/syscInputVectorData.h"]

15["stddef.h"]

14["SystemCouplingParticipant/syscVolumeMesh.h"]

9["SystemCouplingParticipant/syscInputComplexVectorData.h"]

13["SystemCouplingParticipant/syscSurfaceMesh.h"]

11["SystemCouplingParticipant/syscOutputComplexVectorData.h"]

2["SystemCouplingParticipant/LibraryType.hpp"]

7["SystemCouplingParticipant/syscOutputVectorData.h"]

3["SystemCouplingParticipant/syscInputScalarData.h"]

8["SystemCouplingParticipant/syscInputComplexScalarData.h"]

12["SystemCouplingParticipant/syscPointCloud.h"]

5["SystemCouplingParticipant/syscOutputIntegerData.h"]

10["SystemCouplingParticipant/syscOutputComplexScalarData.h"]

6["SystemCouplingParticipant/syscOutputScalarData.h"]

Typedefs​

Typedef SyscInputScalarDataAccess​

Definition: syscFunctionTypes.h (line 39)

typedef SyscInputScalarData(* SyscInputScalarDataAccess) (const char *regionName, const char *variableName)

Provide function prototype for access to input scalar data.

Return type: SyscInputScalarData(*

Typedef SyscInputScalarDataAccessWithPointer​

Definition: syscFunctionTypes.h (line 46)

typedef SyscInputScalarData(* SyscInputScalarDataAccessWithPointer) (SyscOpaqueDataAccess opaqueDataAccess, const char *regionName, const char *variableName)

Provide function prototype for access to input scalar data with opaque pointer.

Return type: SyscInputScalarData(*

Typedef SyscInputScalarDataMultiZoneAccess​

Definition: syscFunctionTypes.h (line 54)

typedef SyscInputScalarData(* SyscInputScalarDataMultiZoneAccess) (SyscOpaqueDataAccess opaqueDataAccess, const char *regionName, const char *variableName, uint16_t zoneIndex)

Provide function prototype for access to multi-zone input scalar data.

Return type: SyscInputScalarData(*

Typedef SyscInputVectorDataAccess​

Definition: syscFunctionTypes.h (line 63)

typedef SyscInputVectorData(* SyscInputVectorDataAccess) (const char *regionName, const char *variableName)

Provide function prototype for access to input vector data.

Return type: SyscInputVectorData(*

Typedef SyscInputVectorDataAccessWithPointer​

Definition: syscFunctionTypes.h (line 70)

typedef SyscInputVectorData(* SyscInputVectorDataAccessWithPointer) (SyscOpaqueDataAccess opaqueDataAccess, const char *regionName, const char *variableName)

Provide function prototype for access to input vector data with opaque pointer.

Return type: SyscInputVectorData(*

Typedef SyscInputVectorDataMultiZoneAccess​

Definition: syscFunctionTypes.h (line 78)

typedef SyscInputVectorData(* SyscInputVectorDataMultiZoneAccess) (SyscOpaqueDataAccess opaqueDataAccess, const char *regionName, const char *variableName, uint16_t zoneIndex)

Provide function prototype for access to multi-zone input vector data.

Return type: SyscInputVectorData(*

Typedef SyscOutputScalarDataAccess​

Definition: syscFunctionTypes.h (line 87)

typedef SyscOutputScalarData(* SyscOutputScalarDataAccess) (const char *regionName, const char *variableName)

Provide function prototype for access to output scalar data.

Return type: SyscOutputScalarData(*

Typedef SyscOutputScalarDataAccessWithPointer​

Definition: syscFunctionTypes.h (line 94)

typedef SyscOutputScalarData(* SyscOutputScalarDataAccessWithPointer) (SyscOpaqueDataAccess opaqueDataAccess, const char *regionName, const char *variableName)

Provide function prototype for access to output scalar data with opaque pointer.

Return type: SyscOutputScalarData(*

Typedef SyscOutputScalarDataMultiZoneAccess​

Definition: syscFunctionTypes.h (line 102)

typedef SyscOutputScalarData(* SyscOutputScalarDataMultiZoneAccess) (SyscOpaqueDataAccess opaqueDataAccess, const char *regionName, const char *variableName, uint16_t zoneIndex)

Provide function prototype for access to multi-zone output scalar data.

Return type: SyscOutputScalarData(*

Typedef SyscOutputVectorDataAccess​

Definition: syscFunctionTypes.h (line 111)

typedef SyscOutputVectorData(* SyscOutputVectorDataAccess) (const char *regionName, const char *variableName)

Provide function prototype for access to output vector data.

Return type: SyscOutputVectorData(*

Typedef SyscOutputVectorDataAccessWithPointer​

Definition: syscFunctionTypes.h (line 118)

typedef SyscOutputVectorData(* SyscOutputVectorDataAccessWithPointer) (SyscOpaqueDataAccess opaqueDataAccess, const char *regionName, const char *variableName)

Provide function prototype for access to output vector data with opaque pointer.

Return type: SyscOutputVectorData(*

Typedef SyscOutputVectorDataMultiZoneAccess​

Definition: syscFunctionTypes.h (line 126)

typedef SyscOutputVectorData(* SyscOutputVectorDataMultiZoneAccess) (SyscOpaqueDataAccess opaqueDataAccess, const char *regionName, const char *variableName, uint16_t zoneIndex)

Provide function prototype for access to multi-zone output vector data.

Return type: SyscOutputVectorData(*

Typedef SyscInputComplexScalarDataAccess​

Definition: syscFunctionTypes.h (line 135)

typedef SyscInputComplexScalarData(* SyscInputComplexScalarDataAccess) (const char *regionName, const char *variableName)

Provide function prototype for access to input complex scalar data.

Return type: SyscInputComplexScalarData(*

Typedef SyscInputComplexScalarDataAccessWithPointer​

Definition: syscFunctionTypes.h (line 142)

typedef SyscInputComplexScalarData(* SyscInputComplexScalarDataAccessWithPointer) (SyscOpaqueDataAccess opaqueDataAccess, const char *regionName, const char *variableName)

Provide function prototype for access to input complex scalar data with opaque pointer.

Return type: SyscInputComplexScalarData(*

Typedef SyscInputComplexVectorDataAccess​

Definition: syscFunctionTypes.h (line 150)

typedef SyscInputComplexVectorData(* SyscInputComplexVectorDataAccess) (const char *regionName, const char *variableName)

Provide function prototype for access to input complex vector data.

Return type: SyscInputComplexVectorData(*

Typedef SyscInputComplexVectorDataAccessWithPointer​

Definition: syscFunctionTypes.h (line 157)

typedef SyscInputComplexVectorData(* SyscInputComplexVectorDataAccessWithPointer) (SyscOpaqueDataAccess opaqueDataAccess, const char *regionName, const char *variableName)

Provide function prototype for access to input complex vector data with opaque pointer.

Return type: SyscInputComplexVectorData(*

Typedef SyscOutputComplexScalarDataAccess​

Definition: syscFunctionTypes.h (line 165)

typedef SyscOutputComplexScalarData(* SyscOutputComplexScalarDataAccess) (const char *regionName, const char *variableName)

Provide function prototype for access to output complex scalar data.

Return type: SyscOutputComplexScalarData(*

Typedef SyscOutputComplexScalarDataAccessWithPointer​

Definition: syscFunctionTypes.h (line 172)

typedef SyscOutputComplexScalarData(* SyscOutputComplexScalarDataAccessWithPointer) (SyscOpaqueDataAccess opaqueDataAccess, const char *regionName, const char *variableName)

Provide function prototype for access to output complex scalar data with opaque pointer.

Return type: SyscOutputComplexScalarData(*

Typedef SyscOutputComplexVectorDataAccess​

Definition: syscFunctionTypes.h (line 180)

typedef SyscOutputComplexVectorData(* SyscOutputComplexVectorDataAccess) (const char *regionName, const char *variableName)

Provide function prototype for access to output complex vector data.

Return type: SyscOutputComplexVectorData(*

Typedef SyscOutputComplexVectorDataAccessWithPointer​

Definition: syscFunctionTypes.h (line 187)

typedef SyscOutputComplexVectorData(* SyscOutputComplexVectorDataAccessWithPointer) (SyscOpaqueDataAccess opaqueDataAccess, const char *regionName, const char *variableName)

Provide function prototype for access to output complex vector data with opaque pointer.

Return type: SyscOutputComplexVectorData(*

Typedef SyscSurfMeshAccess​

Definition: syscFunctionTypes.h (line 195)

typedef SyscSurfaceMesh(* SyscSurfMeshAccess) (const char *regionName)

Provide function prototype for access to surface mesh.

Return type: SyscSurfaceMesh(*

Typedef SyscSurfaceMeshAccessWithPointer​

Definition: syscFunctionTypes.h (line 201)

typedef SyscSurfaceMesh(* SyscSurfaceMeshAccessWithPointer) (SyscOpaqueDataAccess opaqueDataAccess, const char *regionName)

Provide function prototype for access to surface mesh with opaque pointer.

Return type: SyscSurfaceMesh(*

Typedef SyscSurfaceMeshMultiZoneAccess​

Definition: syscFunctionTypes.h (line 206)

typedef SyscSurfaceMesh(* SyscSurfaceMeshMultiZoneAccess) (SyscOpaqueDataAccess opaqueDataAccess, const char *regionName, uint16_t zoneIndex)

Provide function prototype for access to multi-zone surface mesh.

Return type: SyscSurfaceMesh(*

Typedef SyscVolumeMeshAccess​

Definition: syscFunctionTypes.h (line 214)

typedef SyscVolumeMesh(* SyscVolumeMeshAccess) (const char *regionName)

Provide function prototype for access to volume mesh.

Return type: SyscVolumeMesh(*

Typedef SyscVolumeMeshAccessWithPointer​

Definition: syscFunctionTypes.h (line 220)

typedef SyscVolumeMesh(* SyscVolumeMeshAccessWithPointer) (SyscOpaqueDataAccess opaqueDataAccess, const char *regionName)

Provide function prototype for access to volume mesh with opaque pointer.

Return type: SyscVolumeMesh(*

Typedef SyscVolumeMeshMultiZoneAccess​

Definition: syscFunctionTypes.h (line 225)

typedef SyscVolumeMesh(* SyscVolumeMeshMultiZoneAccess) (SyscOpaqueDataAccess opaqueDataAccess, const char *regionName, uint16_t zoneIndex)

Provide function prototype for access to multi-zone volume mesh.

Return type: SyscVolumeMesh(*

Typedef SyscPointCloudAccess​

Definition: syscFunctionTypes.h (line 233)

typedef SyscPointCloud(* SyscPointCloudAccess) (const char *regionName)

Provide function prototype for access to point cloud.

Return type: SyscPointCloud(*

Typedef SyscPointCloudAccessWithPointer​

Definition: syscFunctionTypes.h (line 239)

typedef SyscPointCloud(* SyscPointCloudAccessWithPointer) (SyscOpaqueDataAccess opaqueDataAccess, const char *regionName)

Provide function prototype for access to point cloud with an opaque pointer.

Return type: SyscPointCloud(*

Typedef SyscPointCloudMultiZoneAccess​

Definition: syscFunctionTypes.h (line 244)

typedef SyscPointCloud(* SyscPointCloudMultiZoneAccess) (SyscOpaqueDataAccess opaqueDataAccess, const char *regionName, uint16_t zoneIndex)

Provide function prototype for access to multi-zone point cloud.

Return type: SyscPointCloud(*

Typedef SyscZoneCountAccess​

Definition: syscFunctionTypes.h (line 252)

typedef uint16_t(* SyscZoneCountAccess) (SyscOpaqueDataAccess opaqueDataAccess, const char *regionName)

Provide function prototype for access to zone count.

Return type: uint16_t(*

Typedef SyscRestartPointCreation​

Definition: syscFunctionTypes.h (line 263)

typedef const char*(* SyscRestartPointCreation) ()

Provide function prototype for creating restart points.

This function may be called only during outputs update, and is expected to return a unique string identifier for a given restart point.

Return type: const char (

Source​

/*
* Copyright ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited.
*/

#pragma once

#include "SystemCouplingParticipant/LibraryType.hpp"

#include "SystemCouplingParticipant/syscInputScalarData.h"
#include "SystemCouplingParticipant/syscInputVectorData.h"
#include "SystemCouplingParticipant/syscOutputIntegerData.h"
#include "SystemCouplingParticipant/syscOutputScalarData.h"
#include "SystemCouplingParticipant/syscOutputVectorData.h"
#include "SystemCouplingParticipant/syscInputComplexScalarData.h"
#include "SystemCouplingParticipant/syscInputComplexVectorData.h"
#include "SystemCouplingParticipant/syscOutputComplexScalarData.h"
#include "SystemCouplingParticipant/syscOutputComplexVectorData.h"
#include "SystemCouplingParticipant/syscPointCloud.h"
#include "SystemCouplingParticipant/syscSurfaceMesh.h"
#include "SystemCouplingParticipant/syscVolumeMesh.h"

#include `<stddef.h>`
#include `<stdint.h>`

#ifdef __cplusplus
extern "C" {
#endif

/* ***************** Data access functions prototypes ********************** */

/* *** input scalar data *** */

typedef SyscInputScalarData (*SyscInputScalarDataAccess)(
  const char* regionName,
  const char* variableName);

typedef SyscInputScalarData (*SyscInputScalarDataAccessWithPointer)(
  SyscOpaqueDataAccess opaqueDataAccess,
  const char* regionName,
  const char* variableName);

typedef SyscInputScalarData (*SyscInputScalarDataMultiZoneAccess)(
  SyscOpaqueDataAccess opaqueDataAccess,
  const char* regionName,
  const char* variableName,
  uint16_t zoneIndex);

/* *** input vector data *** */

typedef SyscInputVectorData (*SyscInputVectorDataAccess)(
  const char* regionName,
  const char* variableName);

typedef SyscInputVectorData (*SyscInputVectorDataAccessWithPointer)(
  SyscOpaqueDataAccess opaqueDataAccess,
  const char* regionName,
  const char* variableName);

typedef SyscInputVectorData (*SyscInputVectorDataMultiZoneAccess)(
  SyscOpaqueDataAccess opaqueDataAccess,
  const char* regionName,
  const char* variableName,
  uint16_t zoneIndex);

/* *** output scalar data *** */

typedef SyscOutputScalarData (*SyscOutputScalarDataAccess)(
  const char* regionName,
  const char* variableName);

typedef SyscOutputScalarData (*SyscOutputScalarDataAccessWithPointer)(
  SyscOpaqueDataAccess opaqueDataAccess,
  const char* regionName,
  const char* variableName);

typedef SyscOutputScalarData (*SyscOutputScalarDataMultiZoneAccess)(
  SyscOpaqueDataAccess opaqueDataAccess,
  const char* regionName,
  const char* variableName,
  uint16_t zoneIndex);

/* *** output vector data *** */

typedef SyscOutputVectorData (*SyscOutputVectorDataAccess)(
  const char* regionName,
  const char* variableName);

typedef SyscOutputVectorData (*SyscOutputVectorDataAccessWithPointer)(
  SyscOpaqueDataAccess opaqueDataAccess,
  const char* regionName,
  const char* variableName);

typedef SyscOutputVectorData (*SyscOutputVectorDataMultiZoneAccess)(
  SyscOpaqueDataAccess opaqueDataAccess,
  const char* regionName,
  const char* variableName,
  uint16_t zoneIndex);

/* *** input complex scalar data *** */

typedef SyscInputComplexScalarData (*SyscInputComplexScalarDataAccess)(
  const char* regionName,
  const char* variableName);

typedef SyscInputComplexScalarData (*SyscInputComplexScalarDataAccessWithPointer)(
  SyscOpaqueDataAccess opaqueDataAccess,
  const char* regionName,
  const char* variableName);

/* *** input complex vector data *** */

typedef SyscInputComplexVectorData (*SyscInputComplexVectorDataAccess)(
  const char* regionName,
  const char* variableName);

typedef SyscInputComplexVectorData (*SyscInputComplexVectorDataAccessWithPointer)(
  SyscOpaqueDataAccess opaqueDataAccess,
  const char* regionName,
  const char* variableName);

/* *** output complex scalar data *** */

typedef SyscOutputComplexScalarData (*SyscOutputComplexScalarDataAccess)(
  const char* regionName,
  const char* variableName);

typedef SyscOutputComplexScalarData (*SyscOutputComplexScalarDataAccessWithPointer)(
  SyscOpaqueDataAccess opaqueDataAccess,
  const char* regionName,
  const char* variableName);

/* *** output complex vector data *** */

typedef SyscOutputComplexVectorData (*SyscOutputComplexVectorDataAccess)(
  const char* regionName,
  const char* variableName);

typedef SyscOutputComplexVectorData (*SyscOutputComplexVectorDataAccessWithPointer)(
  SyscOpaqueDataAccess opaqueDataAccess,
  const char* regionName,
  const char* variableName);

/* *** surface mesh *** */

typedef SyscSurfaceMesh (*SyscSurfMeshAccess)(
  const char* regionName);

typedef SyscSurfaceMesh (*SyscSurfaceMeshAccessWithPointer)(
  SyscOpaqueDataAccess opaqueDataAccess,
  const char* regionName);

typedef SyscSurfaceMesh (*SyscSurfaceMeshMultiZoneAccess)(
  SyscOpaqueDataAccess opaqueDataAccess,
  const char* regionName,
  uint16_t zoneIndex);

/* *** volume mesh *** */

typedef SyscVolumeMesh (*SyscVolumeMeshAccess)(
  const char* regionName);

typedef SyscVolumeMesh (*SyscVolumeMeshAccessWithPointer)(
  SyscOpaqueDataAccess opaqueDataAccess,
  const char* regionName);

typedef SyscVolumeMesh (*SyscVolumeMeshMultiZoneAccess)(
  SyscOpaqueDataAccess opaqueDataAccess,
  const char* regionName,
  uint16_t zoneIndex);

/* *** point cloud *** */

typedef SyscPointCloud (*SyscPointCloudAccess)(
  const char* regionName);

typedef SyscPointCloud (*SyscPointCloudAccessWithPointer)(
  SyscOpaqueDataAccess opaqueDataAccess,
  const char* regionName);

typedef SyscPointCloud (*SyscPointCloudMultiZoneAccess)(
  SyscOpaqueDataAccess opaqueDataAccess,
  const char* regionName,
  uint16_t zoneIndex);

/* *** zone count *** */

typedef uint16_t (*SyscZoneCountAccess)(
  SyscOpaqueDataAccess opaqueDataAccess,
  const char* regionName);

/* *** restart points *** */

typedef const char* (*SyscRestartPointCreation)();

#ifdef __cplusplus
}
#endif
Last updated on by rborsaru-ansys