Skip to main content

System Coupling C library 2024 R1

syscRegion

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/syscVariable.h"
11
12#include <stddef.h>
13
14#ifdef __cplusplus
15extern "C" {
16#endif
17
48
63SyscRegion syscGetRegion(const char* name);
64
77SyscRegion syscGetRegionT(const char* name, enum SyscTopology topology);
78
92 const char* name,
93 const char* displayName,
94 enum SyscTopology topology);
95
108 const char* name,
109 enum SyscTopology topology,
110 enum SyscRegionDiscretizationType regionDiscretizationType);
111
124 const char* name,
125 const char* displayName,
126 enum SyscTopology topology,
127 enum SyscRegionDiscretizationType regionDiscretizationType);
128
154 const SyscRegion region,
155 const SyscVariable variable);
156
182 const SyscRegion region,
183 const SyscVariable variable);
184
195
206SyscVariable syscGetInputVariable(const SyscRegion region, size_t index);
207
218
230
233#ifdef __cplusplus
234}
235#endif
SyscRegion syscGetRegionT(const char *name, enum SyscTopology topology)
Create region to be used in a coupled analysis.
SyscVariable syscGetOutputVariable(const SyscRegion region, size_t index)
Return an output variable.
SyscRegionDiscretizationType
Provoide an enum for region mesh type.
SyscRegion syscGetRegionDT(const char *name, const char *displayName, enum SyscTopology topology)
Create region to be used in a coupled analysis.
SyscError syscAddOutputVariable(const SyscRegion region, const SyscVariable variable)
Provide a function to add an output variable to the region.
size_t syscGetNumOutputVariables(const SyscRegion region)
Provide a function to return the number of output variables.
SyscError syscAddInputVariable(const SyscRegion region, const SyscVariable variable)
Provide a function to add an input variable to the region.
SyscRegion syscGetRegionTM(const char *name, enum SyscTopology topology, enum SyscRegionDiscretizationType regionDiscretizationType)
Create region to be used in a coupled analysis.
SyscRegion syscGetRegionDTM(const char *name, const char *displayName, enum SyscTopology topology, enum SyscRegionDiscretizationType regionDiscretizationType)
Create region to be used in a coupled analysis.
#define SYSC_STRING_LENGTH
Define maximum string length.
size_t syscGetNumInputVariables(const SyscRegion region)
Provide a function to return the number of input variables.
SyscTopology
Provide an enum for region topologies.
SyscVariable syscGetInputVariable(const SyscRegion region, size_t index)
Return an input variable.
SyscRegion syscGetRegion(const char *name)
Create region to be used in a coupled analysis.
Provide a struct for detecting errors from the interface calls.
Provide a struct for a System Coupling region.
Definition syscRegion.h:42
enum SyscTopology topology
Definition syscRegion.h:44
char name[SYSC_STRING_LENGTH]
Definition syscRegion.h:43
enum SyscRegionDiscretizationType regionDiscretizationType
Definition syscRegion.h:45
char displayName[SYSC_STRING_LENGTH]
Definition syscRegion.h:46
Provide a struct for a System Coupling variable.

Connect with Ansys