    

 ## On this page

  

 

 # CommonTypes

 Last update: 17.07.2025 

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

<a id="l00002" name="l00002"></a> 2\* Copyright 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\#include &lt;utility&gt;

<a id="l00012" name="l00012"></a> 12 

<a id="l00013" name="l00013"></a> 13namespace sysc {

<a id="l00014" name="l00014"></a> 14 

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

<a id="l00027" name="l00027"></a> 27 Diverging = -1,

<a id="l00028" name="l00028"></a> 28 NotYetConverged = 0,

<a id="l00029" name="l00029"></a> 29 Converged = 1,

<a id="l00030" name="l00030"></a> 30 Complete = 2,

<a id="l00031" name="l00031"></a> 31 NotEvaluated = 3

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



<a id="l00033" name="l00033"></a> 33 

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

<a id="l00036" name="l00036"></a> 36 Real = 0,

<a id="l00037" name="l00037"></a> 37 Complex = 1

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



<a id="l00039" name="l00039"></a> 39 

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

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

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

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

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

<a id="l00048" name="l00048"></a> 48 

<a id="l00050" name="l00050"></a>[ 50](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="l00051" name="l00051"></a> 51 [timeStepNumber](structsysc_1_1TimeStep.xhtml#ab8fbdd8e8dd4384d385c3190b11a2ccf)([timeStepNumber](structsysc_1_1TimeStep.xhtml#ab8fbdd8e8dd4384d385c3190b11a2ccf)),

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

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



<a id="l00054" name="l00054"></a> 54};



<a id="l00055" name="l00055"></a> 55 

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

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

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

<a id="l00060" name="l00060"></a> 60};



<a id="l00061" name="l00061"></a> 61 

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

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

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

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

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

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

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



<a id="l00075" name="l00075"></a> 75 

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

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

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

<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 [restartsSupported](structsysc_1_1SetupInfo.xhtml#a46dc0b1c447b1534103f3f05455ee717)([restartsSupported](structsysc_1_1SetupInfo.xhtml#a46dc0b1c447b1534103f3f05455ee717)){};



<a id="l00087" name="l00087"></a> 87 

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

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

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

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

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

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

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



<a id="l00102" name="l00102"></a> 102 

<a id="l00111" name="l00111"></a>[ 111](structsysc_1_1SetupInfo.xhtml#a2e9ea589149b80ffa4af670fb42defea) [SetupInfo](structsysc_1_1SetupInfo.xhtml#a2e9ea589149b80ffa4af670fb42defea)(

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

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

<a id="l00114" name="l00114"></a> 114 enum [Dimension](group__SystemCouplingParticipantAPIs.xhtml#ga47c8e4142175574918b84d336780cc7c) [dimension](structsysc_1_1SetupInfo.xhtml#a9d7c8f147afec2b6269bec443296291d),

<a id="l00115" name="l00115"></a> 115 enum [TimeIntegration](group__SystemCouplingParticipantAPIs.xhtml#gad13ee117d1f4408660fa2e70ee27b454) [timeIntegration](structsysc_1_1SetupInfo.xhtml#a11b9b07a31b9efe30b1ff2472b7a99e2)) :

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

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

<a id="l00118" name="l00118"></a> 118 [dimension](structsysc_1_1SetupInfo.xhtml#a9d7c8f147afec2b6269bec443296291d)([dimension](structsysc_1_1SetupInfo.xhtml#a9d7c8f147afec2b6269bec443296291d)),

<a id="l00119" name="l00119"></a> 119 [timeIntegration](structsysc_1_1SetupInfo.xhtml#a11b9b07a31b9efe30b1ff2472b7a99e2)([timeIntegration](structsysc_1_1SetupInfo.xhtml#a11b9b07a31b9efe30b1ff2472b7a99e2)){};



<a id="l00120" name="l00120"></a> 120 

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

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

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

<a id="l00125" name="l00125"></a>[ 125](structsysc_1_1SetupInfo.xhtml#a11b9b07a31b9efe30b1ff2472b7a99e2) [TimeIntegration](group__SystemCouplingParticipantAPIs.xhtml#gad13ee117d1f4408660fa2e70ee27b454) [timeIntegration](structsysc_1_1SetupInfo.xhtml#a11b9b07a31b9efe30b1ff2472b7a99e2){TimeIntegration::Implicit}; 

<a id="l00126" name="l00126"></a> 126};



<a id="l00127" name="l00127"></a> 127 

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

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

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

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

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



<a id="l00140" name="l00140"></a> 140 

<a id="l00148" name="l00148"></a>[ 148](structsysc_1_1SetupFileInfo.xhtml#ad61495d5f2fd0c14da1245a1e44a1737) [SetupFileInfo](structsysc_1_1SetupFileInfo.xhtml#ad61495d5f2fd0c14da1245a1e44a1737)(std::string [setupFileName](structsysc_1_1SetupFileInfo.xhtml#acf9bd8de151bb98c37844bce125c20d0)) :

<a id="l00149" name="l00149"></a> 149 [setupFileName](structsysc_1_1SetupFileInfo.xhtml#acf9bd8de151bb98c37844bce125c20d0)(std::move([setupFileName](structsysc_1_1SetupFileInfo.xhtml#acf9bd8de151bb98c37844bce125c20d0))),

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



<a id="l00151" name="l00151"></a> 151 

<a id="l00158" name="l00158"></a>[ 158](structsysc_1_1SetupFileInfo.xhtml#af78fd7b774f9096e72210180c5f68fea) [SetupFileInfo](structsysc_1_1SetupFileInfo.xhtml#af78fd7b774f9096e72210180c5f68fea)(std::string [setupFileName](structsysc_1_1SetupFileInfo.xhtml#acf9bd8de151bb98c37844bce125c20d0), bool [restartsSupported](structsysc_1_1SetupFileInfo.xhtml#a65df447274a91c50920e5af5296c60e3)) :

<a id="l00159" name="l00159"></a> 159 [setupFileName](structsysc_1_1SetupFileInfo.xhtml#acf9bd8de151bb98c37844bce125c20d0)(std::move([setupFileName](structsysc_1_1SetupFileInfo.xhtml#acf9bd8de151bb98c37844bce125c20d0))),

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



<a id="l00161" name="l00161"></a> 161};



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

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

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

<a id="l00168" name="l00168"></a>[ 168](structsysc_1_1ResultsInfo.xhtml#a2e6c0a4ff62fde1317edd3df5752bc78) [ResultsInfo](structsysc_1_1ResultsInfo.xhtml#a2e6c0a4ff62fde1317edd3df5752bc78)(std::string [baseFileName](structsysc_1_1ResultsInfo.xhtml#acc2c96ab4d0c7b8bc630583a814cead4)) :

<a id="l00169" name="l00169"></a> 169 [baseFileName](structsysc_1_1ResultsInfo.xhtml#acc2c96ab4d0c7b8bc630583a814cead4)(std::move([baseFileName](structsysc_1_1ResultsInfo.xhtml#acc2c96ab4d0c7b8bc630583a814cead4))){};



<a id="l00170" name="l00170"></a> 170};



<a id="l00171" name="l00171"></a> 171 

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

<a id="l00174" name="l00174"></a> 174 Surface = 2,

<a id="l00175" name="l00175"></a> 175 Volume = 3

<a id="l00176" name="l00176"></a> 176};



<a id="l00177" name="l00177"></a> 177 

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

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

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

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

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

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

<a id="l00186" name="l00186"></a> 186 

<a id="l00193" name="l00193"></a>[ 193](structsysc_1_1ValidityStatus.xhtml#a11dcd716f4542e1231c0e2ec25ff0d71) [ValidityStatus](structsysc_1_1ValidityStatus.xhtml#a11dcd716f4542e1231c0e2ec25ff0d71)(bool [isValid](structsysc_1_1ValidityStatus.xhtml#ac45ce7d05d6ab0126511da670f3e10a9), std::string [message](structsysc_1_1ValidityStatus.xhtml#ad78928b787427d9c0edf9e7a1e3d857c)) :

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

<a id="l00195" name="l00195"></a> 195 [message](structsysc_1_1ValidityStatus.xhtml#ad78928b787427d9c0edf9e7a1e3d857c)(std::move([message](structsysc_1_1ValidityStatus.xhtml#ad78928b787427d9c0edf9e7a1e3d857c))){};



<a id="l00196" name="l00196"></a> 196};



<a id="l00197" name="l00197"></a> 197 

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

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

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

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

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

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

<a id="l00206" name="l00206"></a> 206 

<a id="l00213" name="l00213"></a>[ 213](structsysc_1_1MeshValidityStatus.xhtml#ad75cfb4f98778300a21ac1d72efba379) [MeshValidityStatus](structsysc_1_1MeshValidityStatus.xhtml#ad75cfb4f98778300a21ac1d72efba379)(bool [isInvalid](structsysc_1_1MeshValidityStatus.xhtml#a3ee3cb844b3594fb7c3be7fce89a4f62), std::string [message](structsysc_1_1MeshValidityStatus.xhtml#ab175079553f6cc1591dbb3d0e74c8ec4)) :

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

<a id="l00215" name="l00215"></a> 215 [message](structsysc_1_1MeshValidityStatus.xhtml#ab175079553f6cc1591dbb3d0e74c8ec4)(std::move([message](structsysc_1_1MeshValidityStatus.xhtml#ab175079553f6cc1591dbb3d0e74c8ec4))){};



<a id="l00216" name="l00216"></a> 216};



<a id="l00217" name="l00217"></a> 217 

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

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

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

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

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

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

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

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



<a id="l00227" name="l00227"></a> 227 

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

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

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

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

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

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

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

<a id="l00236" name="l00236"></a>[ 236](group__SystemCouplingParticipantAPIs.xhtml#ga9cadba4f4e91a46ad88e42877c682d46)using [ParameterName](group__SystemCouplingParticipantAPIs.xhtml#ga9cadba4f4e91a46ad88e42877c682d46) = std::string; 

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

<a id="l00259" name="l00259"></a> 259 std::string scHost;

<a id="l00260" name="l00260"></a> 260 unsigned short scPort{0};

<a id="l00261" name="l00261"></a> 261 std::string participantName;

<a id="l00262" name="l00262"></a> 262 bool isCosimulation{false};

<a id="l00263" name="l00263"></a> 263 std::string buildInformation;

<a id="l00264" name="l00264"></a> 264 std::string transcriptFilename;

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

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

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

<a id="l00270" name="l00270"></a>[ 270](structsysc_1_1ParticipantInfo.xhtml#ad36586cda6d30d65c5f38e0df6ff352c) [ParticipantInfo](structsysc_1_1ParticipantInfo.xhtml#ad36586cda6d30d65c5f38e0df6ff352c)(

<a id="l00271" name="l00271"></a> 271 std::string scHost,

<a id="l00272" name="l00272"></a> 272 unsigned short scPort,

<a id="l00273" name="l00273"></a> 273 std::string participantName) :

<a id="l00274" name="l00274"></a> 274 scHost(std::move(scHost)),

<a id="l00275" name="l00275"></a> 275 scPort(scPort),

<a id="l00276" name="l00276"></a> 276 participantName(std::move(participantName)),

<a id="l00277" name="l00277"></a> 277 isCosimulation(true)

<a id="l00278" name="l00278"></a> 278 {

<a id="l00279" name="l00279"></a> 279 }



<a id="l00280" name="l00280"></a> 280 

<a id="l00282" name="l00282"></a>[ 282](structsysc_1_1ParticipantInfo.xhtml#aeee6c446f5f67d25a4647cd3e6af2208) [ParticipantInfo](structsysc_1_1ParticipantInfo.xhtml#aeee6c446f5f67d25a4647cd3e6af2208)(

<a id="l00283" name="l00283"></a> 283 std::string scHost,

<a id="l00284" name="l00284"></a> 284 unsigned short scPort,

<a id="l00285" name="l00285"></a> 285 std::string participantName,

<a id="l00286" name="l00286"></a> 286 std::string buildInformation) :

<a id="l00287" name="l00287"></a> 287 scHost(std::move(scHost)),

<a id="l00288" name="l00288"></a> 288 scPort(scPort),

<a id="l00289" name="l00289"></a> 289 participantName(std::move(participantName)),

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

<a id="l00291" name="l00291"></a> 291 buildInformation(std::move(buildInformation))

<a id="l00292" name="l00292"></a> 292 {

<a id="l00293" name="l00293"></a> 293 }



<a id="l00294" name="l00294"></a> 294 

<a id="l00296" name="l00296"></a>[ 296](structsysc_1_1ParticipantInfo.xhtml#a95ef3378c1477c0e378ff6682339a72f) [ParticipantInfo](structsysc_1_1ParticipantInfo.xhtml#a95ef3378c1477c0e378ff6682339a72f)(

<a id="l00297" name="l00297"></a> 297 std::string scHost,

<a id="l00298" name="l00298"></a> 298 unsigned short scPort,

<a id="l00299" name="l00299"></a> 299 std::string participantName,

<a id="l00300" name="l00300"></a> 300 std::string buildInformation,

<a id="l00301" name="l00301"></a> 301 std::string transcriptFilename) :

<a id="l00302" name="l00302"></a> 302 scHost(std::move(scHost)),

<a id="l00303" name="l00303"></a> 303 scPort(scPort),

<a id="l00304" name="l00304"></a> 304 participantName(std::move(participantName)),

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

<a id="l00306" name="l00306"></a> 306 buildInformation(std::move(buildInformation)),

<a id="l00307" name="l00307"></a> 307 transcriptFilename(std::move(transcriptFilename))

<a id="l00308" name="l00308"></a> 308 {

<a id="l00309" name="l00309"></a> 309 }



<a id="l00310" name="l00310"></a> 310};



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

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

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

ConvergenceStatus

Provide enum for participant's solver convergence status.

**Definition** [CommonTypes.hpp:26](CommonTypes_8hpp_source.xhtml#l00026)



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

void * OpaqueDataAccess

**Definition** [CommonTypes.hpp:228](CommonTypes_8hpp_source.xhtml#l00228)



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

Dimension

Provide an enum for participant dimension.

**Definition** [CommonSettings.hpp:26](CommonSettings_8hpp_source.xhtml#l00026)



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

std::string VariableName

**Definition** [CommonTypes.hpp:231](CommonTypes_8hpp_source.xhtml#l00231)



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

std::string DisplayName

**Definition** [CommonTypes.hpp:234](CommonTypes_8hpp_source.xhtml#l00234)



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

std::string CouplingInterfaceName

**Definition** [CommonTypes.hpp:232](CommonTypes_8hpp_source.xhtml#l00232)



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

DataType

Provide enum for variable data types.

**Definition** [CommonTypes.hpp:35](CommonTypes_8hpp_source.xhtml#l00035)



[sysc::ParameterName](group__SystemCouplingParticipantAPIs.xhtml#ga9cadba4f4e91a46ad88e42877c682d46)

std::string ParameterName

**Definition** [CommonTypes.hpp:236](CommonTypes_8hpp_source.xhtml#l00236)



[sysc::TimeIntegration](group__SystemCouplingParticipantAPIs.xhtml#gad13ee117d1f4408660fa2e70ee27b454)

TimeIntegration

Provide an enum for time integration.

**Definition** [CommonSettings.hpp:20](CommonSettings_8hpp_source.xhtml#l00020)



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

PrimitiveType

Provide enum for supported primitive types.

**Definition** [CommonTypes.hpp:219](CommonTypes_8hpp_source.xhtml#l00219)



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

std::string RegionName

**Definition** [CommonTypes.hpp:230](CommonTypes_8hpp_source.xhtml#l00230)



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

std::string AttributeName

**Definition** [CommonTypes.hpp:235](CommonTypes_8hpp_source.xhtml#l00235)



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

Topology

Provide enum for region topologies.

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



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

std::string RestartPoint

**Definition** [CommonTypes.hpp:233](CommonTypes_8hpp_source.xhtml#l00233)



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

AnalysisType

Provide an enum for coupled analysis type.

**Definition** [CommonSettings.hpp:14](CommonSettings_8hpp_source.xhtml#l00014)



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

@ Double

**Definition** [CommonTypes.hpp:221](CommonTypes_8hpp_source.xhtml#l00221)



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

@ Int32

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



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

@ Int64

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



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

@ UnsignedInt64

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



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

@ UnsignedInt16

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



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

@ Float

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



[sysc::MeshValidityStatus](structsysc_1_1MeshValidityStatus.xhtml)

Provide a struct that contains information about mesh validity.

**Definition** [CommonTypes.hpp:199](CommonTypes_8hpp_source.xhtml#l00199)



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

bool isInvalid

**Definition** [CommonTypes.hpp:200](CommonTypes_8hpp_source.xhtml#l00200)



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

std::string message

**Definition** [CommonTypes.hpp:201](CommonTypes_8hpp_source.xhtml#l00201)



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

MeshValidityStatus(bool isInvalid, std::string message)

Provide a non-default constructor for MeshValidityStatus.

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



[sysc::ParticipantInfo](structsysc_1_1ParticipantInfo.xhtml)

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

**Definition** [CommonTypes.hpp:258](CommonTypes_8hpp_source.xhtml#l00258)



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

ParticipantInfo()=default

Provide a default constructor.



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

ParticipantInfo(std::string scHost, unsigned short scPort, std::string participantName, std::string buildInformation, std::string transcriptFilename)

Provide a non-default constructor.

**Definition** [CommonTypes.hpp:296](CommonTypes_8hpp_source.xhtml#l00296)



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

ParticipantInfo(std::string scHost, unsigned short scPort, std::string participantName)

Provide a non-default constructor.

**Definition** [CommonTypes.hpp:270](CommonTypes_8hpp_source.xhtml#l00270)



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

ParticipantInfo(std::string scHost, unsigned short scPort, std::string participantName, std::string buildInformation)

Provide a non-default constructor.

**Definition** [CommonTypes.hpp:282](CommonTypes_8hpp_source.xhtml#l00282)



[sysc::ResultsInfo](structsysc_1_1ResultsInfo.xhtml)

Provide a structure for writing System Coupling results files.

**Definition** [CommonTypes.hpp:164](CommonTypes_8hpp_source.xhtml#l00164)



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

ResultsInfo(std::string baseFileName)

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

**Definition** [CommonTypes.hpp:168](CommonTypes_8hpp_source.xhtml#l00168)



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

std::string baseFileName

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



[sysc::SetupFileInfo](structsysc_1_1SetupFileInfo.xhtml)

Provide a structure for writing System Coupling setup files.

**Definition** [CommonTypes.hpp:129](CommonTypes_8hpp_source.xhtml#l00129)



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

bool restartsSupported

**Definition** [CommonTypes.hpp:131](CommonTypes_8hpp_source.xhtml#l00131)



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

std::string setupFileName

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



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

SetupFileInfo(std::string setupFileName)

Provide a non-default constructor for SetupFileInfo.

**Definition** [CommonTypes.hpp:148](CommonTypes_8hpp_source.xhtml#l00148)



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

SetupFileInfo()

Provide a default constructor for SetupFileInfo.

**Definition** [CommonTypes.hpp:138](CommonTypes_8hpp_source.xhtml#l00138)



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

SetupFileInfo(std::string setupFileName, bool restartsSupported)

Provide a non-default constructor for SetupFileInfo.

**Definition** [CommonTypes.hpp:158](CommonTypes_8hpp_source.xhtml#l00158)



[sysc::SetupInfo](structsysc_1_1SetupInfo.xhtml)

Provide a structure for System Coupling setup information.

**Definition** [CommonTypes.hpp:63](CommonTypes_8hpp_source.xhtml#l00063)



[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:95](CommonTypes_8hpp_source.xhtml#l00095)



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

TimeIntegration timeIntegration

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



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

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

Provide a constructor for SetupInfo.

**Definition** [CommonTypes.hpp:111](CommonTypes_8hpp_source.xhtml#l00111)



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

SetupInfo(enum AnalysisType analysisType)

Provide a constructor for SetupInfo.

**Definition** [CommonTypes.hpp:72](CommonTypes_8hpp_source.xhtml#l00072)



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

AnalysisType analysisType

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



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

bool restartsSupported

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



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

Dimension dimension

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



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

SetupInfo(enum AnalysisType analysisType, bool restartsSupported)

Provide a constructor for SetupInfo.

**Definition** [CommonTypes.hpp:82](CommonTypes_8hpp_source.xhtml#l00082)



[sysc::SolutionControl](structsysc_1_1SolutionControl.xhtml)

Provide a structure containing solution control.

**Definition** [CommonTypes.hpp:57](CommonTypes_8hpp_source.xhtml#l00057)



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

int maximumIterations

**Definition** [CommonTypes.hpp:59](CommonTypes_8hpp_source.xhtml#l00059)



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

int minimumIterations

**Definition** [CommonTypes.hpp:58](CommonTypes_8hpp_source.xhtml#l00058)



[sysc::TimeStep](structsysc_1_1TimeStep.xhtml)

Provide a struct for time step.

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



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

double startTime

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



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

double timeStepSize

**Definition** [CommonTypes.hpp:44](CommonTypes_8hpp_source.xhtml#l00044)



[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:50](CommonTypes_8hpp_source.xhtml#l00050)



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

int timeStepNumber

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



[sysc::ValidityStatus](structsysc_1_1ValidityStatus.xhtml)

Provide a struct that contains information about validity.

**Definition** [CommonTypes.hpp:179](CommonTypes_8hpp_source.xhtml#l00179)



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

ValidityStatus(bool isValid, std::string message)

Provide a non-default constructor for ValidityStatus.

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



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

bool isValid

**Definition** [CommonTypes.hpp:180](CommonTypes_8hpp_source.xhtml#l00180)



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

std::string message

**Definition** [CommonTypes.hpp:181](CommonTypes_8hpp_source.xhtml#l00181)