docs(docs): rebuilt docs for version 1.7.0

This commit is contained in:
2025-09-16 11:24:28 -04:00
parent 461d4ecbe7
commit 25ba902534
101 changed files with 53352 additions and 52284 deletions

View File

@@ -253,10 +253,10 @@ Friends</h2></td></tr>
<div class="line"> <span class="keywordflow">return</span> 0;</div>
<div class="line">}</div>
<div class="ttc" id="aatomic_species_8h_html"><div class="ttname"><a href="atomic_species_8h.html">atomicSpecies.h</a></div></div>
<div class="ttc" id="astructfourdst_1_1atomic_1_1_species_html"><div class="ttname"><a href="structfourdst_1_1atomic_1_1_species.html">fourdst::atomic::Species</a></div><div class="ttdoc">Represents an atomic species (isotope) with its fundamental physical properties.</div><div class="ttdef"><b>Definition</b> <a href="atomic_species_8h_source.html#l00048">atomicSpecies.h:48</a></div></div>
<div class="ttc" id="astructfourdst_1_1atomic_1_1_species_html"><div class="ttname"><a href="structfourdst_1_1atomic_1_1_species.html">fourdst::atomic::Species</a></div><div class="ttdoc">Represents an atomic species (isotope) with its fundamental physical properties.</div><div class="ttdef"><b>Definition</b> <a href="atomic_species_8h_source.html#l00051">atomicSpecies.h:51</a></div></div>
</div><!-- fragment --> </dd></dl>
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00048">48</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00051">51</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a3756508a18b57a60f68f1b0cf58d303c" name="a3756508a18b57a60f68f1b0cf58d303c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3756508a18b57a60f68f1b0cf58d303c">&#9670;&#160;</a></span>Species() <span class="overload">[1/2]</span></h2>
@@ -367,7 +367,7 @@ Friends</h2></td></tr>
</dl>
<dl class="section post"><dt>Postcondition</dt><dd>The <code>m_spin</code> member is initialized by parsing <code>m_spinParity</code> using <code>convert_jpi_to_double</code>. </dd></dl>
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00085">85</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00088">88</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
</div>
</div>
@@ -403,7 +403,7 @@ Friends</h2></td></tr>
</dl>
<dl class="section post"><dt>Postcondition</dt><dd>A new <a class="el" href="structfourdst_1_1atomic_1_1_species.html" title="Represents an atomic species (isotope) with its fundamental physical properties.">Species</a> object is created as a deep copy of <code>species</code>. The <code>m_spin</code> member is re-calculated. </dd></dl>
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00123">123</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00126">126</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
</div>
</div>
@@ -434,7 +434,7 @@ Friends</h2></td></tr>
<p>Gets the mass number. </p>
<dl class="section return"><dt>Returns</dt><dd>The mass number (A = N + Z). </dd></dl>
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00250">250</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00253">253</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
</div>
</div>
@@ -464,7 +464,7 @@ Friends</h2></td></tr>
<p>Gets the beta decay code. </p>
<dl class="section return"><dt>Returns</dt><dd>A string_view of the beta decay code. </dd></dl>
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00202">202</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00205">205</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
</div>
</div>
@@ -494,7 +494,7 @@ Friends</h2></td></tr>
<p>Gets the beta decay energy of the species. </p>
<dl class="section return"><dt>Returns</dt><dd>The beta decay energy in keV. </dd></dl>
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00194">194</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00197">197</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
</div>
</div>
@@ -524,7 +524,7 @@ Friends</h2></td></tr>
<p>Gets the binding energy of the species. </p>
<dl class="section return"><dt>Returns</dt><dd>The binding energy in keV. </dd></dl>
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00186">186</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00189">189</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
</div>
</div>
@@ -554,7 +554,7 @@ Friends</h2></td></tr>
<p>Gets the decay modes as a string. </p>
<dl class="section return"><dt>Returns</dt><dd>A string_view of the decay modes. </dd></dl>
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00178">178</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00181">181</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
</div>
</div>
@@ -584,7 +584,7 @@ Friends</h2></td></tr>
<p>Gets the element symbol of the species. </p>
<dl class="section return"><dt>Returns</dt><dd>A string_view of the element symbol (e.g., "Fe"). </dd></dl>
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00218">218</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00221">221</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
</div>
</div>
@@ -614,7 +614,7 @@ Friends</h2></td></tr>
<p>Gets the half-life of the species. </p>
<dl class="section return"><dt>Returns</dt><dd>The half-life in seconds. </dd></dl>
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00162">162</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00165">165</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
</div>
</div>
@@ -644,7 +644,7 @@ Friends</h2></td></tr>
<p>Gets the atomic mass of the species. </p>
<dl class="section return"><dt>Returns</dt><dd>The atomic mass in atomic mass units (u). </dd></dl>
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00146">146</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00149">149</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
</div>
</div>
@@ -674,7 +674,7 @@ Friends</h2></td></tr>
<p>Gets the uncertainty in the atomic mass. </p>
<dl class="section return"><dt>Returns</dt><dd>The atomic mass uncertainty. </dd></dl>
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00154">154</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00157">157</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
</div>
</div>
@@ -704,7 +704,7 @@ Friends</h2></td></tr>
<p>Gets the number of neutrons. </p>
<dl class="section return"><dt>Returns</dt><dd>The number of neutrons (N). </dd></dl>
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00234">234</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00237">237</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
</div>
</div>
@@ -734,7 +734,7 @@ Friends</h2></td></tr>
<p>Gets the name of the species. </p>
<dl class="section return"><dt>Returns</dt><dd>A string_view of the species name (e.g., "Fe56"). </dd></dl>
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00210">210</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00213">213</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
</div>
</div>
@@ -764,7 +764,7 @@ Friends</h2></td></tr>
<p>Gets the NZ identifier of the species. </p>
<dl class="section return"><dt>Returns</dt><dd>The NZ identifier (1000*Z + A). </dd></dl>
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00226">226</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00229">229</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
</div>
</div>
@@ -794,7 +794,7 @@ Friends</h2></td></tr>
<p>Gets the nuclear spin as a numeric value. </p>
<dl class="section return"><dt>Returns</dt><dd>The spin as a double. </dd></dl>
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00258">258</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00261">261</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
</div>
</div>
@@ -824,7 +824,7 @@ Friends</h2></td></tr>
<p>Gets the spin and parity as a string. </p>
<dl class="section return"><dt>Returns</dt><dd>A string_view of the spin and parity (e.g., "1/2+"). </dd></dl>
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00170">170</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00173">173</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
</div>
</div>
@@ -854,7 +854,7 @@ Friends</h2></td></tr>
<p>Gets the atomic number (number of protons). </p>
<dl class="section return"><dt>Returns</dt><dd>The atomic number (Z). </dd></dl>
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00242">242</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00245">245</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
</div>
</div>
@@ -896,7 +896,7 @@ Friends</h2></td></tr>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if the names are different, <code>false</code> otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00293">293</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00296">296</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
</div>
</div>
@@ -937,7 +937,7 @@ Friends</h2></td></tr>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if lhs atomic mass is less than rhs atomic mass, <code>false</code> otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00302">302</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00305">305</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
</div>
</div>
@@ -978,7 +978,7 @@ Friends</h2></td></tr>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The output stream with the species name. </dd></dl>
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00268">268</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00271">271</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
</div>
</div>
@@ -1019,7 +1019,7 @@ Friends</h2></td></tr>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if the names are identical, <code>false</code> otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00284">284</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00287">287</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
</div>
</div>
@@ -1060,7 +1060,7 @@ Friends</h2></td></tr>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if lhs atomic mass is greater than rhs atomic mass, <code>false</code> otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00311">311</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00314">314</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
</div>
</div>
@@ -1079,7 +1079,7 @@ Friends</h2></td></tr>
<p>Mass number (N + Z). </p>
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00054">54</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00057">57</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
</div>
</div>
@@ -1097,7 +1097,7 @@ Friends</h2></td></tr>
<p>Atomic mass in atomic mass units (u). </p>
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00061">61</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00064">64</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
</div>
</div>
@@ -1115,7 +1115,7 @@ Friends</h2></td></tr>
<p>Uncertainty in the atomic mass. </p>
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00062">62</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00065">65</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
</div>
</div>
@@ -1133,7 +1133,7 @@ Friends</h2></td></tr>
<p>Beta decay code. </p>
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00056">56</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00059">59</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
</div>
</div>
@@ -1151,7 +1151,7 @@ Friends</h2></td></tr>
<p>Beta decay energy in keV. </p>
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00057">57</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00060">60</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
</div>
</div>
@@ -1169,7 +1169,7 @@ Friends</h2></td></tr>
<p>Binding energy in keV. </p>
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00055">55</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00058">58</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
</div>
</div>
@@ -1187,7 +1187,7 @@ Friends</h2></td></tr>
<p>Decay modes as a string. </p>
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00060">60</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00063">63</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
</div>
</div>
@@ -1205,7 +1205,7 @@ Friends</h2></td></tr>
<p>Element symbol (e.g., "Fe"). </p>
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00050">50</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00053">53</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
</div>
</div>
@@ -1223,7 +1223,7 @@ Friends</h2></td></tr>
<p>Half-life in seconds. A value of -1.0 typically indicates stability. </p>
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00058">58</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00061">61</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
</div>
</div>
@@ -1241,7 +1241,7 @@ Friends</h2></td></tr>
<p>Number of neutrons. </p>
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00052">52</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00055">55</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
</div>
</div>
@@ -1259,7 +1259,7 @@ Friends</h2></td></tr>
<p>Name of the species (e.g., "Fe56"). </p>
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00049">49</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00052">52</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
</div>
</div>
@@ -1277,7 +1277,7 @@ Friends</h2></td></tr>
<p>NZ identifier, typically 1000*Z + A. </p>
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00051">51</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00054">54</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
</div>
</div>
@@ -1295,7 +1295,7 @@ Friends</h2></td></tr>
<p>Nuclear spin as a double, derived from m_spinParity. </p>
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00063">63</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00066">66</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
</div>
</div>
@@ -1313,7 +1313,7 @@ Friends</h2></td></tr>
<p>Spin and parity as a string (e.g., "1/2-"). </p>
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00059">59</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00062">62</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
</div>
</div>
@@ -1331,7 +1331,7 @@ Friends</h2></td></tr>
<p>Atomic number (number of protons). </p>
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00053">53</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00056">56</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
</div>
</div>