System Coupling C library 2025 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
15 extern "C" {
16 #endif
17 
37 typedef struct SyscVariable {
38  char name[SYSC_STRING_LENGTH];
39  enum SyscQuantityType quantityType;
40  enum SyscLocation location;
41  char displayName[SYSC_STRING_LENGTH];
42  enum SyscTensorType tensorType;
43  int isExtensive;
44  enum SyscDataType dataType;
45 } SyscVariable;
46 
63  SyscVariable syscGetVariable(
64  const char* name);
65 
85  SyscVariable syscGetVariableDTELQD(
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 
107  SyscVariable syscGetVariableTE(
108  const char* name,
109  enum SyscTensorType tensorType,
110  int isExtensive,
111  enum SyscLocation location);
112 
125  SyscVariable syscGetVariableTEQ(
126  const char* name,
127  const char* displayName,
128  enum SyscTensorType tensorType,
129  int isExtensive,
130  enum SyscLocation location,
131  enum SyscQuantityType quantityType);
132 
160  SyscVariable syscGetVariableQ(
161  const char* name,
162  const char* displayName,
163  enum SyscLocation location,
164  enum SyscQuantityType quantityType);
165 
168 SyscError syscVariableAddRealAttribute(
169  SyscVariable variable,
170  SyscRealAttribute attribute);
171 
174 SyscError syscVariableAddIntegerAttribute(
175  SyscVariable variable,
176  SyscIntegerAttribute attribute);
177 
180 size_t syscVariableGetNumRealAttributes(SyscVariable variable);
181 
184 size_t syscVariableGetNumIntegerAttributes(SyscVariable variable);
185 
188 SyscRealAttribute syscVariableGetRealAttribute(
189  SyscVariable variable,
190  size_t index);
191 
194 SyscIntegerAttribute syscVariableGetIntegerAttribute(
195  SyscVariable variable,
196  size_t index);
197 
200 #ifdef __cplusplus
201 }
202 #endif
SyscTensorType
SyscTensorType
Provide an enum for variable tensor type.
Definition: syscCommonTypes.h:32
syscGetVariable
SyscVariable syscGetVariable(const char *name)
Create variable to be used in a coupled analysis.
syscVariableAddIntegerAttribute
SyscError syscVariableAddIntegerAttribute(SyscVariable variable, SyscIntegerAttribute attribute)
Add integer-valued attribute to the variable.
syscVariableAddRealAttribute
SyscError syscVariableAddRealAttribute(SyscVariable variable, SyscRealAttribute attribute)
Add real-valued attribute to the variable.
syscGetVariableTE
SyscVariable syscGetVariableTE(const char *name, enum SyscTensorType tensorType, int isExtensive, enum SyscLocation location)
Create variable to be used in a coupled analysis.
syscVariableGetNumRealAttributes
size_t syscVariableGetNumRealAttributes(SyscVariable variable)
Get number of real-valued attributes.
syscGetVariableDTELQD
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.
SyscVariable
struct SyscVariable SyscVariable
Provide a struct for a System Coupling variable.
syscVariableGetRealAttribute
SyscRealAttribute syscVariableGetRealAttribute(SyscVariable variable, size_t index)
Return the real-valued attribute at the given index.
syscGetVariableTEQ
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
SyscQuantityType
Provide an enum for supported quantity types.
Definition: syscCommonTypes.h:91
SYSC_STRING_LENGTH
#define SYSC_STRING_LENGTH
Define maximum string length.
Definition: syscCommonTypes.h:23
syscGetVariableQ
SyscVariable syscGetVariableQ(const char *name, const char *displayName, enum SyscLocation location, enum SyscQuantityType quantityType)
Create variable to be used in a coupled analysis.
syscVariableGetIntegerAttribute
SyscIntegerAttribute syscVariableGetIntegerAttribute(SyscVariable variable, size_t index)
Return the integer-valued attribute at the given index.
SyscLocation
SyscLocation
Provide an enum for variable mesh locations.
Definition: syscCommonTypes.h:26
syscVariableGetNumIntegerAttributes
size_t syscVariableGetNumIntegerAttributes(SyscVariable variable)
Get number of integer-valued attributes.
SyscError
Provide a struct for detecting errors from the interface calls.
Definition: syscCommonTypes.h:137
SyscIntegerAttribute
Provide a struct for an integer-valued attribute.
Definition: syscAttribute.h:70
SyscRealAttribute
Provide a struct for a real-valued attribute.
Definition: syscAttribute.h:24
SyscVariable
Provide a struct for a System Coupling variable.
Definition: syscVariable.h:37
SyscVariable::tensorType
enum SyscTensorType tensorType
Definition: syscVariable.h:42
SyscVariable::displayName
char displayName[SYSC_STRING_LENGTH]
Definition: syscVariable.h:41
SyscVariable::name
char name[SYSC_STRING_LENGTH]
Definition: syscVariable.h:38
SyscVariable::location
enum SyscLocation location
Definition: syscVariable.h:40
SyscVariable::quantityType
enum SyscQuantityType quantityType
Definition: syscVariable.h:39
SyscVariable::dataType
enum SyscDataType dataType
Definition: syscVariable.h:44

Connect with Ansys