754 lines
63 KiB
HTML
754 lines
63 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>GridFire: gridfire::reaction::LogicalReaction Class Reference</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<script type="text/javascript" src="clipboard.js"></script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="cookie.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
|
|
<link href="doxygen-awesome-sidebar-only.css" rel="stylesheet" type="text/css"/>
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr id="projectrow">
|
|
<td id="projectalign">
|
|
<div id="projectname">GridFire<span id="projectnumber"> 0.0.1a</span>
|
|
</div>
|
|
<div id="projectbrief">General Purpose Nuclear Network</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&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&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&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&dn=expat.txt MIT */
|
|
$(function(){initNavTree('classgridfire_1_1reaction_1_1_logical_reaction.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> |
|
|
<a href="#pri-methods">Private Member Functions</a> |
|
|
<a href="#pri-attribs">Private Attributes</a> |
|
|
<a href="#friends">Friends</a> |
|
|
<a href="classgridfire_1_1reaction_1_1_logical_reaction-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">gridfire::reaction::LogicalReaction Class Reference<span class="mlabels"><span class="mlabel final">final</span></span></div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Represents a "logical" reaction that aggregates rates from multiple sources.
|
|
<a href="#details">More...</a></p>
|
|
|
|
<p><code>#include <reaction.h></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for gridfire::reaction::LogicalReaction:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="classgridfire_1_1reaction_1_1_logical_reaction.png" usemap="#gridfire::reaction::LogicalReaction_map" alt=""/>
|
|
<map id="gridfire::reaction::LogicalReaction_map" name="gridfire::reaction::LogicalReaction_map">
|
|
<area href="classgridfire_1_1reaction_1_1_reaction.html" title="Represents a single nuclear reaction from a specific data source." alt="gridfire::reaction::Reaction" shape="rect" coords="0,0,201,24"/>
|
|
</map>
|
|
</div></div>
|
|
<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:a6965906ea33ebd0d615811219d9e9537" id="r_a6965906ea33ebd0d615811219d9e9537"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a6965906ea33ebd0d615811219d9e9537">LogicalReaction</a> (const std::vector< <a class="el" href="classgridfire_1_1reaction_1_1_reaction.html">Reaction</a> > &reactions)</td></tr>
|
|
<tr class="memdesc:a6965906ea33ebd0d615811219d9e9537"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a <a class="el" href="classgridfire_1_1reaction_1_1_logical_reaction.html" title="Represents a "logical" reaction that aggregates rates from multiple sources.">LogicalReaction</a> from a vector of <code><a class="el" href="classgridfire_1_1reaction_1_1_reaction.html" title="Represents a single nuclear reaction from a specific data source.">Reaction</a></code> objects. <br /></td></tr>
|
|
<tr class="separator:a6965906ea33ebd0d615811219d9e9537"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a14a24cb8ea25a1514134acc51197f1de" id="r_a14a24cb8ea25a1514134acc51197f1de"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a14a24cb8ea25a1514134acc51197f1de">add_reaction</a> (const <a class="el" href="classgridfire_1_1reaction_1_1_reaction.html">Reaction</a> &reaction)</td></tr>
|
|
<tr class="memdesc:a14a24cb8ea25a1514134acc51197f1de"><td class="mdescLeft"> </td><td class="mdescRight">Adds another <code><a class="el" href="classgridfire_1_1reaction_1_1_reaction.html" title="Represents a single nuclear reaction from a specific data source.">Reaction</a></code> source to this logical reaction. <br /></td></tr>
|
|
<tr class="separator:a14a24cb8ea25a1514134acc51197f1de"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afa41050855b842c63db16c94d2e9b897" id="r_afa41050855b842c63db16c94d2e9b897"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="#afa41050855b842c63db16c94d2e9b897">size</a> () const</td></tr>
|
|
<tr class="memdesc:afa41050855b842c63db16c94d2e9b897"><td class="mdescLeft"> </td><td class="mdescRight">Gets the number of source rates contributing to this logical reaction. <br /></td></tr>
|
|
<tr class="separator:afa41050855b842c63db16c94d2e9b897"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:add094eda0e71126f8443698d7f3317f4" id="r_add094eda0e71126f8443698d7f3317f4"><td class="memItemLeft" align="right" valign="top">std::vector< std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="#add094eda0e71126f8443698d7f3317f4">sources</a> () const</td></tr>
|
|
<tr class="memdesc:add094eda0e71126f8443698d7f3317f4"><td class="mdescLeft"> </td><td class="mdescRight">Gets the list of source labels for the aggregated rates. <br /></td></tr>
|
|
<tr class="separator:add094eda0e71126f8443698d7f3317f4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1d2fb3b6a6a1860ace98b32447d1dd1b" id="r_a1d2fb3b6a6a1860ace98b32447d1dd1b"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="#a1d2fb3b6a6a1860ace98b32447d1dd1b">calculate_rate</a> (const double T9) const override</td></tr>
|
|
<tr class="memdesc:a1d2fb3b6a6a1860ace98b32447d1dd1b"><td class="mdescLeft"> </td><td class="mdescRight">Calculates the total reaction rate by summing all source rates. <br /></td></tr>
|
|
<tr class="separator:a1d2fb3b6a6a1860ace98b32447d1dd1b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa4b8d0d30459f360ff6e29d848e943d5" id="r_aa4b8d0d30459f360ff6e29d848e943d5"><td class="memItemLeft" align="right" valign="top">virtual double </td><td class="memItemRight" valign="bottom"><a class="el" href="#aa4b8d0d30459f360ff6e29d848e943d5">calculate_forward_rate_log_derivative</a> (const double T9) const override</td></tr>
|
|
<tr class="separator:aa4b8d0d30459f360ff6e29d848e943d5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adad6f4297c1d8ce487eab092b73cdd32" id="r_adad6f4297c1d8ce487eab092b73cdd32"><td class="memItemLeft" align="right" valign="top">CppAD::AD< double > </td><td class="memItemRight" valign="bottom"><a class="el" href="#adad6f4297c1d8ce487eab092b73cdd32">calculate_rate</a> (const CppAD::AD< double > T9) const override</td></tr>
|
|
<tr class="memdesc:adad6f4297c1d8ce487eab092b73cdd32"><td class="mdescLeft"> </td><td class="mdescRight">Calculates the total reaction rate using CppAD types. <br /></td></tr>
|
|
<tr class="separator:adad6f4297c1d8ce487eab092b73cdd32"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Iterators</div></td></tr>
|
|
<tr><td colspan="2"><div class="groupText"><p>Provides iterators to loop over the rate coefficient sets. </p>
|
|
</div></td></tr>
|
|
<tr class="memitem:a4ae3806e5e1a802b86a6de292d043476" id="r_a4ae3806e5e1a802b86a6de292d043476"><td class="memItemLeft" align="right" valign="top">auto </td><td class="memItemRight" valign="bottom"><a class="el" href="#a4ae3806e5e1a802b86a6de292d043476">begin</a> ()</td></tr>
|
|
<tr class="separator:a4ae3806e5e1a802b86a6de292d043476"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5d410de1053f8028faed1f0d0a6083f5" id="r_a5d410de1053f8028faed1f0d0a6083f5"><td class="memItemLeft" align="right" valign="top">auto </td><td class="memItemRight" valign="bottom"><a class="el" href="#a5d410de1053f8028faed1f0d0a6083f5">begin</a> () const</td></tr>
|
|
<tr class="separator:a5d410de1053f8028faed1f0d0a6083f5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af8d23557326e6c8499fa4919ac0bd972" id="r_af8d23557326e6c8499fa4919ac0bd972"><td class="memItemLeft" align="right" valign="top">auto </td><td class="memItemRight" valign="bottom"><a class="el" href="#af8d23557326e6c8499fa4919ac0bd972">end</a> ()</td></tr>
|
|
<tr class="separator:af8d23557326e6c8499fa4919ac0bd972"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a054994f733b44293b4d79f3a9b207560" id="r_a054994f733b44293b4d79f3a9b207560"><td class="memItemLeft" align="right" valign="top">auto </td><td class="memItemRight" valign="bottom"><a class="el" href="#a054994f733b44293b4d79f3a9b207560">end</a> () const</td></tr>
|
|
<tr class="separator:a054994f733b44293b4d79f3a9b207560"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_classgridfire_1_1reaction_1_1_reaction"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_classgridfire_1_1reaction_1_1_reaction')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classgridfire_1_1reaction_1_1_reaction.html">gridfire::reaction::Reaction</a></td></tr>
|
|
<tr class="memitem:ab1860df84843be70f97469761e11ab6a inherit pub_methods_classgridfire_1_1reaction_1_1_reaction" id="r_ab1860df84843be70f97469761e11ab6a"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1reaction_1_1_reaction.html#ab1860df84843be70f97469761e11ab6a">~Reaction</a> ()=default</td></tr>
|
|
<tr class="memdesc:ab1860df84843be70f97469761e11ab6a inherit pub_methods_classgridfire_1_1reaction_1_1_reaction"><td class="mdescLeft"> </td><td class="mdescRight">Virtual destructor. <br /></td></tr>
|
|
<tr class="separator:ab1860df84843be70f97469761e11ab6a inherit pub_methods_classgridfire_1_1reaction_1_1_reaction"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7dff19d387e771d96c26e98d75ee9d5c inherit pub_methods_classgridfire_1_1reaction_1_1_reaction" id="r_a7dff19d387e771d96c26e98d75ee9d5c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1reaction_1_1_reaction.html#a7dff19d387e771d96c26e98d75ee9d5c">Reaction</a> (const std::string_view <a class="el" href="classgridfire_1_1reaction_1_1_reaction.html#a084c38181408ed5e6fa2a2dd4d0ec905">id</a>, const std::string_view <a class="el" href="classgridfire_1_1reaction_1_1_reaction.html#a78f42664cc957e266b6cf15fda09be97">peName</a>, const int <a class="el" href="classgridfire_1_1reaction_1_1_reaction.html#a5cb438adfefb640e4bc58e09053bd629">chapter</a>, const std::vector< fourdst::atomic::Species > &<a class="el" href="classgridfire_1_1reaction_1_1_reaction.html#a0b543e9b0bb4a21efe4b29780d9bdf5b">reactants</a>, const std::vector< fourdst::atomic::Species > &<a class="el" href="classgridfire_1_1reaction_1_1_reaction.html#a6e2ff61b9e8409f2a561663628b8ce02">products</a>, const double <a class="el" href="classgridfire_1_1reaction_1_1_reaction.html#abda0b4e4313e6d4ba57acf37d5976fb8">qValue</a>, const std::string_view label, const <a class="el" href="structgridfire_1_1reaction_1_1_rate_coefficient_set.html">RateCoefficientSet</a> &sets, const bool reverse=false)</td></tr>
|
|
<tr class="memdesc:a7dff19d387e771d96c26e98d75ee9d5c inherit pub_methods_classgridfire_1_1reaction_1_1_reaction"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a <a class="el" href="classgridfire_1_1reaction_1_1_reaction.html" title="Represents a single nuclear reaction from a specific data source.">Reaction</a> object. <br /></td></tr>
|
|
<tr class="separator:a7dff19d387e771d96c26e98d75ee9d5c inherit pub_methods_classgridfire_1_1reaction_1_1_reaction"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a78f42664cc957e266b6cf15fda09be97 inherit pub_methods_classgridfire_1_1reaction_1_1_reaction" id="r_a78f42664cc957e266b6cf15fda09be97"><td class="memItemLeft" align="right" valign="top">virtual std::string_view </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1reaction_1_1_reaction.html#a78f42664cc957e266b6cf15fda09be97">peName</a> () const</td></tr>
|
|
<tr class="memdesc:a78f42664cc957e266b6cf15fda09be97 inherit pub_methods_classgridfire_1_1reaction_1_1_reaction"><td class="mdescLeft"> </td><td class="mdescRight">Gets the reaction name in (projectile, ejectile) notation. <br /></td></tr>
|
|
<tr class="separator:a78f42664cc957e266b6cf15fda09be97 inherit pub_methods_classgridfire_1_1reaction_1_1_reaction"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5cb438adfefb640e4bc58e09053bd629 inherit pub_methods_classgridfire_1_1reaction_1_1_reaction" id="r_a5cb438adfefb640e4bc58e09053bd629"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1reaction_1_1_reaction.html#a5cb438adfefb640e4bc58e09053bd629">chapter</a> () const</td></tr>
|
|
<tr class="memdesc:a5cb438adfefb640e4bc58e09053bd629 inherit pub_methods_classgridfire_1_1reaction_1_1_reaction"><td class="mdescLeft"> </td><td class="mdescRight">Gets the REACLIB chapter number. <br /></td></tr>
|
|
<tr class="separator:a5cb438adfefb640e4bc58e09053bd629 inherit pub_methods_classgridfire_1_1reaction_1_1_reaction"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a410e2ab0784ad751f82bbe55be603db0 inherit pub_methods_classgridfire_1_1reaction_1_1_reaction" id="r_a410e2ab0784ad751f82bbe55be603db0"><td class="memItemLeft" align="right" valign="top">std::string_view </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1reaction_1_1_reaction.html#a410e2ab0784ad751f82bbe55be603db0">sourceLabel</a> () const</td></tr>
|
|
<tr class="memdesc:a410e2ab0784ad751f82bbe55be603db0 inherit pub_methods_classgridfire_1_1reaction_1_1_reaction"><td class="mdescLeft"> </td><td class="mdescRight">Gets the source label for the rate data. <br /></td></tr>
|
|
<tr class="separator:a410e2ab0784ad751f82bbe55be603db0 inherit pub_methods_classgridfire_1_1reaction_1_1_reaction"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a85968076e686e67763f4fdf4f72a892e inherit pub_methods_classgridfire_1_1reaction_1_1_reaction" id="r_a85968076e686e67763f4fdf4f72a892e"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structgridfire_1_1reaction_1_1_rate_coefficient_set.html">RateCoefficientSet</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1reaction_1_1_reaction.html#a85968076e686e67763f4fdf4f72a892e">rateCoefficients</a> () const</td></tr>
|
|
<tr class="memdesc:a85968076e686e67763f4fdf4f72a892e inherit pub_methods_classgridfire_1_1reaction_1_1_reaction"><td class="mdescLeft"> </td><td class="mdescRight">Gets the set of rate coefficients. <br /></td></tr>
|
|
<tr class="separator:a85968076e686e67763f4fdf4f72a892e inherit pub_methods_classgridfire_1_1reaction_1_1_reaction"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab92785f331a446e51a0960b75d60b37b inherit pub_methods_classgridfire_1_1reaction_1_1_reaction" id="r_ab92785f331a446e51a0960b75d60b37b"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1reaction_1_1_reaction.html#ab92785f331a446e51a0960b75d60b37b">contains</a> (const fourdst::atomic::Species &species) const</td></tr>
|
|
<tr class="memdesc:ab92785f331a446e51a0960b75d60b37b inherit pub_methods_classgridfire_1_1reaction_1_1_reaction"><td class="mdescLeft"> </td><td class="mdescRight">Checks if the reaction involves a given species as a reactant or product. <br /></td></tr>
|
|
<tr class="separator:ab92785f331a446e51a0960b75d60b37b inherit pub_methods_classgridfire_1_1reaction_1_1_reaction"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abbe243affa61ba9b2cd2a7b905cd5e45 inherit pub_methods_classgridfire_1_1reaction_1_1_reaction" id="r_abbe243affa61ba9b2cd2a7b905cd5e45"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1reaction_1_1_reaction.html#abbe243affa61ba9b2cd2a7b905cd5e45">contains_reactant</a> (const fourdst::atomic::Species &species) const</td></tr>
|
|
<tr class="memdesc:abbe243affa61ba9b2cd2a7b905cd5e45 inherit pub_methods_classgridfire_1_1reaction_1_1_reaction"><td class="mdescLeft"> </td><td class="mdescRight">Checks if the reaction involves a given species as a reactant. <br /></td></tr>
|
|
<tr class="separator:abbe243affa61ba9b2cd2a7b905cd5e45 inherit pub_methods_classgridfire_1_1reaction_1_1_reaction"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a074d3cd2421fd5d0133e47f0522403e2 inherit pub_methods_classgridfire_1_1reaction_1_1_reaction" id="r_a074d3cd2421fd5d0133e47f0522403e2"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1reaction_1_1_reaction.html#a074d3cd2421fd5d0133e47f0522403e2">contains_product</a> (const fourdst::atomic::Species &species) const</td></tr>
|
|
<tr class="memdesc:a074d3cd2421fd5d0133e47f0522403e2 inherit pub_methods_classgridfire_1_1reaction_1_1_reaction"><td class="mdescLeft"> </td><td class="mdescRight">Checks if the reaction involves a given species as a product. <br /></td></tr>
|
|
<tr class="separator:a074d3cd2421fd5d0133e47f0522403e2 inherit pub_methods_classgridfire_1_1reaction_1_1_reaction"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7dc8fda87e0581fde6da0a81cf4d7224 inherit pub_methods_classgridfire_1_1reaction_1_1_reaction" id="r_a7dc8fda87e0581fde6da0a81cf4d7224"><td class="memItemLeft" align="right" valign="top">std::unordered_set< fourdst::atomic::Species > </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1reaction_1_1_reaction.html#a7dc8fda87e0581fde6da0a81cf4d7224">all_species</a> () const</td></tr>
|
|
<tr class="memdesc:a7dc8fda87e0581fde6da0a81cf4d7224 inherit pub_methods_classgridfire_1_1reaction_1_1_reaction"><td class="mdescLeft"> </td><td class="mdescRight">Gets a set of all unique species involved in the reaction. <br /></td></tr>
|
|
<tr class="separator:a7dc8fda87e0581fde6da0a81cf4d7224 inherit pub_methods_classgridfire_1_1reaction_1_1_reaction"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a855ea65e4b62fb0cddc550424a4bc923 inherit pub_methods_classgridfire_1_1reaction_1_1_reaction" id="r_a855ea65e4b62fb0cddc550424a4bc923"><td class="memItemLeft" align="right" valign="top">std::unordered_set< fourdst::atomic::Species > </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1reaction_1_1_reaction.html#a855ea65e4b62fb0cddc550424a4bc923">reactant_species</a> () const</td></tr>
|
|
<tr class="memdesc:a855ea65e4b62fb0cddc550424a4bc923 inherit pub_methods_classgridfire_1_1reaction_1_1_reaction"><td class="mdescLeft"> </td><td class="mdescRight">Gets a set of all unique reactant species. <br /></td></tr>
|
|
<tr class="separator:a855ea65e4b62fb0cddc550424a4bc923 inherit pub_methods_classgridfire_1_1reaction_1_1_reaction"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a01c67726efbaa2ff8e4d6f2c965f485c inherit pub_methods_classgridfire_1_1reaction_1_1_reaction" id="r_a01c67726efbaa2ff8e4d6f2c965f485c"><td class="memItemLeft" align="right" valign="top">std::unordered_set< fourdst::atomic::Species > </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1reaction_1_1_reaction.html#a01c67726efbaa2ff8e4d6f2c965f485c">product_species</a> () const</td></tr>
|
|
<tr class="memdesc:a01c67726efbaa2ff8e4d6f2c965f485c inherit pub_methods_classgridfire_1_1reaction_1_1_reaction"><td class="mdescLeft"> </td><td class="mdescRight">Gets a set of all unique product species. <br /></td></tr>
|
|
<tr class="separator:a01c67726efbaa2ff8e4d6f2c965f485c inherit pub_methods_classgridfire_1_1reaction_1_1_reaction"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1d3c8ab6d55155f9a21ad80ed8b9ef97 inherit pub_methods_classgridfire_1_1reaction_1_1_reaction" id="r_a1d3c8ab6d55155f9a21ad80ed8b9ef97"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1reaction_1_1_reaction.html#a1d3c8ab6d55155f9a21ad80ed8b9ef97">num_species</a> () const</td></tr>
|
|
<tr class="memdesc:a1d3c8ab6d55155f9a21ad80ed8b9ef97 inherit pub_methods_classgridfire_1_1reaction_1_1_reaction"><td class="mdescLeft"> </td><td class="mdescRight">Gets the number of unique species involved in the reaction. <br /></td></tr>
|
|
<tr class="separator:a1d3c8ab6d55155f9a21ad80ed8b9ef97 inherit pub_methods_classgridfire_1_1reaction_1_1_reaction"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aaf0c94db6536b4a9ac1ec08a5c8f01ac inherit pub_methods_classgridfire_1_1reaction_1_1_reaction" id="r_aaf0c94db6536b4a9ac1ec08a5c8f01ac"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1reaction_1_1_reaction.html#aaf0c94db6536b4a9ac1ec08a5c8f01ac">stoichiometry</a> (const fourdst::atomic::Species &species) const</td></tr>
|
|
<tr class="memdesc:aaf0c94db6536b4a9ac1ec08a5c8f01ac inherit pub_methods_classgridfire_1_1reaction_1_1_reaction"><td class="mdescLeft"> </td><td class="mdescRight">Calculates the stoichiometric coefficient for a given species. <br /></td></tr>
|
|
<tr class="separator:aaf0c94db6536b4a9ac1ec08a5c8f01ac inherit pub_methods_classgridfire_1_1reaction_1_1_reaction"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad359c06d7196c1a7a955a7b66a51dbe3 inherit pub_methods_classgridfire_1_1reaction_1_1_reaction" id="r_ad359c06d7196c1a7a955a7b66a51dbe3"><td class="memItemLeft" align="right" valign="top">std::unordered_map< fourdst::atomic::Species, int > </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1reaction_1_1_reaction.html#ad359c06d7196c1a7a955a7b66a51dbe3">stoichiometry</a> () const</td></tr>
|
|
<tr class="memdesc:ad359c06d7196c1a7a955a7b66a51dbe3 inherit pub_methods_classgridfire_1_1reaction_1_1_reaction"><td class="mdescLeft"> </td><td class="mdescRight">Gets a map of all species to their stoichiometric coefficients. <br /></td></tr>
|
|
<tr class="separator:ad359c06d7196c1a7a955a7b66a51dbe3 inherit pub_methods_classgridfire_1_1reaction_1_1_reaction"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a084c38181408ed5e6fa2a2dd4d0ec905 inherit pub_methods_classgridfire_1_1reaction_1_1_reaction" id="r_a084c38181408ed5e6fa2a2dd4d0ec905"><td class="memItemLeft" align="right" valign="top">std::string_view </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1reaction_1_1_reaction.html#a084c38181408ed5e6fa2a2dd4d0ec905">id</a> () const</td></tr>
|
|
<tr class="memdesc:a084c38181408ed5e6fa2a2dd4d0ec905 inherit pub_methods_classgridfire_1_1reaction_1_1_reaction"><td class="mdescLeft"> </td><td class="mdescRight">Gets the unique identifier of the reaction. <br /></td></tr>
|
|
<tr class="separator:a084c38181408ed5e6fa2a2dd4d0ec905 inherit pub_methods_classgridfire_1_1reaction_1_1_reaction"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abda0b4e4313e6d4ba57acf37d5976fb8 inherit pub_methods_classgridfire_1_1reaction_1_1_reaction" id="r_abda0b4e4313e6d4ba57acf37d5976fb8"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1reaction_1_1_reaction.html#abda0b4e4313e6d4ba57acf37d5976fb8">qValue</a> () const</td></tr>
|
|
<tr class="memdesc:abda0b4e4313e6d4ba57acf37d5976fb8 inherit pub_methods_classgridfire_1_1reaction_1_1_reaction"><td class="mdescLeft"> </td><td class="mdescRight">Gets the Q-value of the reaction. <br /></td></tr>
|
|
<tr class="separator:abda0b4e4313e6d4ba57acf37d5976fb8 inherit pub_methods_classgridfire_1_1reaction_1_1_reaction"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0b543e9b0bb4a21efe4b29780d9bdf5b inherit pub_methods_classgridfire_1_1reaction_1_1_reaction" id="r_a0b543e9b0bb4a21efe4b29780d9bdf5b"><td class="memItemLeft" align="right" valign="top">const std::vector< fourdst::atomic::Species > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1reaction_1_1_reaction.html#a0b543e9b0bb4a21efe4b29780d9bdf5b">reactants</a> () const</td></tr>
|
|
<tr class="memdesc:a0b543e9b0bb4a21efe4b29780d9bdf5b inherit pub_methods_classgridfire_1_1reaction_1_1_reaction"><td class="mdescLeft"> </td><td class="mdescRight">Gets the vector of reactant species. <br /></td></tr>
|
|
<tr class="separator:a0b543e9b0bb4a21efe4b29780d9bdf5b inherit pub_methods_classgridfire_1_1reaction_1_1_reaction"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6e2ff61b9e8409f2a561663628b8ce02 inherit pub_methods_classgridfire_1_1reaction_1_1_reaction" id="r_a6e2ff61b9e8409f2a561663628b8ce02"><td class="memItemLeft" align="right" valign="top">const std::vector< fourdst::atomic::Species > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1reaction_1_1_reaction.html#a6e2ff61b9e8409f2a561663628b8ce02">products</a> () const</td></tr>
|
|
<tr class="memdesc:a6e2ff61b9e8409f2a561663628b8ce02 inherit pub_methods_classgridfire_1_1reaction_1_1_reaction"><td class="mdescLeft"> </td><td class="mdescRight">Gets the vector of product species. <br /></td></tr>
|
|
<tr class="separator:a6e2ff61b9e8409f2a561663628b8ce02 inherit pub_methods_classgridfire_1_1reaction_1_1_reaction"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa67d05dfabf007c1acad34052d9a1dba inherit pub_methods_classgridfire_1_1reaction_1_1_reaction" id="r_aa67d05dfabf007c1acad34052d9a1dba"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1reaction_1_1_reaction.html#aa67d05dfabf007c1acad34052d9a1dba">is_reverse</a> () const</td></tr>
|
|
<tr class="memdesc:aa67d05dfabf007c1acad34052d9a1dba inherit pub_methods_classgridfire_1_1reaction_1_1_reaction"><td class="mdescLeft"> </td><td class="mdescRight">Checks if this is a reverse reaction rate. <br /></td></tr>
|
|
<tr class="separator:aa67d05dfabf007c1acad34052d9a1dba inherit pub_methods_classgridfire_1_1reaction_1_1_reaction"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa1d71e38fc55ae691dbb9ec459a612a5 inherit pub_methods_classgridfire_1_1reaction_1_1_reaction" id="r_aa1d71e38fc55ae691dbb9ec459a612a5"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1reaction_1_1_reaction.html#aa1d71e38fc55ae691dbb9ec459a612a5">excess_energy</a> () const</td></tr>
|
|
<tr class="memdesc:aa1d71e38fc55ae691dbb9ec459a612a5 inherit pub_methods_classgridfire_1_1reaction_1_1_reaction"><td class="mdescLeft"> </td><td class="mdescRight">Calculates the excess energy from the mass difference of reactants and products. <br /></td></tr>
|
|
<tr class="separator:aa1d71e38fc55ae691dbb9ec459a612a5 inherit pub_methods_classgridfire_1_1reaction_1_1_reaction"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac426457cf0a54a15b206549422083bac inherit pub_methods_classgridfire_1_1reaction_1_1_reaction" id="r_ac426457cf0a54a15b206549422083bac"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1reaction_1_1_reaction.html#ac426457cf0a54a15b206549422083bac">operator==</a> (const <a class="el" href="classgridfire_1_1reaction_1_1_reaction.html">Reaction</a> &other) const</td></tr>
|
|
<tr class="memdesc:ac426457cf0a54a15b206549422083bac inherit pub_methods_classgridfire_1_1reaction_1_1_reaction"><td class="mdescLeft"> </td><td class="mdescRight">Compares this reaction with another for equality based on their IDs. <br /></td></tr>
|
|
<tr class="separator:ac426457cf0a54a15b206549422083bac inherit pub_methods_classgridfire_1_1reaction_1_1_reaction"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2f1c115a99bc7c477a2e858ff18b1b51 inherit pub_methods_classgridfire_1_1reaction_1_1_reaction" id="r_a2f1c115a99bc7c477a2e858ff18b1b51"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1reaction_1_1_reaction.html#a2f1c115a99bc7c477a2e858ff18b1b51">operator!=</a> (const <a class="el" href="classgridfire_1_1reaction_1_1_reaction.html">Reaction</a> &other) const</td></tr>
|
|
<tr class="memdesc:a2f1c115a99bc7c477a2e858ff18b1b51 inherit pub_methods_classgridfire_1_1reaction_1_1_reaction"><td class="mdescLeft"> </td><td class="mdescRight">Compares this reaction with another for inequality. <br /></td></tr>
|
|
<tr class="separator:a2f1c115a99bc7c477a2e858ff18b1b51 inherit pub_methods_classgridfire_1_1reaction_1_1_reaction"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af6c20e6d03a2d9f87632f71a90b88cb5 inherit pub_methods_classgridfire_1_1reaction_1_1_reaction" id="r_af6c20e6d03a2d9f87632f71a90b88cb5"><td class="memItemLeft" align="right" valign="top">uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1reaction_1_1_reaction.html#af6c20e6d03a2d9f87632f71a90b88cb5">hash</a> (uint64_t seed=0) const</td></tr>
|
|
<tr class="memdesc:af6c20e6d03a2d9f87632f71a90b88cb5 inherit pub_methods_classgridfire_1_1reaction_1_1_reaction"><td class="mdescLeft"> </td><td class="mdescRight">Computes a hash for the reaction based on its ID. <br /></td></tr>
|
|
<tr class="separator:af6c20e6d03a2d9f87632f71a90b88cb5 inherit pub_methods_classgridfire_1_1reaction_1_1_reaction"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-methods" name="pri-methods"></a>
|
|
Private Member Functions</h2></td></tr>
|
|
<tr class="memitem:a019b721d83741acdb16036f00739f87c" id="r_a019b721d83741acdb16036f00739f87c"><td class="memTemplParams" colspan="2">template<typename T> </td></tr>
|
|
<tr class="memitem:a019b721d83741acdb16036f00739f87c"><td class="memTemplItemLeft" align="right" valign="top">T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a019b721d83741acdb16036f00739f87c">calculate_rate</a> (const T T9) const</td></tr>
|
|
<tr class="memdesc:a019b721d83741acdb16036f00739f87c"><td class="mdescLeft"> </td><td class="mdescRight">Template implementation for calculating the total reaction rate. <br /></td></tr>
|
|
<tr class="separator:a019b721d83741acdb16036f00739f87c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-attribs" name="pri-attribs"></a>
|
|
Private Attributes</h2></td></tr>
|
|
<tr class="memitem:a7fe91d24e20ebc76d612f6ad742f476f" id="r_a7fe91d24e20ebc76d612f6ad742f476f"><td class="memItemLeft" align="right" valign="top">std::vector< std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="#a7fe91d24e20ebc76d612f6ad742f476f">m_sources</a></td></tr>
|
|
<tr class="memdesc:a7fe91d24e20ebc76d612f6ad742f476f"><td class="mdescLeft"> </td><td class="mdescRight">List of source labels. <br /></td></tr>
|
|
<tr class="separator:a7fe91d24e20ebc76d612f6ad742f476f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a81f75f0085f8a5a45169f0b7240c809d" id="r_a81f75f0085f8a5a45169f0b7240c809d"><td class="memItemLeft" align="right" valign="top">std::vector< <a class="el" href="structgridfire_1_1reaction_1_1_rate_coefficient_set.html">RateCoefficientSet</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="#a81f75f0085f8a5a45169f0b7240c809d">m_rates</a></td></tr>
|
|
<tr class="memdesc:a81f75f0085f8a5a45169f0b7240c809d"><td class="mdescLeft"> </td><td class="mdescRight">List of rate coefficient sets from each source. <br /></td></tr>
|
|
<tr class="separator:a81f75f0085f8a5a45169f0b7240c809d"><td class="memSeparator" colspan="2"> </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:a10cbea11653524dae2f7eafb5c22c90f" id="r_a10cbea11653524dae2f7eafb5c22c90f"><td class="memItemLeft" align="right" valign="top">std::ostream & </td><td class="memItemRight" valign="bottom"><a class="el" href="#a10cbea11653524dae2f7eafb5c22c90f">operator<<</a> (std::ostream &os, const <a class="el" href="classgridfire_1_1reaction_1_1_logical_reaction.html">LogicalReaction</a> &r)</td></tr>
|
|
<tr class="separator:a10cbea11653524dae2f7eafb5c22c90f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a>
|
|
Additional Inherited Members</h2></td></tr>
|
|
<tr class="inherit_header pro_attribs_classgridfire_1_1reaction_1_1_reaction"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pro_attribs_classgridfire_1_1reaction_1_1_reaction')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="classgridfire_1_1reaction_1_1_reaction.html">gridfire::reaction::Reaction</a></td></tr>
|
|
<tr class="memitem:a7044d0a1d59d85502ce554e4ec2167e4 inherit pro_attribs_classgridfire_1_1reaction_1_1_reaction" id="r_a7044d0a1d59d85502ce554e4ec2167e4"><td class="memItemLeft" align="right" valign="top">quill::Logger * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1reaction_1_1_reaction.html#a7044d0a1d59d85502ce554e4ec2167e4">m_logger</a> = fourdst::logging::LogManager::getInstance().getLogger("log")</td></tr>
|
|
<tr class="separator:a7044d0a1d59d85502ce554e4ec2167e4 inherit pro_attribs_classgridfire_1_1reaction_1_1_reaction"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5c685e5a736b51799e5b9f6746c4126b inherit pro_attribs_classgridfire_1_1reaction_1_1_reaction" id="r_a5c685e5a736b51799e5b9f6746c4126b"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1reaction_1_1_reaction.html#a5c685e5a736b51799e5b9f6746c4126b">m_id</a></td></tr>
|
|
<tr class="memdesc:a5c685e5a736b51799e5b9f6746c4126b inherit pro_attribs_classgridfire_1_1reaction_1_1_reaction"><td class="mdescLeft"> </td><td class="mdescRight">Unique identifier for the reaction (e.g., "h1+h1=>h2+e+nu"). <br /></td></tr>
|
|
<tr class="separator:a5c685e5a736b51799e5b9f6746c4126b inherit pro_attribs_classgridfire_1_1reaction_1_1_reaction"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6124aa9fc2306349e1dd879a37923248 inherit pro_attribs_classgridfire_1_1reaction_1_1_reaction" id="r_a6124aa9fc2306349e1dd879a37923248"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1reaction_1_1_reaction.html#a6124aa9fc2306349e1dd879a37923248">m_peName</a></td></tr>
|
|
<tr class="memdesc:a6124aa9fc2306349e1dd879a37923248 inherit pro_attribs_classgridfire_1_1reaction_1_1_reaction"><td class="mdescLeft"> </td><td class="mdescRight">Name of the reaction in (projectile, ejectile) notation (e.g. "p(p,g)d"). <br /></td></tr>
|
|
<tr class="separator:a6124aa9fc2306349e1dd879a37923248 inherit pro_attribs_classgridfire_1_1reaction_1_1_reaction"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a16f9cbb6269817099d3dc07d4e63da7b inherit pro_attribs_classgridfire_1_1reaction_1_1_reaction" id="r_a16f9cbb6269817099d3dc07d4e63da7b"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1reaction_1_1_reaction.html#a16f9cbb6269817099d3dc07d4e63da7b">m_chapter</a></td></tr>
|
|
<tr class="memdesc:a16f9cbb6269817099d3dc07d4e63da7b inherit pro_attribs_classgridfire_1_1reaction_1_1_reaction"><td class="mdescLeft"> </td><td class="mdescRight">Chapter number from the REACLIB database, defining the reaction structure. <br /></td></tr>
|
|
<tr class="separator:a16f9cbb6269817099d3dc07d4e63da7b inherit pro_attribs_classgridfire_1_1reaction_1_1_reaction"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a59122a2898bb9af640cc3e9aeb49028b inherit pro_attribs_classgridfire_1_1reaction_1_1_reaction" id="r_a59122a2898bb9af640cc3e9aeb49028b"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1reaction_1_1_reaction.html#a59122a2898bb9af640cc3e9aeb49028b">m_qValue</a> = 0.0</td></tr>
|
|
<tr class="memdesc:a59122a2898bb9af640cc3e9aeb49028b inherit pro_attribs_classgridfire_1_1reaction_1_1_reaction"><td class="mdescLeft"> </td><td class="mdescRight">Q-value of the reaction in MeV. <br /></td></tr>
|
|
<tr class="separator:a59122a2898bb9af640cc3e9aeb49028b inherit pro_attribs_classgridfire_1_1reaction_1_1_reaction"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a87a065b3c7806bcdb5eadb7de2978a11 inherit pro_attribs_classgridfire_1_1reaction_1_1_reaction" id="r_a87a065b3c7806bcdb5eadb7de2978a11"><td class="memItemLeft" align="right" valign="top">std::vector< fourdst::atomic::Species > </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1reaction_1_1_reaction.html#a87a065b3c7806bcdb5eadb7de2978a11">m_reactants</a></td></tr>
|
|
<tr class="memdesc:a87a065b3c7806bcdb5eadb7de2978a11 inherit pro_attribs_classgridfire_1_1reaction_1_1_reaction"><td class="mdescLeft"> </td><td class="mdescRight">Reactants of the reaction. <br /></td></tr>
|
|
<tr class="separator:a87a065b3c7806bcdb5eadb7de2978a11 inherit pro_attribs_classgridfire_1_1reaction_1_1_reaction"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4b5607ed413acdf29539b8a57461e49e inherit pro_attribs_classgridfire_1_1reaction_1_1_reaction" id="r_a4b5607ed413acdf29539b8a57461e49e"><td class="memItemLeft" align="right" valign="top">std::vector< fourdst::atomic::Species > </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1reaction_1_1_reaction.html#a4b5607ed413acdf29539b8a57461e49e">m_products</a></td></tr>
|
|
<tr class="memdesc:a4b5607ed413acdf29539b8a57461e49e inherit pro_attribs_classgridfire_1_1reaction_1_1_reaction"><td class="mdescLeft"> </td><td class="mdescRight">Products of the reaction. <br /></td></tr>
|
|
<tr class="separator:a4b5607ed413acdf29539b8a57461e49e inherit pro_attribs_classgridfire_1_1reaction_1_1_reaction"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0185c6be5465d113f25e00aee1297cd6 inherit pro_attribs_classgridfire_1_1reaction_1_1_reaction" id="r_a0185c6be5465d113f25e00aee1297cd6"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1reaction_1_1_reaction.html#a0185c6be5465d113f25e00aee1297cd6">m_sourceLabel</a></td></tr>
|
|
<tr class="memdesc:a0185c6be5465d113f25e00aee1297cd6 inherit pro_attribs_classgridfire_1_1reaction_1_1_reaction"><td class="mdescLeft"> </td><td class="mdescRight">Source label for the rate data (e.g., "wc12w", "st08"). <br /></td></tr>
|
|
<tr class="separator:a0185c6be5465d113f25e00aee1297cd6 inherit pro_attribs_classgridfire_1_1reaction_1_1_reaction"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa61a9a024d7c4ff66a351ccd0277ec72 inherit pro_attribs_classgridfire_1_1reaction_1_1_reaction" id="r_aa61a9a024d7c4ff66a351ccd0277ec72"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structgridfire_1_1reaction_1_1_rate_coefficient_set.html">RateCoefficientSet</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1reaction_1_1_reaction.html#aa61a9a024d7c4ff66a351ccd0277ec72">m_rateCoefficients</a></td></tr>
|
|
<tr class="memdesc:aa61a9a024d7c4ff66a351ccd0277ec72 inherit pro_attribs_classgridfire_1_1reaction_1_1_reaction"><td class="mdescLeft"> </td><td class="mdescRight">The seven rate coefficients. <br /></td></tr>
|
|
<tr class="separator:aa61a9a024d7c4ff66a351ccd0277ec72 inherit pro_attribs_classgridfire_1_1reaction_1_1_reaction"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0b0b9ac498080aae91ffd466d1ae85a9 inherit pro_attribs_classgridfire_1_1reaction_1_1_reaction" id="r_a0b0b9ac498080aae91ffd466d1ae85a9"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1reaction_1_1_reaction.html#a0b0b9ac498080aae91ffd466d1ae85a9">m_reverse</a> = false</td></tr>
|
|
<tr class="memdesc:a0b0b9ac498080aae91ffd466d1ae85a9 inherit pro_attribs_classgridfire_1_1reaction_1_1_reaction"><td class="mdescLeft"> </td><td class="mdescRight">Flag indicating if this is a reverse reaction rate. <br /></td></tr>
|
|
<tr class="separator:a0b0b9ac498080aae91ffd466d1ae85a9 inherit pro_attribs_classgridfire_1_1reaction_1_1_reaction"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Represents a "logical" reaction that aggregates rates from multiple sources. </p>
|
|
<p>A <a class="el" href="classgridfire_1_1reaction_1_1_logical_reaction.html" title="Represents a "logical" reaction that aggregates rates from multiple sources.">LogicalReaction</a> shares the same reactants and products but combines rates from different evaluations (e.g., "wc12" and "st08" for the same physical reaction). The total rate is the sum of the individual rates. It inherits from <a class="el" href="classgridfire_1_1reaction_1_1_reaction.html" title="Represents a single nuclear reaction from a specific data source.">Reaction</a>, using the properties of the first provided reaction as its base properties (reactants, products, Q-value, etc.). </p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a6965906ea33ebd0d615811219d9e9537" name="a6965906ea33ebd0d615811219d9e9537"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6965906ea33ebd0d615811219d9e9537">◆ </a></span>LogicalReaction()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">gridfire::reaction::LogicalReaction::LogicalReaction </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::vector< <a class="el" href="classgridfire_1_1reaction_1_1_reaction.html">Reaction</a> > &</td> <td class="paramname"><span class="paramname"><em>reactions</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel explicit">explicit</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Constructs a <a class="el" href="classgridfire_1_1reaction_1_1_logical_reaction.html" title="Represents a "logical" reaction that aggregates rates from multiple sources.">LogicalReaction</a> from a vector of <code><a class="el" href="classgridfire_1_1reaction_1_1_reaction.html" title="Represents a single nuclear reaction from a specific data source.">Reaction</a></code> objects. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">reactions</td><td>A vector of reactions that represent the same logical process. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="exception"><dt>Exceptions</dt><dd>
|
|
<table class="exception">
|
|
<tr><td class="paramname">std::runtime_error</td><td>if the provided reactions have inconsistent Q-values. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a14a24cb8ea25a1514134acc51197f1de" name="a14a24cb8ea25a1514134acc51197f1de"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a14a24cb8ea25a1514134acc51197f1de">◆ </a></span>add_reaction()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void gridfire::reaction::LogicalReaction::add_reaction </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classgridfire_1_1reaction_1_1_reaction.html">Reaction</a> &</td> <td class="paramname"><span class="paramname"><em>reaction</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Adds another <code><a class="el" href="classgridfire_1_1reaction_1_1_reaction.html" title="Represents a single nuclear reaction from a specific data source.">Reaction</a></code> source to this logical reaction. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">reaction</td><td>The reaction to add. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="exception"><dt>Exceptions</dt><dd>
|
|
<table class="exception">
|
|
<tr><td class="paramname">std::runtime_error</td><td>if the reaction has a different <code>peName</code>, a duplicate source label, or an inconsistent Q-value. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4ae3806e5e1a802b86a6de292d043476" name="a4ae3806e5e1a802b86a6de292d043476"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4ae3806e5e1a802b86a6de292d043476">◆ </a></span>begin() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">auto gridfire::reaction::LogicalReaction::begin </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5d410de1053f8028faed1f0d0a6083f5" name="a5d410de1053f8028faed1f0d0a6083f5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5d410de1053f8028faed1f0d0a6083f5">◆ </a></span>begin() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">auto gridfire::reaction::LogicalReaction::begin </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel nodiscard">nodiscard</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa4b8d0d30459f360ff6e29d848e943d5" name="aa4b8d0d30459f360ff6e29d848e943d5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa4b8d0d30459f360ff6e29d848e943d5">◆ </a></span>calculate_forward_rate_log_derivative()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">double gridfire::reaction::LogicalReaction::calculate_forward_rate_log_derivative </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const double</td> <td class="paramname"><span class="paramname"><em>T9</em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel nodiscard">nodiscard</span><span class="mlabel override">override</span><span class="mlabel virtual">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Reimplemented from <a class="el" href="classgridfire_1_1reaction_1_1_reaction.html#a3a8ba9212d76d5ce51f20df6892c6061">gridfire::reaction::Reaction</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="adad6f4297c1d8ce487eab092b73cdd32" name="adad6f4297c1d8ce487eab092b73cdd32"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#adad6f4297c1d8ce487eab092b73cdd32">◆ </a></span>calculate_rate() <span class="overload">[1/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">CppAD::AD< double > gridfire::reaction::LogicalReaction::calculate_rate </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const CppAD::AD< double ></td> <td class="paramname"><span class="paramname"><em>T9</em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel nodiscard">nodiscard</span><span class="mlabel override">override</span><span class="mlabel virtual">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Calculates the total reaction rate using CppAD types. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">T9</td><td>The temperature in units of 10^9 K, as a CppAD::AD<double>. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The total calculated reaction rate, as a CppAD::AD<double>. </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="classgridfire_1_1reaction_1_1_reaction.html#a735192a42f72cd68f289493753e1a616">gridfire::reaction::Reaction</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1d2fb3b6a6a1860ace98b32447d1dd1b" name="a1d2fb3b6a6a1860ace98b32447d1dd1b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1d2fb3b6a6a1860ace98b32447d1dd1b">◆ </a></span>calculate_rate() <span class="overload">[2/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">double gridfire::reaction::LogicalReaction::calculate_rate </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const double</td> <td class="paramname"><span class="paramname"><em>T9</em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel nodiscard">nodiscard</span><span class="mlabel override">override</span><span class="mlabel virtual">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Calculates the total reaction rate by summing all source rates. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">T9</td><td>The temperature in units of 10^9 K. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The total calculated reaction rate. </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="classgridfire_1_1reaction_1_1_reaction.html#ad81e9b2a1773470059ca6989c60556ec">gridfire::reaction::Reaction</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a019b721d83741acdb16036f00739f87c" name="a019b721d83741acdb16036f00739f87c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a019b721d83741acdb16036f00739f87c">◆ </a></span>calculate_rate() <span class="overload">[3/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">T gridfire::reaction::LogicalReaction::calculate_rate </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const T</td> <td class="paramname"><span class="paramname"><em>T9</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 class="mlabel private">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Template implementation for calculating the total reaction rate. </p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">T</td><td>The numeric type (double or CppAD::AD<double>). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">T9</td><td>The temperature in units of 10^9 K. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The total calculated reaction rate.</dd></dl>
|
|
<p>This method iterates through all stored <code><a class="el" href="structgridfire_1_1reaction_1_1_rate_coefficient_set.html" title="Holds the seven coefficients for the REACLIB rate equation.">RateCoefficientSet</a></code>s, calculates the rate for each, and returns their sum. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af8d23557326e6c8499fa4919ac0bd972" name="af8d23557326e6c8499fa4919ac0bd972"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af8d23557326e6c8499fa4919ac0bd972">◆ </a></span>end() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">auto gridfire::reaction::LogicalReaction::end </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a054994f733b44293b4d79f3a9b207560" name="a054994f733b44293b4d79f3a9b207560"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a054994f733b44293b4d79f3a9b207560">◆ </a></span>end() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">auto gridfire::reaction::LogicalReaction::end </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel nodiscard">nodiscard</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="afa41050855b842c63db16c94d2e9b897" name="afa41050855b842c63db16c94d2e9b897"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afa41050855b842c63db16c94d2e9b897">◆ </a></span>size()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">size_t gridfire::reaction::LogicalReaction::size </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel nodiscard">nodiscard</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the number of source rates contributing to this logical reaction. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The number of aggregated rates. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="add094eda0e71126f8443698d7f3317f4" name="add094eda0e71126f8443698d7f3317f4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#add094eda0e71126f8443698d7f3317f4">◆ </a></span>sources()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::vector< std::string > gridfire::reaction::LogicalReaction::sources </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 list of source labels for the aggregated rates. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>A vector of source label strings. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Friends And Related Symbol Documentation</h2>
|
|
<a id="a10cbea11653524dae2f7eafb5c22c90f" name="a10cbea11653524dae2f7eafb5c22c90f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a10cbea11653524dae2f7eafb5c22c90f">◆ </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">std::ostream & operator<< </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::ostream &</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="classgridfire_1_1reaction_1_1_logical_reaction.html">LogicalReaction</a> &</td> <td class="paramname"><span class="paramname"><em>r</em></span> )</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">
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Data Documentation</h2>
|
|
<a id="a81f75f0085f8a5a45169f0b7240c809d" name="a81f75f0085f8a5a45169f0b7240c809d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a81f75f0085f8a5a45169f0b7240c809d">◆ </a></span>m_rates</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::vector<<a class="el" href="structgridfire_1_1reaction_1_1_rate_coefficient_set.html">RateCoefficientSet</a>> gridfire::reaction::LogicalReaction::m_rates</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>List of rate coefficient sets from each source. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7fe91d24e20ebc76d612f6ad742f476f" name="a7fe91d24e20ebc76d612f6ad742f476f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7fe91d24e20ebc76d612f6ad742f476f">◆ </a></span>m_sources</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::vector<std::string> gridfire::reaction::LogicalReaction::m_sources</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>List of source labels. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li>src/include/gridfire/reaction/<a class="el" href="reaction_8h.html">reaction.h</a></li>
|
|
<li>src/lib/reaction/<a class="el" href="reaction_8cpp.html">reaction.cpp</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="namespacegridfire.html">gridfire</a></li><li class="navelem"><a class="el" href="namespacegridfire_1_1reaction.html">reaction</a></li><li class="navelem"><a class="el" href="classgridfire_1_1reaction_1_1_logical_reaction.html">LogicalReaction</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>
|