System Coupling C++ library 2023 R2

sysc::SetupInfo Struct Reference

Last update: 17.07.2025

Provide a structure for System Coupling setup information. More...

#include <CommonTypes.hpp>

Public Member Functions

 SetupInfo (enum AnalysisType analysisType)
 Provide a constructor for SetupInfo. More...
 
 SetupInfo (enum AnalysisType analysisType, bool restartsSupported)
 Provide a constructor for SetupInfo. More...
 
 SetupInfo (enum AnalysisType analysisType, bool restartsSupported, enum Dimension dimension)
 Provide a constructor for SetupInfo. More...
 

Public Attributes

AnalysisType analysisType {Steady}
 
bool restartsSupported {false}
 
Dimension dimension {Dimension::D3}
 

Detailed Description

Provide a structure for System Coupling setup information.

Definition at line 74 of file CommonTypes.hpp.

Constructor & Destructor Documentation

◆ SetupInfo() [1/3]

sysc::SetupInfo::SetupInfo ( enum AnalysisType  analysisType)
inline

Provide a constructor for SetupInfo.

Parameters
[in]analysisType- analysis type.

Definition at line 83 of file CommonTypes.hpp.

84 :
85 analysisType(analysisType){};
sysc::SetupInfo::analysisType
AnalysisType analysisType
Definition: CommonTypes.hpp:114

◆ SetupInfo() [2/3]

sysc::SetupInfo::SetupInfo ( enum AnalysisType  analysisType,
bool  restartsSupported 
)
inline

Provide a constructor for SetupInfo.

Parameters
[in]analysisType- analysis type.
[in]restartsSupported- flag indicating whether restarts are supported.

Definition at line 93 of file CommonTypes.hpp.

95 :
96 analysisType(analysisType),
97 restartsSupported(restartsSupported){};

◆ SetupInfo() [3/3]

sysc::SetupInfo::SetupInfo ( enum AnalysisType  analysisType,
bool  restartsSupported,
enum Dimension  dimension 
)
inline

Provide a constructor for SetupInfo.

Parameters
[in]analysisType- analysis type.
[in]restartsSupported- flag indicating whether restarts are supported.
[in]Dimension- dimension of the participant.

Definition at line 106 of file CommonTypes.hpp.

109 :
110 analysisType(analysisType),
111 restartsSupported(restartsSupported),
112 dimension(dimension){};
sysc::SetupInfo::dimension
Dimension dimension
Definition: CommonTypes.hpp:117

Member Data Documentation

◆ analysisType

AnalysisType sysc::SetupInfo::analysisType {Steady}

Analysis type.

Definition at line 114 of file CommonTypes.hpp.

◆ dimension

Dimension sysc::SetupInfo::dimension {Dimension::D3}

Participant dimension

Definition at line 117 of file CommonTypes.hpp.

◆ restartsSupported

bool sysc::SetupInfo::restartsSupported {false}

Flag indicating whether restarts are supported.

Definition at line 116 of file CommonTypes.hpp.

Connect with Ansys