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

docs(docs): rebuilt docs

Browse Source
This commit is contained in:
Emily Boudreaux
2025-10-12 10:22:43 -04:00
parent 51dba31a44
commit 8be8ac3b65
202 changed files with 24039 additions and 161918 deletions
Download Patch File Download Diff File Expand all files Collapse all files

180
docs/html/structfourdst_1_1composition_1_1_composition_entry.html
View File

@@ -29,7 +29,7 @@
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">fourdst::libcomposition<span id="projectnumber">&#160;v1.5.2</span>
<div id="projectname">fourdst::libcomposition<span id="projectnumber">&#160;v1.9.0</span>
</div>
<div id="projectbrief">Robust atomic species information library</div>
</td>
@@ -133,21 +133,18 @@ Public Member Functions</h2></td></tr>
<tr class="memitem:a66cb086719d7f654869bd7b0cee87ffc" id="r_a66cb086719d7f654869bd7b0cee87ffc"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a66cb086719d7f654869bd7b0cee87ffc">mass_fraction</a> () const</td></tr>
<tr class="memdesc:a66cb086719d7f654869bd7b0cee87ffc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the mass fraction of the species. <br /></td></tr>
<tr class="separator:a66cb086719d7f654869bd7b0cee87ffc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a27b0ae0f7ef9469d515c4c7b6ec8dc22" id="r_a27b0ae0f7ef9469d515c4c7b6ec8dc22"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a27b0ae0f7ef9469d515c4c7b6ec8dc22">mass_fraction</a> (double meanMolarMass) const</td></tr>
<tr class="memdesc:a27b0ae0f7ef9469d515c4c7b6ec8dc22"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the mass fraction, converting from number fraction if necessary. <br /></td></tr>
<tr class="separator:a27b0ae0f7ef9469d515c4c7b6ec8dc22"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2d55492d285068d4a64db5602dfb1c78" id="r_a2d55492d285068d4a64db5602dfb1c78"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a2d55492d285068d4a64db5602dfb1c78">number_fraction</a> () const</td></tr>
<tr class="memdesc:a2d55492d285068d4a64db5602dfb1c78"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the number fraction of the species. <br /></td></tr>
<tr class="separator:a2d55492d285068d4a64db5602dfb1c78"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab96d976b53f3828237525005b904a39c" id="r_ab96d976b53f3828237525005b904a39c"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab96d976b53f3828237525005b904a39c">number_fraction</a> (double totalMoles) const</td></tr>
<tr class="memdesc:ab96d976b53f3828237525005b904a39c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the number fraction, converting from mass fraction if necessary. <br /></td></tr>
<tr class="separator:ab96d976b53f3828237525005b904a39c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aed91b28f66ed3e0937905c174712c3ca" id="r_aed91b28f66ed3e0937905c174712c3ca"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aed91b28f66ed3e0937905c174712c3ca">number_fraction</a> (double totalMolesPerMass) const</td></tr>
<tr class="memdesc:aed91b28f66ed3e0937905c174712c3ca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the number fraction, converting from mass fraction if necessary. <br /></td></tr>
<tr class="separator:aed91b28f66ed3e0937905c174712c3ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab6619d23e111905d1e3ab16ee822d96c" id="r_ab6619d23e111905d1e3ab16ee822d96c"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab6619d23e111905d1e3ab16ee822d96c">rel_abundance</a> () const</td></tr>
<tr class="memdesc:ab6619d23e111905d1e3ab16ee822d96c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the relative abundance of the species. <br /></td></tr>
<tr class="separator:ab6619d23e111905d1e3ab16ee822d96c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af4f8d292d18755670a914072e2260dfb" id="r_af4f8d292d18755670a914072e2260dfb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structfourdst_1_1atomic_1_1_species.html">atomic::Species</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af4f8d292d18755670a914072e2260dfb">isotope</a> () const</td></tr>
<tr class="memdesc:af4f8d292d18755670a914072e2260dfb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the isotope data for the species. <br /></td></tr>
<tr class="separator:af4f8d292d18755670a914072e2260dfb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af49920b1168be92d517aea03a308fee1" id="r_af49920b1168be92d517aea03a308fee1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structfourdst_1_1atomic_1_1_species.html">atomic::Species</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af49920b1168be92d517aea03a308fee1">isotope</a> () const</td></tr>
<tr class="memdesc:af49920b1168be92d517aea03a308fee1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the isotope data for the species. <br /></td></tr>
<tr class="separator:af49920b1168be92d517aea03a308fee1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a14f12b8b0178df2e32e2023bd4564ddc" id="r_a14f12b8b0178df2e32e2023bd4564ddc"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a14f12b8b0178df2e32e2023bd4564ddc">getMassFracMode</a> () const</td></tr>
<tr class="memdesc:a14f12b8b0178df2e32e2023bd4564ddc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the mode of the composition entry. <br /></td></tr>
<tr class="separator:a14f12b8b0178df2e32e2023bd4564ddc"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -160,9 +157,9 @@ Public Member Functions</h2></td></tr>
<tr class="memitem:a3fb3f63a4e5675c6fefb662a8e3e7aa3" id="r_a3fb3f63a4e5675c6fefb662a8e3e7aa3"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a3fb3f63a4e5675c6fefb662a8e3e7aa3">setMassFracMode</a> (double meanMolarMass)</td></tr>
<tr class="memdesc:a3fb3f63a4e5675c6fefb662a8e3e7aa3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Switches the mode to mass fraction mode. <br /></td></tr>
<tr class="separator:a3fb3f63a4e5675c6fefb662a8e3e7aa3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a743042d1998875851150d789817f5473" id="r_a743042d1998875851150d789817f5473"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a743042d1998875851150d789817f5473">setNumberFracMode</a> (double totalMoles)</td></tr>
<tr class="memdesc:a743042d1998875851150d789817f5473"><td class="mdescLeft">&#160;</td><td class="mdescRight">Switches the mode to number fraction mode. <br /></td></tr>
<tr class="separator:a743042d1998875851150d789817f5473"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a00332551f5b2f0d7f10b12a091e21fa8" id="r_a00332551f5b2f0d7f10b12a091e21fa8"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a00332551f5b2f0d7f10b12a091e21fa8">setNumberFracMode</a> (double totalMolesPerMass)</td></tr>
<tr class="memdesc:a00332551f5b2f0d7f10b12a091e21fa8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Switches the mode to number fraction mode. <br /></td></tr>
<tr class="separator:a00332551f5b2f0d7f10b12a091e21fa8"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
@@ -184,6 +181,11 @@ Public Attributes</h2></td></tr>
<tr class="memitem:a0498d707d8ea78be39283786c10657ef" id="r_a0498d707d8ea78be39283786c10657ef"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0498d707d8ea78be39283786c10657ef">m_relAbundance</a> = 0.0</td></tr>
<tr class="memdesc:a0498d707d8ea78be39283786c10657ef"><td class="mdescLeft">&#160;</td><td class="mdescRight">The relative abundance, used internally for conversions. For mass fraction mode, this is X_i / A_i; for number fraction mode, it's n_i * A_i. <br /></td></tr>
<tr class="separator:a0498d707d8ea78be39283786c10657ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acd41be41f03c819521bab28ea0d8bed2" id="r_acd41be41f03c819521bab28ea0d8bed2"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#acd41be41f03c819521bab28ea0d8bed2">m_molesPerMass</a> = 0.0</td></tr>
<tr class="separator:acd41be41f03c819521bab28ea0d8bed2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3b056b6b923016d271f034333c96d039" id="r_a3b056b6b923016d271f034333c96d039"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a3b056b6b923016d271f034333c96d039">m_cachedNumberFraction</a> = 0.0</td></tr>
<tr class="memdesc:a3b056b6b923016d271f034333c96d039"><td class="mdescLeft">&#160;</td><td class="mdescRight">Cached number fraction for conversions when in mass fraction mode. <br /></td></tr>
<tr class="separator:a3b056b6b923016d271f034333c96d039"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a391e899874cd7ef299a3ae1f64c016d2" id="r_a391e899874cd7ef299a3ae1f64c016d2"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a391e899874cd7ef299a3ae1f64c016d2">m_initialized</a> = false</td></tr>
<tr class="memdesc:a391e899874cd7ef299a3ae1f64c016d2"><td class="mdescLeft">&#160;</td><td class="mdescRight">True if the composition entry has been initialized with a valid species. <br /></td></tr>
<tr class="separator:a391e899874cd7ef299a3ae1f64c016d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -198,7 +200,7 @@ Friends</h2></td></tr>
<div class="textblock"><p>Represents a single entry (an isotope) within a composition. </p>
<p>This struct holds the properties of one component, including its symbol, the corresponding <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, and its abundance (either as a mass fraction or number fraction). It manages the state and conversions for that single entry. </p>
<p class="definition">Definition at line <a class="el" href="composition_8h_source.html#l00083">83</a> of file <a class="el" href="composition_8h_source.html">composition.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="composition_8h_source.html#l00084">84</a> of file <a class="el" href="composition_8h_source.html">composition.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a1cccb94c150dd1dcde860f55fbeaf2bd" name="a1cccb94c150dd1dcde860f55fbeaf2bd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1cccb94c150dd1dcde860f55fbeaf2bd">&#9670;&#160;</a></span>CompositionEntry() <span class="overload">[1/3]</span></h2>
@@ -217,7 +219,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#l00063">63</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#l00069">69</a> of file <a class="el" href="composition_8cpp_source.html">composition.cpp</a>.</p>
</div>
</div>
@@ -264,10 +266,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#l00063">composition.cpp:63</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#l00069">composition.cpp:69</a></div></div>
</div><!-- fragment --> </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#l00074">74</a> of file <a class="el" href="composition_8cpp_source.html">composition.cpp</a>.</p>
</div>
</div>
@@ -276,6 +278,9 @@ Friends</h2></td></tr>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">fourdst::composition::CompositionEntry::CompositionEntry </td>
@@ -284,6 +289,11 @@ Friends</h2></td></tr>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel default">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Copy constructor. </p>
@@ -294,8 +304,6 @@ 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>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
@@ -325,12 +333,12 @@ 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#l00172">172</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#l00183">183</a> of file <a class="el" href="composition_8cpp_source.html">composition.cpp</a>.</p>
</div>
</div>
<a id="af4f8d292d18755670a914072e2260dfb" name="af4f8d292d18755670a914072e2260dfb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af4f8d292d18755670a914072e2260dfb">&#9670;&#160;</a></span>isotope()</h2>
<a id="af49920b1168be92d517aea03a308fee1" name="af49920b1168be92d517aea03a308fee1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af49920b1168be92d517aea03a308fee1">&#9670;&#160;</a></span>isotope()</h2>
<div class="memitem">
<div class="memproto">
@@ -339,7 +347,7 @@ Friends</h2></td></tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structfourdst_1_1atomic_1_1_species.html">fourdst::atomic::Species</a> fourdst::composition::CompositionEntry::isotope </td>
<td class="memname"><a class="el" href="structfourdst_1_1atomic_1_1_species.html">atomic::Species</a> fourdst::composition::CompositionEntry::isotope </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
@@ -355,12 +363,12 @@ 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#l00134">134</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>
<a id="a66cb086719d7f654869bd7b0cee87ffc" name="a66cb086719d7f654869bd7b0cee87ffc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a66cb086719d7f654869bd7b0cee87ffc">&#9670;&#160;</a></span>mass_fraction() <span class="overload">[1/2]</span></h2>
<h2 class="memtitle"><span class="permalink"><a href="#a66cb086719d7f654869bd7b0cee87ffc">&#9670;&#160;</a></span>mass_fraction()</h2>
<div class="memitem">
<div class="memproto">
@@ -392,43 +400,7 @@ Friends</h2></td></tr>
</dd>
</dl>
<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>
<a id="a27b0ae0f7ef9469d515c4c7b6ec8dc22" name="a27b0ae0f7ef9469d515c4c7b6ec8dc22"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a27b0ae0f7ef9469d515c4c7b6ec8dc22">&#9670;&#160;</a></span>mass_fraction() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">double fourdst::composition::CompositionEntry::mass_fraction </td>
<td>(</td>
<td class="paramtype">double</td> <td class="paramname"><span class="paramname"><em>meanMolarMass</em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel nodiscard">nodiscard</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the mass fraction, converting from number fraction if necessary. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">meanMolarMass</td><td>The mean molar mass of the entire composition, required for conversion. </td></tr>
</table>
</dd>
</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#l00104">104</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#l00102">102</a> of file <a class="el" href="composition_8cpp_source.html">composition.cpp</a>.</p>
</div>
</div>
@@ -465,12 +437,12 @@ Friends</h2></td></tr>
</dd>
</dl>
<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>
<p class="definition">Definition at line <a class="el" href="composition_8cpp_source.html#l00110">110</a> of file <a class="el" href="composition_8cpp_source.html">composition.cpp</a>.</p>
</div>
</div>
<a id="ab96d976b53f3828237525005b904a39c" name="ab96d976b53f3828237525005b904a39c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab96d976b53f3828237525005b904a39c">&#9670;&#160;</a></span>number_fraction() <span class="overload">[2/2]</span></h2>
<a id="aed91b28f66ed3e0937905c174712c3ca" name="aed91b28f66ed3e0937905c174712c3ca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aed91b28f66ed3e0937905c174712c3ca">&#9670;&#160;</a></span>number_fraction() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
@@ -481,7 +453,7 @@ Friends</h2></td></tr>
<tr>
<td class="memname">double fourdst::composition::CompositionEntry::number_fraction </td>
<td>(</td>
<td class="paramtype">double</td> <td class="paramname"><span class="paramname"><em>totalMoles</em></span></td><td>)</td>
<td class="paramtype">double</td> <td class="paramname"><span class="paramname"><em>totalMolesPerMass</em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
@@ -495,13 +467,13 @@ Friends</h2></td></tr>
<p>Gets the number fraction, converting from mass fraction if necessary. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">totalMoles</td><td>The total moles per unit mass (specific number density) of the entire composition. </td></tr>
<tr><td class="paramname">totalMolesPerMass</td><td>The total moles per unit mass (specific number density) of the entire composition. </td></tr>
</table>
</dd>
</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#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#l00118">118</a> of file <a class="el" href="composition_8cpp_source.html">composition.cpp</a>.</p>
</div>
</div>
@@ -531,7 +503,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#l00130">130</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#l00126">126</a> of file <a class="el" href="composition_8cpp_source.html">composition.cpp</a>.</p>
</div>
</div>
@@ -559,7 +531,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#l00154">154</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#l00159">159</a> of file <a class="el" href="composition_8cpp_source.html">composition.cpp</a>.</p>
</div>
</div>
@@ -593,12 +565,12 @@ Friends</h2></td></tr>
</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#l00134">134</a> of file <a class="el" href="composition_8cpp_source.html">composition.cpp</a>.</p>
</div>
</div>
<a id="a743042d1998875851150d789817f5473" name="a743042d1998875851150d789817f5473"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a743042d1998875851150d789817f5473">&#9670;&#160;</a></span>setNumberFracMode()</h2>
<a id="a00332551f5b2f0d7f10b12a091e21fa8" name="a00332551f5b2f0d7f10b12a091e21fa8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a00332551f5b2f0d7f10b12a091e21fa8">&#9670;&#160;</a></span>setNumberFracMode()</h2>
<div class="memitem">
<div class="memproto">
@@ -606,7 +578,7 @@ Friends</h2></td></tr>
<tr>
<td class="memname">bool fourdst::composition::CompositionEntry::setNumberFracMode </td>
<td>(</td>
<td class="paramtype">double</td> <td class="paramname"><span class="paramname"><em>totalMoles</em></span></td><td>)</td>
<td class="paramtype">double</td> <td class="paramname"><span class="paramname"><em>totalMolesPerMass</em></span></td><td>)</td>
<td></td>
</tr>
</table>
@@ -615,13 +587,13 @@ Friends</h2></td></tr>
<p>Switches the mode to number fraction mode. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">totalMoles</td><td>The total moles per unit mass (specific number density) of the composition. </td></tr>
<tr><td class="paramname">totalMolesPerMass</td><td>The total moles per unit mass (specific number density) of the composition. </td></tr>
</table>
</dd>
</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#l00163">163</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#l00171">171</a> of file <a class="el" href="composition_8cpp_source.html">composition.cpp</a>.</p>
</div>
</div>
@@ -655,7 +627,7 @@ Friends</h2></td></tr>
</dd>
</dl>
<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>
<p class="definition">Definition at line <a class="el" href="composition_8cpp_source.html#l00148">148</a> of file <a class="el" href="composition_8cpp_source.html">composition.cpp</a>.</p>
</div>
</div>
@@ -689,7 +661,7 @@ Friends</h2></td></tr>
</dd>
</dl>
<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>
<p class="definition">Definition at line <a class="el" href="composition_8cpp_source.html#l00086">86</a> of file <a class="el" href="composition_8cpp_source.html">composition.cpp</a>.</p>
</div>
</div>
@@ -719,7 +691,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#l00093">93</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#l00098">98</a> of file <a class="el" href="composition_8cpp_source.html">composition.cpp</a>.</p>
</div>
</div>
@@ -761,11 +733,29 @@ 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#l00932">932</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#l01070">1070</a> of file <a class="el" href="composition_8cpp_source.html">composition.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a3b056b6b923016d271f034333c96d039" name="a3b056b6b923016d271f034333c96d039"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3b056b6b923016d271f034333c96d039">&#9670;&#160;</a></span>m_cachedNumberFraction</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double fourdst::composition::CompositionEntry::m_cachedNumberFraction = 0.0</td>
</tr>
</table>
</div><div class="memdoc">
<p>Cached number fraction for conversions when in mass fraction mode. </p>
<p class="definition">Definition at line <a class="el" href="composition_8h_source.html#l00093">93</a> of file <a class="el" href="composition_8h_source.html">composition.h</a>.</p>
</div>
</div>
<a id="a391e899874cd7ef299a3ae1f64c016d2" name="a391e899874cd7ef299a3ae1f64c016d2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a391e899874cd7ef299a3ae1f64c016d2">&#9670;&#160;</a></span>m_initialized</h2>
@@ -780,7 +770,7 @@ Friends</h2></td></tr>
<p>True if the composition entry has been initialized with a valid species. </p>
<p class="definition">Definition at line <a class="el" href="composition_8h_source.html#l00092">92</a> of file <a class="el" href="composition_8h_source.html">composition.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="composition_8h_source.html#l00096">96</a> of file <a class="el" href="composition_8h_source.html">composition.h</a>.</p>
</div>
</div>
@@ -798,7 +788,7 @@ Friends</h2></td></tr>
<p>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 containing detailed isotope data. </p>
<p class="definition">Definition at line <a class="el" href="composition_8h_source.html#l00085">85</a> of file <a class="el" href="composition_8h_source.html">composition.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="composition_8h_source.html#l00086">86</a> of file <a class="el" href="composition_8h_source.html">composition.h</a>.</p>
</div>
</div>
@@ -816,7 +806,7 @@ Friends</h2></td></tr>
<p>The mode of the composition entry. True if mass fraction, false if number fraction. </p>
<p class="definition">Definition at line <a class="el" href="composition_8h_source.html#l00086">86</a> of file <a class="el" href="composition_8h_source.html">composition.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="composition_8h_source.html#l00087">87</a> of file <a class="el" href="composition_8h_source.html">composition.h</a>.</p>
</div>
</div>
@@ -834,7 +824,23 @@ Friends</h2></td></tr>
<p>The mass fraction of the species. Valid only if <code>m_massFracMode</code> is true. </p>
<p class="definition">Definition at line <a class="el" href="composition_8h_source.html#l00088">88</a> of file <a class="el" href="composition_8h_source.html">composition.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="composition_8h_source.html#l00089">89</a> of file <a class="el" href="composition_8h_source.html">composition.h</a>.</p>
</div>
</div>
<a id="acd41be41f03c819521bab28ea0d8bed2" name="acd41be41f03c819521bab28ea0d8bed2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acd41be41f03c819521bab28ea0d8bed2">&#9670;&#160;</a></span>m_molesPerMass</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double fourdst::composition::CompositionEntry::m_molesPerMass = 0.0</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="composition_8h_source.html#l00092">92</a> of file <a class="el" href="composition_8h_source.html">composition.h</a>.</p>
</div>
</div>
@@ -852,7 +858,7 @@ Friends</h2></td></tr>
<p>The number fraction (mole fraction) of the species. Valid only if <code>m_massFracMode</code> is false. </p>
<p class="definition">Definition at line <a class="el" href="composition_8h_source.html#l00089">89</a> of file <a class="el" href="composition_8h_source.html">composition.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="composition_8h_source.html#l00090">90</a> of file <a class="el" href="composition_8h_source.html">composition.h</a>.</p>
</div>
</div>
@@ -870,7 +876,7 @@ Friends</h2></td></tr>
<p>The relative abundance, used internally for conversions. For mass fraction mode, this is X_i / A_i; for number fraction mode, it's n_i * A_i. </p>
<p class="definition">Definition at line <a class="el" href="composition_8h_source.html#l00090">90</a> of file <a class="el" href="composition_8h_source.html">composition.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="composition_8h_source.html#l00091">91</a> of file <a class="el" href="composition_8h_source.html">composition.h</a>.</p>
</div>
</div>
@@ -888,7 +894,7 @@ Friends</h2></td></tr>
<p>The chemical symbol of the species (e.g., "H-1", "Fe-56"). </p>
<p class="definition">Definition at line <a class="el" href="composition_8h_source.html#l00084">84</a> of file <a class="el" href="composition_8h_source.html">composition.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="composition_8h_source.html#l00085">85</a> of file <a class="el" href="composition_8h_source.html">composition.h</a>.</p>
</div>
</div>