System Coupling C library 2025 R1

syscCouplingInterface

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/syscCommonTypes.h"
10 #include "SystemCouplingParticipant/syscDataTransfer.h"
11 #include "SystemCouplingParticipant/syscRegion.h"
12 
13 #include <stddef.h>
14 
15 #ifdef __cplusplus
16 extern "C" {
17 #endif
18 
45 typedef struct SyscCouplingInterface {
46  char name[SYSC_STRING_LENGTH];
47 } SyscCouplingInterface;
48 
57 SyscCouplingInterface syscGetCouplingInterface(const char* name);
58 
80 SyscError syscAddSideOneRegion(
81  const SyscCouplingInterface couplingInterface,
82  const SyscRegion region);
83 
105 SyscError syscAddSideTwoRegion(
106  const SyscCouplingInterface couplingInterface,
107  const SyscRegion region);
108 
111 SyscError syscAddDataTransfer(
112  SyscCouplingInterface couplingInterface,
113  SyscDataTransfer dataTransfer);
114 
117 size_t syscCouplingInterfaceGetNumDataTransfers(
118  SyscCouplingInterface couplingInterface);
119 
122 size_t syscCouplingInterfaceGetNumSideOneRegions(
123  SyscCouplingInterface couplingInterface);
124 
127 size_t syscCouplingInterfaceGetNumSideTwoRegions(
128  SyscCouplingInterface couplingInterface);
129 
133 SyscDataTransfer syscCouplingInterfaceGetDataTransfer(
134  SyscCouplingInterface couplingInterface,
135  size_t index);
136 
140 SyscRegion syscCouplingInterfaceGetSideOneRegion(
141  SyscCouplingInterface couplingInterface,
142  size_t index);
143 
147 SyscRegion syscCouplingInterfaceGetSideTwoRegion(
148  SyscCouplingInterface couplingInterface,
149  size_t index);
150 
153 #ifdef __cplusplus
154 }
155 #endif
syscCouplingInterfaceGetNumSideOneRegions
size_t syscCouplingInterfaceGetNumSideOneRegions(SyscCouplingInterface couplingInterface)
Get number of side one regions for a given coupling interface.
syscCouplingInterfaceGetSideTwoRegion
SyscRegion syscCouplingInterfaceGetSideTwoRegion(SyscCouplingInterface couplingInterface, size_t index)
Get the side two region at specified index for a given coupling interface.
syscAddSideTwoRegion
SyscError syscAddSideTwoRegion(const SyscCouplingInterface couplingInterface, const SyscRegion region)
Add region to side two of the interface.
syscCouplingInterfaceGetDataTransfer
SyscDataTransfer syscCouplingInterfaceGetDataTransfer(SyscCouplingInterface couplingInterface, size_t index)
Get the data transfer at specified index for a given coupling interface.
syscCouplingInterfaceGetSideOneRegion
SyscRegion syscCouplingInterfaceGetSideOneRegion(SyscCouplingInterface couplingInterface, size_t index)
Get the side one region at specified index for a given coupling interface.
SyscCouplingInterface
struct SyscCouplingInterface SyscCouplingInterface
Provide a struct for a coupling interface.
syscAddSideOneRegion
SyscError syscAddSideOneRegion(const SyscCouplingInterface couplingInterface, const SyscRegion region)
Add region to side one of the interface.
SYSC_STRING_LENGTH
#define SYSC_STRING_LENGTH
Define maximum string length.
Definition: syscCommonTypes.h:23
syscCouplingInterfaceGetNumDataTransfers
size_t syscCouplingInterfaceGetNumDataTransfers(SyscCouplingInterface couplingInterface)
Get number of data transfer for a given coupling interface.
syscGetCouplingInterface
SyscCouplingInterface syscGetCouplingInterface(const char *name)
Create a coupling interface.
syscAddDataTransfer
SyscError syscAddDataTransfer(SyscCouplingInterface couplingInterface, SyscDataTransfer dataTransfer)
Add the data transfer to the coupling interface.
syscCouplingInterfaceGetNumSideTwoRegions
size_t syscCouplingInterfaceGetNumSideTwoRegions(SyscCouplingInterface couplingInterface)
Get number of side two regions for a given coupling interface.
SyscCouplingInterface
Provide a struct for a coupling interface.
Definition: syscCouplingInterface.h:45
SyscCouplingInterface::name
char name[SYSC_STRING_LENGTH]
Definition: syscCouplingInterface.h:46
SyscDataTransfer
Provide a struct for a data transfer.
Definition: syscDataTransfer.h:29
SyscError
Provide a struct for detecting errors from the interface calls.
Definition: syscCommonTypes.h:137
SyscRegion
Provide a struct for a System Coupling region.
Definition: syscRegion.h:42

Connect with Ansys