Skip to main content

System Coupling C library 2024 R1

SyscCouplingInterface Struct Reference

Last update: 17.07.2025

Provide a struct for a coupling interface. More...

#include <syscCouplingInterface.h>

Data Fields

char name [SYSC_STRING_LENGTH]
 

Detailed Description

Provide a struct for a coupling interface.

Coupling interface can be used to set up the transfers of data between different regions within the same participant solver. Interface contains two sides and each side can contain one or more regions. Data transfers are automatically defined: if a variable is defined as an output on all regions on one side of the interface and as an input on all regions on the opposide side of the interface, then it will be mapped from the former side to the latter side.

All regions on one side of the interface must have the same topology.

To create and/or initialize the SyscCouplingInterface struct, it is highly recommended to use the syscGetCouplingInterface function. This function will initialize all members to the correct values and will help to avoid back-compatibility issues in the future. For example:

SyscCouplingInterface syscGetCouplingInterface(const char *name)
Create a coupling interface.
Provide a struct for a coupling interface.

Definition at line 45 of file syscCouplingInterface.h.

Field Documentation

◆ name

char SyscCouplingInterface::name[SYSC_STRING_LENGTH]

Unique name for the interface.

Definition at line 46 of file syscCouplingInterface.h.

Connect with Ansys