File syscCommonTypes.h
Last update: 09.03.2026Location: syscCommonTypes.h
Classes
- SyscDimensionality
- SyscTimeStep
- SyscSolutionControl
- SyscError
- SyscSetupInfo
- SyscSetupFileInfo
- SyscResultsInfo
- SyscParticipantInfo
Includes
- SystemCouplingParticipant/LibraryType.hpp
- SystemCouplingParticipant/syscElementTypes.h
- <stddef.h>
graph LR
1["syscCommonTypes.h"]
click 1 "syscCommonTypes_8h.md#syscCommonTypes_8h"
1 --> 2
1 --> 3
1 --> 4
2["SystemCouplingParticipant/LibraryType.hpp"]
3["SystemCouplingParticipant/syscElementTypes.h"]
4["stddef.h"]
Macros
Macro SYSC_STRING_LENGTH
#define SYSC_STRING_LENGTH
Enumeration types
Enumeration type SyscLocation
enum SyscLocation { /* ... */ }
Enumeration type SyscTensorType
enum SyscTensorType { /* ... */ }
Enumeration type SyscTopology
enum SyscTopology { /* ... */ }
Enumeration type SyscRegionDiscretizationType
enum SyscRegionDiscretizationType { /* ... */ }
Enumeration type SyscInterfaceSide
enum SyscInterfaceSide { /* ... */ }
Enumeration type SyscDimension
enum SyscDimension { /* ... */ }
Enumeration type SyscTimeIntegration
enum SyscTimeIntegration { /* ... */ }
Enumeration type SyscQuantityType
enum SyscQuantityType { /* ... */ }
Enumeration type SyscDataType
enum SyscDataType { /* ... */ }
Enumeration type SyscConvergenceStatus
enum SyscConvergenceStatus { /* ... */ }
Enumeration type SyscAnalysisType
enum SyscAnalysisType { /* ... */ }
Enumeration type SyscPrimitiveType
enum SyscPrimitiveType { /* ... */ }
Enumeration type SyscParticipantType
enum SyscParticipantType { /* ... */ }
Typedefs
Typedef SyscParticipantInfo
Definition: syscCommonTypes.h (line 371)
typedef struct SyscParticipantInfo SyscParticipantInfo
Return type: struct SyscParticipantInfo
Typedef SyscSolutionControl
Typedef SyscOpaqueDataAccess
Typedef SyscSetupInfo
Typedef SyscSetupFileInfo
Typedef SyscResultsInfo
Functions
Function syscGetParticipantInfoDefault
SyscParticipantInfo syscGetParticipantInfoDefault()
Provide a function to get & construct a default SyscParticipantInfo struct.
Returns:
SyscParticipantInfo A SyscParticipantInfo struct
Return type: SyscParticipantInfo
Function syscGetParticipantInfo
SyscParticipantInfo syscGetParticipantInfo(const char *scHost, unsigned short scPort, const char *participantName)
Provide a function to get & construct a SyscParticipantInfo struct if it doesn't exist.
Parameters:
- scHost: Name of the host on which System Coupling is running.
- scPort: Port number on which System Coupling is listening for participant connections.
- participantName: Name of this participant (e.g. "MAPDL-1").
- buildInformation: Information about the build of this participant solver.
- isCosimulation: Flag signifying if the simulation is a cosimulation.
- transcriptFilename: The filename to be given to the output participant transcript.
Returns:
SyscParticipantInfo A SyscParticipantInfo containing minimal attributes to connect to System Coupling
Parameters:
- const char * scHost
- unsigned short scPort
- const char * participantName
Return type: SyscParticipantInfo
Function syscGetParticipantInfoB
SyscParticipantInfo syscGetParticipantInfoB(const char *scHost, unsigned short scPort, const char *participantName, const char *buildInformation)
Parameters:
- const char * scHost
- unsigned short scPort
- const char * participantName
- const char * buildInformation
Return type: SyscParticipantInfo
Function syscGetParticipantInfoBT
SyscParticipantInfo syscGetParticipantInfoBT(const char *scHost, unsigned short scPort, const char *participantName, const char *buildInformation, const char *transcriptFileName)
Parameters:
- const char * scHost
- unsigned short scPort
- const char * participantName
- const char * buildInformation
- const char * transcriptFileName
Return type: SyscParticipantInfo
Function syscGetDimensionality
Function syscGetSyscError
Function syscGetSetupInfo
Function syscGetSetupInfoA
Function syscGetSetupInfoAR
Function syscGetSetupInfoARD
Function syscGetSetupInfoARDT
Function syscGetSetupInfoARDTP
Function syscGetSetupFileInfo
Function syscGetResultsInfo
Source
/*
* Copyright ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited.
*/
#pragma once
#include "SystemCouplingParticipant/LibraryType.hpp"
#include "SystemCouplingParticipant/syscElementTypes.h"
#include <stddef.h>
#ifdef __cplusplus
extern "C" {
#endif
#define SYSC_STRING_LENGTH 256
enum SyscLocation {
SyscNode = 0,
SyscElement = 1
};
enum SyscTensorType {
SyscScalar = 0,
SyscVector = 1
};
enum SyscTopology {
SyscSurface = 2,
SyscVolume = 3
};
enum SyscRegionDiscretizationType {
SyscMeshRegion = 0,
SyscPointCloudRegion = 1
};
enum SyscInterfaceSide {
SyscInterfaceSide_One = 1,
SyscInterfaceSide_Two = 2
};
enum SyscDimension {
SyscD2 = 2,
SyscD3 = 3
};
enum SyscTimeIntegration {
SyscImplicit = 0,
SyscExplicit = 1
};
typedef struct {
double length;
double time;
double mass;
double temperature;
double amountOfSubstance;
double current;
double luminousIntensity;
double angle;
} SyscDimensionality;
SyscDimensionality syscGetDimensionality();
enum SyscQuantityType {
SyscUnspecified = 0,
SyscForce = 1,
SyscIncrementalDisplacement = 2,
SyscTemperature = 3,
SyscHeatRate = 4,
SyscHeatTransferCoefficient = 5,
SyscConvectionReferenceTemperature = 6,
SyscModeShape = 7,
SyscElectricalConductivity = 8
};
enum SyscDataType {
SyscDataType_Real = 0,
SyscDataType_Complex = 1
};
enum SyscConvergenceStatus {
SyscDiverging = -1,
SyscNotYetConverged = 0,
SyscConverged = 1,
SyscComplete = 2,
SyscNotEvaluated = 3
};
enum SyscAnalysisType {
SyscSteady = 0,
SyscTransient = 1,
SyscMapping = 2
};
typedef struct {
int timeStepNumber;
double startTime;
double timeStepSize;
} SyscTimeStep;
typedef struct SyscSolutionControl {
int minimumIterations;
int maximumIterations;
} SyscSolutionControl;
typedef struct {
int retcode;
char message[SYSC_STRING_LENGTH];
} SyscError;
SyscError syscGetSyscError(int retcode, const char* message);
enum SyscPrimitiveType {
SyscFloat = 0,
SyscDouble = 1,
SyscInt32 = 2,
SyscInt64 = 3,
SyscUnsignedInt16 = 4,
SyscUnsignedInt64 = 5
};
enum SyscParticipantType {
SyscDEFAULT = 0,
SyscCFX = 1,
SyscFLUENT = 2,
SyscMAPDL = 3,
SyscAEDT = 4,
SyscFMU = 5,
SyscFMU_PROXY = 6,
SyscEXTERNALDATA = 7,
SyscFORTE = 8,
SyscDEFAULT_SRV = 9,
SyscMECH_SRV = 10,
SyscCFD_SRV = 11,
SyscSCDT_SRV = 12,
SyscTHERMAL_DESKTOP = 13,
SyscLS_DYNA = 14,
SyscROCKY = 15
};
typedef void* SyscOpaqueDataAccess;
/******************************* Setup info **********************************/
typedef struct SyscSetupInfo {
enum SyscAnalysisType analysisType;
int restartsSupported;
enum SyscDimension dimension;
enum SyscTimeIntegration timeIntegration;
enum SyscParticipantType participantType;
} SyscSetupInfo;
SyscSetupInfo syscGetSetupInfo();
SyscSetupInfo syscGetSetupInfoA(
enum SyscAnalysisType analysisType);
SyscSetupInfo syscGetSetupInfoAR(
enum SyscAnalysisType analysisType,
int restartsSupported);
SyscSetupInfo syscGetSetupInfoARD(
enum SyscAnalysisType analysisType,
int restartsSupported,
enum SyscDimension dimension);
SyscSetupInfo syscGetSetupInfoARDT(
enum SyscAnalysisType analysisType,
int restartsSupported,
enum SyscDimension dimension,
enum SyscTimeIntegration timeIntegration);
SyscSetupInfo syscGetSetupInfoARDTP(
enum SyscAnalysisType analysisType,
int restartsSupported,
enum SyscDimension dimension,
enum SyscTimeIntegration timeIntegration,
enum SyscParticipantType participantType);
/**************************** Setup file info ********************************/
typedef struct SyscSetupFileInfo {
char setupFileName[SYSC_STRING_LENGTH];
int restartsSupported;
} SyscSetupFileInfo;
SyscSetupFileInfo syscGetSetupFileInfo(
const char* setupFileName);
/***************************** Results info **********************************/
typedef struct SyscResultsInfo {
char baseFileName[SYSC_STRING_LENGTH];
} SyscResultsInfo;
SyscResultsInfo syscGetResultsInfo(const char* baseFileName);
typedef struct SyscParticipantInfo {
char scHost[SYSC_STRING_LENGTH];
unsigned short scPort;
char participantName[SYSC_STRING_LENGTH];
int isCosimulation;
char buildInformation[SYSC_STRING_LENGTH];
char transcriptFilename[SYSC_STRING_LENGTH];
size_t numApps;
char myHostName[SYSC_STRING_LENGTH];
} SyscParticipantInfo;
SyscParticipantInfo syscGetParticipantInfoDefault();
SyscParticipantInfo syscGetParticipantInfo(
const char* scHost,
unsigned short scPort,
const char* participantName);
SyscParticipantInfo syscGetParticipantInfoB(
const char* scHost,
unsigned short scPort,
const char* participantName,
const char* buildInformation);
SyscParticipantInfo syscGetParticipantInfoBT(
const char* scHost,
unsigned short scPort,
const char* participantName,
const char* buildInformation,
const char* transcriptFileName);
#ifdef __cplusplus
}
#endif