tboudreaux/libcomposition
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(docs): rebuilt docs for version 1.7.0

Browse Source
This commit is contained in:
Emily Boudreaux
2025-09-16 11:24:28 -04:00
parent 461d4ecbe7
commit 25ba902534
101 changed files with 53352 additions and 52284 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
docs/html/structfourdst_1_1composition_1_1_composition_entry.html
View File

@@ -217,7 +217,7 @@ Friends</h2></td></tr>
<p>Default constructor. Initializes a default entry (H-1), but in an uninitialized state. </p>
<p class="definition">Definition at line <a class="el" href="composition_8cpp_source.html#l00038">38</a> of file <a class="el" href="composition_8cpp_source.html">composition.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="composition_8cpp_source.html#l00063">63</a> of file <a class="el" href="composition_8cpp_source.html">composition.cpp</a>.</p>
</div>
</div>
@@ -264,10 +264,10 @@ Friends</h2></td></tr>
</dd>
</dl>
<dl class="section user"><dt>Usage Example:</dt><dd><div class="fragment"><div class="line"><a class="code hl_function" href="#a1cccb94c150dd1dcde860f55fbeaf2bd">CompositionEntry</a> entry(<span class="stringliteral">&quot;H-1&quot;</span>, <span class="keyword">true</span>); <span class="comment">// Entry for H-1 in mass fraction mode.</span></div>
<div class="ttc" id="astructfourdst_1_1composition_1_1_composition_entry_html_a1cccb94c150dd1dcde860f55fbeaf2bd"><div class="ttname"><a href="#a1cccb94c150dd1dcde860f55fbeaf2bd">fourdst::composition::CompositionEntry::CompositionEntry</a></div><div class="ttdeci">CompositionEntry()</div><div class="ttdoc">Default constructor. Initializes a default entry (H-1), but in an uninitialized state.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00038">composition.cpp:38</a></div></div>
<div class="ttc" id="astructfourdst_1_1composition_1_1_composition_entry_html_a1cccb94c150dd1dcde860f55fbeaf2bd"><div class="ttname"><a href="#a1cccb94c150dd1dcde860f55fbeaf2bd">fourdst::composition::CompositionEntry::CompositionEntry</a></div><div class="ttdeci">CompositionEntry()</div><div class="ttdoc">Default constructor. Initializes a default entry (H-1), but in an uninitialized state.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00063">composition.cpp:63</a></div></div>
</div><!-- fragment --> </dd></dl>
<p class="definition">Definition at line <a class="el" href="composition_8cpp_source.html#l00043">43</a> of file <a class="el" href="composition_8cpp_source.html">composition.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="composition_8cpp_source.html#l00068">68</a> of file <a class="el" href="composition_8cpp_source.html">composition.cpp</a>.</p>
</div>
</div>
@@ -294,7 +294,7 @@ Friends</h2></td></tr>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="composition_8cpp_source.html#l00047">47</a> of file <a class="el" href="composition_8cpp_source.html">composition.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="composition_8cpp_source.html#l00072">72</a> of file <a class="el" href="composition_8cpp_source.html">composition.cpp</a>.</p>
</div>
</div>
@@ -325,7 +325,7 @@ Friends</h2></td></tr>
<p>Gets the mode of the composition entry. </p>
<dl class="section return"><dt>Returns</dt><dd>True if in mass fraction mode, false if in number fraction mode. </dd></dl>
<p class="definition">Definition at line <a class="el" href="composition_8cpp_source.html#l00147">147</a> of file <a class="el" href="composition_8cpp_source.html">composition.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="composition_8cpp_source.html#l00172">172</a> of file <a class="el" href="composition_8cpp_source.html">composition.cpp</a>.</p>
</div>
</div>
@@ -355,7 +355,7 @@ Friends</h2></td></tr>
<p>Gets the isotope data for the species. </p>
<dl class="section return"><dt>Returns</dt><dd>A const reference to the <code><a class="el" href="structfourdst_1_1atomic_1_1_species.html" title="Represents an atomic species (isotope) with its fundamental physical properties.">atomic::Species</a></code> object. </dd></dl>
<p class="definition">Definition at line <a class="el" href="composition_8cpp_source.html#l00109">109</a> of file <a class="el" href="composition_8cpp_source.html">composition.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="composition_8cpp_source.html#l00134">134</a> of file <a class="el" href="composition_8cpp_source.html">composition.cpp</a>.</p>
</div>
</div>
@@ -392,7 +392,7 @@ Friends</h2></td></tr>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="composition_8cpp_source.html#l00072">72</a> of file <a class="el" href="composition_8cpp_source.html">composition.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="composition_8cpp_source.html#l00097">97</a> of file <a class="el" href="composition_8cpp_source.html">composition.cpp</a>.</p>
</div>
</div>
@@ -428,7 +428,7 @@ Friends</h2></td></tr>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The mass fraction of the species. </dd></dl>
<p class="definition">Definition at line <a class="el" href="composition_8cpp_source.html#l00079">79</a> of file <a class="el" href="composition_8cpp_source.html">composition.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="composition_8cpp_source.html#l00104">104</a> of file <a class="el" href="composition_8cpp_source.html">composition.cpp</a>.</p>
</div>
</div>
@@ -465,7 +465,7 @@ Friends</h2></td></tr>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="composition_8cpp_source.html#l00089">89</a> of file <a class="el" href="composition_8cpp_source.html">composition.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="composition_8cpp_source.html#l00114">114</a> of file <a class="el" href="composition_8cpp_source.html">composition.cpp</a>.</p>
</div>
</div>
@@ -501,7 +501,7 @@ Friends</h2></td></tr>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The number fraction of the species. </dd></dl>
<p class="definition">Definition at line <a class="el" href="composition_8cpp_source.html#l00096">96</a> of file <a class="el" href="composition_8cpp_source.html">composition.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="composition_8cpp_source.html#l00121">121</a> of file <a class="el" href="composition_8cpp_source.html">composition.cpp</a>.</p>
</div>
</div>
@@ -531,7 +531,7 @@ Friends</h2></td></tr>
<p>Gets the relative abundance of the species. </p>
<dl class="section return"><dt>Returns</dt><dd>The relative abundance. </dd></dl>
<p class="definition">Definition at line <a class="el" href="composition_8cpp_source.html#l00105">105</a> of file <a class="el" href="composition_8cpp_source.html">composition.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="composition_8cpp_source.html#l00130">130</a> of file <a class="el" href="composition_8cpp_source.html">composition.cpp</a>.</p>
</div>
</div>
@@ -559,7 +559,7 @@ Friends</h2></td></tr>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if the mode was successfully set, false otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="composition_8cpp_source.html#l00129">129</a> of file <a class="el" href="composition_8cpp_source.html">composition.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="composition_8cpp_source.html#l00154">154</a> of file <a class="el" href="composition_8cpp_source.html">composition.cpp</a>.</p>
</div>
</div>
@@ -593,7 +593,7 @@ Friends</h2></td></tr>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="composition_8cpp_source.html#l00113">113</a> of file <a class="el" href="composition_8cpp_source.html">composition.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="composition_8cpp_source.html#l00138">138</a> of file <a class="el" href="composition_8cpp_source.html">composition.cpp</a>.</p>
</div>
</div>
@@ -621,7 +621,7 @@ Friends</h2></td></tr>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if the mode was successfully set, false otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="composition_8cpp_source.html#l00138">138</a> of file <a class="el" href="composition_8cpp_source.html">composition.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="composition_8cpp_source.html#l00163">163</a> of file <a class="el" href="composition_8cpp_source.html">composition.cpp</a>.</p>
</div>
</div>
@@ -655,7 +655,7 @@ Friends</h2></td></tr>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="composition_8cpp_source.html#l00121">121</a> of file <a class="el" href="composition_8cpp_source.html">composition.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="composition_8cpp_source.html#l00146">146</a> of file <a class="el" href="composition_8cpp_source.html">composition.cpp</a>.</p>
</div>
</div>
@@ -689,7 +689,7 @@ Friends</h2></td></tr>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="composition_8cpp_source.html#l00056">56</a> of file <a class="el" href="composition_8cpp_source.html">composition.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="composition_8cpp_source.html#l00081">81</a> of file <a class="el" href="composition_8cpp_source.html">composition.cpp</a>.</p>
</div>
</div>
@@ -719,7 +719,7 @@ Friends</h2></td></tr>
<p>Gets the chemical symbol of the species. </p>
<dl class="section return"><dt>Returns</dt><dd>The chemical symbol. </dd></dl>
<p class="definition">Definition at line <a class="el" href="composition_8cpp_source.html#l00068">68</a> of file <a class="el" href="composition_8cpp_source.html">composition.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="composition_8cpp_source.html#l00093">93</a> of file <a class="el" href="composition_8cpp_source.html">composition.cpp</a>.</p>
</div>
</div>
@@ -761,7 +761,7 @@ Friends</h2></td></tr>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The output stream. </dd></dl>
<p class="definition">Definition at line <a class="el" href="composition_8cpp_source.html#l00767">767</a> of file <a class="el" href="composition_8cpp_source.html">composition.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="composition_8cpp_source.html#l00932">932</a> of file <a class="el" href="composition_8cpp_source.html">composition.cpp</a>.</p>
</div>
</div>