docs(docs): rebuilt docs for version 1.7.0
This commit is contained in:
@@ -322,111 +322,128 @@ $(function(){initNavTree('composition_8h_source.html',''); initResizable(true);
|
||||
<div class="line"><a id="l00725" name="l00725"></a><span class="lineno"> 725</span></div>
|
||||
<div class="line"><a id="l00735" name="l00735"></a><span class="lineno"> 735</span> [[nodiscard]] <a class="code hl_struct" href="structfourdst_1_1composition_1_1_canonical_composition.html">CanonicalComposition</a> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#ac75dbc8377556c835455991c7c7fe206">getCanonicalComposition</a>(<span class="keywordtype">bool</span> harsh=<span class="keyword">false</span>) <span class="keyword">const</span>;</div>
|
||||
<div class="line"><a id="l00736" name="l00736"></a><span class="lineno"> 736</span></div>
|
||||
<div class="line"><a id="l00743" name="l00743"></a><span class="lineno"> 743</span> <span class="keyword">friend</span> std::ostream& <a class="code hl_friend" href="classfourdst_1_1composition_1_1_composition.html#a36c2525d21cd932065bb2bb30bc57fb4">operator<<</a>(std::ostream& os, <span class="keyword">const</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a23b83b76ee025f6fc009184ee19bba88">Composition</a>& <a class="code hl_namespace" href="namespacefourdst_1_1composition.html">composition</a>);</div>
|
||||
<div class="line"><a id="l00744" name="l00744"></a><span class="lineno"> 744</span></div>
|
||||
<div class="line"><a id="l00753" name="l00753"></a><span class="lineno"> 753</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a23b83b76ee025f6fc009184ee19bba88">Composition</a> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a24a3bdeb8e8e55b54ecdee6dcb0d9561">operator+</a>(<span class="keyword">const</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a23b83b76ee025f6fc009184ee19bba88">Composition</a>& other) <span class="keyword">const</span>;</div>
|
||||
<div class="line"><a id="l00744" name="l00744"></a><span class="lineno"> 744</span> [[nodiscard]] std::vector<double> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#acdbdf980297580e885ce3f124164315f">getMassFractionVector</a>() <span class="keyword">const</span>;</div>
|
||||
<div class="line"><a id="l00745" name="l00745"></a><span class="lineno"> 745</span></div>
|
||||
<div class="line"><a id="l00753" name="l00753"></a><span class="lineno"> 753</span> [[nodiscard]] std::vector<double> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a2a41242de5d49b005e0b608e79e2f2d9">getNumberFractionVector</a>() <span class="keyword">const</span>;</div>
|
||||
<div class="line"><a id="l00754" name="l00754"></a><span class="lineno"> 754</span></div>
|
||||
<div class="foldopen" id="foldopen00759" data-start="{" data-end="}">
|
||||
<div class="line"><a id="l00759" name="l00759"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1_composition.html#ab1701644ff1c83c220dc04eb58d1621b"> 759</a></span> <span class="keyword">auto</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#ab1701644ff1c83c220dc04eb58d1621b">begin</a>() {</div>
|
||||
<div class="line"><a id="l00760" name="l00760"></a><span class="lineno"> 760</span> <span class="keywordflow">return</span> <a class="code hl_variable" href="classfourdst_1_1composition_1_1_composition.html#aa7f2753b10e85ae3bbf0c3d600a973db">m_compositions</a>.begin();</div>
|
||||
<div class="line"><a id="l00761" name="l00761"></a><span class="lineno"> 761</span> }</div>
|
||||
<div class="line"><a id="l00762" name="l00762"></a><span class="lineno"> 762</span> [[nodiscard]] std::vector<double> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a84d62b971bee83d944d2792c6850bc0b">getMolarAbundanceVector</a>() <span class="keyword">const</span>;</div>
|
||||
<div class="line"><a id="l00763" name="l00763"></a><span class="lineno"> 763</span></div>
|
||||
<div class="line"><a id="l00774" name="l00774"></a><span class="lineno"> 774</span> [[nodiscard]] <span class="keywordtype">size_t</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a1204a6421205feaaed13937aefa158ba">getSpeciesIndex</a>(<span class="keyword">const</span> std::string& symbol) <span class="keyword">const</span>;</div>
|
||||
<div class="line"><a id="l00775" name="l00775"></a><span class="lineno"> 775</span></div>
|
||||
<div class="line"><a id="l00786" name="l00786"></a><span class="lineno"> 786</span> [[nodiscard]] <span class="keywordtype">size_t</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a1204a6421205feaaed13937aefa158ba">getSpeciesIndex</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structfourdst_1_1atomic_1_1_species.html">atomic::Species</a>& species) <span class="keyword">const</span>;</div>
|
||||
<div class="line"><a id="l00787" name="l00787"></a><span class="lineno"> 787</span></div>
|
||||
<div class="line"><a id="l00797" name="l00797"></a><span class="lineno"> 797</span> [[nodiscard]] <a class="code hl_struct" href="structfourdst_1_1atomic_1_1_species.html">atomic::Species</a> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#aa534a01f24074cc9edd7f41df228eb50">getSpeciesAtIndex</a>(<span class="keywordtype">size_t</span> index) <span class="keyword">const</span>;</div>
|
||||
<div class="line"><a id="l00798" name="l00798"></a><span class="lineno"> 798</span></div>
|
||||
<div class="line"><a id="l00805" name="l00805"></a><span class="lineno"> 805</span> <span class="keyword">friend</span> std::ostream& <a class="code hl_friend" href="classfourdst_1_1composition_1_1_composition.html#a36c2525d21cd932065bb2bb30bc57fb4">operator<<</a>(std::ostream& os, <span class="keyword">const</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a23b83b76ee025f6fc009184ee19bba88">Composition</a>& <a class="code hl_namespace" href="namespacefourdst_1_1composition.html">composition</a>);</div>
|
||||
<div class="line"><a id="l00806" name="l00806"></a><span class="lineno"> 806</span></div>
|
||||
<div class="line"><a id="l00815" name="l00815"></a><span class="lineno"> 815</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a23b83b76ee025f6fc009184ee19bba88">Composition</a> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a24a3bdeb8e8e55b54ecdee6dcb0d9561">operator+</a>(<span class="keyword">const</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#a23b83b76ee025f6fc009184ee19bba88">Composition</a>& other) <span class="keyword">const</span>;</div>
|
||||
<div class="line"><a id="l00816" name="l00816"></a><span class="lineno"> 816</span></div>
|
||||
<div class="foldopen" id="foldopen00821" data-start="{" data-end="}">
|
||||
<div class="line"><a id="l00821" name="l00821"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1_composition.html#ab1701644ff1c83c220dc04eb58d1621b"> 821</a></span> <span class="keyword">auto</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#ab1701644ff1c83c220dc04eb58d1621b">begin</a>() {</div>
|
||||
<div class="line"><a id="l00822" name="l00822"></a><span class="lineno"> 822</span> <span class="keywordflow">return</span> <a class="code hl_variable" href="classfourdst_1_1composition_1_1_composition.html#aa7f2753b10e85ae3bbf0c3d600a973db">m_compositions</a>.begin();</div>
|
||||
<div class="line"><a id="l00823" name="l00823"></a><span class="lineno"> 823</span> }</div>
|
||||
</div>
|
||||
<div class="line"><a id="l00762" name="l00762"></a><span class="lineno"> 762</span></div>
|
||||
<div class="foldopen" id="foldopen00767" data-start="{" data-end="}">
|
||||
<div class="line"><a id="l00767" name="l00767"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1_composition.html#adf41a833e8b704daf4f581fca5c8cb9b"> 767</a></span> <span class="keyword">auto</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#adf41a833e8b704daf4f581fca5c8cb9b">begin</a>()<span class="keyword"> const </span>{</div>
|
||||
<div class="line"><a id="l00768" name="l00768"></a><span class="lineno"> 768</span> <span class="keywordflow">return</span> <a class="code hl_variable" href="classfourdst_1_1composition_1_1_composition.html#aa7f2753b10e85ae3bbf0c3d600a973db">m_compositions</a>.cbegin();</div>
|
||||
<div class="line"><a id="l00769" name="l00769"></a><span class="lineno"> 769</span> }</div>
|
||||
<div class="line"><a id="l00824" name="l00824"></a><span class="lineno"> 824</span></div>
|
||||
<div class="foldopen" id="foldopen00829" data-start="{" data-end="}">
|
||||
<div class="line"><a id="l00829" name="l00829"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1_composition.html#adf41a833e8b704daf4f581fca5c8cb9b"> 829</a></span> [[nodiscard]] <span class="keyword">auto</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#adf41a833e8b704daf4f581fca5c8cb9b">begin</a>()<span class="keyword"> const </span>{</div>
|
||||
<div class="line"><a id="l00830" name="l00830"></a><span class="lineno"> 830</span> <span class="keywordflow">return</span> <a class="code hl_variable" href="classfourdst_1_1composition_1_1_composition.html#aa7f2753b10e85ae3bbf0c3d600a973db">m_compositions</a>.cbegin();</div>
|
||||
<div class="line"><a id="l00831" name="l00831"></a><span class="lineno"> 831</span> }</div>
|
||||
</div>
|
||||
<div class="line"><a id="l00770" name="l00770"></a><span class="lineno"> 770</span></div>
|
||||
<div class="foldopen" id="foldopen00775" data-start="{" data-end="}">
|
||||
<div class="line"><a id="l00775" name="l00775"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1_composition.html#adeaf6f1213e78cb1fe8a8317f0a8adc2"> 775</a></span> <span class="keyword">auto</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#adeaf6f1213e78cb1fe8a8317f0a8adc2">end</a>() {</div>
|
||||
<div class="line"><a id="l00776" name="l00776"></a><span class="lineno"> 776</span> <span class="keywordflow">return</span> <a class="code hl_variable" href="classfourdst_1_1composition_1_1_composition.html#aa7f2753b10e85ae3bbf0c3d600a973db">m_compositions</a>.end();</div>
|
||||
<div class="line"><a id="l00777" name="l00777"></a><span class="lineno"> 777</span> }</div>
|
||||
<div class="line"><a id="l00832" name="l00832"></a><span class="lineno"> 832</span></div>
|
||||
<div class="foldopen" id="foldopen00837" data-start="{" data-end="}">
|
||||
<div class="line"><a id="l00837" name="l00837"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1_composition.html#adeaf6f1213e78cb1fe8a8317f0a8adc2"> 837</a></span> <span class="keyword">auto</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#adeaf6f1213e78cb1fe8a8317f0a8adc2">end</a>() {</div>
|
||||
<div class="line"><a id="l00838" name="l00838"></a><span class="lineno"> 838</span> <span class="keywordflow">return</span> <a class="code hl_variable" href="classfourdst_1_1composition_1_1_composition.html#aa7f2753b10e85ae3bbf0c3d600a973db">m_compositions</a>.end();</div>
|
||||
<div class="line"><a id="l00839" name="l00839"></a><span class="lineno"> 839</span> }</div>
|
||||
</div>
|
||||
<div class="line"><a id="l00778" name="l00778"></a><span class="lineno"> 778</span></div>
|
||||
<div class="foldopen" id="foldopen00783" data-start="{" data-end="}">
|
||||
<div class="line"><a id="l00783" name="l00783"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1_composition.html#aed2f5676f8f742199f01e4d1e9664bdd"> 783</a></span> <span class="keyword">auto</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#aed2f5676f8f742199f01e4d1e9664bdd">end</a>()<span class="keyword"> const </span>{</div>
|
||||
<div class="line"><a id="l00784" name="l00784"></a><span class="lineno"> 784</span> <span class="keywordflow">return</span> <a class="code hl_variable" href="classfourdst_1_1composition_1_1_composition.html#aa7f2753b10e85ae3bbf0c3d600a973db">m_compositions</a>.cend();</div>
|
||||
<div class="line"><a id="l00785" name="l00785"></a><span class="lineno"> 785</span> }</div>
|
||||
<div class="line"><a id="l00840" name="l00840"></a><span class="lineno"> 840</span></div>
|
||||
<div class="foldopen" id="foldopen00845" data-start="{" data-end="}">
|
||||
<div class="line"><a id="l00845" name="l00845"></a><span class="lineno"><a class="line" href="classfourdst_1_1composition_1_1_composition.html#aed2f5676f8f742199f01e4d1e9664bdd"> 845</a></span> [[nodiscard]] <span class="keyword">auto</span> <a class="code hl_function" href="classfourdst_1_1composition_1_1_composition.html#aed2f5676f8f742199f01e4d1e9664bdd">end</a>()<span class="keyword"> const </span>{</div>
|
||||
<div class="line"><a id="l00846" name="l00846"></a><span class="lineno"> 846</span> <span class="keywordflow">return</span> <a class="code hl_variable" href="classfourdst_1_1composition_1_1_composition.html#aa7f2753b10e85ae3bbf0c3d600a973db">m_compositions</a>.cend();</div>
|
||||
<div class="line"><a id="l00847" name="l00847"></a><span class="lineno"> 847</span> }</div>
|
||||
</div>
|
||||
<div class="line"><a id="l00786" name="l00786"></a><span class="lineno"> 786</span> </div>
|
||||
<div class="line"><a id="l00787" name="l00787"></a><span class="lineno"> 787</span> };</div>
|
||||
<div class="line"><a id="l00848" name="l00848"></a><span class="lineno"> 848</span> </div>
|
||||
<div class="line"><a id="l00849" name="l00849"></a><span class="lineno"> 849</span> };</div>
|
||||
</div>
|
||||
<div class="line"><a id="l00788" name="l00788"></a><span class="lineno"> 788</span>}; <span class="comment">// namespace fourdst::composition</span></div>
|
||||
<div class="line"><a id="l00850" name="l00850"></a><span class="lineno"> 850</span>}; <span class="comment">// namespace fourdst::composition</span></div>
|
||||
</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="aclassfourdst_1_1composition_1_1_composition_html_a0af981ed1074b26c237cf6cf35f82c9e"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a0af981ed1074b26c237cf6cf35f82c9e">fourdst::composition::Composition::setCompositionMode</a></div><div class="ttdeci">void setCompositionMode(bool massFracMode)</div><div class="ttdoc">Sets the composition mode (mass fraction vs. number fraction).</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00669">composition.cpp:669</a></div></div>
|
||||
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a1138c86f7ccd39594601c2ec63ad89e9"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a1138c86f7ccd39594601c2ec63ad89e9">fourdst::composition::Composition::getComposition</a></div><div class="ttdeci">std::pair< std::unordered_map< std::string, CompositionEntry >, GlobalComposition > getComposition() const</div><div class="ttdoc">Gets all composition entries and the global composition data.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00605">composition.cpp:605</a></div></div>
|
||||
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a17635cd21744c7cf86cb1eb75152c816"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a17635cd21744c7cf86cb1eb75152c816">fourdst::composition::Composition::subset</a></div><div class="ttdeci">Composition subset(const std::vector< std::string > &symbols, const std::string &method="norm") const</div><div class="ttdoc">Creates a new Composition object containing a subset of species from this one.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00640">composition.cpp:640</a></div></div>
|
||||
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a1bc2e64f87c12befdc2bc767e7405661"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a1bc2e64f87c12befdc2bc767e7405661">fourdst::composition::Composition::registerSymbol</a></div><div class="ttdeci">void registerSymbol(const std::string &symbol, bool massFracMode=true)</div><div class="ttdoc">Registers a new symbol for inclusion in the composition.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00208">composition.cpp:208</a></div></div>
|
||||
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a0af981ed1074b26c237cf6cf35f82c9e"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a0af981ed1074b26c237cf6cf35f82c9e">fourdst::composition::Composition::setCompositionMode</a></div><div class="ttdeci">void setCompositionMode(bool massFracMode)</div><div class="ttdoc">Sets the composition mode (mass fraction vs. number fraction).</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00694">composition.cpp:694</a></div></div>
|
||||
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a1138c86f7ccd39594601c2ec63ad89e9"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a1138c86f7ccd39594601c2ec63ad89e9">fourdst::composition::Composition::getComposition</a></div><div class="ttdeci">std::pair< std::unordered_map< std::string, CompositionEntry >, GlobalComposition > getComposition() const</div><div class="ttdoc">Gets all composition entries and the global composition data.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00630">composition.cpp:630</a></div></div>
|
||||
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a1204a6421205feaaed13937aefa158ba"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a1204a6421205feaaed13937aefa158ba">fourdst::composition::Composition::getSpeciesIndex</a></div><div class="ttdeci">size_t getSpeciesIndex(const std::string &symbol) const</div><div class="ttdoc">get the index in the sorted vector representation for a given symbol</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00823">composition.cpp:823</a></div></div>
|
||||
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a17635cd21744c7cf86cb1eb75152c816"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a17635cd21744c7cf86cb1eb75152c816">fourdst::composition::Composition::subset</a></div><div class="ttdeci">Composition subset(const std::vector< std::string > &symbols, const std::string &method="norm") const</div><div class="ttdoc">Creates a new Composition object containing a subset of species from this one.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00665">composition.cpp:665</a></div></div>
|
||||
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a1bc2e64f87c12befdc2bc767e7405661"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a1bc2e64f87c12befdc2bc767e7405661">fourdst::composition::Composition::registerSymbol</a></div><div class="ttdeci">void registerSymbol(const std::string &symbol, bool massFracMode=true)</div><div class="ttdoc">Registers a new symbol for inclusion in the composition.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00233">composition.cpp:233</a></div></div>
|
||||
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a23b83b76ee025f6fc009184ee19bba88"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a23b83b76ee025f6fc009184ee19bba88">fourdst::composition::Composition::Composition</a></div><div class="ttdeci">Composition()=default</div><div class="ttdoc">Default constructor.</div></div>
|
||||
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a24a3bdeb8e8e55b54ecdee6dcb0d9561"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a24a3bdeb8e8e55b54ecdee6dcb0d9561">fourdst::composition::Composition::operator+</a></div><div class="ttdeci">Composition operator+(const Composition &other) const</div><div class="ttdoc">Overloads the + operator to mix two compositions with a 50/50 fraction.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00756">composition.cpp:756</a></div></div>
|
||||
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a36c2525d21cd932065bb2bb30bc57fb4"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a36c2525d21cd932065bb2bb30bc57fb4">fourdst::composition::Composition::operator<<</a></div><div class="ttdeci">friend std::ostream & operator<<(std::ostream &os, const Composition &composition)</div><div class="ttdoc">Overloaded output stream operator for Composition.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00772">composition.cpp:772</a></div></div>
|
||||
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a24a3bdeb8e8e55b54ecdee6dcb0d9561"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a24a3bdeb8e8e55b54ecdee6dcb0d9561">fourdst::composition::Composition::operator+</a></div><div class="ttdeci">Composition operator+(const Composition &other) const</div><div class="ttdoc">Overloads the + operator to mix two compositions with a 50/50 fraction.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00921">composition.cpp:921</a></div></div>
|
||||
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a2a41242de5d49b005e0b608e79e2f2d9"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a2a41242de5d49b005e0b608e79e2f2d9">fourdst::composition::Composition::getNumberFractionVector</a></div><div class="ttdeci">std::vector< double > getNumberFractionVector() const</div><div class="ttdoc">Get a uniform vector representation of the number fractions stored in the composition object sorted s...</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00783">composition.cpp:783</a></div></div>
|
||||
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a36c2525d21cd932065bb2bb30bc57fb4"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a36c2525d21cd932065bb2bb30bc57fb4">fourdst::composition::Composition::operator<<</a></div><div class="ttdeci">friend std::ostream & operator<<(std::ostream &os, const Composition &composition)</div><div class="ttdoc">Overloaded output stream operator for Composition.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00937">composition.cpp:937</a></div></div>
|
||||
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a39bfcb7d81d723cbd9d021abd533b4d6"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a39bfcb7d81d723cbd9d021abd533b4d6">fourdst::composition::Composition::m_registeredSymbols</a></div><div class="ttdeci">std::set< std::string > m_registeredSymbols</div><div class="ttdoc">The registered symbols.</div><div class="ttdef"><b>Definition</b> <a href="#l00269">composition.h:269</a></div></div>
|
||||
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a3aead72892606725a4149a5f65bd31ec"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a3aead72892606725a4149a5f65bd31ec">fourdst::composition::Composition::mix</a></div><div class="ttdeci">Composition mix(const Composition &other, double fraction) const</div><div class="ttdoc">Mixes this composition with another to produce a new composition.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00473">composition.cpp:473</a></div></div>
|
||||
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a3dee7b5e1f54920de9eab99f95a516ec"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a3dee7b5e1f54920de9eab99f95a516ec">fourdst::composition::Composition::getRegisteredSpecies</a></div><div class="ttdeci">std::set< fourdst::atomic::Species > getRegisteredSpecies() const</div><div class="ttdoc">Get a set of all species that are registered in the composition.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00255">composition.cpp:255</a></div></div>
|
||||
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a461ab4e9cb5975cf865db5f16f03ddfe"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a461ab4e9cb5975cf865db5f16f03ddfe">fourdst::composition::Composition::finalizeNumberFracMode</a></div><div class="ttdeci">bool finalizeNumberFracMode(bool norm)</div><div class="ttdoc">Finalizes the composition in number fraction mode.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00439">composition.cpp:439</a></div></div>
|
||||
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a493224656aa3ade68389250720ef09af"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a493224656aa3ade68389250720ef09af">fourdst::composition::Composition::setMassFraction</a></div><div class="ttdeci">double setMassFraction(const std::string &symbol, const double &mass_fraction)</div><div class="ttdoc">Sets the mass fraction for a given symbol.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00287">composition.cpp:287</a></div></div>
|
||||
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a3aead72892606725a4149a5f65bd31ec"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a3aead72892606725a4149a5f65bd31ec">fourdst::composition::Composition::mix</a></div><div class="ttdeci">Composition mix(const Composition &other, double fraction) const</div><div class="ttdoc">Mixes this composition with another to produce a new composition.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00498">composition.cpp:498</a></div></div>
|
||||
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a3dee7b5e1f54920de9eab99f95a516ec"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a3dee7b5e1f54920de9eab99f95a516ec">fourdst::composition::Composition::getRegisteredSpecies</a></div><div class="ttdeci">std::set< fourdst::atomic::Species > getRegisteredSpecies() const</div><div class="ttdoc">Get a set of all species that are registered in the composition.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00280">composition.cpp:280</a></div></div>
|
||||
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a461ab4e9cb5975cf865db5f16f03ddfe"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a461ab4e9cb5975cf865db5f16f03ddfe">fourdst::composition::Composition::finalizeNumberFracMode</a></div><div class="ttdeci">bool finalizeNumberFracMode(bool norm)</div><div class="ttdoc">Finalizes the composition in number fraction mode.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00464">composition.cpp:464</a></div></div>
|
||||
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a493224656aa3ade68389250720ef09af"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a493224656aa3ade68389250720ef09af">fourdst::composition::Composition::setMassFraction</a></div><div class="ttdeci">double setMassFraction(const std::string &symbol, const double &mass_fraction)</div><div class="ttdoc">Sets the mass fraction for a given symbol.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00312">composition.cpp:312</a></div></div>
|
||||
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a4a36c8d22ce61023e7bea1d9417577d4"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a4a36c8d22ce61023e7bea1d9417577d4">fourdst::composition::Composition::m_meanParticleMass</a></div><div class="ttdeci">double m_meanParticleMass</div><div class="ttdoc">The mean particle mass of the composition (\sum_{i} \frac{n_i}{m_i}. where n_i is the number fraction...</div><div class="ttdef"><b>Definition</b> <a href="#l00266">composition.h:266</a></div></div>
|
||||
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a4ce00f73cc133bb1bac2b030b93ab480"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a4ce00f73cc133bb1bac2b030b93ab480">fourdst::composition::Composition::registerSpecies</a></div><div class="ttdeci">void registerSpecies(const fourdst::atomic::Species &species, bool massFracMode=true)</div><div class="ttdoc">Registers a new species by extracting its symbol.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00241">composition.cpp:241</a></div></div>
|
||||
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a4ec1e23cfecef764cb831171fed62fc2"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a4ec1e23cfecef764cb831171fed62fc2">fourdst::composition::Composition::operator=</a></div><div class="ttdeci">Composition & operator=(Composition const &other)</div><div class="ttdoc">Assignment operator.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00194">composition.cpp:194</a></div></div>
|
||||
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a66401fed7054172e9b1a2687e5cc8eff"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a66401fed7054172e9b1a2687e5cc8eff">fourdst::composition::Composition::getMeanParticleMass</a></div><div class="ttdeci">double getMeanParticleMass() const</div><div class="ttdoc">Compute the mean particle mass of the composition.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00613">composition.cpp:613</a></div></div>
|
||||
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a4ce00f73cc133bb1bac2b030b93ab480"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a4ce00f73cc133bb1bac2b030b93ab480">fourdst::composition::Composition::registerSpecies</a></div><div class="ttdeci">void registerSpecies(const fourdst::atomic::Species &species, bool massFracMode=true)</div><div class="ttdoc">Registers a new species by extracting its symbol.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00266">composition.cpp:266</a></div></div>
|
||||
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a4ec1e23cfecef764cb831171fed62fc2"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a4ec1e23cfecef764cb831171fed62fc2">fourdst::composition::Composition::operator=</a></div><div class="ttdeci">Composition & operator=(Composition const &other)</div><div class="ttdoc">Assignment operator.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00219">composition.cpp:219</a></div></div>
|
||||
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a66401fed7054172e9b1a2687e5cc8eff"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a66401fed7054172e9b1a2687e5cc8eff">fourdst::composition::Composition::getMeanParticleMass</a></div><div class="ttdeci">double getMeanParticleMass() const</div><div class="ttdoc">Compute the mean particle mass of the composition.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00638">composition.cpp:638</a></div></div>
|
||||
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a671f1ee8be00f4ff8c1d94fabb382380"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a671f1ee8be00f4ff8c1d94fabb382380">fourdst::composition::Composition::m_massFracMode</a></div><div class="ttdeci">bool m_massFracMode</div><div class="ttdoc">True if mass fraction mode, false if number fraction mode.</div><div class="ttdef"><b>Definition</b> <a href="#l00267">composition.h:267</a></div></div>
|
||||
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a67a2ed844f3aee3d9cc1a3cb996eb56f"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a67a2ed844f3aee3d9cc1a3cb996eb56f">fourdst::composition::Composition::getMolarAbundance</a></div><div class="ttdeci">double getMolarAbundance(const std::string &symbol) const</div><div class="ttdoc">Gets the molar abundance (X_i / A_i) for a given symbol.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00571">composition.cpp:571</a></div></div>
|
||||
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a67a2ed844f3aee3d9cc1a3cb996eb56f"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a67a2ed844f3aee3d9cc1a3cb996eb56f">fourdst::composition::Composition::getMolarAbundance</a></div><div class="ttdeci">double getMolarAbundance(const std::string &symbol) const</div><div class="ttdoc">Gets the molar abundance (X_i / A_i) for a given symbol.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00596">composition.cpp:596</a></div></div>
|
||||
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a695d37ec6cde63d86a20df1e9f26af19"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a695d37ec6cde63d86a20df1e9f26af19">fourdst::composition::Composition::m_logManager</a></div><div class="ttdeci">fourdst::logging::LogManager & m_logManager</div><div class="ttdef"><b>Definition</b> <a href="#l00261">composition.h:261</a></div></div>
|
||||
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a72a368f27094b03fdd9896844e075c94"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a72a368f27094b03fdd9896844e075c94">fourdst::composition::Composition::hasSymbol</a></div><div class="ttdeci">bool hasSymbol(const std::string &symbol) const</div><div class="ttdoc">Checks if a symbol is registered in the composition.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00737">composition.cpp:737</a></div></div>
|
||||
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a72d063a74a9d2197065884a2cea57a14"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a72d063a74a9d2197065884a2cea57a14">fourdst::composition::Composition::finalize</a></div><div class="ttdeci">bool finalize(bool norm=false)</div><div class="ttdoc">Finalizes the composition, making it ready for querying.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00389">composition.cpp:389</a></div></div>
|
||||
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a7731df9b30f8c8f13231f7e1a17b105c"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a7731df9b30f8c8f13231f7e1a17b105c">fourdst::composition::Composition::getNumberFraction</a></div><div class="ttdeci">std::unordered_map< std::string, double > getNumberFraction() const</div><div class="ttdoc">Gets the number fractions of all species in the composition.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00563">composition.cpp:563</a></div></div>
|
||||
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a7d4d748f3ee25e68751fb143717ed080"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a7d4d748f3ee25e68751fb143717ed080">fourdst::composition::Composition::setNumberFraction</a></div><div class="ttdeci">double setNumberFraction(const std::string &symbol, const double &number_fraction)</div><div class="ttdoc">Sets the number fraction for a given symbol.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00338">composition.cpp:338</a></div></div>
|
||||
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a84c7b72c2aee46b94492d404855dd3e0"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a84c7b72c2aee46b94492d404855dd3e0">fourdst::composition::Composition::getRegisteredSymbols</a></div><div class="ttdeci">std::set< std::string > getRegisteredSymbols() const</div><div class="ttdoc">Gets the registered symbols.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00251">composition.cpp:251</a></div></div>
|
||||
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a86982685c34db4a8f079ddafc25c594e"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a86982685c34db4a8f079ddafc25c594e">fourdst::composition::Composition::validateComposition</a></div><div class="ttdeci">void validateComposition(const std::vector< double > &fractions) const</div><div class="ttdoc">Validates the given fractions, throwing an exception on failure.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00263">composition.cpp:263</a></div></div>
|
||||
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a869dbae3db9d09c57b2df56a813a55fb"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a869dbae3db9d09c57b2df56a813a55fb">fourdst::composition::Composition::finalizeMassFracMode</a></div><div class="ttdeci">bool finalizeMassFracMode(bool norm)</div><div class="ttdoc">Finalizes the composition in mass fraction mode.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00402">composition.cpp:402</a></div></div>
|
||||
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a72a368f27094b03fdd9896844e075c94"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a72a368f27094b03fdd9896844e075c94">fourdst::composition::Composition::hasSymbol</a></div><div class="ttdeci">bool hasSymbol(const std::string &symbol) const</div><div class="ttdoc">Checks if a symbol is registered in the composition.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00902">composition.cpp:902</a></div></div>
|
||||
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a72d063a74a9d2197065884a2cea57a14"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a72d063a74a9d2197065884a2cea57a14">fourdst::composition::Composition::finalize</a></div><div class="ttdeci">bool finalize(bool norm=false)</div><div class="ttdoc">Finalizes the composition, making it ready for querying.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00414">composition.cpp:414</a></div></div>
|
||||
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a7731df9b30f8c8f13231f7e1a17b105c"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a7731df9b30f8c8f13231f7e1a17b105c">fourdst::composition::Composition::getNumberFraction</a></div><div class="ttdeci">std::unordered_map< std::string, double > getNumberFraction() const</div><div class="ttdoc">Gets the number fractions of all species in the composition.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00588">composition.cpp:588</a></div></div>
|
||||
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a7d4d748f3ee25e68751fb143717ed080"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a7d4d748f3ee25e68751fb143717ed080">fourdst::composition::Composition::setNumberFraction</a></div><div class="ttdeci">double setNumberFraction(const std::string &symbol, const double &number_fraction)</div><div class="ttdoc">Sets the number fraction for a given symbol.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00363">composition.cpp:363</a></div></div>
|
||||
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a84c7b72c2aee46b94492d404855dd3e0"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a84c7b72c2aee46b94492d404855dd3e0">fourdst::composition::Composition::getRegisteredSymbols</a></div><div class="ttdeci">std::set< std::string > getRegisteredSymbols() const</div><div class="ttdoc">Gets the registered symbols.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00276">composition.cpp:276</a></div></div>
|
||||
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a84d62b971bee83d944d2792c6850bc0b"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a84d62b971bee83d944d2792c6850bc0b">fourdst::composition::Composition::getMolarAbundanceVector</a></div><div class="ttdeci">std::vector< double > getMolarAbundanceVector() const</div><div class="ttdoc">Get a uniform vector representation of the molar abundances stored in the composition object sorted s...</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00803">composition.cpp:803</a></div></div>
|
||||
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a86982685c34db4a8f079ddafc25c594e"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a86982685c34db4a8f079ddafc25c594e">fourdst::composition::Composition::validateComposition</a></div><div class="ttdeci">void validateComposition(const std::vector< double > &fractions) const</div><div class="ttdoc">Validates the given fractions, throwing an exception on failure.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00288">composition.cpp:288</a></div></div>
|
||||
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a869dbae3db9d09c57b2df56a813a55fb"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a869dbae3db9d09c57b2df56a813a55fb">fourdst::composition::Composition::finalizeMassFracMode</a></div><div class="ttdeci">bool finalizeMassFracMode(bool norm)</div><div class="ttdoc">Finalizes the composition in mass fraction mode.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00427">composition.cpp:427</a></div></div>
|
||||
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a8a8096863464338bc6e3c5124407dca4"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a8a8096863464338bc6e3c5124407dca4">fourdst::composition::Composition::m_config</a></div><div class="ttdeci">fourdst::config::Config & m_config</div><div class="ttdef"><b>Definition</b> <a href="#l00260">composition.h:260</a></div></div>
|
||||
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a8fdac26e6298008aaeaa5b15f7fe244f"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a8fdac26e6298008aaeaa5b15f7fe244f">fourdst::composition::Composition::isValidSymbol</a></div><div class="ttdeci">static bool isValidSymbol(const std::string &symbol)</div><div class="ttdoc">Checks if the given symbol is valid by checking against the global species database.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00283">composition.cpp:283</a></div></div>
|
||||
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a98199f435cb553f5cf4f8e520fdb8a7a"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a98199f435cb553f5cf4f8e520fdb8a7a">fourdst::composition::Composition::getMeanAtomicNumber</a></div><div class="ttdeci">double getMeanAtomicNumber() const</div><div class="ttdoc">Compute the mean atomic number of the composition.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00621">composition.cpp:621</a></div></div>
|
||||
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a8fdac26e6298008aaeaa5b15f7fe244f"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a8fdac26e6298008aaeaa5b15f7fe244f">fourdst::composition::Composition::isValidSymbol</a></div><div class="ttdeci">static bool isValidSymbol(const std::string &symbol)</div><div class="ttdoc">Checks if the given symbol is valid by checking against the global species database.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00308">composition.cpp:308</a></div></div>
|
||||
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_a98199f435cb553f5cf4f8e520fdb8a7a"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#a98199f435cb553f5cf4f8e520fdb8a7a">fourdst::composition::Composition::getMeanAtomicNumber</a></div><div class="ttdeci">double getMeanAtomicNumber() const</div><div class="ttdoc">Compute the mean atomic number of the composition.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00646">composition.cpp:646</a></div></div>
|
||||
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_aa00cbc0933d8a22bb900ac21a338e5ac"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#aa00cbc0933d8a22bb900ac21a338e5ac">fourdst::composition::Composition::m_finalized</a></div><div class="ttdeci">bool m_finalized</div><div class="ttdoc">True if the composition is finalized.</div><div class="ttdef"><b>Definition</b> <a href="#l00264">composition.h:264</a></div></div>
|
||||
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_aa3ff8ece122a9fad1252061148566749"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#aa3ff8ece122a9fad1252061148566749">fourdst::composition::Composition::~Composition</a></div><div class="ttdeci">~Composition()=default</div><div class="ttdoc">Default destructor.</div></div>
|
||||
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_aa534a01f24074cc9edd7f41df228eb50"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#aa534a01f24074cc9edd7f41df228eb50">fourdst::composition::Composition::getSpeciesAtIndex</a></div><div class="ttdeci">atomic::Species getSpeciesAtIndex(size_t index) const</div><div class="ttdoc">Get the species at a given index in the sorted vector representation.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00873">composition.cpp:873</a></div></div>
|
||||
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_aa7f2753b10e85ae3bbf0c3d600a973db"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#aa7f2753b10e85ae3bbf0c3d600a973db">fourdst::composition::Composition::m_compositions</a></div><div class="ttdeci">std::unordered_map< std::string, CompositionEntry > m_compositions</div><div class="ttdoc">The compositions.</div><div class="ttdef"><b>Definition</b> <a href="#l00270">composition.h:270</a></div></div>
|
||||
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_ab1701644ff1c83c220dc04eb58d1621b"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#ab1701644ff1c83c220dc04eb58d1621b">fourdst::composition::Composition::begin</a></div><div class="ttdeci">auto begin()</div><div class="ttdoc">Returns an iterator to the beginning of the composition map.</div><div class="ttdef"><b>Definition</b> <a href="#l00759">composition.h:759</a></div></div>
|
||||
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_ab1701644ff1c83c220dc04eb58d1621b"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#ab1701644ff1c83c220dc04eb58d1621b">fourdst::composition::Composition::begin</a></div><div class="ttdeci">auto begin()</div><div class="ttdoc">Returns an iterator to the beginning of the composition map.</div><div class="ttdef"><b>Definition</b> <a href="#l00821">composition.h:821</a></div></div>
|
||||
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_ab6c66f35e1fb05dd24aacaf90e115c5e"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#ab6c66f35e1fb05dd24aacaf90e115c5e">fourdst::composition::Composition::m_logger</a></div><div class="ttdeci">quill::Logger * m_logger</div><div class="ttdef"><b>Definition</b> <a href="#l00262">composition.h:262</a></div></div>
|
||||
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_ac75dbc8377556c835455991c7c7fe206"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#ac75dbc8377556c835455991c7c7fe206">fourdst::composition::Composition::getCanonicalComposition</a></div><div class="ttdeci">CanonicalComposition getCanonicalComposition(bool harsh=false) const</div><div class="ttdoc">Gets the current canonical composition (X, Y, Z).</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00690">composition.cpp:690</a></div></div>
|
||||
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_acb08478f7032ecc13cb02283a18187e9"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#acb08478f7032ecc13cb02283a18187e9">fourdst::composition::Composition::contains</a></div><div class="ttdeci">bool contains(const fourdst::atomic::Species &isotope) const</div><div class="ttdoc">Checks if a given isotope is present in the composition.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00741">composition.cpp:741</a></div></div>
|
||||
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_ad20bd541dd7c45274a2e586e6a0519a7"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#ad20bd541dd7c45274a2e586e6a0519a7">fourdst::composition::Composition::getMassFraction</a></div><div class="ttdeci">std::unordered_map< std::string, double > getMassFraction() const</div><div class="ttdoc">Gets the mass fractions of all species in the composition.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00534">composition.cpp:534</a></div></div>
|
||||
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_ac75dbc8377556c835455991c7c7fe206"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#ac75dbc8377556c835455991c7c7fe206">fourdst::composition::Composition::getCanonicalComposition</a></div><div class="ttdeci">CanonicalComposition getCanonicalComposition(bool harsh=false) const</div><div class="ttdoc">Gets the current canonical composition (X, Y, Z).</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00715">composition.cpp:715</a></div></div>
|
||||
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_acb08478f7032ecc13cb02283a18187e9"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#acb08478f7032ecc13cb02283a18187e9">fourdst::composition::Composition::contains</a></div><div class="ttdeci">bool contains(const fourdst::atomic::Species &isotope) const</div><div class="ttdoc">Checks if a given isotope is present in the composition.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00906">composition.cpp:906</a></div></div>
|
||||
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_acdbdf980297580e885ce3f124164315f"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#acdbdf980297580e885ce3f124164315f">fourdst::composition::Composition::getMassFractionVector</a></div><div class="ttdeci">std::vector< double > getMassFractionVector() const</div><div class="ttdoc">Get a uniform vector representation of the mass fraction stored in the composition object sorted such...</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00762">composition.cpp:762</a></div></div>
|
||||
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_ad20bd541dd7c45274a2e586e6a0519a7"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#ad20bd541dd7c45274a2e586e6a0519a7">fourdst::composition::Composition::getMassFraction</a></div><div class="ttdeci">std::unordered_map< std::string, double > getMassFraction() const</div><div class="ttdoc">Gets the mass fractions of all species in the composition.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00559">composition.cpp:559</a></div></div>
|
||||
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_addae4484da7d5072ab66a721dbe04ced"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#addae4484da7d5072ab66a721dbe04ced">fourdst::composition::Composition::m_specificNumberDensity</a></div><div class="ttdeci">double m_specificNumberDensity</div><div class="ttdoc">The specific number density of the composition (\sum_{i} X_i m_i. Where X_i is the number fraction of...</div><div class="ttdef"><b>Definition</b> <a href="#l00265">composition.h:265</a></div></div>
|
||||
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_addf03ba8b988970d341884d487aa94d5"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#addf03ba8b988970d341884d487aa94d5">fourdst::composition::Composition::isValidComposition</a></div><div class="ttdeci">bool isValidComposition(const std::vector< double > &fractions) const</div><div class="ttdoc">Checks if the given fractions are valid (sum to ~1.0).</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00270">composition.cpp:270</a></div></div>
|
||||
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_adeaf6f1213e78cb1fe8a8317f0a8adc2"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#adeaf6f1213e78cb1fe8a8317f0a8adc2">fourdst::composition::Composition::end</a></div><div class="ttdeci">auto end()</div><div class="ttdoc">Returns an iterator to the end of the composition map.</div><div class="ttdef"><b>Definition</b> <a href="#l00775">composition.h:775</a></div></div>
|
||||
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_adf41a833e8b704daf4f581fca5c8cb9b"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#adf41a833e8b704daf4f581fca5c8cb9b">fourdst::composition::Composition::begin</a></div><div class="ttdeci">auto begin() const</div><div class="ttdoc">Returns a const iterator to the beginning of the composition map.</div><div class="ttdef"><b>Definition</b> <a href="#l00767">composition.h:767</a></div></div>
|
||||
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_aed2f5676f8f742199f01e4d1e9664bdd"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#aed2f5676f8f742199f01e4d1e9664bdd">fourdst::composition::Composition::end</a></div><div class="ttdeci">auto end() const</div><div class="ttdoc">Returns a const iterator to the end of the composition map.</div><div class="ttdef"><b>Definition</b> <a href="#l00783">composition.h:783</a></div></div>
|
||||
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_addf03ba8b988970d341884d487aa94d5"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#addf03ba8b988970d341884d487aa94d5">fourdst::composition::Composition::isValidComposition</a></div><div class="ttdeci">bool isValidComposition(const std::vector< double > &fractions) const</div><div class="ttdoc">Checks if the given fractions are valid (sum to ~1.0).</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00295">composition.cpp:295</a></div></div>
|
||||
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_adeaf6f1213e78cb1fe8a8317f0a8adc2"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#adeaf6f1213e78cb1fe8a8317f0a8adc2">fourdst::composition::Composition::end</a></div><div class="ttdeci">auto end()</div><div class="ttdoc">Returns an iterator to the end of the composition map.</div><div class="ttdef"><b>Definition</b> <a href="#l00837">composition.h:837</a></div></div>
|
||||
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_adf41a833e8b704daf4f581fca5c8cb9b"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#adf41a833e8b704daf4f581fca5c8cb9b">fourdst::composition::Composition::begin</a></div><div class="ttdeci">auto begin() const</div><div class="ttdoc">Returns a const iterator to the beginning of the composition map.</div><div class="ttdef"><b>Definition</b> <a href="#l00829">composition.h:829</a></div></div>
|
||||
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_html_aed2f5676f8f742199f01e4d1e9664bdd"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition.html#aed2f5676f8f742199f01e4d1e9664bdd">fourdst::composition::Composition::end</a></div><div class="ttdeci">auto end() const</div><div class="ttdoc">Returns a const iterator to the end of the composition map.</div><div class="ttdef"><b>Definition</b> <a href="#l00845">composition.h:845</a></div></div>
|
||||
<div class="ttc" id="anamespacefourdst_1_1composition_html"><div class="ttname"><a href="namespacefourdst_1_1composition.html">fourdst::composition</a></div><div class="ttdef"><b>Definition</b> <a href="#l00033">composition.h:33</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 class="ttc" id="astructfourdst_1_1composition_1_1_canonical_composition_html"><div class="ttname"><a href="structfourdst_1_1composition_1_1_canonical_composition.html">fourdst::composition::CanonicalComposition</a></div><div class="ttdoc">Represents the canonical (X, Y, Z) composition of stellar material.</div><div class="ttdef"><b>Definition</b> <a href="#l00043">composition.h:43</a></div></div>
|
||||
<div class="ttc" id="astructfourdst_1_1composition_1_1_canonical_composition_html_a6e447cb601af6bcbd09e290aef759672"><div class="ttname"><a href="structfourdst_1_1composition_1_1_canonical_composition.html#a6e447cb601af6bcbd09e290aef759672">fourdst::composition::CanonicalComposition::operator<<</a></div><div class="ttdeci">friend std::ostream & operator<<(std::ostream &os, const CanonicalComposition &composition)</div><div class="ttdoc">Overloads the stream insertion operator for easy printing.</div><div class="ttdef"><b>Definition</b> <a href="#l00054">composition.h:54</a></div></div>
|
||||
<div class="ttc" id="astructfourdst_1_1composition_1_1_canonical_composition_html_a93927bfccc5d2b3906565d092ed4f7f4"><div class="ttname"><a href="structfourdst_1_1composition_1_1_canonical_composition.html#a93927bfccc5d2b3906565d092ed4f7f4">fourdst::composition::CanonicalComposition::Y</a></div><div class="ttdeci">double Y</div><div class="ttdoc">Mass fraction of Helium.</div><div class="ttdef"><b>Definition</b> <a href="#l00045">composition.h:45</a></div></div>
|
||||
<div class="ttc" id="astructfourdst_1_1composition_1_1_canonical_composition_html_abe5b01574242f8eaabd00c3d653291f7"><div class="ttname"><a href="structfourdst_1_1composition_1_1_canonical_composition.html#abe5b01574242f8eaabd00c3d653291f7">fourdst::composition::CanonicalComposition::X</a></div><div class="ttdeci">double X</div><div class="ttdoc">Mass fraction of Hydrogen.</div><div class="ttdef"><b>Definition</b> <a href="#l00044">composition.h:44</a></div></div>
|
||||
<div class="ttc" id="astructfourdst_1_1composition_1_1_canonical_composition_html_ae1981f5ddd36abd17a4a69fa1f43de18"><div class="ttname"><a href="structfourdst_1_1composition_1_1_canonical_composition.html#ae1981f5ddd36abd17a4a69fa1f43de18">fourdst::composition::CanonicalComposition::Z</a></div><div class="ttdeci">double Z</div><div class="ttdoc">Mass fraction of Metals.</div><div class="ttdef"><b>Definition</b> <a href="#l00046">composition.h:46</a></div></div>
|
||||
<div class="ttc" id="astructfourdst_1_1composition_1_1_composition_entry_html_a0498d707d8ea78be39283786c10657ef"><div class="ttname"><a href="structfourdst_1_1composition_1_1_composition_entry.html#a0498d707d8ea78be39283786c10657ef">fourdst::composition::CompositionEntry::m_relAbundance</a></div><div class="ttdeci">double m_relAbundance</div><div class="ttdoc">The relative abundance, used internally for conversions. For mass fraction mode, this is X_i / A_i; f...</div><div class="ttdef"><b>Definition</b> <a href="#l00090">composition.h:90</a></div></div>
|
||||
<div class="ttc" id="astructfourdst_1_1composition_1_1_composition_entry_html_a14f12b8b0178df2e32e2023bd4564ddc"><div class="ttname"><a href="structfourdst_1_1composition_1_1_composition_entry.html#a14f12b8b0178df2e32e2023bd4564ddc">fourdst::composition::CompositionEntry::getMassFracMode</a></div><div class="ttdeci">bool getMassFracMode() const</div><div class="ttdoc">Gets the mode of the composition entry.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00147">composition.cpp:147</a></div></div>
|
||||
<div class="ttc" id="astructfourdst_1_1composition_1_1_composition_entry_html_a1cccb94c150dd1dcde860f55fbeaf2bd"><div class="ttname"><a href="structfourdst_1_1composition_1_1_composition_entry.html#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_a14f12b8b0178df2e32e2023bd4564ddc"><div class="ttname"><a href="structfourdst_1_1composition_1_1_composition_entry.html#a14f12b8b0178df2e32e2023bd4564ddc">fourdst::composition::CompositionEntry::getMassFracMode</a></div><div class="ttdeci">bool getMassFracMode() const</div><div class="ttdoc">Gets the mode of the composition entry.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00172">composition.cpp:172</a></div></div>
|
||||
<div class="ttc" id="astructfourdst_1_1composition_1_1_composition_entry_html_a1cccb94c150dd1dcde860f55fbeaf2bd"><div class="ttname"><a href="structfourdst_1_1composition_1_1_composition_entry.html#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_a1e860519bea86793413ed67c76d18c8b"><div class="ttname"><a href="structfourdst_1_1composition_1_1_composition_entry.html#a1e860519bea86793413ed67c76d18c8b">fourdst::composition::CompositionEntry::m_massFracMode</a></div><div class="ttdeci">bool m_massFracMode</div><div class="ttdoc">The mode of the composition entry. True if mass fraction, false if number fraction.</div><div class="ttdef"><b>Definition</b> <a href="#l00086">composition.h:86</a></div></div>
|
||||
<div class="ttc" id="astructfourdst_1_1composition_1_1_composition_entry_html_a2b5e245f7dabb11076efdbe1ed516d9f"><div class="ttname"><a href="structfourdst_1_1composition_1_1_composition_entry.html#a2b5e245f7dabb11076efdbe1ed516d9f">fourdst::composition::CompositionEntry::m_numberFraction</a></div><div class="ttdeci">double m_numberFraction</div><div class="ttdoc">The number fraction (mole fraction) of the species. Valid only if m_massFracMode is false.</div><div class="ttdef"><b>Definition</b> <a href="#l00089">composition.h:89</a></div></div>
|
||||
<div class="ttc" id="astructfourdst_1_1composition_1_1_composition_entry_html_a2d55492d285068d4a64db5602dfb1c78"><div class="ttname"><a href="structfourdst_1_1composition_1_1_composition_entry.html#a2d55492d285068d4a64db5602dfb1c78">fourdst::composition::CompositionEntry::number_fraction</a></div><div class="ttdeci">double number_fraction() const</div><div class="ttdoc">Gets the number fraction of the species.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00089">composition.cpp:89</a></div></div>
|
||||
<div class="ttc" id="astructfourdst_1_1composition_1_1_composition_entry_html_a2d55492d285068d4a64db5602dfb1c78"><div class="ttname"><a href="structfourdst_1_1composition_1_1_composition_entry.html#a2d55492d285068d4a64db5602dfb1c78">fourdst::composition::CompositionEntry::number_fraction</a></div><div class="ttdeci">double number_fraction() const</div><div class="ttdoc">Gets the number fraction of the species.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00114">composition.cpp:114</a></div></div>
|
||||
<div class="ttc" id="astructfourdst_1_1composition_1_1_composition_entry_html_a391e899874cd7ef299a3ae1f64c016d2"><div class="ttname"><a href="structfourdst_1_1composition_1_1_composition_entry.html#a391e899874cd7ef299a3ae1f64c016d2">fourdst::composition::CompositionEntry::m_initialized</a></div><div class="ttdeci">bool m_initialized</div><div class="ttdoc">True if the composition entry has been initialized with a valid species.</div><div class="ttdef"><b>Definition</b> <a href="#l00092">composition.h:92</a></div></div>
|
||||
<div class="ttc" id="astructfourdst_1_1composition_1_1_composition_entry_html_a3fb3f63a4e5675c6fefb662a8e3e7aa3"><div class="ttname"><a href="structfourdst_1_1composition_1_1_composition_entry.html#a3fb3f63a4e5675c6fefb662a8e3e7aa3">fourdst::composition::CompositionEntry::setMassFracMode</a></div><div class="ttdeci">bool setMassFracMode(double meanMolarMass)</div><div class="ttdoc">Switches the mode to mass fraction mode.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00129">composition.cpp:129</a></div></div>
|
||||
<div class="ttc" id="astructfourdst_1_1composition_1_1_composition_entry_html_a4d6df43e098e7e2e2d94ff7fb76cb4c2"><div class="ttname"><a href="structfourdst_1_1composition_1_1_composition_entry.html#a4d6df43e098e7e2e2d94ff7fb76cb4c2">fourdst::composition::CompositionEntry::setMassFraction</a></div><div class="ttdeci">void setMassFraction(double mass_fraction)</div><div class="ttdoc">Sets the mass fraction of the species.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00113">composition.cpp:113</a></div></div>
|
||||
<div class="ttc" id="astructfourdst_1_1composition_1_1_composition_entry_html_a50d18b4c27611fa9314dd756af54c2f0"><div class="ttname"><a href="structfourdst_1_1composition_1_1_composition_entry.html#a50d18b4c27611fa9314dd756af54c2f0">fourdst::composition::CompositionEntry::symbol</a></div><div class="ttdeci">std::string symbol() const</div><div class="ttdoc">Gets the chemical symbol of the species.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00068">composition.cpp:68</a></div></div>
|
||||
<div class="ttc" id="astructfourdst_1_1composition_1_1_composition_entry_html_a5885a0e33687bceb15b225a00163e9d3"><div class="ttname"><a href="structfourdst_1_1composition_1_1_composition_entry.html#a5885a0e33687bceb15b225a00163e9d3">fourdst::composition::CompositionEntry::setSpecies</a></div><div class="ttdeci">void setSpecies(const std::string &symbol)</div><div class="ttdoc">Sets the species for the composition entry. This can only be done once.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00056">composition.cpp:56</a></div></div>
|
||||
<div class="ttc" id="astructfourdst_1_1composition_1_1_composition_entry_html_a66cb086719d7f654869bd7b0cee87ffc"><div class="ttname"><a href="structfourdst_1_1composition_1_1_composition_entry.html#a66cb086719d7f654869bd7b0cee87ffc">fourdst::composition::CompositionEntry::mass_fraction</a></div><div class="ttdeci">double mass_fraction() const</div><div class="ttdoc">Gets the mass fraction of the species.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00072">composition.cpp:72</a></div></div>
|
||||
<div class="ttc" id="astructfourdst_1_1composition_1_1_composition_entry_html_a743042d1998875851150d789817f5473"><div class="ttname"><a href="structfourdst_1_1composition_1_1_composition_entry.html#a743042d1998875851150d789817f5473">fourdst::composition::CompositionEntry::setNumberFracMode</a></div><div class="ttdeci">bool setNumberFracMode(double totalMoles)</div><div class="ttdoc">Switches the mode to number fraction mode.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00138">composition.cpp:138</a></div></div>
|
||||
<div class="ttc" id="astructfourdst_1_1composition_1_1_composition_entry_html_a3fb3f63a4e5675c6fefb662a8e3e7aa3"><div class="ttname"><a href="structfourdst_1_1composition_1_1_composition_entry.html#a3fb3f63a4e5675c6fefb662a8e3e7aa3">fourdst::composition::CompositionEntry::setMassFracMode</a></div><div class="ttdeci">bool setMassFracMode(double meanMolarMass)</div><div class="ttdoc">Switches the mode to mass fraction mode.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00154">composition.cpp:154</a></div></div>
|
||||
<div class="ttc" id="astructfourdst_1_1composition_1_1_composition_entry_html_a4d6df43e098e7e2e2d94ff7fb76cb4c2"><div class="ttname"><a href="structfourdst_1_1composition_1_1_composition_entry.html#a4d6df43e098e7e2e2d94ff7fb76cb4c2">fourdst::composition::CompositionEntry::setMassFraction</a></div><div class="ttdeci">void setMassFraction(double mass_fraction)</div><div class="ttdoc">Sets the mass fraction of the species.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00138">composition.cpp:138</a></div></div>
|
||||
<div class="ttc" id="astructfourdst_1_1composition_1_1_composition_entry_html_a50d18b4c27611fa9314dd756af54c2f0"><div class="ttname"><a href="structfourdst_1_1composition_1_1_composition_entry.html#a50d18b4c27611fa9314dd756af54c2f0">fourdst::composition::CompositionEntry::symbol</a></div><div class="ttdeci">std::string symbol() const</div><div class="ttdoc">Gets the chemical symbol of the species.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00093">composition.cpp:93</a></div></div>
|
||||
<div class="ttc" id="astructfourdst_1_1composition_1_1_composition_entry_html_a5885a0e33687bceb15b225a00163e9d3"><div class="ttname"><a href="structfourdst_1_1composition_1_1_composition_entry.html#a5885a0e33687bceb15b225a00163e9d3">fourdst::composition::CompositionEntry::setSpecies</a></div><div class="ttdeci">void setSpecies(const std::string &symbol)</div><div class="ttdoc">Sets the species for the composition entry. This can only be done once.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00081">composition.cpp:81</a></div></div>
|
||||
<div class="ttc" id="astructfourdst_1_1composition_1_1_composition_entry_html_a66cb086719d7f654869bd7b0cee87ffc"><div class="ttname"><a href="structfourdst_1_1composition_1_1_composition_entry.html#a66cb086719d7f654869bd7b0cee87ffc">fourdst::composition::CompositionEntry::mass_fraction</a></div><div class="ttdeci">double mass_fraction() const</div><div class="ttdoc">Gets the mass fraction of the species.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00097">composition.cpp:97</a></div></div>
|
||||
<div class="ttc" id="astructfourdst_1_1composition_1_1_composition_entry_html_a743042d1998875851150d789817f5473"><div class="ttname"><a href="structfourdst_1_1composition_1_1_composition_entry.html#a743042d1998875851150d789817f5473">fourdst::composition::CompositionEntry::setNumberFracMode</a></div><div class="ttdeci">bool setNumberFracMode(double totalMoles)</div><div class="ttdoc">Switches the mode to number fraction mode.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00163">composition.cpp:163</a></div></div>
|
||||
<div class="ttc" id="astructfourdst_1_1composition_1_1_composition_entry_html_a79039cbdc76b4401eb2ce44b85467503"><div class="ttname"><a href="structfourdst_1_1composition_1_1_composition_entry.html#a79039cbdc76b4401eb2ce44b85467503">fourdst::composition::CompositionEntry::m_isotope</a></div><div class="ttdeci">atomic::Species m_isotope</div><div class="ttdoc">The atomic::Species object containing detailed isotope data.</div><div class="ttdef"><b>Definition</b> <a href="#l00085">composition.h:85</a></div></div>
|
||||
<div class="ttc" id="astructfourdst_1_1composition_1_1_composition_entry_html_a9ec47cf4b3399128d3836c1b24b031b0"><div class="ttname"><a href="structfourdst_1_1composition_1_1_composition_entry.html#a9ec47cf4b3399128d3836c1b24b031b0">fourdst::composition::CompositionEntry::setNumberFraction</a></div><div class="ttdeci">void setNumberFraction(double number_fraction)</div><div class="ttdoc">Sets the number fraction of the species.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00121">composition.cpp:121</a></div></div>
|
||||
<div class="ttc" id="astructfourdst_1_1composition_1_1_composition_entry_html_ab6619d23e111905d1e3ab16ee822d96c"><div class="ttname"><a href="structfourdst_1_1composition_1_1_composition_entry.html#ab6619d23e111905d1e3ab16ee822d96c">fourdst::composition::CompositionEntry::rel_abundance</a></div><div class="ttdeci">double rel_abundance() const</div><div class="ttdoc">Gets the relative abundance of the species.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00105">composition.cpp:105</a></div></div>
|
||||
<div class="ttc" id="astructfourdst_1_1composition_1_1_composition_entry_html_a9ec47cf4b3399128d3836c1b24b031b0"><div class="ttname"><a href="structfourdst_1_1composition_1_1_composition_entry.html#a9ec47cf4b3399128d3836c1b24b031b0">fourdst::composition::CompositionEntry::setNumberFraction</a></div><div class="ttdeci">void setNumberFraction(double number_fraction)</div><div class="ttdoc">Sets the number fraction of the species.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00146">composition.cpp:146</a></div></div>
|
||||
<div class="ttc" id="astructfourdst_1_1composition_1_1_composition_entry_html_ab6619d23e111905d1e3ab16ee822d96c"><div class="ttname"><a href="structfourdst_1_1composition_1_1_composition_entry.html#ab6619d23e111905d1e3ab16ee822d96c">fourdst::composition::CompositionEntry::rel_abundance</a></div><div class="ttdeci">double rel_abundance() const</div><div class="ttdoc">Gets the relative abundance of the species.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00130">composition.cpp:130</a></div></div>
|
||||
<div class="ttc" id="astructfourdst_1_1composition_1_1_composition_entry_html_ac273debdba6a1b3ac0f11698c399d38e"><div class="ttname"><a href="structfourdst_1_1composition_1_1_composition_entry.html#ac273debdba6a1b3ac0f11698c399d38e">fourdst::composition::CompositionEntry::m_symbol</a></div><div class="ttdeci">std::string m_symbol</div><div class="ttdoc">The chemical symbol of the species (e.g., "H-1", "Fe-56").</div><div class="ttdef"><b>Definition</b> <a href="#l00084">composition.h:84</a></div></div>
|
||||
<div class="ttc" id="astructfourdst_1_1composition_1_1_composition_entry_html_adc20165bf94e18eea3458003025579ac"><div class="ttname"><a href="structfourdst_1_1composition_1_1_composition_entry.html#adc20165bf94e18eea3458003025579ac">fourdst::composition::CompositionEntry::m_massFraction</a></div><div class="ttdeci">double m_massFraction</div><div class="ttdoc">The mass fraction of the species. Valid only if m_massFracMode is true.</div><div class="ttdef"><b>Definition</b> <a href="#l00088">composition.h:88</a></div></div>
|
||||
<div class="ttc" id="astructfourdst_1_1composition_1_1_composition_entry_html_ae7a6a113fc5914248eff5629716d6eb2"><div class="ttname"><a href="structfourdst_1_1composition_1_1_composition_entry.html#ae7a6a113fc5914248eff5629716d6eb2">fourdst::composition::CompositionEntry::operator<<</a></div><div class="ttdeci">friend std::ostream & operator<<(std::ostream &os, const CompositionEntry &entry)</div><div class="ttdoc">Overloaded output stream operator for CompositionEntry.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00767">composition.cpp:767</a></div></div>
|
||||
<div class="ttc" id="astructfourdst_1_1composition_1_1_composition_entry_html_af4f8d292d18755670a914072e2260dfb"><div class="ttname"><a href="structfourdst_1_1composition_1_1_composition_entry.html#af4f8d292d18755670a914072e2260dfb">fourdst::composition::CompositionEntry::isotope</a></div><div class="ttdeci">atomic::Species isotope() const</div><div class="ttdoc">Gets the isotope data for the species.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00109">composition.cpp:109</a></div></div>
|
||||
<div class="ttc" id="astructfourdst_1_1composition_1_1_composition_entry_html_ae7a6a113fc5914248eff5629716d6eb2"><div class="ttname"><a href="structfourdst_1_1composition_1_1_composition_entry.html#ae7a6a113fc5914248eff5629716d6eb2">fourdst::composition::CompositionEntry::operator<<</a></div><div class="ttdeci">friend std::ostream & operator<<(std::ostream &os, const CompositionEntry &entry)</div><div class="ttdoc">Overloaded output stream operator for CompositionEntry.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00932">composition.cpp:932</a></div></div>
|
||||
<div class="ttc" id="astructfourdst_1_1composition_1_1_composition_entry_html_af4f8d292d18755670a914072e2260dfb"><div class="ttname"><a href="structfourdst_1_1composition_1_1_composition_entry.html#af4f8d292d18755670a914072e2260dfb">fourdst::composition::CompositionEntry::isotope</a></div><div class="ttdeci">atomic::Species isotope() const</div><div class="ttdoc">Gets the isotope data for the species.</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00134">composition.cpp:134</a></div></div>
|
||||
<div class="ttc" id="astructfourdst_1_1composition_1_1_global_composition_html"><div class="ttname"><a href="structfourdst_1_1composition_1_1_global_composition.html">fourdst::composition::GlobalComposition</a></div><div class="ttdoc">Represents global properties of a finalized composition.</div><div class="ttdef"><b>Definition</b> <a href="#l00069">composition.h:69</a></div></div>
|
||||
<div class="ttc" id="astructfourdst_1_1composition_1_1_global_composition_html_a0df6ecfe28d13cbffd0abcbfec9aee41"><div class="ttname"><a href="structfourdst_1_1composition_1_1_global_composition.html#a0df6ecfe28d13cbffd0abcbfec9aee41">fourdst::composition::GlobalComposition::specificNumberDensity</a></div><div class="ttdeci">double specificNumberDensity</div><div class="ttdoc">The specific number density (moles per unit mass, sum of X_i/M_i), where X_i is mass fraction and M_i...</div><div class="ttdef"><b>Definition</b> <a href="#l00070">composition.h:70</a></div></div>
|
||||
<div class="ttc" id="astructfourdst_1_1composition_1_1_global_composition_html_a3c072a749c3648607771ac9105181f26"><div class="ttname"><a href="structfourdst_1_1composition_1_1_global_composition.html#a3c072a749c3648607771ac9105181f26">fourdst::composition::GlobalComposition::operator<<</a></div><div class="ttdeci">friend std::ostream & operator<<(std::ostream &os, const GlobalComposition &comp)</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00760">composition.cpp:760</a></div></div>
|
||||
<div class="ttc" id="astructfourdst_1_1composition_1_1_global_composition_html_a3c072a749c3648607771ac9105181f26"><div class="ttname"><a href="structfourdst_1_1composition_1_1_global_composition.html#a3c072a749c3648607771ac9105181f26">fourdst::composition::GlobalComposition::operator<<</a></div><div class="ttdeci">friend std::ostream & operator<<(std::ostream &os, const GlobalComposition &comp)</div><div class="ttdef"><b>Definition</b> <a href="composition_8cpp_source.html#l00925">composition.cpp:925</a></div></div>
|
||||
<div class="ttc" id="astructfourdst_1_1composition_1_1_global_composition_html_a9c35810d965841a755da9ce4644a2f1b"><div class="ttname"><a href="structfourdst_1_1composition_1_1_global_composition.html#a9c35810d965841a755da9ce4644a2f1b">fourdst::composition::GlobalComposition::meanParticleMass</a></div><div class="ttdeci">double meanParticleMass</div><div class="ttdoc">The mean mass per particle (inverse of specific number density). Units: g/mol.</div><div class="ttdef"><b>Definition</b> <a href="#l00071">composition.h:71</a></div></div>
|
||||
</div><!-- fragment --></div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
|
||||
Reference in New Issue
Block a user