SyscRegion Struct Reference
Last update: 17.07.2025Provide a struct for a System Coupling region. More...
#include <syscRegion.h>
Data Fields | |
| char | name [SYSC_STRING_LENGTH] |
| enum SyscTopology | topology |
| enum SyscRegionDiscretizationType | regionDiscretizationType |
| char | displayName [SYSC_STRING_LENGTH] |
Detailed Description
Provide a struct for a System Coupling region.
Participant can declare which regions can be used in the coupled analysis. Each region can declare its input variables and output variables. Input variables represent physical quantities whose values the participant expects System Coupling to provide. Output variables represent physical quantities whose values System Coupling expects the participant to provide.
To create and/or initialize the SyscRegion struct, it is highly recommended to use one of the functions with names starting with syscGetRegion. These functions will initialize all members to the correct values and will help to avoid back-compatibility issues in the future. For example:
Definition at line 42 of file syscRegion.h.
Field Documentation
◆ displayName
| char SyscRegion::displayName[SYSC_STRING_LENGTH] |
User-friendly region name.
Definition at line 46 of file syscRegion.h.
◆ name
| char SyscRegion::name[SYSC_STRING_LENGTH] |
Unique region name.
Definition at line 43 of file syscRegion.h.
◆ regionDiscretizationType
| enum SyscRegionDiscretizationType SyscRegion::regionDiscretizationType |
Reigon mesh type.
Definition at line 45 of file syscRegion.h.
◆ topology
| enum SyscTopology SyscRegion::topology |
Region topology.
Definition at line 44 of file syscRegion.h.