syscCommonTypes.h | Ansys Developer Portal

 /*
 * 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 
 };
  
 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  
 };
  
 typedef void* SyscOpaqueDataAccess; 
 /******************************* Setup info **********************************/
  
 typedef struct SyscSetupInfo {
   enum SyscAnalysisType analysisType;       
   int restartsSupported;                    
   enum SyscDimension dimension;             
   enum SyscTimeIntegration timeIntegration; 
 } 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);
  
 /**************************** 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];
   char buildInformation[SYSC_STRING_LENGTH];
   char transcriptFilename[SYSC_STRING_LENGTH];
 } SyscParticipantInfo;
  
 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
System Coupling C library 2025 R1

syscCommonTypes

Connect with Ansys
