462 lines
32 KiB
HTML
462 lines
32 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.9.8"/>
|
||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||
|
|
<title>GridFire: gridfire::policy::ReactionChainPolicy 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>
|
||
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
||
|
|
<script type="text/javascript" src="resize.js"></script>
|
||
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
||
|
|
<script type="text/javascript" src="navtree.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"> v0.7.1_rc2</span>
|
||
|
|
</div>
|
||
|
|
<div id="projectbrief">General Purpose Nuclear Network</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<!-- end header part -->
|
||
|
|
<!-- Generated by Doxygen 1.9.8 -->
|
||
|
|
<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" 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');
|
||
|
|
$(document).ready(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 */
|
||
|
|
$(document).ready(function(){initNavTree('classgridfire_1_1policy_1_1ReactionChainPolicy.html',''); initResizable(); });
|
||
|
|
/* @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="#friends">Friends</a> |
|
||
|
|
<a href="classgridfire_1_1policy_1_1ReactionChainPolicy-members.html">List of all members</a> </div>
|
||
|
|
<div class="headertitle"><div class="title">gridfire::policy::ReactionChainPolicy Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div></div>
|
||
|
|
</div><!--header-->
|
||
|
|
<div class="contents">
|
||
|
|
|
||
|
|
<p>Abstract interface encapsulating a set of reactions representing a single chain or pathway.
|
||
|
|
<a href="classgridfire_1_1policy_1_1ReactionChainPolicy.html#details">More...</a></p>
|
||
|
|
|
||
|
|
<p><code>#include <policy_abstract.h></code></p>
|
||
|
|
<div class="dynheader">
|
||
|
|
Inheritance diagram for gridfire::policy::ReactionChainPolicy:</div>
|
||
|
|
<div class="dyncontent">
|
||
|
|
<div class="center"><div class="zoom"><iframe scrolling="no" frameborder="0" src="classgridfire_1_1policy_1_1ReactionChainPolicy__inherit__graph.svg" width="100%" height="600"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div></div>
|
||
|
|
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
|
||
|
|
<table class="memberdecls">
|
||
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
|
||
|
|
Public Member Functions</h2></td></tr>
|
||
|
|
<tr class="memitem:aa3e6c1e4844fe788aeb08d272070ae13" id="r_aa3e6c1e4844fe788aeb08d272070ae13"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1policy_1_1ReactionChainPolicy.html#aa3e6c1e4844fe788aeb08d272070ae13">~ReactionChainPolicy</a> ()=default</td></tr>
|
||
|
|
<tr class="separator:aa3e6c1e4844fe788aeb08d272070ae13"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ad8bccf78e7fc99d08387aec5015e8849" id="r_ad8bccf78e7fc99d08387aec5015e8849"><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="classgridfire_1_1reaction_1_1ReactionSet.html">reaction::ReactionSet</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1policy_1_1ReactionChainPolicy.html#ad8bccf78e7fc99d08387aec5015e8849">get_reactions</a> () const =0</td></tr>
|
||
|
|
<tr class="memdesc:ad8bccf78e7fc99d08387aec5015e8849"><td class="mdescLeft"> </td><td class="mdescRight">Returns the ReactionSet describing this chain. <br /></td></tr>
|
||
|
|
<tr class="separator:ad8bccf78e7fc99d08387aec5015e8849"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a0c9a42646920ac02c8d1e63dfe6f9461" id="r_a0c9a42646920ac02c8d1e63dfe6f9461"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1policy_1_1ReactionChainPolicy.html#a0c9a42646920ac02c8d1e63dfe6f9461">contains</a> (const std::string &id) const =0</td></tr>
|
||
|
|
<tr class="separator:a0c9a42646920ac02c8d1e63dfe6f9461"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a68239737ada169238251f1994680fc7e" id="r_a68239737ada169238251f1994680fc7e"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1policy_1_1ReactionChainPolicy.html#a68239737ada169238251f1994680fc7e">contains</a> (const <a class="el" href="classgridfire_1_1reaction_1_1Reaction.html">reaction::Reaction</a> &reaction) const =0</td></tr>
|
||
|
|
<tr class="separator:a68239737ada169238251f1994680fc7e"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ac24ff49b7715ad3eefea4bed1bf23686" id="r_ac24ff49b7715ad3eefea4bed1bf23686"><td class="memItemLeft" align="right" valign="top">virtual std::unique_ptr< <a class="el" href="classgridfire_1_1policy_1_1ReactionChainPolicy.html">ReactionChainPolicy</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1policy_1_1ReactionChainPolicy.html#ac24ff49b7715ad3eefea4bed1bf23686">clone</a> () const =0</td></tr>
|
||
|
|
<tr class="separator:ac24ff49b7715ad3eefea4bed1bf23686"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a41758d921a2d7e83f446aa4fec00d598" id="r_a41758d921a2d7e83f446aa4fec00d598"><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1policy_1_1ReactionChainPolicy.html#a41758d921a2d7e83f446aa4fec00d598">name</a> () const =0</td></tr>
|
||
|
|
<tr class="separator:a41758d921a2d7e83f446aa4fec00d598"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a5d1b5640d654f49399145f912e77c19b" id="r_a5d1b5640d654f49399145f912e77c19b"><td class="memItemLeft" align="right" valign="top">virtual uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1policy_1_1ReactionChainPolicy.html#a5d1b5640d654f49399145f912e77c19b">hash</a> (uint64_t seed) const =0</td></tr>
|
||
|
|
<tr class="separator:a5d1b5640d654f49399145f912e77c19b"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a30420a3881779c822ab06c0405ea7b28" id="r_a30420a3881779c822ab06c0405ea7b28"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1policy_1_1ReactionChainPolicy.html#a30420a3881779c822ab06c0405ea7b28">operator==</a> (const <a class="el" href="classgridfire_1_1policy_1_1ReactionChainPolicy.html">ReactionChainPolicy</a> &other) const =0</td></tr>
|
||
|
|
<tr class="separator:a30420a3881779c822ab06c0405ea7b28"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ac19e354a8bcd28f60783b70d8a761030" id="r_ac19e354a8bcd28f60783b70d8a761030"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1policy_1_1ReactionChainPolicy.html#ac19e354a8bcd28f60783b70d8a761030">operator!=</a> (const <a class="el" href="classgridfire_1_1policy_1_1ReactionChainPolicy.html">ReactionChainPolicy</a> &other) const =0</td></tr>
|
||
|
|
<tr class="separator:ac19e354a8bcd28f60783b70d8a761030"><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:a264e0d1d13c7d4d5f05bdda5d5ada5c0" id="r_a264e0d1d13c7d4d5f05bdda5d5ada5c0"><td class="memItemLeft" align="right" valign="top">std::ostream & </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1policy_1_1ReactionChainPolicy.html#a264e0d1d13c7d4d5f05bdda5d5ada5c0">operator<<</a> (std::ostream &os, const <a class="el" href="classgridfire_1_1policy_1_1ReactionChainPolicy.html">ReactionChainPolicy</a> &rcp)</td></tr>
|
||
|
|
<tr class="separator:a264e0d1d13c7d4d5f05bdda5d5ada5c0"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
</table>
|
||
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||
|
|
<div class="textblock"><p>Abstract interface encapsulating a set of reactions representing a single chain or pathway. </p>
|
||
|
|
<p><a class="el" href="classgridfire_1_1policy_1_1ReactionChainPolicy.html" title="Abstract interface encapsulating a set of reactions representing a single chain or pathway.">ReactionChainPolicy</a> implementations (see <code><a class="el" href="chains_8h.html" title="Concrete implementations of ReactionChainPolicy for key stellar reaction chains.">chains.h</a></code>) supply a ReactionSet describing the reactions that comprise a nuclear reaction chain (for example the proton-proton chain, CNO cycle, etc.).</p>
|
||
|
|
<dl class="section user"><dt>Example</dt><dd><div class="fragment"><div class="line"><a class="code hl_class" href="classgridfire_1_1policy_1_1ProtonProtonChainPolicy.html">ProtonProtonChainPolicy</a> pp;</div>
|
||
|
|
<div class="line"><span class="keyword">const</span> <a class="code hl_class" href="classgridfire_1_1reaction_1_1ReactionSet.html">gridfire::reaction::ReactionSet</a>& reactions = pp.<a class="code hl_function" href="classgridfire_1_1policy_1_1MultiReactionChainPolicy.html#ae689a0dfeb36f85ddc6db5a8dc4f630a">get_reactions</a>();</div>
|
||
|
|
<div class="ttc" id="aclassgridfire_1_1policy_1_1MultiReactionChainPolicy_html_ae689a0dfeb36f85ddc6db5a8dc4f630a"><div class="ttname"><a href="classgridfire_1_1policy_1_1MultiReactionChainPolicy.html#ae689a0dfeb36f85ddc6db5a8dc4f630a">gridfire::policy::MultiReactionChainPolicy::get_reactions</a></div><div class="ttdeci">const reaction::ReactionSet & get_reactions() const override</div><div class="ttdoc">Returns the combined ReactionSet of all child chain policies.</div><div class="ttdef"><b>Definition</b> policy_logical.cpp:20</div></div>
|
||
|
|
<div class="ttc" id="aclassgridfire_1_1policy_1_1ProtonProtonChainPolicy_html"><div class="ttname"><a href="classgridfire_1_1policy_1_1ProtonProtonChainPolicy.html">gridfire::policy::ProtonProtonChainPolicy</a></div><div class="ttdoc">Proton-Proton Chain Policy.</div><div class="ttdef"><b>Definition</b> chains.h:197</div></div>
|
||
|
|
<div class="ttc" id="aclassgridfire_1_1reaction_1_1ReactionSet_html"><div class="ttname"><a href="classgridfire_1_1reaction_1_1ReactionSet.html">gridfire::reaction::ReactionSet</a></div><div class="ttdef"><b>Definition</b> reaction.h:842</div></div>
|
||
|
|
</div><!-- fragment --></dd></dl>
|
||
|
|
<dl class="section note"><dt>Note</dt><dd>Concrete implementations may throw exceptions on construction if the underlying reaction database (e.g. REACLIB) does not include requested reactions. See <code><a class="el" href="chains_8h.html" title="Concrete implementations of ReactionChainPolicy for key stellar reaction chains.">chains.h</a></code> for details. </dd></dl>
|
||
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
||
|
|
<a id="aa3e6c1e4844fe788aeb08d272070ae13" name="aa3e6c1e4844fe788aeb08d272070ae13"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa3e6c1e4844fe788aeb08d272070ae13">◆ </a></span>~ReactionChainPolicy()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">virtual gridfire::policy::ReactionChainPolicy::~ReactionChainPolicy </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">default</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
||
|
|
<a id="ac24ff49b7715ad3eefea4bed1bf23686" name="ac24ff49b7715ad3eefea4bed1bf23686"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac24ff49b7715ad3eefea4bed1bf23686">◆ </a></span>clone()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">virtual std::unique_ptr< <a class="el" href="classgridfire_1_1policy_1_1ReactionChainPolicy.html">ReactionChainPolicy</a> > gridfire::policy::ReactionChainPolicy::clone </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td> const</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Implemented in <a class="el" href="classgridfire_1_1policy_1_1ProtonProtonIChainPolicy.html#affd234a60ba31decca25b3367c7ede5e">gridfire::policy::ProtonProtonIChainPolicy</a>, <a class="el" href="classgridfire_1_1policy_1_1ProtonProtonIIChainPolicy.html#ad70b081f8623fad207050c0f81f6a457">gridfire::policy::ProtonProtonIIChainPolicy</a>, <a class="el" href="classgridfire_1_1policy_1_1ProtonProtonIIIChainPolicy.html#ac84ab054fc0f600f783ea3282d6fd4f6">gridfire::policy::ProtonProtonIIIChainPolicy</a>, <a class="el" href="classgridfire_1_1policy_1_1CNOIChainPolicy.html#a83042f4626ec22810314fa5181d3392a">gridfire::policy::CNOIChainPolicy</a>, <a class="el" href="classgridfire_1_1policy_1_1CNOIIChainPolicy.html#ab3aa5daaf2d9274770f981d8f67ae20b">gridfire::policy::CNOIIChainPolicy</a>, <a class="el" href="classgridfire_1_1policy_1_1CNOIIIChainPolicy.html#a9c0e056615742b3d77f47b3eb676ff28">gridfire::policy::CNOIIIChainPolicy</a>, <a class="el" href="classgridfire_1_1policy_1_1CNOIVChainPolicy.html#a35bef8035035eb85bb188ede6045556c">gridfire::policy::CNOIVChainPolicy</a>, <a class="el" href="classgridfire_1_1policy_1_1HotCNOIChainPolicy.html#ae70a448fdeee35e159784fd6a506dce7">gridfire::policy::HotCNOIChainPolicy</a>, <a class="el" href="classgridfire_1_1policy_1_1HotCNOIIChainPolicy.html#afeb9b237b70963715adc64ad68e11675">gridfire::policy::HotCNOIIChainPolicy</a>, <a class="el" href="classgridfire_1_1policy_1_1HotCNOIIIChainPolicy.html#a5d86341bb4370647762c889519793d41">gridfire::policy::HotCNOIIIChainPolicy</a>, <a class="el" href="classgridfire_1_1policy_1_1TripleAlphaChainPolicy.html#a447ff0d2de9df09400e63f0fc087efa3">gridfire::policy::TripleAlphaChainPolicy</a>, <a class="el" href="classgridfire_1_1policy_1_1MultiReactionChainPolicy.html#ab3bbbf21164211a01c5398a0ee281bb2">gridfire::policy::MultiReactionChainPolicy</a>, and <a class="el" href="classPyReactionChainPolicy.html#a0b44991bd6a5edebb861e78a26f783cd">PyReactionChainPolicy</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a68239737ada169238251f1994680fc7e" name="a68239737ada169238251f1994680fc7e"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a68239737ada169238251f1994680fc7e">◆ </a></span>contains() <span class="overload">[1/2]</span></h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">virtual bool gridfire::policy::ReactionChainPolicy::contains </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">const <a class="el" href="classgridfire_1_1reaction_1_1Reaction.html">reaction::Reaction</a> & </td>
|
||
|
|
<td class="paramname"><em>reaction</em></td><td>)</td>
|
||
|
|
<td> const</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Implemented in <a class="el" href="classPyReactionChainPolicy.html#ab30925d8253ecdabb73ea2b116e9c7da">PyReactionChainPolicy</a>, <a class="el" href="classgridfire_1_1policy_1_1TemperatureDependentChainPolicy.html#a8984d58dee6865d4bd98aedf31bb445e">gridfire::policy::TemperatureDependentChainPolicy</a>, and <a class="el" href="classgridfire_1_1policy_1_1MultiReactionChainPolicy.html#a864a00097e80db7b0f3838d696aa9f5d">gridfire::policy::MultiReactionChainPolicy</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a0c9a42646920ac02c8d1e63dfe6f9461" name="a0c9a42646920ac02c8d1e63dfe6f9461"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0c9a42646920ac02c8d1e63dfe6f9461">◆ </a></span>contains() <span class="overload">[2/2]</span></h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">virtual bool gridfire::policy::ReactionChainPolicy::contains </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">const std::string & </td>
|
||
|
|
<td class="paramname"><em>id</em></td><td>)</td>
|
||
|
|
<td> const</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Implemented in <a class="el" href="classgridfire_1_1policy_1_1TemperatureDependentChainPolicy.html#a8869287d36b3ff143e7f84799ef35dd9">gridfire::policy::TemperatureDependentChainPolicy</a>, <a class="el" href="classgridfire_1_1policy_1_1MultiReactionChainPolicy.html#a792cf0af8e5c365d0332cd585968dae1">gridfire::policy::MultiReactionChainPolicy</a>, and <a class="el" href="classPyReactionChainPolicy.html#a16f289efd1d92eead3a3ca6fcfceba4d">PyReactionChainPolicy</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="ad8bccf78e7fc99d08387aec5015e8849" name="ad8bccf78e7fc99d08387aec5015e8849"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad8bccf78e7fc99d08387aec5015e8849">◆ </a></span>get_reactions()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">virtual const <a class="el" href="classgridfire_1_1reaction_1_1ReactionSet.html">reaction::ReactionSet</a> & gridfire::policy::ReactionChainPolicy::get_reactions </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td> const</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Returns the ReactionSet describing this chain. </p>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>const <a class="el" href="classgridfire_1_1reaction_1_1ReactionSet.html">reaction::ReactionSet</a>& reference to the chain's reactions.</dd></dl>
|
||
|
|
<dl class="section user"><dt>Example</dt><dd><div class="fragment"><div class="line"><span class="keyword">const</span> <a class="code hl_class" href="classgridfire_1_1reaction_1_1ReactionSet.html">reaction::ReactionSet</a> &set = chainPolicy.get_reactions();</div>
|
||
|
|
<div class="line">std::cout << <span class="stringliteral">"Chain contains "</span> << set.<a class="code hl_function" href="classgridfire_1_1reaction_1_1ReactionSet.html#af14cf34d7367cb6a6be5191724c2d4cf">size</a>() << <span class="stringliteral">" reactions\n"</span>;</div>
|
||
|
|
<div class="ttc" id="aclassgridfire_1_1reaction_1_1ReactionSet_html_af14cf34d7367cb6a6be5191724c2d4cf"><div class="ttname"><a href="classgridfire_1_1reaction_1_1ReactionSet.html#af14cf34d7367cb6a6be5191724c2d4cf">gridfire::reaction::ReactionSet::size</a></div><div class="ttdeci">size_t size() const</div><div class="ttdoc">Gets the number of reactions in the set.</div><div class="ttdef"><b>Definition</b> reaction.h:903</div></div>
|
||
|
|
</div><!-- fragment --></dd></dl>
|
||
|
|
<dl class="exception"><dt>Exceptions</dt><dd>
|
||
|
|
<table class="exception">
|
||
|
|
<tr><td class="paramname"><a class="el" href="classgridfire_1_1exceptions_1_1MissingBaseReactionError.html" title="Exception thrown when a required reaction is missing from the underlying database (e....">gridfire::exceptions::MissingBaseReactionError</a></td><td>may be thrown by concrete implementations at construction time if the required reactions cannot be found in the base reaction set. </td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<p>Implemented in <a class="el" href="classgridfire_1_1policy_1_1TemperatureDependentChainPolicy.html#ae93a5a2d753ddd32f2a4a5a750ef44b4">gridfire::policy::TemperatureDependentChainPolicy</a>, <a class="el" href="classgridfire_1_1policy_1_1MultiReactionChainPolicy.html#ae689a0dfeb36f85ddc6db5a8dc4f630a">gridfire::policy::MultiReactionChainPolicy</a>, and <a class="el" href="classPyReactionChainPolicy.html#a5fd4ff9137e1d76decf7318066d45969">PyReactionChainPolicy</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a5d1b5640d654f49399145f912e77c19b" name="a5d1b5640d654f49399145f912e77c19b"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5d1b5640d654f49399145f912e77c19b">◆ </a></span>hash()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">virtual uint64_t gridfire::policy::ReactionChainPolicy::hash </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">uint64_t </td>
|
||
|
|
<td class="paramname"><em>seed</em></td><td>)</td>
|
||
|
|
<td> const</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Implemented in <a class="el" href="classgridfire_1_1policy_1_1TemperatureDependentChainPolicy.html#a0b2c469f8e17ccba0f45632b19395731">gridfire::policy::TemperatureDependentChainPolicy</a>, <a class="el" href="classgridfire_1_1policy_1_1MultiReactionChainPolicy.html#ae5ac6534ec96cfcdefcad2f9694efd36">gridfire::policy::MultiReactionChainPolicy</a>, and <a class="el" href="classPyReactionChainPolicy.html#a42d2f71522e7f13624c2598597f14809">PyReactionChainPolicy</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a41758d921a2d7e83f446aa4fec00d598" name="a41758d921a2d7e83f446aa4fec00d598"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a41758d921a2d7e83f446aa4fec00d598">◆ </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">virtual std::string gridfire::policy::ReactionChainPolicy::name </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td> const</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Implemented in <a class="el" href="classgridfire_1_1policy_1_1ProtonProtonIChainPolicy.html#ab9542fd71e87159216cdd51501b6d1d3">gridfire::policy::ProtonProtonIChainPolicy</a>, <a class="el" href="classgridfire_1_1policy_1_1ProtonProtonIIChainPolicy.html#a2782c6abea3596cf566a246239b96f80">gridfire::policy::ProtonProtonIIChainPolicy</a>, <a class="el" href="classgridfire_1_1policy_1_1ProtonProtonIIIChainPolicy.html#a06d103e970b19c9a40cbae8d52ef0d0c">gridfire::policy::ProtonProtonIIIChainPolicy</a>, <a class="el" href="classgridfire_1_1policy_1_1ProtonProtonChainPolicy.html#a2e818c9a269bc859b01985fea8423ac0">gridfire::policy::ProtonProtonChainPolicy</a>, <a class="el" href="classgridfire_1_1policy_1_1CNOIChainPolicy.html#ad3d4721e3046d792c0aa8e5c6c99aa2d">gridfire::policy::CNOIChainPolicy</a>, <a class="el" href="classgridfire_1_1policy_1_1CNOIIChainPolicy.html#a6bf1057d28cb37db4f9ffde9cb3815ed">gridfire::policy::CNOIIChainPolicy</a>, <a class="el" href="classgridfire_1_1policy_1_1CNOIIIChainPolicy.html#a96abfb16ec2b692c070da139444435e3">gridfire::policy::CNOIIIChainPolicy</a>, <a class="el" href="classgridfire_1_1policy_1_1CNOIVChainPolicy.html#a101a884a8ead5d961fd5d43a0dbffde8">gridfire::policy::CNOIVChainPolicy</a>, <a class="el" href="classgridfire_1_1policy_1_1CNOChainPolicy.html#a66511726b37f0e114cba2dd15db42440">gridfire::policy::CNOChainPolicy</a>, <a class="el" href="classgridfire_1_1policy_1_1HotCNOIChainPolicy.html#a13b2857d96e42f162888dcc294a27b9b">gridfire::policy::HotCNOIChainPolicy</a>, <a class="el" href="classgridfire_1_1policy_1_1HotCNOIIChainPolicy.html#a262a18dafbc68db925beefb14c43668f">gridfire::policy::HotCNOIIChainPolicy</a>, <a class="el" href="classgridfire_1_1policy_1_1HotCNOIIIChainPolicy.html#a59168da23f2d6b4d8667f5118153b514">gridfire::policy::HotCNOIIIChainPolicy</a>, <a class="el" href="classgridfire_1_1policy_1_1HotCNOChainPolicy.html#a95e2f3c1a32b3f2dd5d5601c2a81f42f">gridfire::policy::HotCNOChainPolicy</a>, <a class="el" href="classgridfire_1_1policy_1_1TripleAlphaChainPolicy.html#a2d6543b9fa7f96b8b21d7e7545f9a22d">gridfire::policy::TripleAlphaChainPolicy</a>, <a class="el" href="classgridfire_1_1policy_1_1MainSequenceReactionChainPolicy.html#a7411e9a885d7ebb79590d8e1c5834881">gridfire::policy::MainSequenceReactionChainPolicy</a>, <a class="el" href="classgridfire_1_1policy_1_1MultiReactionChainPolicy.html#ac21f837d0d452d32588451f48d5482e6">gridfire::policy::MultiReactionChainPolicy</a>, and <a class="el" href="classPyReactionChainPolicy.html#af148bf87fea9ebe61de745913a2fd504">PyReactionChainPolicy</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="ac19e354a8bcd28f60783b70d8a761030" name="ac19e354a8bcd28f60783b70d8a761030"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac19e354a8bcd28f60783b70d8a761030">◆ </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">virtual bool gridfire::policy::ReactionChainPolicy::operator!= </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">const <a class="el" href="classgridfire_1_1policy_1_1ReactionChainPolicy.html">ReactionChainPolicy</a> & </td>
|
||
|
|
<td class="paramname"><em>other</em></td><td>)</td>
|
||
|
|
<td> const</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Implemented in <a class="el" href="classgridfire_1_1policy_1_1TemperatureDependentChainPolicy.html#a264dc45c3410ab3ec49a340633aa5950">gridfire::policy::TemperatureDependentChainPolicy</a>, and <a class="el" href="classgridfire_1_1policy_1_1MultiReactionChainPolicy.html#aa36844fe4417617175d31124e541da50">gridfire::policy::MultiReactionChainPolicy</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a30420a3881779c822ab06c0405ea7b28" name="a30420a3881779c822ab06c0405ea7b28"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a30420a3881779c822ab06c0405ea7b28">◆ </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">virtual bool gridfire::policy::ReactionChainPolicy::operator== </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">const <a class="el" href="classgridfire_1_1policy_1_1ReactionChainPolicy.html">ReactionChainPolicy</a> & </td>
|
||
|
|
<td class="paramname"><em>other</em></td><td>)</td>
|
||
|
|
<td> const</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Implemented in <a class="el" href="classgridfire_1_1policy_1_1TemperatureDependentChainPolicy.html#add9c0230ad7c3e6e2cb182bdb4849c52">gridfire::policy::TemperatureDependentChainPolicy</a>, and <a class="el" href="classgridfire_1_1policy_1_1MultiReactionChainPolicy.html#abc3ed7c255b3e6c06e292aee8ef7f46d">gridfire::policy::MultiReactionChainPolicy</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<h2 class="groupheader">Friends And Related Symbol Documentation</h2>
|
||
|
|
<a id="a264e0d1d13c7d4d5f05bdda5d5ada5c0" name="a264e0d1d13c7d4d5f05bdda5d5ada5c0"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a264e0d1d13c7d4d5f05bdda5d5ada5c0">◆ </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"><em>os</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">const <a class="el" href="classgridfire_1_1policy_1_1ReactionChainPolicy.html">ReactionChainPolicy</a> & </td>
|
||
|
|
<td class="paramname"><em>rcp</em> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">friend</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
||
|
|
<li>src/include/gridfire/policy/<a class="el" href="policy__abstract_8h.html">policy_abstract.h</a></li>
|
||
|
|
</ul>
|
||
|
|
</div><!-- contents -->
|
||
|
|
</div><!-- doc-content -->
|
||
|
|
<!-- start footer part -->
|
||
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||
|
|
<ul>
|
||
|
|
<li class="navelem"><a class="el" href="namespacegridfire.html">gridfire</a></li><li class="navelem"><a class="el" href="namespacegridfire_1_1policy.html">policy</a></li><li class="navelem"><a class="el" href="classgridfire_1_1policy_1_1ReactionChainPolicy.html">ReactionChainPolicy</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.9.8 </li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|