System Coupling C++ library 2024 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.
 
 SetupInfo (enum AnalysisType analysisType, bool restartsSupported)
 Provide a constructor for SetupInfo.
 
 SetupInfo (enum AnalysisType analysisType, bool restartsSupported, enum Dimension dimension)
 Provide a constructor for SetupInfo.
 
 SetupInfo (enum AnalysisType analysisType, bool restartsSupported, enum Dimension dimension, enum TimeIntegration timeIntegration)
 Provide a constructor for SetupInfo.
 

Public Attributes

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

Detailed Description

Provide a structure for System Coupling setup information.

Definition at line 63 of file CommonTypes.hpp.

Constructor & Destructor Documentation

◆ SetupInfo() [1/4]

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

Provide a constructor for SetupInfo.

Parameters
[in]analysisType- analysis type.

Definition at line 72 of file CommonTypes.hpp.

73 :
74 analysisType(analysisType){};
sysc::SetupInfo::analysisType
AnalysisType analysisType
Definition CommonTypes.hpp:121

◆ SetupInfo() [2/4]

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 82 of file CommonTypes.hpp.

84 :
85 analysisType(analysisType),
86 restartsSupported(restartsSupported){};

◆ SetupInfo() [3/4]

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 95 of file CommonTypes.hpp.

98 :
99 analysisType(analysisType),
100 restartsSupported(restartsSupported),
101 dimension(dimension){};
sysc::SetupInfo::dimension
Dimension dimension
Definition CommonTypes.hpp:124

◆ SetupInfo() [4/4]

sysc::SetupInfo::SetupInfo ( enum AnalysisType  analysisType,
bool  restartsSupported,
enum Dimension  dimension,
enum TimeIntegration  timeIntegration 
)
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.
[in]TimeIntegration- time integration method to use.

Definition at line 111 of file CommonTypes.hpp.

115 :
116 analysisType(analysisType),
117 restartsSupported(restartsSupported),
118 dimension(dimension),
119 timeIntegration(timeIntegration){};
sysc::SetupInfo::timeIntegration
TimeIntegration timeIntegration
Definition CommonTypes.hpp:125

Member Data Documentation

◆ analysisType

AnalysisType sysc::SetupInfo::analysisType {Steady}

Analysis type.

Definition at line 121 of file CommonTypes.hpp.

121{Steady};

◆ dimension

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

Participant dimension

Definition at line 124 of file CommonTypes.hpp.

124{Dimension::D3};

◆ restartsSupported

bool sysc::SetupInfo::restartsSupported {false}

Flag indicating whether restarts are supported.

Definition at line 123 of file CommonTypes.hpp.

123{false};

◆ timeIntegration

TimeIntegration sysc::SetupInfo::timeIntegration {TimeIntegration::Implicit}

Time integration method

Definition at line 125 of file CommonTypes.hpp.

125{TimeIntegration::Implicit};

Connect with Ansys