tboudreaux/libcomposition
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
7a303b8d3acee0dc2139f5c8ee0178742abb0ab4
libcomposition/docs/html/structfourdst_1_1atomic_1_1_species.html

1352 lines
78 KiB
HTML
Raw Normal View History

docs(docs): added robust docs
2025-07-24 09:35:52 -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::atomic::Species Struct 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
2025-10-12 10:22:43 -04:00
<div id="projectname">fourdst::libcomposition<span id="projectnumber">&#160;v1.9.0</span>
docs(docs): added robust docs
2025-07-24 09:35:52 -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('structfourdst_1_1atomic_1_1_species.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-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="structfourdst_1_1atomic_1_1_species-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">fourdst::atomic::Species Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Represents an atomic species (isotope) with its fundamental physical properties.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>&gt;</code></p>
<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:a3756508a18b57a60f68f1b0cf58d303c" id="r_a3756508a18b57a60f68f1b0cf58d303c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a3756508a18b57a60f68f1b0cf58d303c">Species</a> (const std::string_view <a class="el" href="#a1fcc01fc978b34ba2531117f10be6741">name</a>, const std::string_view <a class="el" href="#a326c260a1b53deafcd04c21b2787f6c4">el</a>, const int <a class="el" href="#aa5e452accca3a9b4937867044617a032">nz</a>, const int <a class="el" href="#a957734e413f07adf1d570885c480768d">n</a>, const int <a class="el" href="#a1d50917a60a1adb2c9912193f214fab0">z</a>, const int <a class="el" href="#adc960c98d6e6051940d0a5c0d9a1183d">a</a>, const double <a class="el" href="#abeef75170cabef39fdaa6362780ddfc8">bindingEnergy</a>, const std::string_view <a class="el" href="#a57391049d534ffd1a4b4d6ed63d65ffc">betaCode</a>, const double <a class="el" href="#a7d0e8a3b3d30fa56bdcc59577fa9ff73">betaDecayEnergy</a>, const double halfLife_s, const std::string_view <a class="el" href="#afcdd2f750d8cf206e3bcc507d57dabb1">spinParity</a>, const std::string_view <a class="el" href="#aad5094dfc8317db36468356bbc4a3e2f">decayModes</a>, const double atomicMass, const double atomicMassUnc)</td></tr>
<tr class="memdesc:a3756508a18b57a60f68f1b0cf58d303c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a <a class="el" href="structfourdst_1_1atomic_1_1_species.html" title="Represents an atomic species (isotope) with its fundamental physical properties.">Species</a> object with detailed properties. <br /></td></tr>
<tr class="separator:a3756508a18b57a60f68f1b0cf58d303c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a873551c1ffbdcd6867ab0d1ed34ead0b" id="r_a873551c1ffbdcd6867ab0d1ed34ead0b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a873551c1ffbdcd6867ab0d1ed34ead0b">Species</a> (const <a class="el" href="structfourdst_1_1atomic_1_1_species.html">Species</a> &amp;<a class="el" href="namespacefourdst_1_1atomic.html#a3f619cc8f8b2cd718a4082c6adb0de90">species</a>)</td></tr>
<tr class="memdesc:a873551c1ffbdcd6867ab0d1ed34ead0b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy constructor for <a class="el" href="structfourdst_1_1atomic_1_1_species.html" title="Represents an atomic species (isotope) with its fundamental physical properties.">Species</a>. <br /></td></tr>
<tr class="separator:a873551c1ffbdcd6867ab0d1ed34ead0b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af5bdcc90ddafddfc027f94a98972eca3" id="r_af5bdcc90ddafddfc027f94a98972eca3"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af5bdcc90ddafddfc027f94a98972eca3">mass</a> () const</td></tr>
<tr class="memdesc:af5bdcc90ddafddfc027f94a98972eca3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the atomic mass of the species. <br /></td></tr>
<tr class="separator:af5bdcc90ddafddfc027f94a98972eca3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac041c089469dc8d36548805c81492aca" id="r_ac041c089469dc8d36548805c81492aca"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac041c089469dc8d36548805c81492aca">massUnc</a> () const</td></tr>
<tr class="memdesc:ac041c089469dc8d36548805c81492aca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the uncertainty in the atomic mass. <br /></td></tr>
<tr class="separator:ac041c089469dc8d36548805c81492aca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a34c4bb95e3c3e29087bc242d83aeefa1" id="r_a34c4bb95e3c3e29087bc242d83aeefa1"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a34c4bb95e3c3e29087bc242d83aeefa1">halfLife</a> () const</td></tr>
<tr class="memdesc:a34c4bb95e3c3e29087bc242d83aeefa1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the half-life of the species. <br /></td></tr>
<tr class="separator:a34c4bb95e3c3e29087bc242d83aeefa1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afcdd2f750d8cf206e3bcc507d57dabb1" id="r_afcdd2f750d8cf206e3bcc507d57dabb1"><td class="memItemLeft" align="right" valign="top">std::string_view&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#afcdd2f750d8cf206e3bcc507d57dabb1">spinParity</a> () const</td></tr>
<tr class="memdesc:afcdd2f750d8cf206e3bcc507d57dabb1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the spin and parity as a string. <br /></td></tr>
<tr class="separator:afcdd2f750d8cf206e3bcc507d57dabb1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aad5094dfc8317db36468356bbc4a3e2f" id="r_aad5094dfc8317db36468356bbc4a3e2f"><td class="memItemLeft" align="right" valign="top">std::string_view&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aad5094dfc8317db36468356bbc4a3e2f">decayModes</a> () const</td></tr>
<tr class="memdesc:aad5094dfc8317db36468356bbc4a3e2f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the decay modes as a string. <br /></td></tr>
<tr class="separator:aad5094dfc8317db36468356bbc4a3e2f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abeef75170cabef39fdaa6362780ddfc8" id="r_abeef75170cabef39fdaa6362780ddfc8"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#abeef75170cabef39fdaa6362780ddfc8">bindingEnergy</a> () const</td></tr>
<tr class="memdesc:abeef75170cabef39fdaa6362780ddfc8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the binding energy of the species. <br /></td></tr>
<tr class="separator:abeef75170cabef39fdaa6362780ddfc8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7d0e8a3b3d30fa56bdcc59577fa9ff73" id="r_a7d0e8a3b3d30fa56bdcc59577fa9ff73"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a7d0e8a3b3d30fa56bdcc59577fa9ff73">betaDecayEnergy</a> () const</td></tr>
<tr class="memdesc:a7d0e8a3b3d30fa56bdcc59577fa9ff73"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the beta decay energy of the species. <br /></td></tr>
<tr class="separator:a7d0e8a3b3d30fa56bdcc59577fa9ff73"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a57391049d534ffd1a4b4d6ed63d65ffc" id="r_a57391049d534ffd1a4b4d6ed63d65ffc"><td class="memItemLeft" align="right" valign="top">std::string_view&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a57391049d534ffd1a4b4d6ed63d65ffc">betaCode</a> () const</td></tr>
<tr class="memdesc:a57391049d534ffd1a4b4d6ed63d65ffc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the beta decay code. <br /></td></tr>
<tr class="separator:a57391049d534ffd1a4b4d6ed63d65ffc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1fcc01fc978b34ba2531117f10be6741" id="r_a1fcc01fc978b34ba2531117f10be6741"><td class="memItemLeft" align="right" valign="top">std::string_view&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a1fcc01fc978b34ba2531117f10be6741">name</a> () const</td></tr>
<tr class="memdesc:a1fcc01fc978b34ba2531117f10be6741"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the name of the species. <br /></td></tr>
<tr class="separator:a1fcc01fc978b34ba2531117f10be6741"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a326c260a1b53deafcd04c21b2787f6c4" id="r_a326c260a1b53deafcd04c21b2787f6c4"><td class="memItemLeft" align="right" valign="top">std::string_view&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a326c260a1b53deafcd04c21b2787f6c4">el</a> () const</td></tr>
<tr class="memdesc:a326c260a1b53deafcd04c21b2787f6c4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the element symbol of the species. <br /></td></tr>
<tr class="separator:a326c260a1b53deafcd04c21b2787f6c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa5e452accca3a9b4937867044617a032" id="r_aa5e452accca3a9b4937867044617a032"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa5e452accca3a9b4937867044617a032">nz</a> () const</td></tr>
<tr class="memdesc:aa5e452accca3a9b4937867044617a032"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the NZ identifier of the species. <br /></td></tr>
<tr class="separator:aa5e452accca3a9b4937867044617a032"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a957734e413f07adf1d570885c480768d" id="r_a957734e413f07adf1d570885c480768d"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a957734e413f07adf1d570885c480768d">n</a> () const</td></tr>
<tr class="memdesc:a957734e413f07adf1d570885c480768d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the number of neutrons. <br /></td></tr>
<tr class="separator:a957734e413f07adf1d570885c480768d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1d50917a60a1adb2c9912193f214fab0" id="r_a1d50917a60a1adb2c9912193f214fab0"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a1d50917a60a1adb2c9912193f214fab0">z</a> () const</td></tr>
<tr class="memdesc:a1d50917a60a1adb2c9912193f214fab0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the atomic number (number of protons). <br /></td></tr>
<tr class="separator:a1d50917a60a1adb2c9912193f214fab0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adc960c98d6e6051940d0a5c0d9a1183d" id="r_adc960c98d6e6051940d0a5c0d9a1183d"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#adc960c98d6e6051940d0a5c0d9a1183d">a</a> () const</td></tr>
<tr class="memdesc:adc960c98d6e6051940d0a5c0d9a1183d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the mass number. <br /></td></tr>
<tr class="separator:adc960c98d6e6051940d0a5c0d9a1183d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0e5d73c7c629cb08f254f2bc41f6ac4b" id="r_a0e5d73c7c629cb08f254f2bc41f6ac4b"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0e5d73c7c629cb08f254f2bc41f6ac4b">spin</a> () const</td></tr>
<tr class="memdesc:a0e5d73c7c629cb08f254f2bc41f6ac4b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the nuclear spin as a numeric value. <br /></td></tr>
<tr class="separator:a0e5d73c7c629cb08f254f2bc41f6ac4b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a4f782752e18e8972c66ee7168a06279d" id="r_a4f782752e18e8972c66ee7168a06279d"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4f782752e18e8972c66ee7168a06279d">m_name</a></td></tr>
<tr class="memdesc:a4f782752e18e8972c66ee7168a06279d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Name of the species (e.g., "Fe56"). <br /></td></tr>
<tr class="separator:a4f782752e18e8972c66ee7168a06279d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a704e9d164033a89d610685c494fd53eb" id="r_a704e9d164033a89d610685c494fd53eb"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a704e9d164033a89d610685c494fd53eb">m_el</a></td></tr>
<tr class="memdesc:a704e9d164033a89d610685c494fd53eb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Element symbol (e.g., "Fe"). <br /></td></tr>
<tr class="separator:a704e9d164033a89d610685c494fd53eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a50d5e1c96be4884ccfebde1eec79b6e8" id="r_a50d5e1c96be4884ccfebde1eec79b6e8"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a50d5e1c96be4884ccfebde1eec79b6e8">m_nz</a></td></tr>
<tr class="memdesc:a50d5e1c96be4884ccfebde1eec79b6e8"><td class="mdescLeft">&#160;</td><td class="mdescRight">NZ identifier, typically 1000*Z + A. <br /></td></tr>
<tr class="separator:a50d5e1c96be4884ccfebde1eec79b6e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8f0a4eb006c924bc006bb9eb6d3907ac" id="r_a8f0a4eb006c924bc006bb9eb6d3907ac"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8f0a4eb006c924bc006bb9eb6d3907ac">m_n</a></td></tr>
<tr class="memdesc:a8f0a4eb006c924bc006bb9eb6d3907ac"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of neutrons. <br /></td></tr>
<tr class="separator:a8f0a4eb006c924bc006bb9eb6d3907ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aae24c637c169f9f5eca03b6dcf8329e0" id="r_aae24c637c169f9f5eca03b6dcf8329e0"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aae24c637c169f9f5eca03b6dcf8329e0">m_z</a></td></tr>
<tr class="memdesc:aae24c637c169f9f5eca03b6dcf8329e0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Atomic number (number of protons). <br /></td></tr>
<tr class="separator:aae24c637c169f9f5eca03b6dcf8329e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6e7c5ab92da7ab867018da87a14ef3ef" id="r_a6e7c5ab92da7ab867018da87a14ef3ef"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a6e7c5ab92da7ab867018da87a14ef3ef">m_a</a></td></tr>
<tr class="memdesc:a6e7c5ab92da7ab867018da87a14ef3ef"><td class="mdescLeft">&#160;</td><td class="mdescRight">Mass number (N + Z). <br /></td></tr>
<tr class="separator:a6e7c5ab92da7ab867018da87a14ef3ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acbb5b36d6892ee09e95d774eda235d3c" id="r_acbb5b36d6892ee09e95d774eda235d3c"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#acbb5b36d6892ee09e95d774eda235d3c">m_bindingEnergy</a></td></tr>
<tr class="memdesc:acbb5b36d6892ee09e95d774eda235d3c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Binding energy in keV. <br /></td></tr>
<tr class="separator:acbb5b36d6892ee09e95d774eda235d3c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abe9c5f69d657383e17dd49b41b7e4e15" id="r_abe9c5f69d657383e17dd49b41b7e4e15"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#abe9c5f69d657383e17dd49b41b7e4e15">m_betaCode</a></td></tr>
<tr class="memdesc:abe9c5f69d657383e17dd49b41b7e4e15"><td class="mdescLeft">&#160;</td><td class="mdescRight">Beta decay code. <br /></td></tr>
<tr class="separator:abe9c5f69d657383e17dd49b41b7e4e15"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0fc7e4b41662fe0a726dd962e9dbae9e" id="r_a0fc7e4b41662fe0a726dd962e9dbae9e"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0fc7e4b41662fe0a726dd962e9dbae9e">m_betaDecayEnergy</a></td></tr>
<tr class="memdesc:a0fc7e4b41662fe0a726dd962e9dbae9e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Beta decay energy in keV. <br /></td></tr>
<tr class="separator:a0fc7e4b41662fe0a726dd962e9dbae9e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af76d148ab7be629601a389f5758238ee" id="r_af76d148ab7be629601a389f5758238ee"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af76d148ab7be629601a389f5758238ee">m_halfLife_s</a></td></tr>
<tr class="memdesc:af76d148ab7be629601a389f5758238ee"><td class="mdescLeft">&#160;</td><td class="mdescRight">Half-life in seconds. A value of -1.0 typically indicates stability. <br /></td></tr>
<tr class="separator:af76d148ab7be629601a389f5758238ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a874bc48272e4f091817bc25a72eebc2d" id="r_a874bc48272e4f091817bc25a72eebc2d"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a874bc48272e4f091817bc25a72eebc2d">m_spinParity</a></td></tr>
<tr class="memdesc:a874bc48272e4f091817bc25a72eebc2d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Spin and parity as a string (e.g., "1/2-"). <br /></td></tr>
<tr class="separator:a874bc48272e4f091817bc25a72eebc2d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a545093f4fd3d9ad490a5bea84e950d35" id="r_a545093f4fd3d9ad490a5bea84e950d35"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a545093f4fd3d9ad490a5bea84e950d35">m_decayModes</a></td></tr>
<tr class="memdesc:a545093f4fd3d9ad490a5bea84e950d35"><td class="mdescLeft">&#160;</td><td class="mdescRight">Decay modes as a string. <br /></td></tr>
<tr class="separator:a545093f4fd3d9ad490a5bea84e950d35"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab3e057d426e0d8dbf0134f92fda1c322" id="r_ab3e057d426e0d8dbf0134f92fda1c322"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab3e057d426e0d8dbf0134f92fda1c322">m_atomicMass</a></td></tr>
<tr class="memdesc:ab3e057d426e0d8dbf0134f92fda1c322"><td class="mdescLeft">&#160;</td><td class="mdescRight">Atomic mass in atomic mass units (u). <br /></td></tr>
<tr class="separator:ab3e057d426e0d8dbf0134f92fda1c322"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4c6aa98435227f8257b93311a19c4adf" id="r_a4c6aa98435227f8257b93311a19c4adf"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4c6aa98435227f8257b93311a19c4adf">m_atomicMassUnc</a></td></tr>
<tr class="memdesc:a4c6aa98435227f8257b93311a19c4adf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Uncertainty in the atomic mass. <br /></td></tr>
<tr class="separator:a4c6aa98435227f8257b93311a19c4adf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af1d73b936b428aaa29b37c119e3426e7" id="r_af1d73b936b428aaa29b37c119e3426e7"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af1d73b936b428aaa29b37c119e3426e7">m_spin</a> = 0.0</td></tr>
<tr class="memdesc:af1d73b936b428aaa29b37c119e3426e7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Nuclear spin as a double, derived from m_spinParity. <br /></td></tr>
<tr class="separator:af1d73b936b428aaa29b37c119e3426e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="friends" name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:ad431f09aba3c2d8bafde06a459636965" id="r_ad431f09aba3c2d8bafde06a459636965"><td class="memItemLeft" align="right" valign="top">std::ostream &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad431f09aba3c2d8bafde06a459636965">operator&lt;&lt;</a> (std::ostream &amp;os, const <a class="el" href="structfourdst_1_1atomic_1_1_species.html">Species</a> &amp;<a class="el" href="namespacefourdst_1_1atomic.html#a3f619cc8f8b2cd718a4082c6adb0de90">species</a>)</td></tr>
<tr class="memdesc:ad431f09aba3c2d8bafde06a459636965"><td class="mdescLeft">&#160;</td><td class="mdescRight">Overloads the stream insertion operator for easy printing of a <a class="el" href="structfourdst_1_1atomic_1_1_species.html" title="Represents an atomic species (isotope) with its fundamental physical properties.">Species</a> object. <br /></td></tr>
<tr class="separator:ad431f09aba3c2d8bafde06a459636965"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7864aa6e0ab9a953d657faf56cc921a1" id="r_a7864aa6e0ab9a953d657faf56cc921a1"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a7864aa6e0ab9a953d657faf56cc921a1">operator==</a> (const <a class="el" href="structfourdst_1_1atomic_1_1_species.html">Species</a> &amp;lhs, const <a class="el" href="structfourdst_1_1atomic_1_1_species.html">Species</a> &amp;rhs)</td></tr>
<tr class="memdesc:a7864aa6e0ab9a953d657faf56cc921a1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Equality operator for <a class="el" href="structfourdst_1_1atomic_1_1_species.html" title="Represents an atomic species (isotope) with its fundamental physical properties.">Species</a>. Compares based on name. <br /></td></tr>
<tr class="separator:a7864aa6e0ab9a953d657faf56cc921a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae1cc99d92a460877ec5bc28f13424c04" id="r_ae1cc99d92a460877ec5bc28f13424c04"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae1cc99d92a460877ec5bc28f13424c04">operator!=</a> (const <a class="el" href="structfourdst_1_1atomic_1_1_species.html">Species</a> &amp;lhs, const <a class="el" href="structfourdst_1_1atomic_1_1_species.html">Species</a> &amp;rhs)</td></tr>
<tr class="memdesc:ae1cc99d92a460877ec5bc28f13424c04"><td class="mdescLeft">&#160;</td><td class="mdescRight">Inequality operator for <a class="el" href="structfourdst_1_1atomic_1_1_species.html" title="Represents an atomic species (isotope) with its fundamental physical properties.">Species</a>. Compares based on name. <br /></td></tr>
<tr class="separator:ae1cc99d92a460877ec5bc28f13424c04"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afc74eacd01f350dc20e2c7ec6a35c49b" id="r_afc74eacd01f350dc20e2c7ec6a35c49b"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#afc74eacd01f350dc20e2c7ec6a35c49b">operator&lt;</a> (const <a class="el" href="structfourdst_1_1atomic_1_1_species.html">Species</a> &amp;lhs, const <a class="el" href="structfourdst_1_1atomic_1_1_species.html">Species</a> &amp;rhs)</td></tr>
<tr class="memdesc:afc74eacd01f350dc20e2c7ec6a35c49b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Less-than operator for <a class="el" href="structfourdst_1_1atomic_1_1_species.html" title="Represents an atomic species (isotope) with its fundamental physical properties.">Species</a>. Compares based on atomic mass. <br /></td></tr>
<tr class="separator:afc74eacd01f350dc20e2c7ec6a35c49b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab9503c9331c5746c283faa68a6ef3ef9" id="r_ab9503c9331c5746c283faa68a6ef3ef9"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab9503c9331c5746c283faa68a6ef3ef9">operator&gt;</a> (const <a class="el" href="structfourdst_1_1atomic_1_1_species.html">Species</a> &amp;lhs, const <a class="el" href="structfourdst_1_1atomic_1_1_species.html">Species</a> &amp;rhs)</td></tr>
<tr class="memdesc:ab9503c9331c5746c283faa68a6ef3ef9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Greater-than operator for <a class="el" href="structfourdst_1_1atomic_1_1_species.html" title="Represents an atomic species (isotope) with its fundamental physical properties.">Species</a>. Compares based on atomic mass. <br /></td></tr>
<tr class="separator:ab9503c9331c5746c283faa68a6ef3ef9"><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>Represents an atomic species (isotope) with its fundamental physical properties. </p>
<p>This struct holds data parsed from nuclear data libraries, such as atomic mass, half-life, and spin. It is a fundamental data structure for representing the components of a material composition.</p>
<dl class="section note"><dt>Note</dt><dd>This struct is designed to be lightweight and is primarily a data container.</dd></dl>
<dl class="section user"><dt>Usage Example</dt><dd><div class="fragment"><div class="line"><span class="preprocessor">#include &quot;<a class="code" href="atomic_species_8h.html">fourdst/composition/atomicSpecies.h</a>&quot;</span></div>
<div class="line"><span class="preprocessor">#include &lt;iostream&gt;</span></div>
<div class="line"> </div>
<div class="line"><span class="keywordtype">int</span> main() {</div>
<div class="line"> <span class="comment">// Create a species for Deuterium (H-2)</span></div>
<div class="line"> <a class="code hl_struct" href="structfourdst_1_1atomic_1_1_species.html">fourdst::atomic::Species</a> deuterium(</div>
<div class="line"> <span class="stringliteral">&quot;H2&quot;</span>, <span class="stringliteral">&quot;H&quot;</span>, 1002, 1, 1, 2, 2224.52, <span class="stringliteral">&quot;&quot;</span>, 0.0, -1.0, <span class="stringliteral">&quot;1+&quot;</span>, <span class="stringliteral">&quot;&quot;</span>, 2.0141017781, 4.0e-11</div>
<div class="line"> );</div>
<div class="line"> </div>
<div class="line"> std::cout &lt;&lt; <span class="stringliteral">&quot;Species: &quot;</span> &lt;&lt; deuterium.name() &lt;&lt; std::endl;</div>
<div class="line"> std::cout &lt;&lt; <span class="stringliteral">&quot;Atomic Mass: &quot;</span> &lt;&lt; deuterium.mass() &lt;&lt; <span class="stringliteral">&quot; u&quot;</span> &lt;&lt; std::endl;</div>
<div class="line"> std::cout &lt;&lt; <span class="stringliteral">&quot;Spin: &quot;</span> &lt;&lt; deuterium.spin() &lt;&lt; std::endl;</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">return</span> 0;</div>
<div class="line">}</div>
<div class="ttc" id="aatomic_species_8h_html"><div class="ttname"><a href="atomic_species_8h.html">atomicSpecies.h</a></div></div>
docs(docs): rebuilt docs for version 1.7.0
2025-09-16 11:24:28 -04:00
<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>
docs(docs): added robust docs
2025-07-24 09:35:52 -04:00
</div><!-- fragment --> </dd></dl>
docs(docs): rebuilt docs for version 1.7.0
2025-09-16 11:24:28 -04:00
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00051">51</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
docs(docs): added robust docs
2025-07-24 09:35:52 -04:00
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a3756508a18b57a60f68f1b0cf58d303c" name="a3756508a18b57a60f68f1b0cf58d303c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3756508a18b57a60f68f1b0cf58d303c">&#9670;&#160;</a></span>Species() <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">fourdst::atomic::Species::Species </td>
<td>(</td>
<td class="paramtype">const std::string_view</td> <td class="paramname"><span class="paramname"><em>name</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string_view</td> <td class="paramname"><span class="paramname"><em>el</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const int</td> <td class="paramname"><span class="paramname"><em>nz</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const int</td> <td class="paramname"><span class="paramname"><em>n</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const int</td> <td class="paramname"><span class="paramname"><em>z</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const int</td> <td class="paramname"><span class="paramname"><em>a</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const double</td> <td class="paramname"><span class="paramname"><em>bindingEnergy</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string_view</td> <td class="paramname"><span class="paramname"><em>betaCode</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const double</td> <td class="paramname"><span class="paramname"><em>betaDecayEnergy</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const double</td> <td class="paramname"><span class="paramname"><em>halfLife_s</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string_view</td> <td class="paramname"><span class="paramname"><em>spinParity</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string_view</td> <td class="paramname"><span class="paramname"><em>decayModes</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const double</td> <td class="paramname"><span class="paramname"><em>atomicMass</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const double</td> <td class="paramname"><span class="paramname"><em>atomicMassUnc</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructs a <a class="el" href="structfourdst_1_1atomic_1_1_species.html" title="Represents an atomic species (isotope) with its fundamental physical properties.">Species</a> object with detailed properties. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>Name of the species. </td></tr>
<tr><td class="paramname">el</td><td>Element symbol. </td></tr>
<tr><td class="paramname">nz</td><td>NZ identifier. </td></tr>
<tr><td class="paramname">n</td><td>Number of neutrons. </td></tr>
<tr><td class="paramname">z</td><td>Atomic number. </td></tr>
<tr><td class="paramname">a</td><td>Mass number. </td></tr>
<tr><td class="paramname">bindingEnergy</td><td>Binding energy. </td></tr>
<tr><td class="paramname">betaCode</td><td>Beta decay code. </td></tr>
<tr><td class="paramname">betaDecayEnergy</td><td>Beta decay energy. </td></tr>
<tr><td class="paramname">halfLife_s</td><td>Half-life in seconds. </td></tr>
<tr><td class="paramname">spinParity</td><td>Spin and parity string. </td></tr>
<tr><td class="paramname">decayModes</td><td>Decay modes string. </td></tr>
<tr><td class="paramname">atomicMass</td><td>Atomic mass. </td></tr>
<tr><td class="paramname">atomicMassUnc</td><td>Atomic mass uncertainty.</td></tr>
</table>
</dd>
</dl>
<dl class="section post"><dt>Postcondition</dt><dd>The <code>m_spin</code> member is initialized by parsing <code>m_spinParity</code> using <code>convert_jpi_to_double</code>. </dd></dl>
docs(docs): rebuilt docs for version 1.7.0
2025-09-16 11:24:28 -04:00
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00088">88</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
docs(docs): added robust docs
2025-07-24 09:35:52 -04:00
</div>
</div>
<a id="a873551c1ffbdcd6867ab0d1ed34ead0b" name="a873551c1ffbdcd6867ab0d1ed34ead0b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a873551c1ffbdcd6867ab0d1ed34ead0b">&#9670;&#160;</a></span>Species() <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">fourdst::atomic::Species::Species </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structfourdst_1_1atomic_1_1_species.html">Species</a> &amp;</td> <td class="paramname"><span class="paramname"><em>species</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Copy constructor for <a class="el" href="structfourdst_1_1atomic_1_1_species.html" title="Represents an atomic species (isotope) with its fundamental physical properties.">Species</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">species</td><td>The <a class="el" href="structfourdst_1_1atomic_1_1_species.html" title="Represents an atomic species (isotope) with its fundamental physical properties.">Species</a> object to copy. </td></tr>
</table>
</dd>
</dl>
<dl class="section post"><dt>Postcondition</dt><dd>A new <a class="el" href="structfourdst_1_1atomic_1_1_species.html" title="Represents an atomic species (isotope) with its fundamental physical properties.">Species</a> object is created as a deep copy of <code>species</code>. The <code>m_spin</code> member is re-calculated. </dd></dl>
docs(docs): rebuilt docs for version 1.7.0
2025-09-16 11:24:28 -04:00
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00126">126</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
docs(docs): added robust docs
2025-07-24 09:35:52 -04:00
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="adc960c98d6e6051940d0a5c0d9a1183d" name="adc960c98d6e6051940d0a5c0d9a1183d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adc960c98d6e6051940d0a5c0d9a1183d">&#9670;&#160;</a></span>a()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int fourdst::atomic::Species::a </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 inline">inline</span><span class="mlabel nodiscard">nodiscard</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the mass number. </p>
<dl class="section return"><dt>Returns</dt><dd>The mass number (A = N + Z). </dd></dl>
docs(docs): rebuilt docs for version 1.7.0
2025-09-16 11:24:28 -04:00
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00253">253</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
docs(docs): added robust docs
2025-07-24 09:35:52 -04:00
</div>
</div>
<a id="a57391049d534ffd1a4b4d6ed63d65ffc" name="a57391049d534ffd1a4b4d6ed63d65ffc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a57391049d534ffd1a4b4d6ed63d65ffc">&#9670;&#160;</a></span>betaCode()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string_view fourdst::atomic::Species::betaCode </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 inline">inline</span><span class="mlabel nodiscard">nodiscard</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the beta decay code. </p>
<dl class="section return"><dt>Returns</dt><dd>A string_view of the beta decay code. </dd></dl>
docs(docs): rebuilt docs for version 1.7.0
2025-09-16 11:24:28 -04:00
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00205">205</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
docs(docs): added robust docs
2025-07-24 09:35:52 -04:00
</div>
</div>
<a id="a7d0e8a3b3d30fa56bdcc59577fa9ff73" name="a7d0e8a3b3d30fa56bdcc59577fa9ff73"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7d0e8a3b3d30fa56bdcc59577fa9ff73">&#9670;&#160;</a></span>betaDecayEnergy()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">double fourdst::atomic::Species::betaDecayEnergy </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 inline">inline</span><span class="mlabel nodiscard">nodiscard</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the beta decay energy of the species. </p>
<dl class="section return"><dt>Returns</dt><dd>The beta decay energy in keV. </dd></dl>
docs(docs): rebuilt docs for version 1.7.0
2025-09-16 11:24:28 -04:00
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00197">197</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
docs(docs): added robust docs
2025-07-24 09:35:52 -04:00
</div>
</div>
<a id="abeef75170cabef39fdaa6362780ddfc8" name="abeef75170cabef39fdaa6362780ddfc8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abeef75170cabef39fdaa6362780ddfc8">&#9670;&#160;</a></span>bindingEnergy()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">double fourdst::atomic::Species::bindingEnergy </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 inline">inline</span><span class="mlabel nodiscard">nodiscard</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the binding energy of the species. </p>
<dl class="section return"><dt>Returns</dt><dd>The binding energy in keV. </dd></dl>
docs(docs): rebuilt docs for version 1.7.0
2025-09-16 11:24:28 -04:00
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00189">189</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
docs(docs): added robust docs
2025-07-24 09:35:52 -04:00
</div>
</div>
<a id="aad5094dfc8317db36468356bbc4a3e2f" name="aad5094dfc8317db36468356bbc4a3e2f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aad5094dfc8317db36468356bbc4a3e2f">&#9670;&#160;</a></span>decayModes()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string_view fourdst::atomic::Species::decayModes </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 inline">inline</span><span class="mlabel nodiscard">nodiscard</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the decay modes as a string. </p>
<dl class="section return"><dt>Returns</dt><dd>A string_view of the decay modes. </dd></dl>
docs(docs): rebuilt docs for version 1.7.0
2025-09-16 11:24:28 -04:00
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00181">181</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
docs(docs): added robust docs
2025-07-24 09:35:52 -04:00
</div>
</div>
<a id="a326c260a1b53deafcd04c21b2787f6c4" name="a326c260a1b53deafcd04c21b2787f6c4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a326c260a1b53deafcd04c21b2787f6c4">&#9670;&#160;</a></span>el()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string_view fourdst::atomic::Species::el </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 inline">inline</span><span class="mlabel nodiscard">nodiscard</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the element symbol of the species. </p>
<dl class="section return"><dt>Returns</dt><dd>A string_view of the element symbol (e.g., "Fe"). </dd></dl>
docs(docs): rebuilt docs for version 1.7.0
2025-09-16 11:24:28 -04:00
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00221">221</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
docs(docs): added robust docs
2025-07-24 09:35:52 -04:00
</div>
</div>
<a id="a34c4bb95e3c3e29087bc242d83aeefa1" name="a34c4bb95e3c3e29087bc242d83aeefa1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a34c4bb95e3c3e29087bc242d83aeefa1">&#9670;&#160;</a></span>halfLife()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">double fourdst::atomic::Species::halfLife </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 inline">inline</span><span class="mlabel nodiscard">nodiscard</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the half-life of the species. </p>
<dl class="section return"><dt>Returns</dt><dd>The half-life in seconds. </dd></dl>
docs(docs): rebuilt docs for version 1.7.0
2025-09-16 11:24:28 -04:00
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00165">165</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
docs(docs): added robust docs
2025-07-24 09:35:52 -04:00
</div>
</div>
<a id="af5bdcc90ddafddfc027f94a98972eca3" name="af5bdcc90ddafddfc027f94a98972eca3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af5bdcc90ddafddfc027f94a98972eca3">&#9670;&#160;</a></span>mass()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">double fourdst::atomic::Species::mass </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 inline">inline</span><span class="mlabel nodiscard">nodiscard</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the atomic mass of the species. </p>
<dl class="section return"><dt>Returns</dt><dd>The atomic mass in atomic mass units (u). </dd></dl>
docs(docs): rebuilt docs for version 1.7.0
2025-09-16 11:24:28 -04:00
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00149">149</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
docs(docs): added robust docs
2025-07-24 09:35:52 -04:00
</div>
</div>
<a id="ac041c089469dc8d36548805c81492aca" name="ac041c089469dc8d36548805c81492aca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac041c089469dc8d36548805c81492aca">&#9670;&#160;</a></span>massUnc()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">double fourdst::atomic::Species::massUnc </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 inline">inline</span><span class="mlabel nodiscard">nodiscard</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the uncertainty in the atomic mass. </p>
<dl class="section return"><dt>Returns</dt><dd>The atomic mass uncertainty. </dd></dl>
docs(docs): rebuilt docs for version 1.7.0
2025-09-16 11:24:28 -04:00
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00157">157</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
docs(docs): added robust docs
2025-07-24 09:35:52 -04:00
</div>
</div>
<a id="a957734e413f07adf1d570885c480768d" name="a957734e413f07adf1d570885c480768d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a957734e413f07adf1d570885c480768d">&#9670;&#160;</a></span>n()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int fourdst::atomic::Species::n </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 inline">inline</span><span class="mlabel nodiscard">nodiscard</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the number of neutrons. </p>
<dl class="section return"><dt>Returns</dt><dd>The number of neutrons (N). </dd></dl>
docs(docs): rebuilt docs for version 1.7.0
2025-09-16 11:24:28 -04:00
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00237">237</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
docs(docs): added robust docs
2025-07-24 09:35:52 -04:00
</div>
</div>
<a id="a1fcc01fc978b34ba2531117f10be6741" name="a1fcc01fc978b34ba2531117f10be6741"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1fcc01fc978b34ba2531117f10be6741">&#9670;&#160;</a></span>name()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string_view fourdst::atomic::Species::name </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 inline">inline</span><span class="mlabel nodiscard">nodiscard</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the name of the species. </p>
<dl class="section return"><dt>Returns</dt><dd>A string_view of the species name (e.g., "Fe56"). </dd></dl>
docs(docs): rebuilt docs for version 1.7.0
2025-09-16 11:24:28 -04:00
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00213">213</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
docs(docs): added robust docs
2025-07-24 09:35:52 -04:00
</div>
</div>
<a id="aa5e452accca3a9b4937867044617a032" name="aa5e452accca3a9b4937867044617a032"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa5e452accca3a9b4937867044617a032">&#9670;&#160;</a></span>nz()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int fourdst::atomic::Species::nz </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 inline">inline</span><span class="mlabel nodiscard">nodiscard</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the NZ identifier of the species. </p>
<dl class="section return"><dt>Returns</dt><dd>The NZ identifier (1000*Z + A). </dd></dl>
docs(docs): rebuilt docs for version 1.7.0
2025-09-16 11:24:28 -04:00
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00229">229</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
docs(docs): added robust docs
2025-07-24 09:35:52 -04:00
</div>
</div>
<a id="a0e5d73c7c629cb08f254f2bc41f6ac4b" name="a0e5d73c7c629cb08f254f2bc41f6ac4b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0e5d73c7c629cb08f254f2bc41f6ac4b">&#9670;&#160;</a></span>spin()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">double fourdst::atomic::Species::spin </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 inline">inline</span><span class="mlabel nodiscard">nodiscard</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the nuclear spin as a numeric value. </p>
<dl class="section return"><dt>Returns</dt><dd>The spin as a double. </dd></dl>
docs(docs): rebuilt docs for version 1.7.0
2025-09-16 11:24:28 -04:00
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00261">261</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
docs(docs): added robust docs
2025-07-24 09:35:52 -04:00
</div>
</div>
<a id="afcdd2f750d8cf206e3bcc507d57dabb1" name="afcdd2f750d8cf206e3bcc507d57dabb1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afcdd2f750d8cf206e3bcc507d57dabb1">&#9670;&#160;</a></span>spinParity()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string_view fourdst::atomic::Species::spinParity </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 inline">inline</span><span class="mlabel nodiscard">nodiscard</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the spin and parity as a string. </p>
<dl class="section return"><dt>Returns</dt><dd>A string_view of the spin and parity (e.g., "1/2+"). </dd></dl>
docs(docs): rebuilt docs for version 1.7.0
2025-09-16 11:24:28 -04:00
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00173">173</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
docs(docs): added robust docs
2025-07-24 09:35:52 -04:00
</div>
</div>
<a id="a1d50917a60a1adb2c9912193f214fab0" name="a1d50917a60a1adb2c9912193f214fab0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1d50917a60a1adb2c9912193f214fab0">&#9670;&#160;</a></span>z()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int fourdst::atomic::Species::z </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 inline">inline</span><span class="mlabel nodiscard">nodiscard</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the atomic number (number of protons). </p>
<dl class="section return"><dt>Returns</dt><dd>The atomic number (Z). </dd></dl>
docs(docs): rebuilt docs for version 1.7.0
2025-09-16 11:24:28 -04:00
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00245">245</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
docs(docs): added robust docs
2025-07-24 09:35:52 -04:00
</div>
</div>
<h2 class="groupheader">Friends And Related Symbol Documentation</h2>
<a id="ae1cc99d92a460877ec5bc28f13424c04" name="ae1cc99d92a460877ec5bc28f13424c04"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae1cc99d92a460877ec5bc28f13424c04">&#9670;&#160;</a></span>operator!=</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool operator!= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structfourdst_1_1atomic_1_1_species.html">Species</a> &amp;</td> <td class="paramname"><span class="paramname"><em>lhs</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structfourdst_1_1atomic_1_1_species.html">Species</a> &amp;</td> <td class="paramname"><span class="paramname"><em>rhs</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel friend">friend</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Inequality operator for <a class="el" href="structfourdst_1_1atomic_1_1_species.html" title="Represents an atomic species (isotope) with its fundamental physical properties.">Species</a>. Compares based on name. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">lhs</td><td>The left-hand side <a class="el" href="structfourdst_1_1atomic_1_1_species.html" title="Represents an atomic species (isotope) with its fundamental physical properties.">Species</a>. </td></tr>
<tr><td class="paramname">rhs</td><td>The right-hand side <a class="el" href="structfourdst_1_1atomic_1_1_species.html" title="Represents an atomic species (isotope) with its fundamental physical properties.">Species</a>. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if the names are different, <code>false</code> otherwise. </dd></dl>
docs(docs): rebuilt docs for version 1.7.0
2025-09-16 11:24:28 -04:00
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00296">296</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
docs(docs): added robust docs
2025-07-24 09:35:52 -04:00
</div>
</div>
<a id="afc74eacd01f350dc20e2c7ec6a35c49b" name="afc74eacd01f350dc20e2c7ec6a35c49b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afc74eacd01f350dc20e2c7ec6a35c49b">&#9670;&#160;</a></span>operator&lt;</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool operator&lt; </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structfourdst_1_1atomic_1_1_species.html">Species</a> &amp;</td> <td class="paramname"><span class="paramname"><em>lhs</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structfourdst_1_1atomic_1_1_species.html">Species</a> &amp;</td> <td class="paramname"><span class="paramname"><em>rhs</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel friend">friend</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Less-than operator for <a class="el" href="structfourdst_1_1atomic_1_1_species.html" title="Represents an atomic species (isotope) with its fundamental physical properties.">Species</a>. Compares based on atomic mass. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">lhs</td><td>The left-hand side <a class="el" href="structfourdst_1_1atomic_1_1_species.html" title="Represents an atomic species (isotope) with its fundamental physical properties.">Species</a>. </td></tr>
<tr><td class="paramname">rhs</td><td>The right-hand side <a class="el" href="structfourdst_1_1atomic_1_1_species.html" title="Represents an atomic species (isotope) with its fundamental physical properties.">Species</a>. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if lhs atomic mass is less than rhs atomic mass, <code>false</code> otherwise. </dd></dl>
docs(docs): rebuilt docs for version 1.7.0
2025-09-16 11:24:28 -04:00
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00305">305</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
docs(docs): added robust docs
2025-07-24 09:35:52 -04:00
</div>
</div>
<a id="ad431f09aba3c2d8bafde06a459636965" name="ad431f09aba3c2d8bafde06a459636965"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad431f09aba3c2d8bafde06a459636965">&#9670;&#160;</a></span>operator&lt;&lt;</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::ostream &amp; operator&lt;&lt; </td>
<td>(</td>
<td class="paramtype">std::ostream &amp;</td> <td class="paramname"><span class="paramname"><em>os</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structfourdst_1_1atomic_1_1_species.html">Species</a> &amp;</td> <td class="paramname"><span class="paramname"><em>species</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel friend">friend</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Overloads the stream insertion operator for easy printing of a <a class="el" href="structfourdst_1_1atomic_1_1_species.html" title="Represents an atomic species (isotope) with its fundamental physical properties.">Species</a> object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">os</td><td>The output stream. </td></tr>
<tr><td class="paramname">species</td><td>The <a class="el" href="structfourdst_1_1atomic_1_1_species.html" title="Represents an atomic species (isotope) with its fundamental physical properties.">Species</a> object to print. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The output stream with the species name. </dd></dl>
docs(docs): rebuilt docs for version 1.7.0
2025-09-16 11:24:28 -04:00
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00271">271</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
docs(docs): added robust docs
2025-07-24 09:35:52 -04:00
</div>
</div>
<a id="a7864aa6e0ab9a953d657faf56cc921a1" name="a7864aa6e0ab9a953d657faf56cc921a1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7864aa6e0ab9a953d657faf56cc921a1">&#9670;&#160;</a></span>operator==</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool operator== </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structfourdst_1_1atomic_1_1_species.html">Species</a> &amp;</td> <td class="paramname"><span class="paramname"><em>lhs</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structfourdst_1_1atomic_1_1_species.html">Species</a> &amp;</td> <td class="paramname"><span class="paramname"><em>rhs</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel friend">friend</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Equality operator for <a class="el" href="structfourdst_1_1atomic_1_1_species.html" title="Represents an atomic species (isotope) with its fundamental physical properties.">Species</a>. Compares based on name. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">lhs</td><td>The left-hand side <a class="el" href="structfourdst_1_1atomic_1_1_species.html" title="Represents an atomic species (isotope) with its fundamental physical properties.">Species</a>. </td></tr>
<tr><td class="paramname">rhs</td><td>The right-hand side <a class="el" href="structfourdst_1_1atomic_1_1_species.html" title="Represents an atomic species (isotope) with its fundamental physical properties.">Species</a>. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if the names are identical, <code>false</code> otherwise. </dd></dl>
docs(docs): rebuilt docs for version 1.7.0
2025-09-16 11:24:28 -04:00
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00287">287</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
docs(docs): added robust docs
2025-07-24 09:35:52 -04:00
</div>
</div>
<a id="ab9503c9331c5746c283faa68a6ef3ef9" name="ab9503c9331c5746c283faa68a6ef3ef9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab9503c9331c5746c283faa68a6ef3ef9">&#9670;&#160;</a></span>operator&gt;</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool operator&gt; </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structfourdst_1_1atomic_1_1_species.html">Species</a> &amp;</td> <td class="paramname"><span class="paramname"><em>lhs</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structfourdst_1_1atomic_1_1_species.html">Species</a> &amp;</td> <td class="paramname"><span class="paramname"><em>rhs</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel friend">friend</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Greater-than operator for <a class="el" href="structfourdst_1_1atomic_1_1_species.html" title="Represents an atomic species (isotope) with its fundamental physical properties.">Species</a>. Compares based on atomic mass. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">lhs</td><td>The left-hand side <a class="el" href="structfourdst_1_1atomic_1_1_species.html" title="Represents an atomic species (isotope) with its fundamental physical properties.">Species</a>. </td></tr>
<tr><td class="paramname">rhs</td><td>The right-hand side <a class="el" href="structfourdst_1_1atomic_1_1_species.html" title="Represents an atomic species (isotope) with its fundamental physical properties.">Species</a>. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if lhs atomic mass is greater than rhs atomic mass, <code>false</code> otherwise. </dd></dl>
docs(docs): rebuilt docs for version 1.7.0
2025-09-16 11:24:28 -04:00
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00314">314</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
docs(docs): added robust docs
2025-07-24 09:35:52 -04:00
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a6e7c5ab92da7ab867018da87a14ef3ef" name="a6e7c5ab92da7ab867018da87a14ef3ef"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6e7c5ab92da7ab867018da87a14ef3ef">&#9670;&#160;</a></span>m_a</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int fourdst::atomic::Species::m_a</td>
</tr>
</table>
</div><div class="memdoc">
<p>Mass number (N + Z). </p>
docs(docs): rebuilt docs for version 1.7.0
2025-09-16 11:24:28 -04:00
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00057">57</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
docs(docs): added robust docs
2025-07-24 09:35:52 -04:00
</div>
</div>
<a id="ab3e057d426e0d8dbf0134f92fda1c322" name="ab3e057d426e0d8dbf0134f92fda1c322"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab3e057d426e0d8dbf0134f92fda1c322">&#9670;&#160;</a></span>m_atomicMass</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double fourdst::atomic::Species::m_atomicMass</td>
</tr>
</table>
</div><div class="memdoc">
<p>Atomic mass in atomic mass units (u). </p>
docs(docs): rebuilt docs for version 1.7.0
2025-09-16 11:24:28 -04:00
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00064">64</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
docs(docs): added robust docs
2025-07-24 09:35:52 -04:00
</div>
</div>
<a id="a4c6aa98435227f8257b93311a19c4adf" name="a4c6aa98435227f8257b93311a19c4adf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4c6aa98435227f8257b93311a19c4adf">&#9670;&#160;</a></span>m_atomicMassUnc</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double fourdst::atomic::Species::m_atomicMassUnc</td>
</tr>
</table>
</div><div class="memdoc">
<p>Uncertainty in the atomic mass. </p>
docs(docs): rebuilt docs for version 1.7.0
2025-09-16 11:24:28 -04:00
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00065">65</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
docs(docs): added robust docs
2025-07-24 09:35:52 -04:00
</div>
</div>
<a id="abe9c5f69d657383e17dd49b41b7e4e15" name="abe9c5f69d657383e17dd49b41b7e4e15"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abe9c5f69d657383e17dd49b41b7e4e15">&#9670;&#160;</a></span>m_betaCode</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string fourdst::atomic::Species::m_betaCode</td>
</tr>
</table>
</div><div class="memdoc">
<p>Beta decay code. </p>
docs(docs): rebuilt docs for version 1.7.0
2025-09-16 11:24:28 -04:00
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00059">59</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
docs(docs): added robust docs
2025-07-24 09:35:52 -04:00
</div>
</div>
<a id="a0fc7e4b41662fe0a726dd962e9dbae9e" name="a0fc7e4b41662fe0a726dd962e9dbae9e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0fc7e4b41662fe0a726dd962e9dbae9e">&#9670;&#160;</a></span>m_betaDecayEnergy</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double fourdst::atomic::Species::m_betaDecayEnergy</td>
</tr>
</table>
</div><div class="memdoc">
<p>Beta decay energy in keV. </p>
docs(docs): rebuilt docs for version 1.7.0
2025-09-16 11:24:28 -04:00
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00060">60</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
docs(docs): added robust docs
2025-07-24 09:35:52 -04:00
</div>
</div>
<a id="acbb5b36d6892ee09e95d774eda235d3c" name="acbb5b36d6892ee09e95d774eda235d3c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acbb5b36d6892ee09e95d774eda235d3c">&#9670;&#160;</a></span>m_bindingEnergy</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double fourdst::atomic::Species::m_bindingEnergy</td>
</tr>
</table>
</div><div class="memdoc">
<p>Binding energy in keV. </p>
docs(docs): rebuilt docs for version 1.7.0
2025-09-16 11:24:28 -04:00
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00058">58</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
docs(docs): added robust docs
2025-07-24 09:35:52 -04:00
</div>
</div>
<a id="a545093f4fd3d9ad490a5bea84e950d35" name="a545093f4fd3d9ad490a5bea84e950d35"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a545093f4fd3d9ad490a5bea84e950d35">&#9670;&#160;</a></span>m_decayModes</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string fourdst::atomic::Species::m_decayModes</td>
</tr>
</table>
</div><div class="memdoc">
<p>Decay modes as a string. </p>
docs(docs): rebuilt docs for version 1.7.0
2025-09-16 11:24:28 -04:00
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00063">63</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
docs(docs): added robust docs
2025-07-24 09:35:52 -04:00
</div>
</div>
<a id="a704e9d164033a89d610685c494fd53eb" name="a704e9d164033a89d610685c494fd53eb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a704e9d164033a89d610685c494fd53eb">&#9670;&#160;</a></span>m_el</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string fourdst::atomic::Species::m_el</td>
</tr>
</table>
</div><div class="memdoc">
<p>Element symbol (e.g., "Fe"). </p>
docs(docs): rebuilt docs for version 1.7.0
2025-09-16 11:24:28 -04:00
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00053">53</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
docs(docs): added robust docs
2025-07-24 09:35:52 -04:00
</div>
</div>
<a id="af76d148ab7be629601a389f5758238ee" name="af76d148ab7be629601a389f5758238ee"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af76d148ab7be629601a389f5758238ee">&#9670;&#160;</a></span>m_halfLife_s</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double fourdst::atomic::Species::m_halfLife_s</td>
</tr>
</table>
</div><div class="memdoc">
<p>Half-life in seconds. A value of -1.0 typically indicates stability. </p>
docs(docs): rebuilt docs for version 1.7.0
2025-09-16 11:24:28 -04:00
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00061">61</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
docs(docs): added robust docs
2025-07-24 09:35:52 -04:00
</div>
</div>
<a id="a8f0a4eb006c924bc006bb9eb6d3907ac" name="a8f0a4eb006c924bc006bb9eb6d3907ac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8f0a4eb006c924bc006bb9eb6d3907ac">&#9670;&#160;</a></span>m_n</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int fourdst::atomic::Species::m_n</td>
</tr>
</table>
</div><div class="memdoc">
<p>Number of neutrons. </p>
docs(docs): rebuilt docs for version 1.7.0
2025-09-16 11:24:28 -04:00
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00055">55</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
docs(docs): added robust docs
2025-07-24 09:35:52 -04:00
</div>
</div>
<a id="a4f782752e18e8972c66ee7168a06279d" name="a4f782752e18e8972c66ee7168a06279d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4f782752e18e8972c66ee7168a06279d">&#9670;&#160;</a></span>m_name</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string fourdst::atomic::Species::m_name</td>
</tr>
</table>
</div><div class="memdoc">
<p>Name of the species (e.g., "Fe56"). </p>
docs(docs): rebuilt docs for version 1.7.0
2025-09-16 11:24:28 -04:00
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00052">52</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
docs(docs): added robust docs
2025-07-24 09:35:52 -04:00
</div>
</div>
<a id="a50d5e1c96be4884ccfebde1eec79b6e8" name="a50d5e1c96be4884ccfebde1eec79b6e8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a50d5e1c96be4884ccfebde1eec79b6e8">&#9670;&#160;</a></span>m_nz</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int fourdst::atomic::Species::m_nz</td>
</tr>
</table>
</div><div class="memdoc">
<p>NZ identifier, typically 1000*Z + A. </p>
docs(docs): rebuilt docs for version 1.7.0
2025-09-16 11:24:28 -04:00
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00054">54</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
docs(docs): added robust docs
2025-07-24 09:35:52 -04:00
</div>
</div>
<a id="af1d73b936b428aaa29b37c119e3426e7" name="af1d73b936b428aaa29b37c119e3426e7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af1d73b936b428aaa29b37c119e3426e7">&#9670;&#160;</a></span>m_spin</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double fourdst::atomic::Species::m_spin = 0.0</td>
</tr>
</table>
</div><div class="memdoc">
<p>Nuclear spin as a double, derived from m_spinParity. </p>
docs(docs): rebuilt docs for version 1.7.0
2025-09-16 11:24:28 -04:00
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00066">66</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
docs(docs): added robust docs
2025-07-24 09:35:52 -04:00
</div>
</div>
<a id="a874bc48272e4f091817bc25a72eebc2d" name="a874bc48272e4f091817bc25a72eebc2d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a874bc48272e4f091817bc25a72eebc2d">&#9670;&#160;</a></span>m_spinParity</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string fourdst::atomic::Species::m_spinParity</td>
</tr>
</table>
</div><div class="memdoc">
<p>Spin and parity as a string (e.g., "1/2-"). </p>
docs(docs): rebuilt docs for version 1.7.0
2025-09-16 11:24:28 -04:00
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00062">62</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
docs(docs): added robust docs
2025-07-24 09:35:52 -04:00
</div>
</div>
<a id="aae24c637c169f9f5eca03b6dcf8329e0" name="aae24c637c169f9f5eca03b6dcf8329e0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aae24c637c169f9f5eca03b6dcf8329e0">&#9670;&#160;</a></span>m_z</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int fourdst::atomic::Species::m_z</td>
</tr>
</table>
</div><div class="memdoc">
<p>Atomic number (number of protons). </p>
docs(docs): rebuilt docs for version 1.7.0
2025-09-16 11:24:28 -04:00
<p class="definition">Definition at line <a class="el" href="atomic_species_8h_source.html#l00056">56</a> of file <a class="el" href="atomic_species_8h_source.html">atomicSpecies.h</a>.</p>
docs(docs): added robust docs
2025-07-24 09:35:52 -04:00
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>src/composition/include/fourdst/composition/<a class="el" href="atomic_species_8h_source.html">atomicSpecies.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_1atomic.html">atomic</a></li><li class="navelem"><a class="el" href="structfourdst_1_1atomic_1_1_species.html">Species</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