## On this page

  

 

 # sysc::SetupInfo Struct Reference

 Last update: 17.07.2025 

Provide a structure for System Coupling setup information. [More...](structsysc_1_1SetupInfo.xhtml#details)

`#include <<a class="el" href="CommonTypes_8hpp_source.xhtml">CommonTypes.hpp</a>>`

## <a id="pub-methods" name="pub-methods"></a>Public Member Functions

 [SetupInfo](structsysc_1_1SetupInfo.xhtml#a33ac9fc553fff914c295acf695b61efc) (enum [AnalysisType](group__SystemCouplingParticipantAPIs.xhtml#gaffd523474fbd708f481a712f1841a967) [analysisType](structsysc_1_1SetupInfo.xhtml#a45906ec4c888b7d0fbd42066f318284b)) Provide a constructor for [SetupInfo](structsysc_1_1SetupInfo.xhtml "Provide a structure for System Coupling setup information.").   
  [SetupInfo](structsysc_1_1SetupInfo.xhtml#ab17e9d12184e6b93080eb71dac25a328) (enum [AnalysisType](group__SystemCouplingParticipantAPIs.xhtml#gaffd523474fbd708f481a712f1841a967) [analysisType](structsysc_1_1SetupInfo.xhtml#a45906ec4c888b7d0fbd42066f318284b), bool [restartsSupported](structsysc_1_1SetupInfo.xhtml#a46dc0b1c447b1534103f3f05455ee717)) Provide a constructor for [SetupInfo](structsysc_1_1SetupInfo.xhtml "Provide a structure for System Coupling setup information.").   
  [SetupInfo](structsysc_1_1SetupInfo.xhtml#a0808c997023319d5ec2e7eb623a172cd) (enum [AnalysisType](group__SystemCouplingParticipantAPIs.xhtml#gaffd523474fbd708f481a712f1841a967) [analysisType](structsysc_1_1SetupInfo.xhtml#a45906ec4c888b7d0fbd42066f318284b), bool [restartsSupported](structsysc_1_1SetupInfo.xhtml#a46dc0b1c447b1534103f3f05455ee717), enum [Dimension](group__SystemCouplingParticipantAPIs.xhtml#ga47c8e4142175574918b84d336780cc7c) [dimension](structsysc_1_1SetupInfo.xhtml#a9d7c8f147afec2b6269bec443296291d)) Provide a constructor for [SetupInfo](structsysc_1_1SetupInfo.xhtml "Provide a structure for System Coupling setup information.").   
  [SetupInfo](structsysc_1_1SetupInfo.xhtml#a2e9ea589149b80ffa4af670fb42defea) (enum [AnalysisType](group__SystemCouplingParticipantAPIs.xhtml#gaffd523474fbd708f481a712f1841a967) [analysisType](structsysc_1_1SetupInfo.xhtml#a45906ec4c888b7d0fbd42066f318284b), bool [restartsSupported](structsysc_1_1SetupInfo.xhtml#a46dc0b1c447b1534103f3f05455ee717), enum [Dimension](group__SystemCouplingParticipantAPIs.xhtml#ga47c8e4142175574918b84d336780cc7c) [dimension](structsysc_1_1SetupInfo.xhtml#a9d7c8f147afec2b6269bec443296291d), enum [TimeIntegration](group__SystemCouplingParticipantAPIs.xhtml#gad13ee117d1f4408660fa2e70ee27b454) [timeIntegration](structsysc_1_1SetupInfo.xhtml#a11b9b07a31b9efe30b1ff2472b7a99e2)) Provide a constructor for [SetupInfo](structsysc_1_1SetupInfo.xhtml "Provide a structure for System Coupling setup information.").   
 ## <a id="pub-attribs" name="pub-attribs"></a>Public Attributes

[AnalysisType](group__SystemCouplingParticipantAPIs.xhtml#gaffd523474fbd708f481a712f1841a967) [analysisType](structsysc_1_1SetupInfo.xhtml#a45906ec4c888b7d0fbd42066f318284b) {Steady} bool [restartsSupported](structsysc_1_1SetupInfo.xhtml#a46dc0b1c447b1534103f3f05455ee717) {false} [Dimension](group__SystemCouplingParticipantAPIs.xhtml#ga47c8e4142175574918b84d336780cc7c) [dimension](structsysc_1_1SetupInfo.xhtml#a9d7c8f147afec2b6269bec443296291d) {Dimension::D3} [TimeIntegration](group__SystemCouplingParticipantAPIs.xhtml#gad13ee117d1f4408660fa2e70ee27b454) [timeIntegration](structsysc_1_1SetupInfo.xhtml#a11b9b07a31b9efe30b1ff2472b7a99e2) {TimeIntegration::Implicit} <a id="details" name="details"></a>## Detailed Description

Provide a structure for System Coupling setup information.

Definition at line [63](CommonTypes_8hpp_source.xhtml#l00063) of file [CommonTypes.hpp](CommonTypes_8hpp_source.xhtml).



## Constructor &amp; Destructor Documentation

<a id="a33ac9fc553fff914c295acf695b61efc" name="a33ac9fc553fff914c295acf695b61efc"></a>## [◆ ](#a33ac9fc553fff914c295acf695b61efc)SetupInfo() \[1/4\]

 sysc::SetupInfo::SetupInfo  ( enum [AnalysisType](group__SystemCouplingParticipantAPIs.xhtml#gaffd523474fbd708f481a712f1841a967)  *analysisType*)   inline 

Provide a constructor for [SetupInfo](structsysc_1_1SetupInfo.xhtml "Provide a structure for System Coupling setup information.").

Parameters \[in\]analysisType- analysis type. Definition at line [72](CommonTypes_8hpp_source.xhtml#l00072) of file [CommonTypes.hpp](CommonTypes_8hpp_source.xhtml).

 73 :

 74 [analysisType](structsysc_1_1SetupInfo.xhtml#a45906ec4c888b7d0fbd42066f318284b)([analysisType](structsysc_1_1SetupInfo.xhtml#a45906ec4c888b7d0fbd42066f318284b)){};

[sysc::SetupInfo::analysisType](structsysc_1_1SetupInfo.xhtml#a45906ec4c888b7d0fbd42066f318284b)

AnalysisType analysisType

**Definition** [CommonTypes.hpp:121](CommonTypes_8hpp_source.xhtml#l00121)









<a id="ab17e9d12184e6b93080eb71dac25a328" name="ab17e9d12184e6b93080eb71dac25a328"></a>## [◆ ](#ab17e9d12184e6b93080eb71dac25a328)SetupInfo() \[2/4\]

 sysc::SetupInfo::SetupInfo  ( enum [AnalysisType](group__SystemCouplingParticipantAPIs.xhtml#gaffd523474fbd708f481a712f1841a967)  *analysisType*,    bool  *restartsSupported*   )   inline 

Provide a constructor for [SetupInfo](structsysc_1_1SetupInfo.xhtml "Provide a structure for System Coupling setup information.").

Parameters \[in\]analysisType- analysis type. \[in\]restartsSupported- flag indicating whether restarts are supported. Definition at line [82](CommonTypes_8hpp_source.xhtml#l00082) of file [CommonTypes.hpp](CommonTypes_8hpp_source.xhtml).

 84 :

 85 [analysisType](structsysc_1_1SetupInfo.xhtml#a45906ec4c888b7d0fbd42066f318284b)([analysisType](structsysc_1_1SetupInfo.xhtml#a45906ec4c888b7d0fbd42066f318284b)),

 86 [restartsSupported](structsysc_1_1SetupInfo.xhtml#a46dc0b1c447b1534103f3f05455ee717)([restartsSupported](structsysc_1_1SetupInfo.xhtml#a46dc0b1c447b1534103f3f05455ee717)){};

[sysc::SetupInfo::restartsSupported](structsysc_1_1SetupInfo.xhtml#a46dc0b1c447b1534103f3f05455ee717)

bool restartsSupported

**Definition** [CommonTypes.hpp:123](CommonTypes_8hpp_source.xhtml#l00123)









<a id="a0808c997023319d5ec2e7eb623a172cd" name="a0808c997023319d5ec2e7eb623a172cd"></a>## [◆ ](#a0808c997023319d5ec2e7eb623a172cd)SetupInfo() \[3/4\]

 sysc::SetupInfo::SetupInfo  ( enum [AnalysisType](group__SystemCouplingParticipantAPIs.xhtml#gaffd523474fbd708f481a712f1841a967)  *analysisType*,    bool  *restartsSupported*,    enum [Dimension](group__SystemCouplingParticipantAPIs.xhtml#ga47c8e4142175574918b84d336780cc7c)  *dimension*   )   inline 

Provide a constructor for [SetupInfo](structsysc_1_1SetupInfo.xhtml "Provide a structure for System Coupling setup information.").

Parameters \[in\]analysisType- analysis type. \[in\]restartsSupported- flag indicating whether restarts are supported. \[in\]Dimension- dimension of the participant. Definition at line [95](CommonTypes_8hpp_source.xhtml#l00095) of file [CommonTypes.hpp](CommonTypes_8hpp_source.xhtml).

 98 :

 99 [analysisType](structsysc_1_1SetupInfo.xhtml#a45906ec4c888b7d0fbd42066f318284b)([analysisType](structsysc_1_1SetupInfo.xhtml#a45906ec4c888b7d0fbd42066f318284b)),

 100 [restartsSupported](structsysc_1_1SetupInfo.xhtml#a46dc0b1c447b1534103f3f05455ee717)([restartsSupported](structsysc_1_1SetupInfo.xhtml#a46dc0b1c447b1534103f3f05455ee717)),

 101 [dimension](structsysc_1_1SetupInfo.xhtml#a9d7c8f147afec2b6269bec443296291d)([dimension](structsysc_1_1SetupInfo.xhtml#a9d7c8f147afec2b6269bec443296291d)){};

[sysc::SetupInfo::dimension](structsysc_1_1SetupInfo.xhtml#a9d7c8f147afec2b6269bec443296291d)

Dimension dimension

**Definition** [CommonTypes.hpp:124](CommonTypes_8hpp_source.xhtml#l00124)









<a id="a2e9ea589149b80ffa4af670fb42defea" name="a2e9ea589149b80ffa4af670fb42defea"></a>## [◆ ](#a2e9ea589149b80ffa4af670fb42defea)SetupInfo() \[4/4\]

 sysc::SetupInfo::SetupInfo  ( enum [AnalysisType](group__SystemCouplingParticipantAPIs.xhtml#gaffd523474fbd708f481a712f1841a967)  *analysisType*,    bool  *restartsSupported*,    enum [Dimension](group__SystemCouplingParticipantAPIs.xhtml#ga47c8e4142175574918b84d336780cc7c)  *dimension*,    enum [TimeIntegration](group__SystemCouplingParticipantAPIs.xhtml#gad13ee117d1f4408660fa2e70ee27b454)  *timeIntegration*   )   inline 

Provide a constructor for [SetupInfo](structsysc_1_1SetupInfo.xhtml "Provide a structure for System Coupling setup information.").

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](CommonTypes_8hpp_source.xhtml#l00111) of file [CommonTypes.hpp](CommonTypes_8hpp_source.xhtml).

 115 :

 116 [analysisType](structsysc_1_1SetupInfo.xhtml#a45906ec4c888b7d0fbd42066f318284b)([analysisType](structsysc_1_1SetupInfo.xhtml#a45906ec4c888b7d0fbd42066f318284b)),

 117 [restartsSupported](structsysc_1_1SetupInfo.xhtml#a46dc0b1c447b1534103f3f05455ee717)([restartsSupported](structsysc_1_1SetupInfo.xhtml#a46dc0b1c447b1534103f3f05455ee717)),

 118 [dimension](structsysc_1_1SetupInfo.xhtml#a9d7c8f147afec2b6269bec443296291d)([dimension](structsysc_1_1SetupInfo.xhtml#a9d7c8f147afec2b6269bec443296291d)),

 119 [timeIntegration](structsysc_1_1SetupInfo.xhtml#a11b9b07a31b9efe30b1ff2472b7a99e2)([timeIntegration](structsysc_1_1SetupInfo.xhtml#a11b9b07a31b9efe30b1ff2472b7a99e2)){};

[sysc::SetupInfo::timeIntegration](structsysc_1_1SetupInfo.xhtml#a11b9b07a31b9efe30b1ff2472b7a99e2)

TimeIntegration timeIntegration

**Definition** [CommonTypes.hpp:125](CommonTypes_8hpp_source.xhtml#l00125)









## Member Data Documentation

<a id="a45906ec4c888b7d0fbd42066f318284b" name="a45906ec4c888b7d0fbd42066f318284b"></a>## [◆ ](#a45906ec4c888b7d0fbd42066f318284b)analysisType

 [AnalysisType](group__SystemCouplingParticipantAPIs.xhtml#gaffd523474fbd708f481a712f1841a967) sysc::SetupInfo::analysisType {Steady}

Analysis type.

Definition at line [121](CommonTypes_8hpp_source.xhtml#l00121) of file [CommonTypes.hpp](CommonTypes_8hpp_source.xhtml).

 121{Steady}; 







<a id="a9d7c8f147afec2b6269bec443296291d" name="a9d7c8f147afec2b6269bec443296291d"></a>## [◆ ](#a9d7c8f147afec2b6269bec443296291d)dimension

 [Dimension](group__SystemCouplingParticipantAPIs.xhtml#ga47c8e4142175574918b84d336780cc7c) sysc::SetupInfo::dimension {Dimension::D3}

Participant dimension

Definition at line [124](CommonTypes_8hpp_source.xhtml#l00124) of file [CommonTypes.hpp](CommonTypes_8hpp_source.xhtml).

 124{Dimension::D3}; 







<a id="a46dc0b1c447b1534103f3f05455ee717" name="a46dc0b1c447b1534103f3f05455ee717"></a>## [◆ ](#a46dc0b1c447b1534103f3f05455ee717)restartsSupported

 bool sysc::SetupInfo::restartsSupported {false}

Flag indicating whether restarts are supported.

Definition at line [123](CommonTypes_8hpp_source.xhtml#l00123) of file [CommonTypes.hpp](CommonTypes_8hpp_source.xhtml).

 123{false};







<a id="a11b9b07a31b9efe30b1ff2472b7a99e2" name="a11b9b07a31b9efe30b1ff2472b7a99e2"></a>## [◆ ](#a11b9b07a31b9efe30b1ff2472b7a99e2)timeIntegration

 [TimeIntegration](group__SystemCouplingParticipantAPIs.xhtml#gad13ee117d1f4408660fa2e70ee27b454) sysc::SetupInfo::timeIntegration {TimeIntegration::Implicit}

Time integration method

Definition at line [125](CommonTypes_8hpp_source.xhtml#l00125) of file [CommonTypes.hpp](CommonTypes_8hpp_source.xhtml).

 125{TimeIntegration::Implicit};