Structure sysc::SetupInfo
Definition: CommonTypes.hpp (line 64)
Provide a structure for System Coupling setup information.
Members
- analysisType
- dimension
- participantType
- restartsSupported
- SetupInfo
- SetupInfo
- SetupInfo
- SetupInfo
- SetupInfo
- SetupInfo
- timeIntegration
Public attributes
Variable analysisType
Definition: CommonTypes.hpp (line 143)
AnalysisType sysc::SetupInfo::analysisType {Steady}
Analysis type.
Type: AnalysisType
Variable restartsSupported
Definition: CommonTypes.hpp (line 145)
bool sysc::SetupInfo::restartsSupported {false}
Flag indicating whether restarts are supported.
Type: bool
Variable dimension
Definition: CommonTypes.hpp (line 146)
Dimension sysc::SetupInfo::dimension {Dimension::D3}
Participant dimension
Type: Dimension
Variable timeIntegration
Definition: CommonTypes.hpp (line 147)
TimeIntegration sysc::SetupInfo::timeIntegration {TimeIntegration::Implicit}
Time integration method
Type: TimeIntegration
Variable participantType
Definition: CommonTypes.hpp (line 148)
ParticipantType sysc::SetupInfo::participantType {ParticipantType::DEFAULT}
Participant type
Type: ParticipantType
Public functions
Function SetupInfo
sysc::SetupInfo::SetupInfo()=default
Return type:
Function SetupInfo
sysc::SetupInfo::SetupInfo(enum AnalysisType analysisType)
Provide a constructor for SetupInfo.
Parameters:
- analysisType: - analysis type.
Parameters:
- enum AnalysisType analysisType
Return type:
Function SetupInfo
sysc::SetupInfo::SetupInfo(enum AnalysisType analysisType, bool restartsSupported)
Provide a constructor for SetupInfo.
Parameters:
- analysisType: - analysis type.
- restartsSupported: - flag indicating whether restarts are supported.
Parameters:
- enum AnalysisType analysisType
- bool restartsSupported
Return type:
Function SetupInfo
sysc::SetupInfo::SetupInfo(enum AnalysisType analysisType, bool restartsSupported, enum Dimension dimension)
Provide a constructor for SetupInfo.
Parameters:
- analysisType: - analysis type.
- restartsSupported: - flag indicating whether restarts are supported.
- Dimension: - dimension of the participant.
Parameters:
- enum AnalysisType analysisType
- bool restartsSupported
- enum Dimension dimension
Return type:
Function SetupInfo
sysc::SetupInfo::SetupInfo(enum AnalysisType analysisType, bool restartsSupported, enum Dimension dimension, enum TimeIntegration timeIntegration)
Provide a constructor for SetupInfo.
Parameters:
- analysisType: - analysis type.
- restartsSupported: - flag indicating whether restarts are supported.
- Dimension: - dimension of the participant.
- TimeIntegration: - time integration method to use.
Parameters:
- enum AnalysisType analysisType
- bool restartsSupported
- enum Dimension dimension
- enum TimeIntegration timeIntegration
Return type:
Function SetupInfo
sysc::SetupInfo::SetupInfo(enum AnalysisType analysisType, bool restartsSupported, enum Dimension dimension, enum TimeIntegration timeIntegration, enum ParticipantType participantType)
Provide a constructor for SetupInfo.
Parameters:
- analysisType: - analysis type.
- restartsSupported: - flag indicating whether restarts are supported.
- Dimension: - dimension of the participant.
- TimeIntegration: - time integration method to use.
- ParticipantType: - participant type.
Parameters:
- enum AnalysisType analysisType
- bool restartsSupported
- enum Dimension dimension
- enum TimeIntegration timeIntegration
- enum ParticipantType participantType
Return type: