Skip to main content

System Coupling C library 2024 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
16extern "C" {
17#endif
18
48
58
81 const SyscCouplingInterface couplingInterface,
82 const SyscRegion region);
83
106 const SyscCouplingInterface couplingInterface,
107 const SyscRegion region);
108
112 SyscCouplingInterface couplingInterface,
113 SyscDataTransfer dataTransfer);
114
118 SyscCouplingInterface couplingInterface);
119
123 SyscCouplingInterface couplingInterface);
124
128 SyscCouplingInterface couplingInterface);
129
134 SyscCouplingInterface couplingInterface,
135 size_t index);
136
141 SyscCouplingInterface couplingInterface,
142 size_t index);
143
148 SyscCouplingInterface couplingInterface,
149 size_t index);
150
153#ifdef __cplusplus
154}
155#endif
size_t syscCouplingInterfaceGetNumSideOneRegions(SyscCouplingInterface couplingInterface)
Get number of side one regions for a given coupling interface.
SyscRegion syscCouplingInterfaceGetSideTwoRegion(SyscCouplingInterface couplingInterface, size_t index)
Get the side two region at specified index for a given coupling interface.
SyscError syscAddSideTwoRegion(const SyscCouplingInterface couplingInterface, const SyscRegion region)
Add region to side two of the interface.
SyscDataTransfer syscCouplingInterfaceGetDataTransfer(SyscCouplingInterface couplingInterface, size_t index)
Get the data transfer at specified index for a given coupling interface.
SyscRegion syscCouplingInterfaceGetSideOneRegion(SyscCouplingInterface couplingInterface, size_t index)
Get the side one region at specified index for a given coupling interface.
SyscError syscAddSideOneRegion(const SyscCouplingInterface couplingInterface, const SyscRegion region)
Add region to side one of the interface.
#define SYSC_STRING_LENGTH
Define maximum string length.
size_t syscCouplingInterfaceGetNumDataTransfers(SyscCouplingInterface couplingInterface)
Get number of data transfer for a given coupling interface.
SyscCouplingInterface syscGetCouplingInterface(const char *name)
Create a coupling interface.
SyscError syscAddDataTransfer(SyscCouplingInterface couplingInterface, SyscDataTransfer dataTransfer)
Add the data transfer to the coupling interface.
size_t syscCouplingInterfaceGetNumSideTwoRegions(SyscCouplingInterface couplingInterface)
Get number of side two regions for a given coupling interface.
Provide a struct for a coupling interface.
char name[SYSC_STRING_LENGTH]
Provide a struct for a data transfer.
Provide a struct for detecting errors from the interface calls.
Provide a struct for a System Coupling region.
Definition syscRegion.h:42

Connect with Ansys