Files
libcomposition/docs/html/functions_func.html

223 lines
16 KiB
HTML

<!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: Class Members - Functions</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">
<div id="projectname">fourdst::libcomposition<span id="projectnumber">&#160;v2.0.1</span>
</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('functions_func.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="contents">
<div class="textblock">Here is a list of all functions with links to the classes they belong to:</div>
<h3><a id="index_a" name="index_a"></a>- a -</h3><ul>
<li>a()&#160;:&#160;<a class="el" href="structfourdst_1_1atomic_1_1_species.html#adc960c98d6e6051940d0a5c0d9a1183d">fourdst::atomic::Species</a></li>
</ul>
<h3><a id="index_b" name="index_b"></a>- b -</h3><ul>
<li>begin()&#160;:&#160;<a class="el" href="classfourdst_1_1composition_1_1_composition.html#ab1701644ff1c83c220dc04eb58d1621b">fourdst::composition::Composition</a></li>
<li>betaCode()&#160;:&#160;<a class="el" href="structfourdst_1_1atomic_1_1_species.html#a57391049d534ffd1a4b4d6ed63d65ffc">fourdst::atomic::Species</a></li>
<li>betaDecayEnergy()&#160;:&#160;<a class="el" href="structfourdst_1_1atomic_1_1_species.html#a7d0e8a3b3d30fa56bdcc59577fa9ff73">fourdst::atomic::Species</a></li>
<li>bindingEnergy()&#160;:&#160;<a class="el" href="structfourdst_1_1atomic_1_1_species.html#abeef75170cabef39fdaa6362780ddfc8">fourdst::atomic::Species</a></li>
</ul>
<h3><a id="index_c" name="index_c"></a>- c -</h3><ul>
<li>clear()&#160;:&#160;<a class="el" href="structfourdst_1_1composition_1_1_composition_1_1_composition_cache.html#ac8b576c3b48c4cedda6e9e2790072b0d">fourdst::composition::Composition::CompositionCache</a></li>
<li>Composition()&#160;:&#160;<a class="el" href="classfourdst_1_1composition_1_1_composition.html#a23b83b76ee025f6fc009184ee19bba88">fourdst::composition::Composition</a></li>
<li>CompositionError()&#160;:&#160;<a class="el" href="classfourdst_1_1composition_1_1exceptions_1_1_composition_error.html#aef0cd13a4d1eb60b6d75ca5480e9146c">fourdst::composition::exceptions::CompositionError</a>, <a class="el" href="classfourdst_1_1composition_1_1exceptions_1_1_invalid_composition_error.html#aef0cd13a4d1eb60b6d75ca5480e9146c">fourdst::composition::exceptions::InvalidCompositionError</a>, <a class="el" href="classfourdst_1_1composition_1_1exceptions_1_1_unregistered_symbol_error.html#aef0cd13a4d1eb60b6d75ca5480e9146c">fourdst::composition::exceptions::UnregisteredSymbolError</a></li>
<li>contains()&#160;:&#160;<a class="el" href="class_composition_abstract.html#af42050fabc3c888d77f0fc98f08bc80a">CompositionAbstract</a>, <a class="el" href="classfourdst_1_1composition_1_1_composition.html#a194f715788e7921bd611579440de2ecd">fourdst::composition::Composition</a></li>
</ul>
<h3><a id="index_d" name="index_d"></a>- d -</h3><ul>
<li>decayModes()&#160;:&#160;<a class="el" href="structfourdst_1_1atomic_1_1_species.html#aad5094dfc8317db36468356bbc4a3e2f">fourdst::atomic::Species</a></li>
</ul>
<h3><a id="index_e" name="index_e"></a>- e -</h3><ul>
<li>el()&#160;:&#160;<a class="el" href="structfourdst_1_1atomic_1_1_species.html#a326c260a1b53deafcd04c21b2787f6c4">fourdst::atomic::Species</a></li>
<li>end()&#160;:&#160;<a class="el" href="classfourdst_1_1composition_1_1_composition.html#adeaf6f1213e78cb1fe8a8317f0a8adc2">fourdst::composition::Composition</a></li>
</ul>
<h3><a id="index_g" name="index_g"></a>- g -</h3><ul>
<li>getCanonicalComposition()&#160;:&#160;<a class="el" href="classfourdst_1_1composition_1_1_composition.html#aac5b214a3d1278e127422224cb9cee50">fourdst::composition::Composition</a></li>
<li>getElectronAbundance()&#160;:&#160;<a class="el" href="class_composition_abstract.html#a86b60205094ed72435ee84abf9498e21">CompositionAbstract</a>, <a class="el" href="classfourdst_1_1composition_1_1_composition.html#a90fc71d1fe03017ee4c7a1cac69d24fb">fourdst::composition::Composition</a></li>
<li>getLogger()&#160;:&#160;<a class="el" href="classfourdst_1_1composition_1_1_composition.html#a46a706f9e4c06a45b45ae3dffdde5e9e">fourdst::composition::Composition</a></li>
<li>getMassFraction()&#160;:&#160;<a class="el" href="class_composition_abstract.html#afb72c61da511b7963382804a0e87a54a">CompositionAbstract</a>, <a class="el" href="classfourdst_1_1composition_1_1_composition.html#a9ea2b673341fdc67afeb0f0517a54c8c">fourdst::composition::Composition</a></li>
<li>getMassFractionVector()&#160;:&#160;<a class="el" href="class_composition_abstract.html#a82583ffa3c08297cda6c3957a6a7dbc6">CompositionAbstract</a>, <a class="el" href="classfourdst_1_1composition_1_1_composition.html#af4f44aaf8b7e0d63872a70b5e2131369">fourdst::composition::Composition</a></li>
<li>getMeanParticleMass()&#160;:&#160;<a class="el" href="class_composition_abstract.html#a85bf97a30ecadd0750bece4442f4deff">CompositionAbstract</a>, <a class="el" href="classfourdst_1_1composition_1_1_composition.html#afbbb5e51ad5ae5c0fa6bc0094195aecd">fourdst::composition::Composition</a></li>
<li>getMolarAbundance()&#160;:&#160;<a class="el" href="class_composition_abstract.html#a71fb459bf4375af2fe33c8a7c0747ce0">CompositionAbstract</a>, <a class="el" href="classfourdst_1_1composition_1_1_composition.html#add67a92d73e3a57a2bbdb52bc9ca3bfe">fourdst::composition::Composition</a></li>
<li>getMolarAbundanceVector()&#160;:&#160;<a class="el" href="class_composition_abstract.html#a1ad7a33d17db32b2c9ce0a30cd6628f9">CompositionAbstract</a>, <a class="el" href="classfourdst_1_1composition_1_1_composition.html#abcb391f5fca2b636127e48e681e4c3ee">fourdst::composition::Composition</a></li>
<li>getNumberFraction()&#160;:&#160;<a class="el" href="class_composition_abstract.html#a506ef92e69f99ad02598c8d178df1c31">CompositionAbstract</a>, <a class="el" href="classfourdst_1_1composition_1_1_composition.html#a34f71d4d8f0297c576fd62fabd490305">fourdst::composition::Composition</a></li>
<li>getNumberFractionVector()&#160;:&#160;<a class="el" href="class_composition_abstract.html#a883ea47508557952b9f15432bf0be376">CompositionAbstract</a>, <a class="el" href="classfourdst_1_1composition_1_1_composition.html#ae4f72972cf4d1ff422d0790080e11473">fourdst::composition::Composition</a></li>
<li>getRegisteredSpecies()&#160;:&#160;<a class="el" href="class_composition_abstract.html#ae6e7152d69fc5f5a128f8cb2cfce1587">CompositionAbstract</a>, <a class="el" href="classfourdst_1_1composition_1_1_composition.html#a33db253ca50431b5166d43412ff18f71">fourdst::composition::Composition</a></li>
<li>getRegisteredSymbols()&#160;:&#160;<a class="el" href="class_composition_abstract.html#a5a4362dc0d77659b75d528a0e884ed7b">CompositionAbstract</a>, <a class="el" href="classfourdst_1_1composition_1_1_composition.html#a3ae885c28580ae15be8c16614bef3b0e">fourdst::composition::Composition</a></li>
<li>getSpeciesAtIndex()&#160;:&#160;<a class="el" href="class_composition_abstract.html#aaee3651c1672b2763181e966e4525ba6">CompositionAbstract</a>, <a class="el" href="classfourdst_1_1composition_1_1_composition.html#ae4f854ded38f5e6fcd157a74a57cbf0c">fourdst::composition::Composition</a></li>
<li>getSpeciesIndex()&#160;:&#160;<a class="el" href="class_composition_abstract.html#a1e5195debe590960aa064289733958ba">CompositionAbstract</a>, <a class="el" href="classfourdst_1_1composition_1_1_composition.html#a0d94f62402bb90b5d12679faeaa8c5d7">fourdst::composition::Composition</a></li>
</ul>
<h3><a id="index_h" name="index_h"></a>- h -</h3><ul>
<li>halfLife()&#160;:&#160;<a class="el" href="structfourdst_1_1atomic_1_1_species.html#a34c4bb95e3c3e29087bc242d83aeefa1">fourdst::atomic::Species</a></li>
</ul>
<h3><a id="index_i" name="index_i"></a>- i -</h3><ul>
<li>is_clear()&#160;:&#160;<a class="el" href="structfourdst_1_1composition_1_1_composition_1_1_composition_cache.html#af291583560120bb53c4546a598666477">fourdst::composition::Composition::CompositionCache</a></li>
</ul>
<h3><a id="index_m" name="index_m"></a>- m -</h3><ul>
<li>mass()&#160;:&#160;<a class="el" href="structfourdst_1_1atomic_1_1_species.html#af5bdcc90ddafddfc027f94a98972eca3">fourdst::atomic::Species</a></li>
<li>massUnc()&#160;:&#160;<a class="el" href="structfourdst_1_1atomic_1_1_species.html#ac041c089469dc8d36548805c81492aca">fourdst::atomic::Species</a></li>
</ul>
<h3><a id="index_n" name="index_n"></a>- n -</h3><ul>
<li>n()&#160;:&#160;<a class="el" href="structfourdst_1_1atomic_1_1_species.html#a957734e413f07adf1d570885c480768d">fourdst::atomic::Species</a></li>
<li>name()&#160;:&#160;<a class="el" href="structfourdst_1_1atomic_1_1_species.html#a1fcc01fc978b34ba2531117f10be6741">fourdst::atomic::Species</a></li>
<li>nz()&#160;:&#160;<a class="el" href="structfourdst_1_1atomic_1_1_species.html#aa5e452accca3a9b4937867044617a032">fourdst::atomic::Species</a></li>
</ul>
<h3><a id="index_o" name="index_o"></a>- o -</h3><ul>
<li>operator()()&#160;:&#160;<a class="el" href="structstd_1_1hash_3_01fourdst_1_1atomic_1_1_species_01_4.html#afa44fa4cf54e7f6283d6e2ce93c63b6a">std::hash&lt; fourdst::atomic::Species &gt;</a></li>
<li>operator=()&#160;:&#160;<a class="el" href="classfourdst_1_1composition_1_1_composition.html#a4ec1e23cfecef764cb831171fed62fc2">fourdst::composition::Composition</a></li>
</ul>
<h3><a id="index_r" name="index_r"></a>- r -</h3><ul>
<li>registerSpecies()&#160;:&#160;<a class="el" href="classfourdst_1_1composition_1_1_composition.html#a392a34c19f45d6c936cc7030e6cfaf3f">fourdst::composition::Composition</a></li>
<li>registerSymbol()&#160;:&#160;<a class="el" href="classfourdst_1_1composition_1_1_composition.html#a3ab4dcda0bfd1a35b169bcc57fe66725">fourdst::composition::Composition</a></li>
</ul>
<h3><a id="index_s" name="index_s"></a>- s -</h3><ul>
<li>setMolarAbundance()&#160;:&#160;<a class="el" href="classfourdst_1_1composition_1_1_composition.html#a262d7133035d4e6f45daa81827abf5e7">fourdst::composition::Composition</a></li>
<li>size()&#160;:&#160;<a class="el" href="class_composition_abstract.html#a230f58ef18a9816c1d13c287eaf3ba05">CompositionAbstract</a>, <a class="el" href="classfourdst_1_1composition_1_1_composition.html#a9d177d36b728442bcbd8cb66712c7c75">fourdst::composition::Composition</a></li>
<li>Species()&#160;:&#160;<a class="el" href="structfourdst_1_1atomic_1_1_species.html#a3756508a18b57a60f68f1b0cf58d303c">fourdst::atomic::Species</a></li>
<li>SpeciesError()&#160;:&#160;<a class="el" href="classfourdst_1_1composition_1_1exceptions_1_1_species_error.html#af67ed95557b2511ff5143c7064fc5813">fourdst::composition::exceptions::SpeciesError</a>, <a class="el" href="classfourdst_1_1composition_1_1exceptions_1_1_unknown_symbol_error.html#af67ed95557b2511ff5143c7064fc5813">fourdst::composition::exceptions::UnknownSymbolError</a></li>
<li>spin()&#160;:&#160;<a class="el" href="structfourdst_1_1atomic_1_1_species.html#a0e5d73c7c629cb08f254f2bc41f6ac4b">fourdst::atomic::Species</a></li>
<li>spinParity()&#160;:&#160;<a class="el" href="structfourdst_1_1atomic_1_1_species.html#afcdd2f750d8cf206e3bcc507d57dabb1">fourdst::atomic::Species</a></li>
</ul>
<h3><a id="index_w" name="index_w"></a>- w -</h3><ul>
<li>what()&#160;:&#160;<a class="el" href="classfourdst_1_1composition_1_1exceptions_1_1_composition_error.html#ae44ceddb19da8a8cda7ee150b6826d08">fourdst::composition::exceptions::CompositionError</a>, <a class="el" href="classfourdst_1_1composition_1_1exceptions_1_1_species_error.html#af0c63f7e05d0c65157b960c654d09b67">fourdst::composition::exceptions::SpeciesError</a></li>
</ul>
<h3><a id="index_z" name="index_z"></a>- z -</h3><ul>
<li>z()&#160;:&#160;<a class="el" href="structfourdst_1_1atomic_1_1_species.html#a1d50917a60a1adb2c9912193f214fab0">fourdst::atomic::Species</a></li>
</ul>
<h3><a id="index__7E" name="index__7E"></a>- ~ -</h3><ul>
<li>~Composition()&#160;:&#160;<a class="el" href="classfourdst_1_1composition_1_1_composition.html#a08c1d1fe9384c5255a6ba40e34b18315">fourdst::composition::Composition</a></li>
<li>~CompositionAbstract()&#160;:&#160;<a class="el" href="class_composition_abstract.html#aaae3d6215b7433cb9871664852a95d1b">CompositionAbstract</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="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>