## On this page

  

 

 # CommonTypes

 Last update: 17.07.2025 

<a id="l00001" name="l00001"></a> 1/\*

<a id="l00002" name="l00002"></a> 2\* Copyright 2023 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited.

<a id="l00003" name="l00003"></a> 3\*/

<a id="l00004" name="l00004"></a> 4 

<a id="l00005" name="l00005"></a> 5\#pragma once

<a id="l00006" name="l00006"></a> 6 

<a id="l00007" name="l00007"></a> 7\#include "SystemCouplingParticipant/CommonSettings.hpp"

<a id="l00008" name="l00008"></a> 8\#include "SystemCouplingParticipant/ElementTypes.hpp"

<a id="l00009" name="l00009"></a> 9 

<a id="l00010" name="l00010"></a> 10\#include &lt;string&gt;

<a id="l00011" name="l00011"></a> 11 

<a id="l00012" name="l00012"></a> 12namespace sysc {

<a id="l00013" name="l00013"></a> 13 

<a id="l00025" name="l00025"></a>[ 25](group__SystemCouplingParticipantAPIs.xhtml#ga0b8801743579159eb41cf07d8372a734)enum [ConvergenceStatus](group__SystemCouplingParticipantAPIs.xhtml#ga0b8801743579159eb41cf07d8372a734) {

<a id="l00026" name="l00026"></a> 26 Diverging = -1,

<a id="l00027" name="l00027"></a> 27 NotYetConverged = 0,

<a id="l00028" name="l00028"></a> 28 Converged = 1,

<a id="l00029" name="l00029"></a> 29 Complete = 2,

<a id="l00030" name="l00030"></a> 30 NotEvaluated = 3

<a id="l00031" name="l00031"></a> 31};

<a id="l00032" name="l00032"></a> 32 

<a id="l00034" name="l00034"></a>[ 34](group__SystemCouplingParticipantAPIs.xhtml#ga8c2b9557240fd9b2f908c98e3b1b27d3)enum class [DataType](group__SystemCouplingParticipantAPIs.xhtml#ga8c2b9557240fd9b2f908c98e3b1b27d3) {

<a id="l00035" name="l00035"></a> 35 Real = 0,

<a id="l00036" name="l00036"></a> 36 Complex = 1

<a id="l00037" name="l00037"></a> 37};

<a id="l00038" name="l00038"></a> 38 

<a id="l00040" name="l00040"></a>[ 40](structsysc_1_1TimeStep.xhtml)struct [TimeStep](structsysc_1_1TimeStep.xhtml) {

<a id="l00041" name="l00041"></a>[ 41](structsysc_1_1TimeStep.xhtml#ab8fbdd8e8dd4384d385c3190b11a2ccf) int [timeStepNumber](structsysc_1_1TimeStep.xhtml#ab8fbdd8e8dd4384d385c3190b11a2ccf){0}; 

<a id="l00042" name="l00042"></a>[ 42](structsysc_1_1TimeStep.xhtml#a115810021ec63279be6a82d5deb853c2) double [startTime](structsysc_1_1TimeStep.xhtml#a115810021ec63279be6a82d5deb853c2){0.0}; 

<a id="l00043" name="l00043"></a>[ 43](structsysc_1_1TimeStep.xhtml#a91d6e07b37c9c461ddfc8e85965321b2) double [timeStepSize](structsysc_1_1TimeStep.xhtml#a91d6e07b37c9c461ddfc8e85965321b2){0.0}; 

<a id="l00046" name="l00046"></a>[ 46](structsysc_1_1TimeStep.xhtml#a97ce4b55faaefbe7618a16b0363c092e) [TimeStep](structsysc_1_1TimeStep.xhtml#a97ce4b55faaefbe7618a16b0363c092e)() = default;

<a id="l00047" name="l00047"></a> 47 

<a id="l00049" name="l00049"></a>[ 49](structsysc_1_1TimeStep.xhtml#a906537e7fc2612dc3d4636c5162eb5f7) [TimeStep](structsysc_1_1TimeStep.xhtml#a906537e7fc2612dc3d4636c5162eb5f7)(const [TimeStep](structsysc_1_1TimeStep.xhtml)&amp;) = default;

<a id="l00050" name="l00050"></a> 50 

<a id="l00052" name="l00052"></a>[ 52](structsysc_1_1TimeStep.xhtml#ae918242dae80573ecbeb91968d8df048) [TimeStep](structsysc_1_1TimeStep.xhtml#ae918242dae80573ecbeb91968d8df048)([TimeStep](structsysc_1_1TimeStep.xhtml)&amp;&amp;) = default;

<a id="l00053" name="l00053"></a> 53 

<a id="l00055" name="l00055"></a>[ 55](structsysc_1_1TimeStep.xhtml#af46085bcb6747bb5e17badf99cdbc27c) [TimeStep](structsysc_1_1TimeStep.xhtml)&amp; [operator=](structsysc_1_1TimeStep.xhtml#af46085bcb6747bb5e17badf99cdbc27c)(const [TimeStep](structsysc_1_1TimeStep.xhtml)&amp;) = default;

<a id="l00056" name="l00056"></a> 56 

<a id="l00058" name="l00058"></a>[ 58](structsysc_1_1TimeStep.xhtml#a908b9a5d14f4f7977be059cde82d258a) [TimeStep](structsysc_1_1TimeStep.xhtml)&amp; [operator=](structsysc_1_1TimeStep.xhtml#a908b9a5d14f4f7977be059cde82d258a)([TimeStep](structsysc_1_1TimeStep.xhtml)&amp;&amp;) = default;

<a id="l00059" name="l00059"></a> 59 

<a id="l00061" name="l00061"></a>[ 61](structsysc_1_1TimeStep.xhtml#aa92d1684145d3aa5ed39d171d2100299) [TimeStep](structsysc_1_1TimeStep.xhtml#aa92d1684145d3aa5ed39d171d2100299)(int [timeStepNumber](structsysc_1_1TimeStep.xhtml#ab8fbdd8e8dd4384d385c3190b11a2ccf), double [startTime](structsysc_1_1TimeStep.xhtml#a115810021ec63279be6a82d5deb853c2), double [timeStepSize](structsysc_1_1TimeStep.xhtml#a91d6e07b37c9c461ddfc8e85965321b2)) :

<a id="l00062" name="l00062"></a> 62 [timeStepNumber](structsysc_1_1TimeStep.xhtml#ab8fbdd8e8dd4384d385c3190b11a2ccf)([timeStepNumber](structsysc_1_1TimeStep.xhtml#ab8fbdd8e8dd4384d385c3190b11a2ccf)),

<a id="l00063" name="l00063"></a> 63 [startTime](structsysc_1_1TimeStep.xhtml#a115810021ec63279be6a82d5deb853c2)([startTime](structsysc_1_1TimeStep.xhtml#a115810021ec63279be6a82d5deb853c2)),

<a id="l00064" name="l00064"></a> 64 [timeStepSize](structsysc_1_1TimeStep.xhtml#a91d6e07b37c9c461ddfc8e85965321b2)([timeStepSize](structsysc_1_1TimeStep.xhtml#a91d6e07b37c9c461ddfc8e85965321b2)){};

<a id="l00065" name="l00065"></a> 65};

<a id="l00066" name="l00066"></a> 66 

<a id="l00068" name="l00068"></a>[ 68](structsysc_1_1SolutionControl.xhtml)struct [SolutionControl](structsysc_1_1SolutionControl.xhtml) {

<a id="l00069" name="l00069"></a>[ 69](structsysc_1_1SolutionControl.xhtml#a6c84cc77b261df44b0f7f339f77a526b) int [minimumIterations](structsysc_1_1SolutionControl.xhtml#a6c84cc77b261df44b0f7f339f77a526b){0}; 

<a id="l00070" name="l00070"></a>[ 70](structsysc_1_1SolutionControl.xhtml#a0c973b27756ebeaf6fbe6d456c13b697) int [maximumIterations](structsysc_1_1SolutionControl.xhtml#a0c973b27756ebeaf6fbe6d456c13b697){0}; 

<a id="l00071" name="l00071"></a> 71};

<a id="l00072" name="l00072"></a> 72 

<a id="l00074" name="l00074"></a>[ 74](structsysc_1_1SetupInfo.xhtml)struct [SetupInfo](structsysc_1_1SetupInfo.xhtml) {

<a id="l00075" name="l00075"></a> 75 /\* \\brief Provide a constructor for SetupInfo. \*/

<a id="l00076" name="l00076"></a> 76 [SetupInfo](structsysc_1_1SetupInfo.xhtml)() = default;

<a id="l00077" name="l00077"></a> 77 

<a id="l00083" name="l00083"></a>[ 83](structsysc_1_1SetupInfo.xhtml#a33ac9fc553fff914c295acf695b61efc) [SetupInfo](structsysc_1_1SetupInfo.xhtml#a33ac9fc553fff914c295acf695b61efc)(

<a id="l00084" name="l00084"></a> 84 enum [AnalysisType](group__SystemCouplingParticipantAPIs.xhtml#gaffd523474fbd708f481a712f1841a967) [analysisType](structsysc_1_1SetupInfo.xhtml#a45906ec4c888b7d0fbd42066f318284b)) :

<a id="l00085" name="l00085"></a> 85 [analysisType](structsysc_1_1SetupInfo.xhtml#a45906ec4c888b7d0fbd42066f318284b)([analysisType](structsysc_1_1SetupInfo.xhtml#a45906ec4c888b7d0fbd42066f318284b)){};

<a id="l00086" name="l00086"></a> 86 

<a id="l00093" name="l00093"></a>[ 93](structsysc_1_1SetupInfo.xhtml#ab17e9d12184e6b93080eb71dac25a328) [SetupInfo](structsysc_1_1SetupInfo.xhtml#ab17e9d12184e6b93080eb71dac25a328)(

<a id="l00094" name="l00094"></a> 94 enum [AnalysisType](group__SystemCouplingParticipantAPIs.xhtml#gaffd523474fbd708f481a712f1841a967) [analysisType](structsysc_1_1SetupInfo.xhtml#a45906ec4c888b7d0fbd42066f318284b),

<a id="l00095" name="l00095"></a> 95 bool [restartsSupported](structsysc_1_1SetupInfo.xhtml#a46dc0b1c447b1534103f3f05455ee717)) :

<a id="l00096" name="l00096"></a> 96 [analysisType](structsysc_1_1SetupInfo.xhtml#a45906ec4c888b7d0fbd42066f318284b)([analysisType](structsysc_1_1SetupInfo.xhtml#a45906ec4c888b7d0fbd42066f318284b)),

<a id="l00097" name="l00097"></a> 97 [restartsSupported](structsysc_1_1SetupInfo.xhtml#a46dc0b1c447b1534103f3f05455ee717)([restartsSupported](structsysc_1_1SetupInfo.xhtml#a46dc0b1c447b1534103f3f05455ee717)){};

<a id="l00098" name="l00098"></a> 98 

<a id="l00106" name="l00106"></a>[ 106](structsysc_1_1SetupInfo.xhtml#a0808c997023319d5ec2e7eb623a172cd) [SetupInfo](structsysc_1_1SetupInfo.xhtml#a0808c997023319d5ec2e7eb623a172cd)(

<a id="l00107" name="l00107"></a> 107 enum [AnalysisType](group__SystemCouplingParticipantAPIs.xhtml#gaffd523474fbd708f481a712f1841a967) [analysisType](structsysc_1_1SetupInfo.xhtml#a45906ec4c888b7d0fbd42066f318284b),

<a id="l00108" name="l00108"></a> 108 bool [restartsSupported](structsysc_1_1SetupInfo.xhtml#a46dc0b1c447b1534103f3f05455ee717),

<a id="l00109" name="l00109"></a> 109 enum [Dimension](group__SystemCouplingParticipantAPIs.xhtml#ga47c8e4142175574918b84d336780cc7c) [dimension](structsysc_1_1SetupInfo.xhtml#a9d7c8f147afec2b6269bec443296291d)) :

<a id="l00110" name="l00110"></a> 110 [analysisType](structsysc_1_1SetupInfo.xhtml#a45906ec4c888b7d0fbd42066f318284b)([analysisType](structsysc_1_1SetupInfo.xhtml#a45906ec4c888b7d0fbd42066f318284b)),

<a id="l00111" name="l00111"></a> 111 [restartsSupported](structsysc_1_1SetupInfo.xhtml#a46dc0b1c447b1534103f3f05455ee717)([restartsSupported](structsysc_1_1SetupInfo.xhtml#a46dc0b1c447b1534103f3f05455ee717)),

<a id="l00112" name="l00112"></a> 112 [dimension](structsysc_1_1SetupInfo.xhtml#a9d7c8f147afec2b6269bec443296291d)([dimension](structsysc_1_1SetupInfo.xhtml#a9d7c8f147afec2b6269bec443296291d)){};

<a id="l00113" name="l00113"></a> 113 

<a id="l00114" name="l00114"></a>[ 114](structsysc_1_1SetupInfo.xhtml#a45906ec4c888b7d0fbd42066f318284b) [AnalysisType](group__SystemCouplingParticipantAPIs.xhtml#gaffd523474fbd708f481a712f1841a967) [analysisType](structsysc_1_1SetupInfo.xhtml#a45906ec4c888b7d0fbd42066f318284b){Steady}; 

<a id="l00116" name="l00116"></a>[ 116](structsysc_1_1SetupInfo.xhtml#a46dc0b1c447b1534103f3f05455ee717) bool [restartsSupported](structsysc_1_1SetupInfo.xhtml#a46dc0b1c447b1534103f3f05455ee717){false};

<a id="l00117" name="l00117"></a>[ 117](structsysc_1_1SetupInfo.xhtml#a9d7c8f147afec2b6269bec443296291d) [Dimension](group__SystemCouplingParticipantAPIs.xhtml#ga47c8e4142175574918b84d336780cc7c) [dimension](structsysc_1_1SetupInfo.xhtml#a9d7c8f147afec2b6269bec443296291d){Dimension::D3}; 

<a id="l00118" name="l00118"></a> 118};

<a id="l00119" name="l00119"></a> 119 

<a id="l00121" name="l00121"></a>[ 121](structsysc_1_1SetupFileInfo.xhtml)struct [SetupFileInfo](structsysc_1_1SetupFileInfo.xhtml) {

<a id="l00122" name="l00122"></a>[ 122](structsysc_1_1SetupFileInfo.xhtml#acf9bd8de151bb98c37844bce125c20d0) std::string [setupFileName](structsysc_1_1SetupFileInfo.xhtml#acf9bd8de151bb98c37844bce125c20d0); 

<a id="l00123" name="l00123"></a>[ 123](structsysc_1_1SetupFileInfo.xhtml#a65df447274a91c50920e5af5296c60e3) bool [restartsSupported](structsysc_1_1SetupFileInfo.xhtml#a65df447274a91c50920e5af5296c60e3); 

<a id="l00130" name="l00130"></a>[ 130](structsysc_1_1SetupFileInfo.xhtml#af3e2bd60fca807c13cb906f13a662570) [SetupFileInfo](structsysc_1_1SetupFileInfo.xhtml#af3e2bd60fca807c13cb906f13a662570)() :

<a id="l00131" name="l00131"></a> 131 [restartsSupported](structsysc_1_1SetupFileInfo.xhtml#a65df447274a91c50920e5af5296c60e3)(false){};

<a id="l00132" name="l00132"></a> 132 

<a id="l00140" name="l00140"></a>[ 140](structsysc_1_1SetupFileInfo.xhtml#a95583fe2f73ddcca1c1697af2f9eee3e) [SetupFileInfo](structsysc_1_1SetupFileInfo.xhtml#a95583fe2f73ddcca1c1697af2f9eee3e)(const std::string&amp; [setupFileName](structsysc_1_1SetupFileInfo.xhtml#acf9bd8de151bb98c37844bce125c20d0)) :

<a id="l00141" name="l00141"></a> 141 [setupFileName](structsysc_1_1SetupFileInfo.xhtml#acf9bd8de151bb98c37844bce125c20d0)([setupFileName](structsysc_1_1SetupFileInfo.xhtml#acf9bd8de151bb98c37844bce125c20d0)),

<a id="l00142" name="l00142"></a> 142 [restartsSupported](structsysc_1_1SetupFileInfo.xhtml#a65df447274a91c50920e5af5296c60e3)(false){};

<a id="l00143" name="l00143"></a> 143 

<a id="l00150" name="l00150"></a>[ 150](structsysc_1_1SetupFileInfo.xhtml#a4d53c4b1663965e3dcac0ac7a86b0334) [SetupFileInfo](structsysc_1_1SetupFileInfo.xhtml#a4d53c4b1663965e3dcac0ac7a86b0334)(const std::string&amp; [setupFileName](structsysc_1_1SetupFileInfo.xhtml#acf9bd8de151bb98c37844bce125c20d0), bool [restartsSupported](structsysc_1_1SetupFileInfo.xhtml#a65df447274a91c50920e5af5296c60e3)) :

<a id="l00151" name="l00151"></a> 151 [setupFileName](structsysc_1_1SetupFileInfo.xhtml#acf9bd8de151bb98c37844bce125c20d0)([setupFileName](structsysc_1_1SetupFileInfo.xhtml#acf9bd8de151bb98c37844bce125c20d0)),

<a id="l00152" name="l00152"></a> 152 [restartsSupported](structsysc_1_1SetupFileInfo.xhtml#a65df447274a91c50920e5af5296c60e3)([restartsSupported](structsysc_1_1SetupFileInfo.xhtml#a65df447274a91c50920e5af5296c60e3)){};

<a id="l00153" name="l00153"></a> 153};

<a id="l00154" name="l00154"></a> 154 

<a id="l00156" name="l00156"></a>[ 156](structsysc_1_1ResultsInfo.xhtml)struct [ResultsInfo](structsysc_1_1ResultsInfo.xhtml) {

<a id="l00157" name="l00157"></a>[ 157](structsysc_1_1ResultsInfo.xhtml#acc2c96ab4d0c7b8bc630583a814cead4) std::string [baseFileName](structsysc_1_1ResultsInfo.xhtml#acc2c96ab4d0c7b8bc630583a814cead4); 

<a id="l00160" name="l00160"></a>[ 160](structsysc_1_1ResultsInfo.xhtml#a673c9e77e725e4d4311106fac4ea7110) [ResultsInfo](structsysc_1_1ResultsInfo.xhtml#a673c9e77e725e4d4311106fac4ea7110)(const std::string&amp; [baseFileName](structsysc_1_1ResultsInfo.xhtml#acc2c96ab4d0c7b8bc630583a814cead4)) :

<a id="l00161" name="l00161"></a> 161 [baseFileName](structsysc_1_1ResultsInfo.xhtml#acc2c96ab4d0c7b8bc630583a814cead4)([baseFileName](structsysc_1_1ResultsInfo.xhtml#acc2c96ab4d0c7b8bc630583a814cead4)){};

<a id="l00162" name="l00162"></a> 162};

<a id="l00163" name="l00163"></a> 163 

<a id="l00165" name="l00165"></a>[ 165](group__SystemCouplingParticipantAPIs.xhtml#gadbbc75f28fce0c9b5b31fa64bb8b1e39)enum [Topology](group__SystemCouplingParticipantAPIs.xhtml#gadbbc75f28fce0c9b5b31fa64bb8b1e39) {

<a id="l00166" name="l00166"></a> 166 Surface = 2,

<a id="l00167" name="l00167"></a> 167 Volume = 3

<a id="l00168" name="l00168"></a> 168};

<a id="l00169" name="l00169"></a> 169 

<a id="l00171" name="l00171"></a>[ 171](structsysc_1_1ValidityStatus.xhtml)struct [ValidityStatus](structsysc_1_1ValidityStatus.xhtml) {

<a id="l00172" name="l00172"></a>[ 172](structsysc_1_1ValidityStatus.xhtml#ac45ce7d05d6ab0126511da670f3e10a9) bool [isValid](structsysc_1_1ValidityStatus.xhtml#ac45ce7d05d6ab0126511da670f3e10a9); 

<a id="l00173" name="l00173"></a>[ 173](structsysc_1_1ValidityStatus.xhtml#ad78928b787427d9c0edf9e7a1e3d857c) std::string [message](structsysc_1_1ValidityStatus.xhtml#ad78928b787427d9c0edf9e7a1e3d857c); 

<a id="l00175" name="l00175"></a> 175 /\* \\brief Provide a default constructor for ValidityStatus \*/

<a id="l00176" name="l00176"></a> 176 [ValidityStatus](structsysc_1_1ValidityStatus.xhtml)() :

<a id="l00177" name="l00177"></a> 177 [isValid](structsysc_1_1ValidityStatus.xhtml#ac45ce7d05d6ab0126511da670f3e10a9)(true){};

<a id="l00178" name="l00178"></a> 178 

<a id="l00185" name="l00185"></a>[ 185](structsysc_1_1ValidityStatus.xhtml#a45833f599239b5ec57232fd73ee127b5) [ValidityStatus](structsysc_1_1ValidityStatus.xhtml#a45833f599239b5ec57232fd73ee127b5)(bool [isValid](structsysc_1_1ValidityStatus.xhtml#ac45ce7d05d6ab0126511da670f3e10a9), const std::string&amp; [message](structsysc_1_1ValidityStatus.xhtml#ad78928b787427d9c0edf9e7a1e3d857c)) :

<a id="l00186" name="l00186"></a> 186 [isValid](structsysc_1_1ValidityStatus.xhtml#ac45ce7d05d6ab0126511da670f3e10a9)([isValid](structsysc_1_1ValidityStatus.xhtml#ac45ce7d05d6ab0126511da670f3e10a9)),

<a id="l00187" name="l00187"></a> 187 [message](structsysc_1_1ValidityStatus.xhtml#ad78928b787427d9c0edf9e7a1e3d857c)([message](structsysc_1_1ValidityStatus.xhtml#ad78928b787427d9c0edf9e7a1e3d857c)){};

<a id="l00188" name="l00188"></a> 188};

<a id="l00189" name="l00189"></a> 189 

<a id="l00191" name="l00191"></a>[ 191](structsysc_1_1MeshValidityStatus.xhtml)struct [MeshValidityStatus](structsysc_1_1MeshValidityStatus.xhtml) {

<a id="l00192" name="l00192"></a>[ 192](structsysc_1_1MeshValidityStatus.xhtml#a3ee3cb844b3594fb7c3be7fce89a4f62) bool [isInvalid](structsysc_1_1MeshValidityStatus.xhtml#a3ee3cb844b3594fb7c3be7fce89a4f62); 

<a id="l00193" name="l00193"></a>[ 193](structsysc_1_1MeshValidityStatus.xhtml#ab175079553f6cc1591dbb3d0e74c8ec4) std::string [message](structsysc_1_1MeshValidityStatus.xhtml#ab175079553f6cc1591dbb3d0e74c8ec4); 

<a id="l00195" name="l00195"></a> 195 /\* \\brief Provide a default constructor for MeshValidityStatus \*/

<a id="l00196" name="l00196"></a> 196 [MeshValidityStatus](structsysc_1_1MeshValidityStatus.xhtml)() :

<a id="l00197" name="l00197"></a> 197 [isInvalid](structsysc_1_1MeshValidityStatus.xhtml#a3ee3cb844b3594fb7c3be7fce89a4f62)(false){};

<a id="l00198" name="l00198"></a> 198 

<a id="l00205" name="l00205"></a>[ 205](structsysc_1_1MeshValidityStatus.xhtml#a2fe7b6037e4fb99914de7f40097b3acb) [MeshValidityStatus](structsysc_1_1MeshValidityStatus.xhtml#a2fe7b6037e4fb99914de7f40097b3acb)(bool [isInvalid](structsysc_1_1MeshValidityStatus.xhtml#a3ee3cb844b3594fb7c3be7fce89a4f62), const std::string&amp; [message](structsysc_1_1MeshValidityStatus.xhtml#ab175079553f6cc1591dbb3d0e74c8ec4)) :

<a id="l00206" name="l00206"></a> 206 [isInvalid](structsysc_1_1MeshValidityStatus.xhtml#a3ee3cb844b3594fb7c3be7fce89a4f62)([isInvalid](structsysc_1_1MeshValidityStatus.xhtml#a3ee3cb844b3594fb7c3be7fce89a4f62)),

<a id="l00207" name="l00207"></a> 207 [message](structsysc_1_1MeshValidityStatus.xhtml#ab175079553f6cc1591dbb3d0e74c8ec4)([message](structsysc_1_1MeshValidityStatus.xhtml#ab175079553f6cc1591dbb3d0e74c8ec4)){};

<a id="l00208" name="l00208"></a> 208};

<a id="l00209" name="l00209"></a> 209 

<a id="l00211" name="l00211"></a>[ 211](group__SystemCouplingParticipantAPIs.xhtml#gad3b1c73e4a63f4d292d65f3db875e844)enum [PrimitiveType](group__SystemCouplingParticipantAPIs.xhtml#gad3b1c73e4a63f4d292d65f3db875e844) {

<a id="l00212" name="l00212"></a>[ 212](group__SystemCouplingParticipantAPIs.xhtml#ggad3b1c73e4a63f4d292d65f3db875e844af25f11e4d5a18405d2880727956e3c06) [Float](group__SystemCouplingParticipantAPIs.xhtml#ggad3b1c73e4a63f4d292d65f3db875e844af25f11e4d5a18405d2880727956e3c06) = 0, 

<a id="l00213" name="l00213"></a>[ 213](group__SystemCouplingParticipantAPIs.xhtml#ggad3b1c73e4a63f4d292d65f3db875e844a29843d2c1bb5760f768dcc066dac1ac1) [Double](group__SystemCouplingParticipantAPIs.xhtml#ggad3b1c73e4a63f4d292d65f3db875e844a29843d2c1bb5760f768dcc066dac1ac1) = 1, 

<a id="l00214" name="l00214"></a>[ 214](group__SystemCouplingParticipantAPIs.xhtml#ggad3b1c73e4a63f4d292d65f3db875e844a65168a2fa10ccf906e55b9ae11f4d98d) [Int32](group__SystemCouplingParticipantAPIs.xhtml#ggad3b1c73e4a63f4d292d65f3db875e844a65168a2fa10ccf906e55b9ae11f4d98d) = 2, 

<a id="l00215" name="l00215"></a>[ 215](group__SystemCouplingParticipantAPIs.xhtml#ggad3b1c73e4a63f4d292d65f3db875e844a7280672fe5e965512085d9837dbacf7f) [Int64](group__SystemCouplingParticipantAPIs.xhtml#ggad3b1c73e4a63f4d292d65f3db875e844a7280672fe5e965512085d9837dbacf7f) = 3, 

<a id="l00216" name="l00216"></a>[ 216](group__SystemCouplingParticipantAPIs.xhtml#ggad3b1c73e4a63f4d292d65f3db875e844aa75e06a552b1c3cbfd131efe80431fa0) [UnsignedInt16](group__SystemCouplingParticipantAPIs.xhtml#ggad3b1c73e4a63f4d292d65f3db875e844aa75e06a552b1c3cbfd131efe80431fa0) = 4, 

<a id="l00217" name="l00217"></a> 217 [UnsignedInt64](group__SystemCouplingParticipantAPIs.xhtml#ggad3b1c73e4a63f4d292d65f3db875e844a89e71558fbcaabe137d0bcf04df90462) = 5 

<a id="l00218" name="l00218"></a>[ 218](group__SystemCouplingParticipantAPIs.xhtml#ggad3b1c73e4a63f4d292d65f3db875e844a89e71558fbcaabe137d0bcf04df90462)};

<a id="l00219" name="l00219"></a> 219 

<a id="l00220" name="l00220"></a>[ 220](group__SystemCouplingParticipantAPIs.xhtml#ga23b9971b358756814178dd1cb3c0bc80)using [OpaqueDataAccess](group__SystemCouplingParticipantAPIs.xhtml#ga23b9971b358756814178dd1cb3c0bc80) = void*; 

<a id="l00222" name="l00222"></a>[ 222](group__SystemCouplingParticipantAPIs.xhtml#gad700042fb75659f4591c4dae6560a62d)using [RegionName](group__SystemCouplingParticipantAPIs.xhtml#gad700042fb75659f4591c4dae6560a62d) = std::string; 

<a id="l00223" name="l00223"></a>[ 223](group__SystemCouplingParticipantAPIs.xhtml#ga500337cdc8405b3e819ca3623bb44266)using [VariableName](group__SystemCouplingParticipantAPIs.xhtml#ga500337cdc8405b3e819ca3623bb44266) = std::string; 

<a id="l00224" name="l00224"></a>[ 224](group__SystemCouplingParticipantAPIs.xhtml#ga8a62847c55d192b835faff927dbf41a3)using [CouplingInterfaceName](group__SystemCouplingParticipantAPIs.xhtml#ga8a62847c55d192b835faff927dbf41a3) = std::string; 

<a id="l00225" name="l00225"></a>[ 225](group__SystemCouplingParticipantAPIs.xhtml#gaf2402e0ffcce217d0b9d2dda8dc2e61f)using [RestartPoint](group__SystemCouplingParticipantAPIs.xhtml#gaf2402e0ffcce217d0b9d2dda8dc2e61f) = std::string; 

<a id="l00226" name="l00226"></a>[ 226](group__SystemCouplingParticipantAPIs.xhtml#ga708d69b0e949d6a42b6a0d7885eed90f)using [DisplayName](group__SystemCouplingParticipantAPIs.xhtml#ga708d69b0e949d6a42b6a0d7885eed90f) = std::string; 

<a id="l00227" name="l00227"></a>[ 227](group__SystemCouplingParticipantAPIs.xhtml#gadb06eacf4ed0787d18e8ddbf0612c83c)using [AttributeName](group__SystemCouplingParticipantAPIs.xhtml#gadb06eacf4ed0787d18e8ddbf0612c83c) = std::string; 

<a id="l00249" name="l00249"></a>[ 249](structsysc_1_1ParticipantInfo.xhtml)struct [ParticipantInfo](structsysc_1_1ParticipantInfo.xhtml) {

<a id="l00250" name="l00250"></a> 250 std::string scHost;

<a id="l00251" name="l00251"></a> 251 unsigned short scPort{0};

<a id="l00252" name="l00252"></a> 252 std::string participantName;

<a id="l00253" name="l00253"></a> 253 bool isCosimulation{false};

<a id="l00254" name="l00254"></a> 254 std::string buildInformation;

<a id="l00255" name="l00255"></a> 255 std::string transcriptFilename;

<a id="l00256" name="l00256"></a> 256 

<a id="l00258" name="l00258"></a>[ 258](structsysc_1_1ParticipantInfo.xhtml#a62ca76d7ec19c59606870814aaec771e) [ParticipantInfo](structsysc_1_1ParticipantInfo.xhtml#a62ca76d7ec19c59606870814aaec771e)() = default;

<a id="l00259" name="l00259"></a> 259 

<a id="l00261" name="l00261"></a>[ 261](structsysc_1_1ParticipantInfo.xhtml#afcc2de675aa909571507b6e388c84592) [ParticipantInfo](structsysc_1_1ParticipantInfo.xhtml#afcc2de675aa909571507b6e388c84592)(const [ParticipantInfo](structsysc_1_1ParticipantInfo.xhtml)&amp;) = default;

<a id="l00262" name="l00262"></a> 262 

<a id="l00264" name="l00264"></a>[ 264](structsysc_1_1ParticipantInfo.xhtml#aede3e04a870f7ed298e7df71042c452e) [ParticipantInfo](structsysc_1_1ParticipantInfo.xhtml#aede3e04a870f7ed298e7df71042c452e)([ParticipantInfo](structsysc_1_1ParticipantInfo.xhtml)&amp;&amp;) = default;

<a id="l00265" name="l00265"></a> 265 

<a id="l00267" name="l00267"></a>[ 267](structsysc_1_1ParticipantInfo.xhtml#aee8b24b8a6bb40e1b49d52849ffd7381) [ParticipantInfo](structsysc_1_1ParticipantInfo.xhtml)&amp; [operator=](structsysc_1_1ParticipantInfo.xhtml#aee8b24b8a6bb40e1b49d52849ffd7381)(const [ParticipantInfo](structsysc_1_1ParticipantInfo.xhtml)&amp;) = default;

<a id="l00268" name="l00268"></a> 268 

<a id="l00270" name="l00270"></a>[ 270](structsysc_1_1ParticipantInfo.xhtml#a3edb39cc4d7965fc44f613e5d9c5eb50) [ParticipantInfo](structsysc_1_1ParticipantInfo.xhtml)&amp; [operator=](structsysc_1_1ParticipantInfo.xhtml#a3edb39cc4d7965fc44f613e5d9c5eb50)([ParticipantInfo](structsysc_1_1ParticipantInfo.xhtml)&amp;&amp;) = default;

<a id="l00271" name="l00271"></a> 271 

<a id="l00273" name="l00273"></a>[ 273](structsysc_1_1ParticipantInfo.xhtml#aaa27d3d6711d46253b08d5a9faa89932) [ParticipantInfo](structsysc_1_1ParticipantInfo.xhtml#aaa27d3d6711d46253b08d5a9faa89932)(

<a id="l00274" name="l00274"></a> 274 const std::string&amp; scHost,

<a id="l00275" name="l00275"></a> 275 unsigned short scPort,

<a id="l00276" name="l00276"></a> 276 const std::string&amp; participantName) :

<a id="l00277" name="l00277"></a> 277 scHost(scHost),

<a id="l00278" name="l00278"></a> 278 scPort(scPort),

<a id="l00279" name="l00279"></a> 279 participantName(participantName),

<a id="l00280" name="l00280"></a> 280 isCosimulation(true)

<a id="l00281" name="l00281"></a> 281 {

<a id="l00282" name="l00282"></a> 282 }

<a id="l00283" name="l00283"></a> 283 

<a id="l00285" name="l00285"></a>[ 285](structsysc_1_1ParticipantInfo.xhtml#a2e86803e776980c1ca6a2695c02989f0) [ParticipantInfo](structsysc_1_1ParticipantInfo.xhtml#a2e86803e776980c1ca6a2695c02989f0)(

<a id="l00286" name="l00286"></a> 286 const std::string&amp; scHost,

<a id="l00287" name="l00287"></a> 287 unsigned short scPort,

<a id="l00288" name="l00288"></a> 288 const std::string&amp; participantName,

<a id="l00289" name="l00289"></a> 289 const std::string&amp; buildInformation) :

<a id="l00290" name="l00290"></a> 290 scHost(scHost),

<a id="l00291" name="l00291"></a> 291 scPort(scPort),

<a id="l00292" name="l00292"></a> 292 participantName(participantName),

<a id="l00293" name="l00293"></a> 293 isCosimulation(true),

<a id="l00294" name="l00294"></a> 294 buildInformation(buildInformation)

<a id="l00295" name="l00295"></a> 295 {

<a id="l00296" name="l00296"></a> 296 }

<a id="l00297" name="l00297"></a> 297 

<a id="l00299" name="l00299"></a>[ 299](structsysc_1_1ParticipantInfo.xhtml#a2ad671f9752d8c33476a91a423bf5964) [ParticipantInfo](structsysc_1_1ParticipantInfo.xhtml#a2ad671f9752d8c33476a91a423bf5964)(

<a id="l00300" name="l00300"></a> 300 const std::string&amp; scHost,

<a id="l00301" name="l00301"></a> 301 unsigned short scPort,

<a id="l00302" name="l00302"></a> 302 const std::string&amp; participantName,

<a id="l00303" name="l00303"></a> 303 const std::string&amp; buildInformation,

<a id="l00304" name="l00304"></a> 304 const std::string&amp; transcriptFilename) :

<a id="l00305" name="l00305"></a> 305 scHost(scHost),

<a id="l00306" name="l00306"></a> 306 scPort(scPort),

<a id="l00307" name="l00307"></a> 307 participantName(participantName),

<a id="l00308" name="l00308"></a> 308 isCosimulation(true),

<a id="l00309" name="l00309"></a> 309 buildInformation(buildInformation),

<a id="l00310" name="l00310"></a> 310 transcriptFilename(transcriptFilename)

<a id="l00311" name="l00311"></a> 311 {

<a id="l00312" name="l00312"></a> 312 }

<a id="l00313" name="l00313"></a> 313};

<a id="l00314" name="l00314"></a> 314 

<a id="l00315" name="l00315"></a> 315} // namespace sysc

[sysc::ConvergenceStatus](group__SystemCouplingParticipantAPIs.xhtml#ga0b8801743579159eb41cf07d8372a734)

ConvergenceStatus

Provide enum for participant's solver convergence status.

**Definition:** [CommonTypes.hpp:25](CommonTypes_8hpp_source.xhtml#l00025)



[sysc::OpaqueDataAccess](group__SystemCouplingParticipantAPIs.xhtml#ga23b9971b358756814178dd1cb3c0bc80)

void * OpaqueDataAccess

**Definition:** [CommonTypes.hpp:220](CommonTypes_8hpp_source.xhtml#l00220)



[sysc::Dimension](group__SystemCouplingParticipantAPIs.xhtml#ga47c8e4142175574918b84d336780cc7c)

Dimension

Provide an enum for participant dimension.

**Definition:** [CommonSettings.hpp:24](CommonSettings_8hpp_source.xhtml#l00024)



[sysc::VariableName](group__SystemCouplingParticipantAPIs.xhtml#ga500337cdc8405b3e819ca3623bb44266)

std::string VariableName

**Definition:** [CommonTypes.hpp:223](CommonTypes_8hpp_source.xhtml#l00223)



[sysc::DisplayName](group__SystemCouplingParticipantAPIs.xhtml#ga708d69b0e949d6a42b6a0d7885eed90f)

std::string DisplayName

**Definition:** [CommonTypes.hpp:226](CommonTypes_8hpp_source.xhtml#l00226)



[sysc::CouplingInterfaceName](group__SystemCouplingParticipantAPIs.xhtml#ga8a62847c55d192b835faff927dbf41a3)

std::string CouplingInterfaceName

**Definition:** [CommonTypes.hpp:224](CommonTypes_8hpp_source.xhtml#l00224)



[sysc::DataType](group__SystemCouplingParticipantAPIs.xhtml#ga8c2b9557240fd9b2f908c98e3b1b27d3)

DataType

Provide enum for variable data types.

**Definition:** [CommonTypes.hpp:34](CommonTypes_8hpp_source.xhtml#l00034)



[sysc::PrimitiveType](group__SystemCouplingParticipantAPIs.xhtml#gad3b1c73e4a63f4d292d65f3db875e844)

PrimitiveType

Provide enum for supported primitive types.

**Definition:** [CommonTypes.hpp:211](CommonTypes_8hpp_source.xhtml#l00211)



[sysc::RegionName](group__SystemCouplingParticipantAPIs.xhtml#gad700042fb75659f4591c4dae6560a62d)

std::string RegionName

**Definition:** [CommonTypes.hpp:222](CommonTypes_8hpp_source.xhtml#l00222)



[sysc::AttributeName](group__SystemCouplingParticipantAPIs.xhtml#gadb06eacf4ed0787d18e8ddbf0612c83c)

std::string AttributeName

**Definition:** [CommonTypes.hpp:227](CommonTypes_8hpp_source.xhtml#l00227)



[sysc::Topology](group__SystemCouplingParticipantAPIs.xhtml#gadbbc75f28fce0c9b5b31fa64bb8b1e39)

Topology

Provide enum for region topologies.

**Definition:** [CommonTypes.hpp:165](CommonTypes_8hpp_source.xhtml#l00165)



[sysc::RestartPoint](group__SystemCouplingParticipantAPIs.xhtml#gaf2402e0ffcce217d0b9d2dda8dc2e61f)

std::string RestartPoint

**Definition:** [CommonTypes.hpp:225](CommonTypes_8hpp_source.xhtml#l00225)



[sysc::AnalysisType](group__SystemCouplingParticipantAPIs.xhtml#gaffd523474fbd708f481a712f1841a967)

AnalysisType

Provide an enum for coupled analysis type.

**Definition:** [CommonSettings.hpp:18](CommonSettings_8hpp_source.xhtml#l00018)



[sysc::Double](group__SystemCouplingParticipantAPIs.xhtml#ggad3b1c73e4a63f4d292d65f3db875e844a29843d2c1bb5760f768dcc066dac1ac1)

@ Double

**Definition:** [CommonTypes.hpp:213](CommonTypes_8hpp_source.xhtml#l00213)



[sysc::Int32](group__SystemCouplingParticipantAPIs.xhtml#ggad3b1c73e4a63f4d292d65f3db875e844a65168a2fa10ccf906e55b9ae11f4d98d)

@ Int32

**Definition:** [CommonTypes.hpp:214](CommonTypes_8hpp_source.xhtml#l00214)



[sysc::Int64](group__SystemCouplingParticipantAPIs.xhtml#ggad3b1c73e4a63f4d292d65f3db875e844a7280672fe5e965512085d9837dbacf7f)

@ Int64

**Definition:** [CommonTypes.hpp:215](CommonTypes_8hpp_source.xhtml#l00215)



[sysc::UnsignedInt64](group__SystemCouplingParticipantAPIs.xhtml#ggad3b1c73e4a63f4d292d65f3db875e844a89e71558fbcaabe137d0bcf04df90462)

@ UnsignedInt64

**Definition:** [CommonTypes.hpp:217](CommonTypes_8hpp_source.xhtml#l00218)



[sysc::UnsignedInt16](group__SystemCouplingParticipantAPIs.xhtml#ggad3b1c73e4a63f4d292d65f3db875e844aa75e06a552b1c3cbfd131efe80431fa0)

@ UnsignedInt16

**Definition:** [CommonTypes.hpp:216](CommonTypes_8hpp_source.xhtml#l00216)



[sysc::Float](group__SystemCouplingParticipantAPIs.xhtml#ggad3b1c73e4a63f4d292d65f3db875e844af25f11e4d5a18405d2880727956e3c06)

@ Float

**Definition:** [CommonTypes.hpp:212](CommonTypes_8hpp_source.xhtml#l00212)



[sysc::MeshValidityStatus](structsysc_1_1MeshValidityStatus.xhtml)

Provide a struct that contains information about mesh validity.

**Definition:** [CommonTypes.hpp:191](CommonTypes_8hpp_source.xhtml#l00191)



[sysc::MeshValidityStatus::MeshValidityStatus](structsysc_1_1MeshValidityStatus.xhtml#a2fe7b6037e4fb99914de7f40097b3acb)

MeshValidityStatus(bool isInvalid, const std::string &amp;message)

Provide a non-default constructor for MeshValidityStatus.

**Definition:** [CommonTypes.hpp:205](CommonTypes_8hpp_source.xhtml#l00205)



[sysc::MeshValidityStatus::isInvalid](structsysc_1_1MeshValidityStatus.xhtml#a3ee3cb844b3594fb7c3be7fce89a4f62)

bool isInvalid

**Definition:** [CommonTypes.hpp:192](CommonTypes_8hpp_source.xhtml#l00192)



[sysc::MeshValidityStatus::message](structsysc_1_1MeshValidityStatus.xhtml#ab175079553f6cc1591dbb3d0e74c8ec4)

std::string message

**Definition:** [CommonTypes.hpp:193](CommonTypes_8hpp_source.xhtml#l00193)



[sysc::ParticipantInfo](structsysc_1_1ParticipantInfo.xhtml)

provide a structure for the participant information needed to connect to a System Coupling object

**Definition:** [CommonTypes.hpp:249](CommonTypes_8hpp_source.xhtml#l00249)



[sysc::ParticipantInfo::ParticipantInfo](structsysc_1_1ParticipantInfo.xhtml#a2ad671f9752d8c33476a91a423bf5964)

ParticipantInfo(const std::string &amp;scHost, unsigned short scPort, const std::string &amp;participantName, const std::string &amp;buildInformation, const std::string &amp;transcriptFilename)

Provide a non-default constructor.

**Definition:** [CommonTypes.hpp:299](CommonTypes_8hpp_source.xhtml#l00299)



[sysc::ParticipantInfo::ParticipantInfo](structsysc_1_1ParticipantInfo.xhtml#a2e86803e776980c1ca6a2695c02989f0)

ParticipantInfo(const std::string &amp;scHost, unsigned short scPort, const std::string &amp;participantName, const std::string &amp;buildInformation)

Provide a non-default constructor.

**Definition:** [CommonTypes.hpp:285](CommonTypes_8hpp_source.xhtml#l00285)



[sysc::ParticipantInfo::operator=](structsysc_1_1ParticipantInfo.xhtml#a3edb39cc4d7965fc44f613e5d9c5eb50)

ParticipantInfo &amp; operator=(ParticipantInfo &amp;&amp;)=default

Provide a move-assign operator.



[sysc::ParticipantInfo::ParticipantInfo](structsysc_1_1ParticipantInfo.xhtml#a62ca76d7ec19c59606870814aaec771e)

ParticipantInfo()=default

Provide a default constructor.



[sysc::ParticipantInfo::ParticipantInfo](structsysc_1_1ParticipantInfo.xhtml#aaa27d3d6711d46253b08d5a9faa89932)

ParticipantInfo(const std::string &amp;scHost, unsigned short scPort, const std::string &amp;participantName)

Provide a non-default constructor.

**Definition:** [CommonTypes.hpp:273](CommonTypes_8hpp_source.xhtml#l00273)



[sysc::ParticipantInfo::ParticipantInfo](structsysc_1_1ParticipantInfo.xhtml#aede3e04a870f7ed298e7df71042c452e)

ParticipantInfo(ParticipantInfo &amp;&amp;)=default

Provide a move-constructor.



[sysc::ParticipantInfo::operator=](structsysc_1_1ParticipantInfo.xhtml#aee8b24b8a6bb40e1b49d52849ffd7381)

ParticipantInfo &amp; operator=(const ParticipantInfo &amp;)=default

Provide a copy-assign operator.



[sysc::ParticipantInfo::ParticipantInfo](structsysc_1_1ParticipantInfo.xhtml#afcc2de675aa909571507b6e388c84592)

ParticipantInfo(const ParticipantInfo &amp;)=default

Provide a copy-constructor.



[sysc::ResultsInfo](structsysc_1_1ResultsInfo.xhtml)

Provide a structure for writing System Coupling results files.

**Definition:** [CommonTypes.hpp:156](CommonTypes_8hpp_source.xhtml#l00156)



[sysc::ResultsInfo::ResultsInfo](structsysc_1_1ResultsInfo.xhtml#a673c9e77e725e4d4311106fac4ea7110)

ResultsInfo(const std::string &amp;baseFileName)

Create results file info struct, given a base file name.

**Definition:** [CommonTypes.hpp:160](CommonTypes_8hpp_source.xhtml#l00160)



[sysc::ResultsInfo::baseFileName](structsysc_1_1ResultsInfo.xhtml#acc2c96ab4d0c7b8bc630583a814cead4)

std::string baseFileName

**Definition:** [CommonTypes.hpp:157](CommonTypes_8hpp_source.xhtml#l00157)



[sysc::SetupFileInfo](structsysc_1_1SetupFileInfo.xhtml)

Provide a structure for writing System Coupling setup files.

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



[sysc::SetupFileInfo::SetupFileInfo](structsysc_1_1SetupFileInfo.xhtml#a4d53c4b1663965e3dcac0ac7a86b0334)

SetupFileInfo(const std::string &amp;setupFileName, bool restartsSupported)

Provide a non-default constructor for SetupFileInfo.

**Definition:** [CommonTypes.hpp:150](CommonTypes_8hpp_source.xhtml#l00150)



[sysc::SetupFileInfo::restartsSupported](structsysc_1_1SetupFileInfo.xhtml#a65df447274a91c50920e5af5296c60e3)

bool restartsSupported

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



[sysc::SetupFileInfo::SetupFileInfo](structsysc_1_1SetupFileInfo.xhtml#a95583fe2f73ddcca1c1697af2f9eee3e)

SetupFileInfo(const std::string &amp;setupFileName)

Provide a non-default constructor for SetupFileInfo.

**Definition:** [CommonTypes.hpp:140](CommonTypes_8hpp_source.xhtml#l00140)



[sysc::SetupFileInfo::setupFileName](structsysc_1_1SetupFileInfo.xhtml#acf9bd8de151bb98c37844bce125c20d0)

std::string setupFileName

**Definition:** [CommonTypes.hpp:122](CommonTypes_8hpp_source.xhtml#l00122)



[sysc::SetupFileInfo::SetupFileInfo](structsysc_1_1SetupFileInfo.xhtml#af3e2bd60fca807c13cb906f13a662570)

SetupFileInfo()

Provide a default constructor for SetupFileInfo.

**Definition:** [CommonTypes.hpp:130](CommonTypes_8hpp_source.xhtml#l00130)



[sysc::SetupInfo](structsysc_1_1SetupInfo.xhtml)

Provide a structure for System Coupling setup information.

**Definition:** [CommonTypes.hpp:74](CommonTypes_8hpp_source.xhtml#l00074)



[sysc::SetupInfo::SetupInfo](structsysc_1_1SetupInfo.xhtml#a0808c997023319d5ec2e7eb623a172cd)

SetupInfo(enum AnalysisType analysisType, bool restartsSupported, enum Dimension dimension)

Provide a constructor for SetupInfo.

**Definition:** [CommonTypes.hpp:106](CommonTypes_8hpp_source.xhtml#l00106)



[sysc::SetupInfo::SetupInfo](structsysc_1_1SetupInfo.xhtml#a33ac9fc553fff914c295acf695b61efc)

SetupInfo(enum AnalysisType analysisType)

Provide a constructor for SetupInfo.

**Definition:** [CommonTypes.hpp:83](CommonTypes_8hpp_source.xhtml#l00083)



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

AnalysisType analysisType

**Definition:** [CommonTypes.hpp:114](CommonTypes_8hpp_source.xhtml#l00114)



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

bool restartsSupported

**Definition:** [CommonTypes.hpp:116](CommonTypes_8hpp_source.xhtml#l00116)



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

Dimension dimension

**Definition:** [CommonTypes.hpp:117](CommonTypes_8hpp_source.xhtml#l00117)



[sysc::SetupInfo::SetupInfo](structsysc_1_1SetupInfo.xhtml#ab17e9d12184e6b93080eb71dac25a328)

SetupInfo(enum AnalysisType analysisType, bool restartsSupported)

Provide a constructor for SetupInfo.

**Definition:** [CommonTypes.hpp:93](CommonTypes_8hpp_source.xhtml#l00093)



[sysc::SolutionControl](structsysc_1_1SolutionControl.xhtml)

Provide a structure containing solution control.

**Definition:** [CommonTypes.hpp:68](CommonTypes_8hpp_source.xhtml#l00068)



[sysc::SolutionControl::maximumIterations](structsysc_1_1SolutionControl.xhtml#a0c973b27756ebeaf6fbe6d456c13b697)

int maximumIterations

**Definition:** [CommonTypes.hpp:70](CommonTypes_8hpp_source.xhtml#l00070)



[sysc::SolutionControl::minimumIterations](structsysc_1_1SolutionControl.xhtml#a6c84cc77b261df44b0f7f339f77a526b)

int minimumIterations

**Definition:** [CommonTypes.hpp:69](CommonTypes_8hpp_source.xhtml#l00069)



[sysc::TimeStep](structsysc_1_1TimeStep.xhtml)

Provide a struct for time step.

**Definition:** [CommonTypes.hpp:40](CommonTypes_8hpp_source.xhtml#l00040)



[sysc::TimeStep::startTime](structsysc_1_1TimeStep.xhtml#a115810021ec63279be6a82d5deb853c2)

double startTime

**Definition:** [CommonTypes.hpp:42](CommonTypes_8hpp_source.xhtml#l00042)



[sysc::TimeStep::TimeStep](structsysc_1_1TimeStep.xhtml#a906537e7fc2612dc3d4636c5162eb5f7)

TimeStep(const TimeStep &amp;)=default

Provide a copy-constructor.



[sysc::TimeStep::operator=](structsysc_1_1TimeStep.xhtml#a908b9a5d14f4f7977be059cde82d258a)

TimeStep &amp; operator=(TimeStep &amp;&amp;)=default

Provide a move-assign operator.



[sysc::TimeStep::timeStepSize](structsysc_1_1TimeStep.xhtml#a91d6e07b37c9c461ddfc8e85965321b2)

double timeStepSize

**Definition:** [CommonTypes.hpp:43](CommonTypes_8hpp_source.xhtml#l00043)



[sysc::TimeStep::TimeStep](structsysc_1_1TimeStep.xhtml#a97ce4b55faaefbe7618a16b0363c092e)

TimeStep()=default

Provide a default constructor for TimeStep.



[sysc::TimeStep::TimeStep](structsysc_1_1TimeStep.xhtml#aa92d1684145d3aa5ed39d171d2100299)

TimeStep(int timeStepNumber, double startTime, double timeStepSize)

Provide a non-default constructor for TimeStep.

**Definition:** [CommonTypes.hpp:61](CommonTypes_8hpp_source.xhtml#l00061)



[sysc::TimeStep::timeStepNumber](structsysc_1_1TimeStep.xhtml#ab8fbdd8e8dd4384d385c3190b11a2ccf)

int timeStepNumber

**Definition:** [CommonTypes.hpp:41](CommonTypes_8hpp_source.xhtml#l00041)



[sysc::TimeStep::TimeStep](structsysc_1_1TimeStep.xhtml#ae918242dae80573ecbeb91968d8df048)

TimeStep(TimeStep &amp;&amp;)=default

Provide a move-constructor.



[sysc::TimeStep::operator=](structsysc_1_1TimeStep.xhtml#af46085bcb6747bb5e17badf99cdbc27c)

TimeStep &amp; operator=(const TimeStep &amp;)=default

Provide a copy-assign operator.



[sysc::ValidityStatus](structsysc_1_1ValidityStatus.xhtml)

Provide a struct that contains information about validity.

**Definition:** [CommonTypes.hpp:171](CommonTypes_8hpp_source.xhtml#l00171)



[sysc::ValidityStatus::ValidityStatus](structsysc_1_1ValidityStatus.xhtml#a45833f599239b5ec57232fd73ee127b5)

ValidityStatus(bool isValid, const std::string &amp;message)

Provide a non-default constructor for ValidityStatus.

**Definition:** [CommonTypes.hpp:185](CommonTypes_8hpp_source.xhtml#l00185)



[sysc::ValidityStatus::isValid](structsysc_1_1ValidityStatus.xhtml#ac45ce7d05d6ab0126511da670f3e10a9)

bool isValid

**Definition:** [CommonTypes.hpp:172](CommonTypes_8hpp_source.xhtml#l00172)



[sysc::ValidityStatus::message](structsysc_1_1ValidityStatus.xhtml#ad78928b787427d9c0edf9e7a1e3d857c)

std::string message

**Definition:** [CommonTypes.hpp:173](CommonTypes_8hpp_source.xhtml#l00173)