Skip to main content

System Coupling C library 2024 R1

syscVariable

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/syscAttribute.h"
11
12#include <stddef.h>
13
14#ifdef __cplusplus
15extern "C" {
16#endif
17
46
64 const char* name);
65
86 const char* name,
87 const char* displayName,
88 enum SyscTensorType tensorType,
89 int isExtensive,
90 enum SyscLocation location,
91 enum SyscQuantityType quantityType,
92 enum SyscDataType dataType);
93
108 const char* name,
109 enum SyscTensorType tensorType,
110 int isExtensive,
111 enum SyscLocation location);
112
126 const char* name,
127 const char* displayName,
128 enum SyscTensorType tensorType,
129 int isExtensive,
130 enum SyscLocation location,
131 enum SyscQuantityType quantityType);
132
161 const char* name,
162 const char* displayName,
163 enum SyscLocation location,
164 enum SyscQuantityType quantityType);
165
169 SyscVariable variable,
170 SyscRealAttribute attribute);
171
175 SyscVariable variable,
176 SyscIntegerAttribute attribute);
177
181
185
189 SyscVariable variable,
190 size_t index);
191
195 SyscVariable variable,
196 size_t index);
197
200#ifdef __cplusplus
201}
202#endif
SyscTensorType
Provide an enum for variable tensor type.
SyscVariable syscGetVariable(const char *name)
Create variable to be used in a coupled analysis.
SyscError syscVariableAddIntegerAttribute(SyscVariable variable, SyscIntegerAttribute attribute)
Add integer-valued attribute to the variable.
SyscError syscVariableAddRealAttribute(SyscVariable variable, SyscRealAttribute attribute)
Add real-valued attribute to the variable.
SyscVariable syscGetVariableTE(const char *name, enum SyscTensorType tensorType, int isExtensive, enum SyscLocation location)
Create variable to be used in a coupled analysis.
size_t syscVariableGetNumRealAttributes(SyscVariable variable)
Get number of real-valued attributes.
SyscVariable syscGetVariableDTELQD(const char *name, const char *displayName, enum SyscTensorType tensorType, int isExtensive, enum SyscLocation location, enum SyscQuantityType quantityType, enum SyscDataType dataType)
Create variable to be used in a coupled analysis.
SyscRealAttribute syscVariableGetRealAttribute(SyscVariable variable, size_t index)
Return the real-valued attribute at the given index.
SyscVariable syscGetVariableTEQ(const char *name, const char *displayName, enum SyscTensorType tensorType, int isExtensive, enum SyscLocation location, enum SyscQuantityType quantityType)
Create variable to be used in a coupled analysis.
SyscQuantityType
Provide an enum for supported quantity types.
#define SYSC_STRING_LENGTH
Define maximum string length.
SyscVariable syscGetVariableQ(const char *name, const char *displayName, enum SyscLocation location, enum SyscQuantityType quantityType)
Create variable to be used in a coupled analysis.
SyscIntegerAttribute syscVariableGetIntegerAttribute(SyscVariable variable, size_t index)
Return the integer-valued attribute at the given index.
SyscLocation
Provide an enum for variable mesh locations.
size_t syscVariableGetNumIntegerAttributes(SyscVariable variable)
Get number of integer-valued attributes.
Provide a struct for detecting errors from the interface calls.
Provide a struct for an integer-valued attribute.
Provide a struct for a real-valued attribute.
Provide a struct for a System Coupling variable.
enum SyscTensorType tensorType
char displayName[SYSC_STRING_LENGTH]
char name[SYSC_STRING_LENGTH]
enum SyscLocation location
enum SyscQuantityType quantityType
enum SyscDataType dataType

Connect with Ansys