tboudreaux/libcomposition
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
30da87c74c2b99a0983cb7061d1406d2352132d0
libcomposition/docs/html/classfourdst_1_1composition_1_1_composition_abstract.html

1155 lines
72 KiB
HTML
Raw Normal View History

docs(docs): rebuilt docs
2026-05-18 10:08:43 -04:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.13.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>fourdst::libcomposition: fourdst::composition::CompositionAbstract Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome-sidebar-only.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
docs(docs): rebuilt docs
2026-06-12 10:49:27 -04:00
<div id="projectname">fourdst::libcomposition<span id="projectnumber">&#160;v2.4.9</span>
docs(docs): rebuilt docs
2026-05-18 10:08:43 -04:00
</div>
<div id="projectbrief">Robust atomic species information library</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.13.2 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search',true);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('classfourdst_1_1composition_1_1_composition_abstract.html',''); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classfourdst_1_1composition_1_1_composition_abstract-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">fourdst::composition::CompositionAbstract Class Reference<span class="mlabels"><span class="mlabel abstract">abstract</span></span></div></div>
</div><!--header-->
<div class="contents">
<p>Abstract base class for chemical composition representations.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="composition__abstract_8h_source.html">composition_abstract.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for fourdst::composition::CompositionAbstract:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classfourdst_1_1composition_1_1_composition_abstract__inherit__graph.svg" width="334" height="230"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:abd12f3a9a5b6217498ff19e25ee3ddb0" id="r_abd12f3a9a5b6217498ff19e25ee3ddb0"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#abd12f3a9a5b6217498ff19e25ee3ddb0">iterator</a> = <a class="el" href="classfourdst_1_1composition_1_1detail_1_1_composition_iterator.html">detail::CompositionIterator</a>&lt;false&gt;</td></tr>
<tr class="separator:abd12f3a9a5b6217498ff19e25ee3ddb0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0bb9772bc73d637950b6cf2e8e6afeb0" id="r_a0bb9772bc73d637950b6cf2e8e6afeb0"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0bb9772bc73d637950b6cf2e8e6afeb0">const_iterator</a> = <a class="el" href="classfourdst_1_1composition_1_1detail_1_1_composition_iterator.html">detail::CompositionIterator</a>&lt;true&gt;</td></tr>
<tr class="separator:a0bb9772bc73d637950b6cf2e8e6afeb0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a83ff77f3f390bb66c978e157d9bb6394" id="r_a83ff77f3f390bb66c978e157d9bb6394"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a83ff77f3f390bb66c978e157d9bb6394">~CompositionAbstract</a> ()=default</td></tr>
<tr class="memdesc:a83ff77f3f390bb66c978e157d9bb6394"><td class="mdescLeft">&#160;</td><td class="mdescRight">Virtual destructor. <br /></td></tr>
<tr class="separator:a83ff77f3f390bb66c978e157d9bb6394"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2e6c4d27d2b295b6be87c6964cac1e1e" id="r_a2e6c4d27d2b295b6be87c6964cac1e1e"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a2e6c4d27d2b295b6be87c6964cac1e1e">contains</a> (const <a class="el" href="structfourdst_1_1atomic_1_1_species.html">fourdst::atomic::Species</a> &amp;species) const noexcept=0</td></tr>
<tr class="memdesc:a2e6c4d27d2b295b6be87c6964cac1e1e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if the composition contains the given species. <br /></td></tr>
<tr class="separator:a2e6c4d27d2b295b6be87c6964cac1e1e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6fe83824aefb045d8a5399e8ac9852f9" id="r_a6fe83824aefb045d8a5399e8ac9852f9"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a6fe83824aefb045d8a5399e8ac9852f9">contains</a> (const std::string &amp;symbol) const =0</td></tr>
<tr class="memdesc:a6fe83824aefb045d8a5399e8ac9852f9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if the composition contains the given species. <br /></td></tr>
<tr class="separator:a6fe83824aefb045d8a5399e8ac9852f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af7ec2eaa16a0c78d19728e32469cec06" id="r_af7ec2eaa16a0c78d19728e32469cec06"><td class="memItemLeft" align="right" valign="top">virtual size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af7ec2eaa16a0c78d19728e32469cec06">size</a> () const noexcept=0</td></tr>
<tr class="separator:af7ec2eaa16a0c78d19728e32469cec06"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a94c2cadeae32ab19cee42fc1670c4c6c" id="r_a94c2cadeae32ab19cee42fc1670c4c6c"><td class="memItemLeft" align="right" valign="top">virtual std::set&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a94c2cadeae32ab19cee42fc1670c4c6c">getRegisteredSymbols</a> () const noexcept=0</td></tr>
<tr class="memdesc:a94c2cadeae32ab19cee42fc1670c4c6c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get all registered chemical symbols in the composition. <br /></td></tr>
<tr class="separator:a94c2cadeae32ab19cee42fc1670c4c6c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad17ae8649860ef4f7a949e7c9143c0ec" id="r_ad17ae8649860ef4f7a949e7c9143c0ec"><td class="memItemLeft" align="right" valign="top">virtual const std::vector&lt; <a class="el" href="structfourdst_1_1atomic_1_1_species.html">atomic::Species</a> &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad17ae8649860ef4f7a949e7c9143c0ec">getRegisteredSpecies</a> () const noexcept=0</td></tr>
<tr class="memdesc:ad17ae8649860ef4f7a949e7c9143c0ec"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get all registered atomic species in the composition. <br /></td></tr>
<tr class="separator:ad17ae8649860ef4f7a949e7c9143c0ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3e3248162611754ca4c54b9979f6664d" id="r_a3e3248162611754ca4c54b9979f6664d"><td class="memItemLeft" align="right" valign="top">virtual std::unordered_map&lt; <a class="el" href="structfourdst_1_1atomic_1_1_species.html">fourdst::atomic::Species</a>, double &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a3e3248162611754ca4c54b9979f6664d">getMassFraction</a> () const noexcept=0</td></tr>
<tr class="memdesc:a3e3248162611754ca4c54b9979f6664d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the mass fraction for all registered symbols. <br /></td></tr>
<tr class="separator:a3e3248162611754ca4c54b9979f6664d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a65bae043ffbf4514b2593ccb63c6e265" id="r_a65bae043ffbf4514b2593ccb63c6e265"><td class="memItemLeft" align="right" valign="top">virtual std::unordered_map&lt; <a class="el" href="structfourdst_1_1atomic_1_1_species.html">fourdst::atomic::Species</a>, double &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a65bae043ffbf4514b2593ccb63c6e265">getNumberFraction</a> () const noexcept=0</td></tr>
<tr class="memdesc:a65bae043ffbf4514b2593ccb63c6e265"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the number fraction for all registered symbols. <br /></td></tr>
<tr class="separator:a65bae043ffbf4514b2593ccb63c6e265"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0ebe22344f785e5db693e04b9b598a5a" id="r_a0ebe22344f785e5db693e04b9b598a5a"><td class="memItemLeft" align="right" valign="top">virtual double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0ebe22344f785e5db693e04b9b598a5a">getMassFraction</a> (const std::string &amp;symbol) const =0</td></tr>
<tr class="memdesc:a0ebe22344f785e5db693e04b9b598a5a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the mass fraction for a given symbol. <br /></td></tr>
<tr class="separator:a0ebe22344f785e5db693e04b9b598a5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0396f17ba252d053c0126323a76e9142" id="r_a0396f17ba252d053c0126323a76e9142"><td class="memItemLeft" align="right" valign="top">virtual double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0396f17ba252d053c0126323a76e9142">getMassFraction</a> (const <a class="el" href="structfourdst_1_1atomic_1_1_species.html">fourdst::atomic::Species</a> &amp;species) const =0</td></tr>
<tr class="memdesc:a0396f17ba252d053c0126323a76e9142"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the mass fraction for a given species. <br /></td></tr>
<tr class="separator:a0396f17ba252d053c0126323a76e9142"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af490daa6942717605093b4fca3e676b8" id="r_af490daa6942717605093b4fca3e676b8"><td class="memItemLeft" align="right" valign="top">virtual double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af490daa6942717605093b4fca3e676b8">getNumberFraction</a> (const std::string &amp;symbol) const =0</td></tr>
<tr class="memdesc:af490daa6942717605093b4fca3e676b8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the number fraction for a given symbol. <br /></td></tr>
<tr class="separator:af490daa6942717605093b4fca3e676b8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a71b351d6e69cf0d7e7c43409e1b13c4c" id="r_a71b351d6e69cf0d7e7c43409e1b13c4c"><td class="memItemLeft" align="right" valign="top">virtual double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a71b351d6e69cf0d7e7c43409e1b13c4c">getNumberFraction</a> (const <a class="el" href="structfourdst_1_1atomic_1_1_species.html">fourdst::atomic::Species</a> &amp;species) const =0</td></tr>
<tr class="memdesc:a71b351d6e69cf0d7e7c43409e1b13c4c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the number fraction for a given species. <br /></td></tr>
<tr class="separator:a71b351d6e69cf0d7e7c43409e1b13c4c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a29613d8197cee96f764aeeaa3b7286f8" id="r_a29613d8197cee96f764aeeaa3b7286f8"><td class="memItemLeft" align="right" valign="top">virtual double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a29613d8197cee96f764aeeaa3b7286f8">getMolarAbundance</a> (const std::string &amp;symbol) const =0</td></tr>
<tr class="memdesc:a29613d8197cee96f764aeeaa3b7286f8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the molar abundance for a given symbol. <br /></td></tr>
<tr class="separator:a29613d8197cee96f764aeeaa3b7286f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adf861bd58e80025b021af2949b41d126" id="r_adf861bd58e80025b021af2949b41d126"><td class="memItemLeft" align="right" valign="top">virtual double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#adf861bd58e80025b021af2949b41d126">getMolarAbundance</a> (const <a class="el" href="structfourdst_1_1atomic_1_1_species.html">fourdst::atomic::Species</a> &amp;species) const =0</td></tr>
<tr class="memdesc:adf861bd58e80025b021af2949b41d126"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the molar abundance for a given species. <br /></td></tr>
<tr class="separator:adf861bd58e80025b021af2949b41d126"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afedcef16ed403b95ce7f1e6756aa46e8" id="r_afedcef16ed403b95ce7f1e6756aa46e8"><td class="memItemLeft" align="right" valign="top">virtual double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#afedcef16ed403b95ce7f1e6756aa46e8">getMeanParticleMass</a> () const noexcept=0</td></tr>
<tr class="memdesc:afedcef16ed403b95ce7f1e6756aa46e8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the mean particle mass of the composition. <br /></td></tr>
<tr class="separator:afedcef16ed403b95ce7f1e6756aa46e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad0fcf2e51cca02c4224241828335db1a" id="r_ad0fcf2e51cca02c4224241828335db1a"><td class="memItemLeft" align="right" valign="top">virtual double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad0fcf2e51cca02c4224241828335db1a">getElectronAbundance</a> () const noexcept=0</td></tr>
<tr class="memdesc:ad0fcf2e51cca02c4224241828335db1a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the electron abundance of the composition. <br /></td></tr>
<tr class="separator:ad0fcf2e51cca02c4224241828335db1a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a752af872347c612bf3b43b1711c2cfc0" id="r_a752af872347c612bf3b43b1711c2cfc0"><td class="memItemLeft" align="right" valign="top">virtual std::vector&lt; double &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a752af872347c612bf3b43b1711c2cfc0">getMassFractionVector</a> () const noexcept=0</td></tr>
<tr class="memdesc:a752af872347c612bf3b43b1711c2cfc0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the mass fraction as a vector. <br /></td></tr>
<tr class="separator:a752af872347c612bf3b43b1711c2cfc0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a83343286d738d101635b2a7f5b7d96ef" id="r_a83343286d738d101635b2a7f5b7d96ef"><td class="memItemLeft" align="right" valign="top">virtual std::vector&lt; double &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a83343286d738d101635b2a7f5b7d96ef">getNumberFractionVector</a> () const noexcept=0</td></tr>
<tr class="memdesc:a83343286d738d101635b2a7f5b7d96ef"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the number fraction as a vector. <br /></td></tr>
<tr class="separator:a83343286d738d101635b2a7f5b7d96ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a657c12d36b2f44e44c32e86d5296c063" id="r_a657c12d36b2f44e44c32e86d5296c063"><td class="memItemLeft" align="right" valign="top">virtual std::vector&lt; double &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a657c12d36b2f44e44c32e86d5296c063">getMolarAbundanceVector</a> () const noexcept=0</td></tr>
<tr class="memdesc:a657c12d36b2f44e44c32e86d5296c063"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the molar abundance as a vector. <br /></td></tr>
<tr class="separator:a657c12d36b2f44e44c32e86d5296c063"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aebf28eab9c902a285589fe2ab7f3060f" id="r_aebf28eab9c902a285589fe2ab7f3060f"><td class="memItemLeft" align="right" valign="top">virtual size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aebf28eab9c902a285589fe2ab7f3060f">getSpeciesIndex</a> (const std::string &amp;symbol) const =0</td></tr>
<tr class="memdesc:aebf28eab9c902a285589fe2ab7f3060f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the index of a species by symbol. <br /></td></tr>
<tr class="separator:aebf28eab9c902a285589fe2ab7f3060f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5d04b801f152f7955b392710275105bc" id="r_a5d04b801f152f7955b392710275105bc"><td class="memItemLeft" align="right" valign="top">virtual size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5d04b801f152f7955b392710275105bc">getSpeciesIndex</a> (const <a class="el" href="structfourdst_1_1atomic_1_1_species.html">fourdst::atomic::Species</a> &amp;species) const =0</td></tr>
<tr class="memdesc:a5d04b801f152f7955b392710275105bc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the index of a species. <br /></td></tr>
<tr class="separator:a5d04b801f152f7955b392710275105bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a43138cbf3d399e8f278db742fe1b02a7" id="r_a43138cbf3d399e8f278db742fe1b02a7"><td class="memItemLeft" align="right" valign="top">virtual <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="#a43138cbf3d399e8f278db742fe1b02a7">getSpeciesAtIndex</a> (size_t index) const =0</td></tr>
<tr class="memdesc:a43138cbf3d399e8f278db742fe1b02a7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the species at a given index. <br /></td></tr>
<tr class="separator:a43138cbf3d399e8f278db742fe1b02a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a81d5a4da267e24662ae90c6a29f3d0a1" id="r_a81d5a4da267e24662ae90c6a29f3d0a1"><td class="memItemLeft" align="right" valign="top">virtual std::unique_ptr&lt; <a class="el" href="classfourdst_1_1composition_1_1_composition_abstract.html">CompositionAbstract</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a81d5a4da267e24662ae90c6a29f3d0a1">clone</a> () const =0</td></tr>
<tr class="separator:a81d5a4da267e24662ae90c6a29f3d0a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a643f2e1f843d8a6f81c9382278916fe5" id="r_a643f2e1f843d8a6f81c9382278916fe5"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="#abd12f3a9a5b6217498ff19e25ee3ddb0">iterator</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a643f2e1f843d8a6f81c9382278916fe5">begin</a> ()=0</td></tr>
<tr class="separator:a643f2e1f843d8a6f81c9382278916fe5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9f903ec8d0444c7ed9178c09de902176" id="r_a9f903ec8d0444c7ed9178c09de902176"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="#abd12f3a9a5b6217498ff19e25ee3ddb0">iterator</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a9f903ec8d0444c7ed9178c09de902176">end</a> ()=0</td></tr>
<tr class="separator:a9f903ec8d0444c7ed9178c09de902176"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0a1845dab0dbf23399233cac7aeb05c1" id="r_a0a1845dab0dbf23399233cac7aeb05c1"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="#a0bb9772bc73d637950b6cf2e8e6afeb0">const_iterator</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0a1845dab0dbf23399233cac7aeb05c1">begin</a> () const =0</td></tr>
<tr class="separator:a0a1845dab0dbf23399233cac7aeb05c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9ac49da6e4df7bee8aa7974e8fec8181" id="r_a9ac49da6e4df7bee8aa7974e8fec8181"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="#a0bb9772bc73d637950b6cf2e8e6afeb0">const_iterator</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a9ac49da6e4df7bee8aa7974e8fec8181">end</a> () const =0</td></tr>
<tr class="separator:a9ac49da6e4df7bee8aa7974e8fec8181"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2d5472a63e2dbfc94d7e4617b5660e23" id="r_a2d5472a63e2dbfc94d7e4617b5660e23"><td class="memItemLeft" align="right" valign="top">virtual std::size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a2d5472a63e2dbfc94d7e4617b5660e23">hash</a> () const =0</td></tr>
<tr class="separator:a2d5472a63e2dbfc94d7e4617b5660e23"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Abstract base class for chemical composition representations. </p>
<p>The purpose of this class is to define a standard interface for all composition types. Children of this class are responsible for implementing the setter methods, but any object that is a child of <a class="el" href="classfourdst_1_1composition_1_1_composition_abstract.html" title="Abstract base class for chemical composition representations.">CompositionAbstract</a> will always have these getter methods.</p>
<p>This ensures that all derived composition classes provide a consistent API for querying composition properties, regardless of how the data is set or stored.</p>
<dl class="section user"><dt>Example</dt><dd><div class="fragment"><div class="line"><span class="keyword">class </span>MyComposition : <span class="keyword">public</span> <a class="code hl_class" href="classfourdst_1_1composition_1_1_composition_abstract.html">CompositionAbstract</a> {</div>
<div class="line"> <span class="comment">// ...implement all pure virtual methods...</span></div>
<div class="line">};</div>
<div class="line"> </div>
<div class="line">MyComposition comp;</div>
<div class="line"><span class="keywordflow">if</span> (comp.hasSymbol(<span class="stringliteral">&quot;H&quot;</span>)) {</div>
<div class="line"> <span class="keywordtype">double</span> mf = comp.getMassFraction(<span class="stringliteral">&quot;H&quot;</span>);</div>
<div class="line">}</div>
<div class="line">std::set&lt;std::string&gt; symbols = comp.getRegisteredSymbols();</div>
<div class="ttc" id="aclassfourdst_1_1composition_1_1_composition_abstract_html"><div class="ttname"><a href="classfourdst_1_1composition_1_1_composition_abstract.html">fourdst::composition::CompositionAbstract</a></div><div class="ttdoc">Abstract base class for chemical composition representations.</div><div class="ttdef"><b>Definition</b> <a href="composition__abstract_8h_source.html#l00036">composition_abstract.h:36</a></div></div>
</div><!-- fragment --> </dd></dl>
<p class="definition">Definition at line <a class="el" href="composition__abstract_8h_source.html#l00036">36</a> of file <a class="el" href="composition__abstract_8h_source.html">composition_abstract.h</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="a0bb9772bc73d637950b6cf2e8e6afeb0" name="a0bb9772bc73d637950b6cf2e8e6afeb0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0bb9772bc73d637950b6cf2e8e6afeb0">&#9670;&#160;</a></span>const_iterator</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="#a0bb9772bc73d637950b6cf2e8e6afeb0">fourdst::composition::CompositionAbstract::const_iterator</a> = <a class="el" href="classfourdst_1_1composition_1_1detail_1_1_composition_iterator.html">detail::CompositionIterator</a>&lt;true&gt;</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="composition__abstract_8h_source.html#l00039">39</a> of file <a class="el" href="composition__abstract_8h_source.html">composition_abstract.h</a>.</p>
</div>
</div>
<a id="abd12f3a9a5b6217498ff19e25ee3ddb0" name="abd12f3a9a5b6217498ff19e25ee3ddb0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abd12f3a9a5b6217498ff19e25ee3ddb0">&#9670;&#160;</a></span>iterator</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="#abd12f3a9a5b6217498ff19e25ee3ddb0">fourdst::composition::CompositionAbstract::iterator</a> = <a class="el" href="classfourdst_1_1composition_1_1detail_1_1_composition_iterator.html">detail::CompositionIterator</a>&lt;false&gt;</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="composition__abstract_8h_source.html#l00038">38</a> of file <a class="el" href="composition__abstract_8h_source.html">composition_abstract.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a83ff77f3f390bb66c978e157d9bb6394" name="a83ff77f3f390bb66c978e157d9bb6394"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a83ff77f3f390bb66c978e157d9bb6394">&#9670;&#160;</a></span>~CompositionAbstract()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual fourdst::composition::CompositionAbstract::~CompositionAbstract </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel virtual">virtual</span><span class="mlabel default">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Virtual destructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a0a1845dab0dbf23399233cac7aeb05c1" name="a0a1845dab0dbf23399233cac7aeb05c1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0a1845dab0dbf23399233cac7aeb05c1">&#9670;&#160;</a></span>begin() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="#a0bb9772bc73d637950b6cf2e8e6afeb0">const_iterator</a> fourdst::composition::CompositionAbstract::begin </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></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 class="mlabel pure-virtual">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="classfourdst_1_1composition_1_1_composition.html#ae4600dc915645fc1b50c67e0218b794d">fourdst::composition::Composition</a>, <a class="el" href="classfourdst_1_1composition_1_1_composition_decorator.html#a125e06aaf1edfd035d7d102792a120d5">fourdst::composition::CompositionDecorator</a>, and <a class="el" href="classfourdst_1_1composition_1_1_masked_composition.html#a047dae84149b92be5849c4294cd481de">fourdst::composition::MaskedComposition</a>.</p>
</div>
</div>
<a id="a643f2e1f843d8a6f81c9382278916fe5" name="a643f2e1f843d8a6f81c9382278916fe5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a643f2e1f843d8a6f81c9382278916fe5">&#9670;&#160;</a></span>begin() <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">virtual <a class="el" href="#abd12f3a9a5b6217498ff19e25ee3ddb0">iterator</a> fourdst::composition::CompositionAbstract::begin </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel nodiscard">nodiscard</span><span class="mlabel pure-virtual">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="classfourdst_1_1composition_1_1_composition.html#a5bdb6ca3f734fae901b3d6179dbc17a0">fourdst::composition::Composition</a>, <a class="el" href="classfourdst_1_1composition_1_1_composition_decorator.html#a34e7e9fd25cd4037ba359bc7a7236929">fourdst::composition::CompositionDecorator</a>, and <a class="el" href="classfourdst_1_1composition_1_1_masked_composition.html#aa01637b823d0127736cdc767284eb28d">fourdst::composition::MaskedComposition</a>.</p>
</div>
</div>
<a id="a81d5a4da267e24662ae90c6a29f3d0a1" name="a81d5a4da267e24662ae90c6a29f3d0a1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a81d5a4da267e24662ae90c6a29f3d0a1">&#9670;&#160;</a></span>clone()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual std::unique_ptr&lt; <a class="el" href="classfourdst_1_1composition_1_1_composition_abstract.html">CompositionAbstract</a> &gt; fourdst::composition::CompositionAbstract::clone </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></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 class="mlabel pure-virtual">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="classfourdst_1_1composition_1_1_composition.html#a5a1f5661a329ec7bc8b7e118ff9d6c25">fourdst::composition::Composition</a>, and <a class="el" href="classfourdst_1_1composition_1_1_masked_composition.html#a30f89ba71d9db6ad330c645d0a161164">fourdst::composition::MaskedComposition</a>.</p>
</div>
</div>
<a id="a2e6c4d27d2b295b6be87c6964cac1e1e" name="a2e6c4d27d2b295b6be87c6964cac1e1e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2e6c4d27d2b295b6be87c6964cac1e1e">&#9670;&#160;</a></span>contains() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool fourdst::composition::CompositionAbstract::contains </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structfourdst_1_1atomic_1_1_species.html">fourdst::atomic::Species</a> &amp;</td> <td class="paramname"><span class="paramname"><em>species</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 class="mlabel pure-virtual">pure virtual</span><span class="mlabel noexcept">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if the composition contains the given species. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">species</td><td>The atomic species to check. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if the species is contained, false otherwise. </dd></dl>
<p>Implemented in <a class="el" href="classfourdst_1_1composition_1_1_composition.html#a194f715788e7921bd611579440de2ecd">fourdst::composition::Composition</a>, <a class="el" href="classfourdst_1_1composition_1_1_composition_decorator.html#a811e91b7cc08f19b8c92de43fdb91401">fourdst::composition::CompositionDecorator</a>, and <a class="el" href="classfourdst_1_1composition_1_1_masked_composition.html#a045cfdf1e771895df872a6da61c53966">fourdst::composition::MaskedComposition</a>.</p>
</div>
</div>
<a id="a6fe83824aefb045d8a5399e8ac9852f9" name="a6fe83824aefb045d8a5399e8ac9852f9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6fe83824aefb045d8a5399e8ac9852f9">&#9670;&#160;</a></span>contains() <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">virtual bool fourdst::composition::CompositionAbstract::contains </td>
<td>(</td>
<td class="paramtype">const std::string &amp;</td> <td class="paramname"><span class="paramname"><em>symbol</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 class="mlabel pure-virtual">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if the composition contains the given species. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">symbol</td><td>The symbol of the atomic species to check. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if the species is contained, false otherwise. </dd></dl>
<p>Implemented in <a class="el" href="classfourdst_1_1composition_1_1_composition.html#ac3bfb56a2587215a59894e76d4867ede">fourdst::composition::Composition</a>, <a class="el" href="classfourdst_1_1composition_1_1_composition_decorator.html#af40ce87fce6fc0fae837bf8f31fec274">fourdst::composition::CompositionDecorator</a>, and <a class="el" href="classfourdst_1_1composition_1_1_masked_composition.html#a83b73b24715d8a0fc29811653bb7c9a6">fourdst::composition::MaskedComposition</a>.</p>
</div>
</div>
<a id="a9ac49da6e4df7bee8aa7974e8fec8181" name="a9ac49da6e4df7bee8aa7974e8fec8181"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9ac49da6e4df7bee8aa7974e8fec8181">&#9670;&#160;</a></span>end() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="#a0bb9772bc73d637950b6cf2e8e6afeb0">const_iterator</a> fourdst::composition::CompositionAbstract::end </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></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 class="mlabel pure-virtual">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="classfourdst_1_1composition_1_1_composition.html#aabcde53961ecadfa823de5a766f0da84">fourdst::composition::Composition</a>, <a class="el" href="classfourdst_1_1composition_1_1_composition_decorator.html#a56d0561c510efa577dc9a295174827ec">fourdst::composition::CompositionDecorator</a>, and <a class="el" href="classfourdst_1_1composition_1_1_masked_composition.html#a272b2164c1ad6efab7e86ed26efcbb96">fourdst::composition::MaskedComposition</a>.</p>
</div>
</div>
<a id="a9f903ec8d0444c7ed9178c09de902176" name="a9f903ec8d0444c7ed9178c09de902176"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9f903ec8d0444c7ed9178c09de902176">&#9670;&#160;</a></span>end() <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">virtual <a class="el" href="#abd12f3a9a5b6217498ff19e25ee3ddb0">iterator</a> fourdst::composition::CompositionAbstract::end </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel nodiscard">nodiscard</span><span class="mlabel pure-virtual">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="classfourdst_1_1composition_1_1_composition.html#aaa89050308dda5e51d4b47d18d54cb58">fourdst::composition::Composition</a>, <a class="el" href="classfourdst_1_1composition_1_1_composition_decorator.html#aaf47cdfcb7feb3991d6e151bbf2521ff">fourdst::composition::CompositionDecorator</a>, and <a class="el" href="classfourdst_1_1composition_1_1_masked_composition.html#aae6a6799ee6877064728bd880348420d">fourdst::composition::MaskedComposition</a>.</p>
</div>
</div>
<a id="ad0fcf2e51cca02c4224241828335db1a" name="ad0fcf2e51cca02c4224241828335db1a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad0fcf2e51cca02c4224241828335db1a">&#9670;&#160;</a></span>getElectronAbundance()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual double fourdst::composition::CompositionAbstract::getElectronAbundance </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></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 class="mlabel pure-virtual">pure virtual</span><span class="mlabel noexcept">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the electron abundance of the composition. </p>
<dl class="section return"><dt>Returns</dt><dd>The electron abundance. </dd></dl>
<p>Implemented in <a class="el" href="classfourdst_1_1composition_1_1_composition.html#a90fc71d1fe03017ee4c7a1cac69d24fb">fourdst::composition::Composition</a>, <a class="el" href="classfourdst_1_1composition_1_1_composition_decorator.html#a39f1df55aff6650c653e62c0e9a2cc5e">fourdst::composition::CompositionDecorator</a>, and <a class="el" href="classfourdst_1_1composition_1_1_masked_composition.html#a38fc871469f94b3c07ba18a00548085d">fourdst::composition::MaskedComposition</a>.</p>
</div>
</div>
<a id="a3e3248162611754ca4c54b9979f6664d" name="a3e3248162611754ca4c54b9979f6664d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3e3248162611754ca4c54b9979f6664d">&#9670;&#160;</a></span>getMassFraction() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual std::unordered_map&lt; <a class="el" href="structfourdst_1_1atomic_1_1_species.html">fourdst::atomic::Species</a>, double &gt; fourdst::composition::CompositionAbstract::getMassFraction </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></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 class="mlabel pure-virtual">pure virtual</span><span class="mlabel noexcept">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the mass fraction for all registered symbols. </p>
<dl class="section return"><dt>Returns</dt><dd>An unordered map from symbol to mass fraction. </dd></dl>
<p>Implemented in <a class="el" href="classfourdst_1_1composition_1_1_composition.html#a9ea2b673341fdc67afeb0f0517a54c8c">fourdst::composition::Composition</a>, <a class="el" href="classfourdst_1_1composition_1_1_composition_decorator.html#a8c1a4cd69465ef5b65bea547ed919ca5">fourdst::composition::CompositionDecorator</a>, and <a class="el" href="classfourdst_1_1composition_1_1_masked_composition.html#a2383b69a4b1dbe1c7be01bb826b06c07">fourdst::composition::MaskedComposition</a>.</p>
</div>
</div>
<a id="a0396f17ba252d053c0126323a76e9142" name="a0396f17ba252d053c0126323a76e9142"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0396f17ba252d053c0126323a76e9142">&#9670;&#160;</a></span>getMassFraction() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual double fourdst::composition::CompositionAbstract::getMassFraction </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structfourdst_1_1atomic_1_1_species.html">fourdst::atomic::Species</a> &amp;</td> <td class="paramname"><span class="paramname"><em>species</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 class="mlabel pure-virtual">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the mass fraction for a given species. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">species</td><td>The atomic species. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The mass fraction for the species. </dd></dl>
<p>Implemented in <a class="el" href="classfourdst_1_1composition_1_1_composition.html#ae8fe4e7158f8317bf29b5cd0c65a9524">fourdst::composition::Composition</a>, <a class="el" href="classfourdst_1_1composition_1_1_composition_decorator.html#a12a5cdb232ce4ce30980a016d20b4a43">fourdst::composition::CompositionDecorator</a>, and <a class="el" href="classfourdst_1_1composition_1_1_masked_composition.html#a81cab92e09924db1804e9b943611648a">fourdst::composition::MaskedComposition</a>.</p>
</div>
</div>
<a id="a0ebe22344f785e5db693e04b9b598a5a" name="a0ebe22344f785e5db693e04b9b598a5a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0ebe22344f785e5db693e04b9b598a5a">&#9670;&#160;</a></span>getMassFraction() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual double fourdst::composition::CompositionAbstract::getMassFraction </td>
<td>(</td>
<td class="paramtype">const std::string &amp;</td> <td class="paramname"><span class="paramname"><em>symbol</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 class="mlabel pure-virtual">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the mass fraction for a given symbol. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">symbol</td><td>The chemical symbol. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The mass fraction for the symbol. </dd></dl>
<p>Implemented in <a class="el" href="classfourdst_1_1composition_1_1_composition.html#ae5d8d21632fca2b35b0898f2b205cd10">fourdst::composition::Composition</a>, <a class="el" href="classfourdst_1_1composition_1_1_composition_decorator.html#a52591cb38ab7712fc459eeb48b9d2eaf">fourdst::composition::CompositionDecorator</a>, and <a class="el" href="classfourdst_1_1composition_1_1_masked_composition.html#ab2a8d9eb543eb712f9a0bbabcc94383a">fourdst::composition::MaskedComposition</a>.</p>
</div>
</div>
<a id="a752af872347c612bf3b43b1711c2cfc0" name="a752af872347c612bf3b43b1711c2cfc0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a752af872347c612bf3b43b1711c2cfc0">&#9670;&#160;</a></span>getMassFractionVector()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual std::vector&lt; double &gt; fourdst::composition::CompositionAbstract::getMassFractionVector </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></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 class="mlabel pure-virtual">pure virtual</span><span class="mlabel noexcept">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the mass fraction as a vector. </p>
<dl class="section return"><dt>Returns</dt><dd>A vector of mass fractions for all species. </dd></dl>
<p>Implemented in <a class="el" href="classfourdst_1_1composition_1_1_composition.html#af4f44aaf8b7e0d63872a70b5e2131369">fourdst::composition::Composition</a>, <a class="el" href="classfourdst_1_1composition_1_1_composition_decorator.html#a4d2795fa73ec3f5185232d4cca5684a6">fourdst::composition::CompositionDecorator</a>, and <a class="el" href="classfourdst_1_1composition_1_1_masked_composition.html#a7655d278224486e762d22d0501187f58">fourdst::composition::MaskedComposition</a>.</p>
</div>
</div>
<a id="afedcef16ed403b95ce7f1e6756aa46e8" name="afedcef16ed403b95ce7f1e6756aa46e8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afedcef16ed403b95ce7f1e6756aa46e8">&#9670;&#160;</a></span>getMeanParticleMass()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual double fourdst::composition::CompositionAbstract::getMeanParticleMass </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></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 class="mlabel pure-virtual">pure virtual</span><span class="mlabel noexcept">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the mean particle mass of the composition. </p>
<dl class="section return"><dt>Returns</dt><dd>The mean particle mass. </dd></dl>
<p>Implemented in <a class="el" href="classfourdst_1_1composition_1_1_composition.html#afbbb5e51ad5ae5c0fa6bc0094195aecd">fourdst::composition::Composition</a>, <a class="el" href="classfourdst_1_1composition_1_1_composition_decorator.html#a3b8f0f8fd75888d001177deff39f7405">fourdst::composition::CompositionDecorator</a>, and <a class="el" href="classfourdst_1_1composition_1_1_masked_composition.html#a3f50005318f2aa7bf7c3cd5b1d2aef7a">fourdst::composition::MaskedComposition</a>.</p>
</div>
</div>
<a id="adf861bd58e80025b021af2949b41d126" name="adf861bd58e80025b021af2949b41d126"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adf861bd58e80025b021af2949b41d126">&#9670;&#160;</a></span>getMolarAbundance() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual double fourdst::composition::CompositionAbstract::getMolarAbundance </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structfourdst_1_1atomic_1_1_species.html">fourdst::atomic::Species</a> &amp;</td> <td class="paramname"><span class="paramname"><em>species</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 class="mlabel pure-virtual">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the molar abundance for a given species. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">species</td><td>The atomic species. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The molar abundance for the species. </dd></dl>
<p>Implemented in <a class="el" href="classfourdst_1_1composition_1_1_composition.html#a78a43e9e77a9c1b0f27c50b9feb52449">fourdst::composition::Composition</a>, <a class="el" href="classfourdst_1_1composition_1_1_composition_decorator.html#a57a1cc37e96234477b21866881fbdbaa">fourdst::composition::CompositionDecorator</a>, and <a class="el" href="classfourdst_1_1composition_1_1_masked_composition.html#a9766e12e53e504aab985e46dc4e0d6d6">fourdst::composition::MaskedComposition</a>.</p>
</div>
</div>
<a id="a29613d8197cee96f764aeeaa3b7286f8" name="a29613d8197cee96f764aeeaa3b7286f8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a29613d8197cee96f764aeeaa3b7286f8">&#9670;&#160;</a></span>getMolarAbundance() <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">virtual double fourdst::composition::CompositionAbstract::getMolarAbundance </td>
<td>(</td>
<td class="paramtype">const std::string &amp;</td> <td class="paramname"><span class="paramname"><em>symbol</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 class="mlabel pure-virtual">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the molar abundance for a given symbol. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">symbol</td><td>The chemical symbol. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The molar abundance for the symbol. </dd></dl>
<p>Implemented in <a class="el" href="classfourdst_1_1composition_1_1_composition.html#add67a92d73e3a57a2bbdb52bc9ca3bfe">fourdst::composition::Composition</a>, <a class="el" href="classfourdst_1_1composition_1_1_composition_decorator.html#a0c46d440cafd9ae2d04589ece5fd41fb">fourdst::composition::CompositionDecorator</a>, and <a class="el" href="classfourdst_1_1composition_1_1_masked_composition.html#a3064af4fb0b59dce5b484d5657d25506">fourdst::composition::MaskedComposition</a>.</p>
</div>
</div>
<a id="a657c12d36b2f44e44c32e86d5296c063" name="a657c12d36b2f44e44c32e86d5296c063"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a657c12d36b2f44e44c32e86d5296c063">&#9670;&#160;</a></span>getMolarAbundanceVector()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual std::vector&lt; double &gt; fourdst::composition::CompositionAbstract::getMolarAbundanceVector </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></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 class="mlabel pure-virtual">pure virtual</span><span class="mlabel noexcept">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the molar abundance as a vector. </p>
<dl class="section return"><dt>Returns</dt><dd>A vector of molar abundances for all species. </dd></dl>
<p>Implemented in <a class="el" href="classfourdst_1_1composition_1_1_composition.html#abcb391f5fca2b636127e48e681e4c3ee">fourdst::composition::Composition</a>, <a class="el" href="classfourdst_1_1composition_1_1_composition_decorator.html#a80e528239b4a197985e6993c8b6dab48">fourdst::composition::CompositionDecorator</a>, and <a class="el" href="classfourdst_1_1composition_1_1_masked_composition.html#ac2f827bedae5405ebab7108b2e4397c5">fourdst::composition::MaskedComposition</a>.</p>
</div>
</div>
<a id="a65bae043ffbf4514b2593ccb63c6e265" name="a65bae043ffbf4514b2593ccb63c6e265"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a65bae043ffbf4514b2593ccb63c6e265">&#9670;&#160;</a></span>getNumberFraction() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual std::unordered_map&lt; <a class="el" href="structfourdst_1_1atomic_1_1_species.html">fourdst::atomic::Species</a>, double &gt; fourdst::composition::CompositionAbstract::getNumberFraction </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></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 class="mlabel pure-virtual">pure virtual</span><span class="mlabel noexcept">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the number fraction for all registered symbols. </p>
<dl class="section return"><dt>Returns</dt><dd>An unordered map from symbol to number fraction. </dd></dl>
<p>Implemented in <a class="el" href="classfourdst_1_1composition_1_1_composition.html#a1f87ed64a1be9a6091c852131d24e476">fourdst::composition::Composition</a>, <a class="el" href="classfourdst_1_1composition_1_1_composition_decorator.html#a66724877d66017bac3dc3cc784dda57c">fourdst::composition::CompositionDecorator</a>, and <a class="el" href="classfourdst_1_1composition_1_1_masked_composition.html#a2c299c44f385b65202ed0d475402562a">fourdst::composition::MaskedComposition</a>.</p>
</div>
</div>
<a id="a71b351d6e69cf0d7e7c43409e1b13c4c" name="a71b351d6e69cf0d7e7c43409e1b13c4c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a71b351d6e69cf0d7e7c43409e1b13c4c">&#9670;&#160;</a></span>getNumberFraction() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual double fourdst::composition::CompositionAbstract::getNumberFraction </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structfourdst_1_1atomic_1_1_species.html">fourdst::atomic::Species</a> &amp;</td> <td class="paramname"><span class="paramname"><em>species</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 class="mlabel pure-virtual">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the number fraction for a given species. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">species</td><td>The atomic species. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The number fraction for the species. </dd></dl>
<p>Implemented in <a class="el" href="classfourdst_1_1composition_1_1_composition.html#a1aa79993925f16ba3c30a376aa39161b">fourdst::composition::Composition</a>, <a class="el" href="classfourdst_1_1composition_1_1_composition_decorator.html#a92c3d23d632f242e8b5526b343617f67">fourdst::composition::CompositionDecorator</a>, and <a class="el" href="classfourdst_1_1composition_1_1_masked_composition.html#a7cbb41a5b9e8d49c85bcbc821c3ff47e">fourdst::composition::MaskedComposition</a>.</p>
</div>
</div>
<a id="af490daa6942717605093b4fca3e676b8" name="af490daa6942717605093b4fca3e676b8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af490daa6942717605093b4fca3e676b8">&#9670;&#160;</a></span>getNumberFraction() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual double fourdst::composition::CompositionAbstract::getNumberFraction </td>
<td>(</td>
<td class="paramtype">const std::string &amp;</td> <td class="paramname"><span class="paramname"><em>symbol</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 class="mlabel pure-virtual">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the number fraction for a given symbol. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">symbol</td><td>The chemical symbol. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The number fraction for the symbol. </dd></dl>
<p>Implemented in <a class="el" href="classfourdst_1_1composition_1_1_composition.html#a34f71d4d8f0297c576fd62fabd490305">fourdst::composition::Composition</a>, <a class="el" href="classfourdst_1_1composition_1_1_composition_decorator.html#a0ff3454e625043c76131a1206d9293c6">fourdst::composition::CompositionDecorator</a>, and <a class="el" href="classfourdst_1_1composition_1_1_masked_composition.html#af4f65f7cad735494aa5010cf0832f23b">fourdst::composition::MaskedComposition</a>.</p>
</div>
</div>
<a id="a83343286d738d101635b2a7f5b7d96ef" name="a83343286d738d101635b2a7f5b7d96ef"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a83343286d738d101635b2a7f5b7d96ef">&#9670;&#160;</a></span>getNumberFractionVector()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual std::vector&lt; double &gt; fourdst::composition::CompositionAbstract::getNumberFractionVector </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></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 class="mlabel pure-virtual">pure virtual</span><span class="mlabel noexcept">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the number fraction as a vector. </p>
<dl class="section return"><dt>Returns</dt><dd>A vector of number fractions for all species. </dd></dl>
<p>Implemented in <a class="el" href="classfourdst_1_1composition_1_1_composition.html#ae4f72972cf4d1ff422d0790080e11473">fourdst::composition::Composition</a>, <a class="el" href="classfourdst_1_1composition_1_1_composition_decorator.html#a72ffd49c3b3e7f3f22ed28ceb2169cb5">fourdst::composition::CompositionDecorator</a>, and <a class="el" href="classfourdst_1_1composition_1_1_masked_composition.html#ad28b1f5c98bd25378c24c732d74deab4">fourdst::composition::MaskedComposition</a>.</p>
</div>
</div>
<a id="ad17ae8649860ef4f7a949e7c9143c0ec" name="ad17ae8649860ef4f7a949e7c9143c0ec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad17ae8649860ef4f7a949e7c9143c0ec">&#9670;&#160;</a></span>getRegisteredSpecies()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual const std::vector&lt; <a class="el" href="structfourdst_1_1atomic_1_1_species.html">atomic::Species</a> &gt; &amp; fourdst::composition::CompositionAbstract::getRegisteredSpecies </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></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 class="mlabel pure-virtual">pure virtual</span><span class="mlabel noexcept">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get all registered atomic species in the composition. </p>
<dl class="section return"><dt>Returns</dt><dd>A set of registered atomic species. </dd></dl>
<p>Implemented in <a class="el" href="classfourdst_1_1composition_1_1_composition.html#af4b01ec4140e278d92c18f139f69ab1f">fourdst::composition::Composition</a>, <a class="el" href="classfourdst_1_1composition_1_1_composition_decorator.html#a0cdc50a57e09bf8461839d08eb4ae212">fourdst::composition::CompositionDecorator</a>, and <a class="el" href="classfourdst_1_1composition_1_1_masked_composition.html#a44fddc3b8d34b76114afafbdc9b0ec6d">fourdst::composition::MaskedComposition</a>.</p>
</div>
</div>
<a id="a94c2cadeae32ab19cee42fc1670c4c6c" name="a94c2cadeae32ab19cee42fc1670c4c6c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a94c2cadeae32ab19cee42fc1670c4c6c">&#9670;&#160;</a></span>getRegisteredSymbols()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual std::set&lt; std::string &gt; fourdst::composition::CompositionAbstract::getRegisteredSymbols </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></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 class="mlabel pure-virtual">pure virtual</span><span class="mlabel noexcept">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get all registered chemical symbols in the composition. </p>
<dl class="section return"><dt>Returns</dt><dd>A set of registered chemical symbols. </dd></dl>
<p>Implemented in <a class="el" href="classfourdst_1_1composition_1_1_composition.html#a3ae885c28580ae15be8c16614bef3b0e">fourdst::composition::Composition</a>, <a class="el" href="classfourdst_1_1composition_1_1_composition_decorator.html#a85acea9a107432dfefcbfffe4c3c7c62">fourdst::composition::CompositionDecorator</a>, and <a class="el" href="classfourdst_1_1composition_1_1_masked_composition.html#a9b33507e9820b7fd55209d3624388077">fourdst::composition::MaskedComposition</a>.</p>
</div>
</div>
<a id="a43138cbf3d399e8f278db742fe1b02a7" name="a43138cbf3d399e8f278db742fe1b02a7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a43138cbf3d399e8f278db742fe1b02a7">&#9670;&#160;</a></span>getSpeciesAtIndex()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="structfourdst_1_1atomic_1_1_species.html">atomic::Species</a> fourdst::composition::CompositionAbstract::getSpeciesAtIndex </td>
<td>(</td>
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>index</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 class="mlabel pure-virtual">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the species at a given index. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">index</td><td>The index of the species. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The atomic species at the specified index. </dd></dl>
<p>Implemented in <a class="el" href="classfourdst_1_1composition_1_1_composition.html#ae4f854ded38f5e6fcd157a74a57cbf0c">fourdst::composition::Composition</a>, <a class="el" href="classfourdst_1_1composition_1_1_composition_decorator.html#a996066b4bf67e415eb2dd3ea7aed68bd">fourdst::composition::CompositionDecorator</a>, and <a class="el" href="classfourdst_1_1composition_1_1_masked_composition.html#acc9d3af0aad6c6209c9aefd94f86996b">fourdst::composition::MaskedComposition</a>.</p>
</div>
</div>
<a id="a5d04b801f152f7955b392710275105bc" name="a5d04b801f152f7955b392710275105bc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5d04b801f152f7955b392710275105bc">&#9670;&#160;</a></span>getSpeciesIndex() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual size_t fourdst::composition::CompositionAbstract::getSpeciesIndex </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structfourdst_1_1atomic_1_1_species.html">fourdst::atomic::Species</a> &amp;</td> <td class="paramname"><span class="paramname"><em>species</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 class="mlabel pure-virtual">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the index of a species. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">species</td><td>The atomic species. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The index of the species. </dd></dl>
<p>Implemented in <a class="el" href="classfourdst_1_1composition_1_1_composition.html#a3d220b42fa06d7d3a43944ee2b8f6a5f">fourdst::composition::Composition</a>, <a class="el" href="classfourdst_1_1composition_1_1_composition_decorator.html#ab02b459d8ce7f36a0a1c6058c013a75c">fourdst::composition::CompositionDecorator</a>, and <a class="el" href="classfourdst_1_1composition_1_1_masked_composition.html#a395e5b14cd2a9f9d467fea25542f8ebd">fourdst::composition::MaskedComposition</a>.</p>
</div>
</div>
<a id="aebf28eab9c902a285589fe2ab7f3060f" name="aebf28eab9c902a285589fe2ab7f3060f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aebf28eab9c902a285589fe2ab7f3060f">&#9670;&#160;</a></span>getSpeciesIndex() <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">virtual size_t fourdst::composition::CompositionAbstract::getSpeciesIndex </td>
<td>(</td>
<td class="paramtype">const std::string &amp;</td> <td class="paramname"><span class="paramname"><em>symbol</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 class="mlabel pure-virtual">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the index of a species by symbol. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">symbol</td><td>The chemical symbol. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The index of the species. </dd></dl>
<p>Implemented in <a class="el" href="classfourdst_1_1composition_1_1_composition.html#a0d94f62402bb90b5d12679faeaa8c5d7">fourdst::composition::Composition</a>, <a class="el" href="classfourdst_1_1composition_1_1_composition_decorator.html#a9b7e6388d9a73c05ddd34660bde43867">fourdst::composition::CompositionDecorator</a>, and <a class="el" href="classfourdst_1_1composition_1_1_masked_composition.html#a7277650debc78e081963663557de73eb">fourdst::composition::MaskedComposition</a>.</p>
</div>
</div>
<a id="a2d5472a63e2dbfc94d7e4617b5660e23" name="a2d5472a63e2dbfc94d7e4617b5660e23"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2d5472a63e2dbfc94d7e4617b5660e23">&#9670;&#160;</a></span>hash()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual std::size_t fourdst::composition::CompositionAbstract::hash </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></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 class="mlabel pure-virtual">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="classfourdst_1_1composition_1_1_composition.html#a5b3631fa33b0c6809ad652b0e31663a1">fourdst::composition::Composition</a>, and <a class="el" href="classfourdst_1_1composition_1_1_masked_composition.html#a0cff238d7aec2db1f7c509d199b56afb">fourdst::composition::MaskedComposition</a>.</p>
</div>
</div>
<a id="af7ec2eaa16a0c78d19728e32469cec06" name="af7ec2eaa16a0c78d19728e32469cec06"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af7ec2eaa16a0c78d19728e32469cec06">&#9670;&#160;</a></span>size()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual size_t fourdst::composition::CompositionAbstract::size </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></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 class="mlabel pure-virtual">pure virtual</span><span class="mlabel noexcept">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="classfourdst_1_1composition_1_1_composition.html#a9d177d36b728442bcbd8cb66712c7c75">fourdst::composition::Composition</a>, <a class="el" href="classfourdst_1_1composition_1_1_composition_decorator.html#af70b703b6b946d959cdd5cd15e853a9d">fourdst::composition::CompositionDecorator</a>, and <a class="el" href="classfourdst_1_1composition_1_1_masked_composition.html#a6b6c7a9ad6293558ddc8834d22f4bc62">fourdst::composition::MaskedComposition</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/composition/include/fourdst/composition/<a class="el" href="composition__abstract_8h_source.html">composition_abstract.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespacefourdst.html">fourdst</a></li><li class="navelem"><a class="el" href="namespacefourdst_1_1composition.html">composition</a></li><li class="navelem"><a class="el" href="classfourdst_1_1composition_1_1_composition_abstract.html">CompositionAbstract</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.13.2 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue Copy Permalink