Skip to content

Commit

Permalink
doc update and headers
Browse files Browse the repository at this point in the history
  • Loading branch information
@giozu
giozu committed Aug 26, 2024
1 parent 87a9e33 commit 6ac467c
Show file tree
Hide file tree
Showing 155 changed files with 1,618 additions and 1,734 deletions.
2 changes: 1 addition & 1 deletion docs/_constants_8h_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment">// //</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment">// Originally developed by D. Pizzocri &amp; T. Barani //</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment">// //</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment">// Version: 2.0 //</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment">// Version: 2.1 //</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment">// Year: 2023 //</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment">// Authors: D. Pizzocri, G. Zullo. //</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment">// //</span></div>
Expand Down
8 changes: 4 additions & 4 deletions docs/_error_messages_8h_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment">// //</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment">// Originally developed by D. Pizzocri &amp; T. Barani //</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment">// //</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment">// Version: 2.0 //</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment">// Version: 2.1 //</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment">// Year: 2023 //</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment">// Authors: D. Pizzocri, G. Zullo. //</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment">// //</span></div>
Expand All @@ -101,9 +101,9 @@
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;};</div>
<div class="ttc" id="a_main_variables_8h_html"><div class="ttname"><a href="_main_variables_8h.html">MainVariables.h</a></div><div class="ttdoc">This header file contains declarations for variables that are used in MainSCIANTIX....</div></div>
<div class="ttc" id="anamespace_error_messages_html"><div class="ttname"><a href="namespace_error_messages.html">ErrorMessages</a></div><div class="ttdoc">Contains functions for error handling in SCIANTIX software.</div><div class="ttdef"><b>Definition:</b> ErrorMessages.C:20</div></div>
<div class="ttc" id="anamespace_error_messages_html_a56f68241fab2bb790dc731ae11321405"><div class="ttname"><a href="namespace_error_messages.html#a56f68241fab2bb790dc731ae11321405">ErrorMessages::MissingInputFile</a></div><div class="ttdeci">void MissingInputFile(const char *missing_file)</div><div class="ttdoc">Logs an error when an input file is missing and exits the program.</div><div class="ttdef"><b>Definition:</b> ErrorMessages.C:26</div></div>
<div class="ttc" id="anamespace_error_messages_html_a7435ab36e2c6ee4a6ca39f7f41417dd8"><div class="ttname"><a href="namespace_error_messages.html#a7435ab36e2c6ee4a6ca39f7f41417dd8">ErrorMessages::Switch</a></div><div class="ttdeci">void Switch(std::string routine, std::string variable_name, int variable)</div><div class="ttdoc">Accumulates a warning message about an out-of-range input setting.</div><div class="ttdef"><b>Definition:</b> ErrorMessages.C:41</div></div>
<div class="ttc" id="anamespace_error_messages_html_ad7d5a686487ad45e4b1eaca9e6074da4"><div class="ttname"><a href="namespace_error_messages.html#ad7d5a686487ad45e4b1eaca9e6074da4">ErrorMessages::writeErrorLog</a></div><div class="ttdeci">void writeErrorLog()</div><div class="ttdoc">Writes all accumulated error messages to the error log file.</div><div class="ttdef"><b>Definition:</b> ErrorMessages.C:47</div></div>
<div class="ttc" id="anamespace_error_messages_html_a56f68241fab2bb790dc731ae11321405"><div class="ttname"><a href="namespace_error_messages.html#a56f68241fab2bb790dc731ae11321405">ErrorMessages::MissingInputFile</a></div><div class="ttdeci">void MissingInputFile(const char *missing_file)</div><div class="ttdoc">Logs an error when an input file is missing and exits the program.</div><div class="ttdef"><b>Definition:</b> ErrorMessages.C:25</div></div>
<div class="ttc" id="anamespace_error_messages_html_a7435ab36e2c6ee4a6ca39f7f41417dd8"><div class="ttname"><a href="namespace_error_messages.html#a7435ab36e2c6ee4a6ca39f7f41417dd8">ErrorMessages::Switch</a></div><div class="ttdeci">void Switch(std::string routine, std::string variable_name, int variable)</div><div class="ttdoc">Accumulates a warning message about an out-of-range input setting.</div><div class="ttdef"><b>Definition:</b> ErrorMessages.C:40</div></div>
<div class="ttc" id="anamespace_error_messages_html_ad7d5a686487ad45e4b1eaca9e6074da4"><div class="ttname"><a href="namespace_error_messages.html#ad7d5a686487ad45e4b1eaca9e6074da4">ErrorMessages::writeErrorLog</a></div><div class="ttdeci">void writeErrorLog()</div><div class="ttdoc">Writes all accumulated error messages to the error log file.</div><div class="ttdef"><b>Definition:</b> ErrorMessages.C:46</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Expand Down
6 changes: 3 additions & 3 deletions docs/_gas_8h_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment">// //</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment">// Originally developed by D. Pizzocri &amp; T. Barani //</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment">// //</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment">// Version: 2.0 //</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment">// Version: 2.1 //</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment">// Year: 2023 //</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment">// Authors: D. Pizzocri, G. Zullo. //</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment">// //</span></div>
Expand Down Expand Up @@ -159,10 +159,10 @@
<div class="ttc" id="aclass_gas_html_a0b97469d7028b86471f40a15536f9a99"><div class="ttname"><a href="class_gas.html#a0b97469d7028b86471f40a15536f9a99">Gas::getMassNumber</a></div><div class="ttdeci">double getMassNumber()</div><div class="ttdoc">Returns the mass number of the gas.</div><div class="ttdef"><b>Definition:</b> Gas.h:72</div></div>
<div class="ttc" id="aclass_gas_html_a340d7f021c9f062b6feacae62480d1b7"><div class="ttname"><a href="class_gas.html#a340d7f021c9f062b6feacae62480d1b7">Gas::getVanDerWaalsVolume</a></div><div class="ttdeci">double getVanDerWaalsVolume()</div><div class="ttdoc">Returns the Van der Waals volume of the gas.</div><div class="ttdef"><b>Definition:</b> Gas.h:90</div></div>
<div class="ttc" id="aclass_gas_html_a36977c727cb4a4f9dd2fc1a23d2c45e0"><div class="ttname"><a href="class_gas.html#a36977c727cb4a4f9dd2fc1a23d2c45e0">Gas::setMassNumber</a></div><div class="ttdeci">void setMassNumber(double y)</div><div class="ttdoc">Sets the mass number of the gas.</div><div class="ttdef"><b>Definition:</b> Gas.h:63</div></div>
<div class="ttc" id="aclass_gas_html_a6506127f6d3c2f0e15e9592c1e0134ea"><div class="ttname"><a href="class_gas.html#a6506127f6d3c2f0e15e9592c1e0134ea">Gas::Gas</a></div><div class="ttdeci">Gas()</div><div class="ttdoc">Default constructor for the Gas class.</div><div class="ttdef"><b>Definition:</b> Gas.h:134</div></div>
<div class="ttc" id="aclass_gas_html_a6506127f6d3c2f0e15e9592c1e0134ea"><div class="ttname"><a href="class_gas.html#a6506127f6d3c2f0e15e9592c1e0134ea">Gas::Gas</a></div><div class="ttdeci">Gas()</div><div class="ttdoc">Constructor.</div><div class="ttdef"><b>Definition:</b> Gas.h:134</div></div>
<div class="ttc" id="aclass_gas_html_a65927d8adbea13e8a200bd9100e469d7"><div class="ttname"><a href="class_gas.html#a65927d8adbea13e8a200bd9100e469d7">Gas::setAtomicNumber</a></div><div class="ttdeci">void setAtomicNumber(int y)</div><div class="ttdoc">Sets the atomic number of the gas.</div><div class="ttdef"><b>Definition:</b> Gas.h:45</div></div>
<div class="ttc" id="aclass_gas_html_a6d269f6e9e0c61d4ce93bea87b6f9dba"><div class="ttname"><a href="class_gas.html#a6d269f6e9e0c61d4ce93bea87b6f9dba">Gas::getPrecursorFactor</a></div><div class="ttdeci">double getPrecursorFactor()</div><div class="ttdoc">Returns the precursor factor for nuclear reactions.</div><div class="ttdef"><b>Definition:</b> Gas.h:126</div></div>
<div class="ttc" id="aclass_gas_html_a78b0365eb5310af7b1f2f1092be31926"><div class="ttname"><a href="class_gas.html#a78b0365eb5310af7b1f2f1092be31926">Gas::~Gas</a></div><div class="ttdeci">~Gas()</div><div class="ttdoc">Destructor for the Gas class.</div><div class="ttdef"><b>Definition:</b> Gas.h:139</div></div>
<div class="ttc" id="aclass_gas_html_a78b0365eb5310af7b1f2f1092be31926"><div class="ttname"><a href="class_gas.html#a78b0365eb5310af7b1f2f1092be31926">Gas::~Gas</a></div><div class="ttdeci">~Gas()</div><div class="ttdoc">Destructor.</div><div class="ttdef"><b>Definition:</b> Gas.h:139</div></div>
<div class="ttc" id="aclass_gas_html_ab2e58d1040eb1d1afb886be830604952"><div class="ttname"><a href="class_gas.html#ab2e58d1040eb1d1afb886be830604952">Gas::setDecayRate</a></div><div class="ttdeci">void setDecayRate(double l)</div><div class="ttdoc">Sets the decay rate of the gas.</div><div class="ttdef"><b>Definition:</b> Gas.h:99</div></div>
<div class="ttc" id="aclass_gas_html_acdf7a3949d3b8c9cc8cdad3a84a4eb23"><div class="ttname"><a href="class_gas.html#acdf7a3949d3b8c9cc8cdad3a84a4eb23">Gas::getDecayRate</a></div><div class="ttdeci">double getDecayRate()</div><div class="ttdoc">Returns the decay rate of the gas.</div><div class="ttdef"><b>Definition:</b> Gas.h:108</div></div>
<div class="ttc" id="aclass_gas_html_ad6e3672b8592aca1c3e417468affed9b"><div class="ttname"><a href="class_gas.html#ad6e3672b8592aca1c3e417468affed9b">Gas::setPrecursorFactor</a></div><div class="ttdeci">void setPrecursorFactor(double h)</div><div class="ttdoc">Sets the precursor factor for nuclear reactions.</div><div class="ttdef"><b>Definition:</b> Gas.h:117</div></div>
Expand Down
8 changes: 4 additions & 4 deletions docs/_gas_diffusion_8h_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment">// //</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment">// Originally developed by D. Pizzocri &amp; T. Barani //</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment">// //</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment">// Version: 2.0 //</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment">// Version: 2.1 //</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment">// Year: 2023 //</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment">// Authors: D. Pizzocri, G. Zullo. //</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment">// //</span></div>
Expand All @@ -96,9 +96,9 @@
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;<span class="keywordtype">void</span> defineSpectralDiffusion3Equations(<a class="code" href="class_sciantix_array.html">SciantixArray&lt;System&gt;</a> &amp;sciantix_system, <a class="code" href="class_sciantix_array.html">SciantixArray&lt;Model&gt;</a> &amp;model, </div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; <a class="code" href="class_sciantix_array.html">SciantixArray&lt;SciantixVariable&gt;</a> sciantix_variable, <a class="code" href="class_sciantix_array.html">SciantixArray&lt;SciantixVariable&gt;</a> physics_variable, <span class="keywordtype">int</span> n_modes);</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; </div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;<span class="keywordtype">void</span> errorHandling(<a class="code" href="class_sciantix_array.html">SciantixArray&lt;InputVariable&gt;</a> input_variable);</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; </div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;<span class="preprocessor">#endif </span><span class="comment">// GAS_DIFFUSION_H</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;<span class="keywordtype">void</span> errorHandling(<a class="code" href="class_sciantix_array.html">SciantixArray&lt;InputVariable&gt;</a> input_variable);</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; </div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;<span class="preprocessor">#endif </span><span class="comment">// GAS_DIFFUSION_H</span></div>
<div class="ttc" id="aclass_sciantix_array_html"><div class="ttname"><a href="class_sciantix_array.html">SciantixArray&lt; System &gt;</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
Expand Down
2 changes: 1 addition & 1 deletion docs/_initialization_8h_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment">// //</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment">// Originally developed by D. Pizzocri &amp; T. Barani //</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment">// //</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment">// Version: 2.0 //</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment">// Version: 2.1 //</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment">// Year: 2023 //</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment">// Authors: D. Pizzocri, G. Zullo. //</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment">// //</span></div>
Expand Down
2 changes: 1 addition & 1 deletion docs/_input_interpolation_8h_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment">// //</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment">// Originally developed by D. Pizzocri &amp; T. Barani //</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment">// //</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment">// Version: 2.0 //</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment">// Version: 2.1 //</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment">// Year: 2023 //</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment">// Authors: D. Pizzocri, G. Zullo. //</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment">// //</span></div>
Expand Down
Loading

0 comments on commit 6ac467c

Please sign in to comment.