tboudreaux/GridFire
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
75a88b97207e31ec8695e619f5392ccbcc6af3ab
GridFire/docs/html/classgridfire_1_1policy_1_1TemperatureDependentChainPolicy.html

675 lines
38 KiB
HTML
Raw Blame History

<!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::TemperatureDependentChainPolicy 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">&#160;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&amp;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&amp;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&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('classgridfire_1_1policy_1_1TemperatureDependentChainPolicy.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="#nested-classes">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classgridfire_1_1policy_1_1TemperatureDependentChainPolicy-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">gridfire::policy::TemperatureDependentChainPolicy Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Base class for reaction chain policies that are active only within specific temperature ranges.
<a href="classgridfire_1_1policy_1_1TemperatureDependentChainPolicy.html#details">More...</a></p>
<p><code>#include &lt;chains.h&gt;</code></p>
<div class="dynheader">
Inheritance diagram for gridfire::policy::TemperatureDependentChainPolicy:</div>
<div class="dyncontent">
<div class="center"><div class="zoom"><iframe scrolling="no" frameborder="0" src="classgridfire_1_1policy_1_1TemperatureDependentChainPolicy__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>
<div class="dynheader">
Collaboration diagram for gridfire::policy::TemperatureDependentChainPolicy:</div>
<div class="dyncontent">
<div class="center"><div class="zoom"><iframe scrolling="no" frameborder="0" src="classgridfire_1_1policy_1_1TemperatureDependentChainPolicy__coll__graph.svg" width="100%" height="524"><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="nested-classes" name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgridfire_1_1policy_1_1TemperatureDependentChainPolicy_1_1ActiveTempRange.html">ActiveTempRange</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Struct to hold the active temperature range for the reaction chain. <a href="structgridfire_1_1policy_1_1TemperatureDependentChainPolicy_1_1ActiveTempRange.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a07f5a057d382874ec641b3494338dc65" id="r_a07f5a057d382874ec641b3494338dc65"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1policy_1_1TemperatureDependentChainPolicy.html#a07f5a057d382874ec641b3494338dc65">TemperatureDependentChainPolicy</a> (const std::vector&lt; std::string &gt; &amp;reactionIDs)</td></tr>
<tr class="memdesc:a07f5a057d382874ec641b3494338dc65"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct a new Temperature Dependent Chain Policy object. <br /></td></tr>
<tr class="separator:a07f5a057d382874ec641b3494338dc65"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab7f64e19d0ce405aba55b518ed301b92" id="r_ab7f64e19d0ce405aba55b518ed301b92"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1policy_1_1TemperatureDependentChainPolicy.html#ab7f64e19d0ce405aba55b518ed301b92">TemperatureDependentChainPolicy</a> (const std::vector&lt; std::string &gt; &amp;reactionIDs, std::optional&lt; double &gt; minT9)</td></tr>
<tr class="memdesc:ab7f64e19d0ce405aba55b518ed301b92"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct a new Temperature Dependent Chain Policy object. <br /></td></tr>
<tr class="separator:ab7f64e19d0ce405aba55b518ed301b92"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4886c44a082151ebf7b75594dbc6856b" id="r_a4886c44a082151ebf7b75594dbc6856b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1policy_1_1TemperatureDependentChainPolicy.html#a4886c44a082151ebf7b75594dbc6856b">TemperatureDependentChainPolicy</a> (const std::vector&lt; std::string &gt; &amp;reactionIDs, std::optional&lt; double &gt; minT9, std::optional&lt; double &gt; maxT9)</td></tr>
<tr class="memdesc:a4886c44a082151ebf7b75594dbc6856b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct a new Temperature Dependent Chain Policy object. <br /></td></tr>
<tr class="separator:a4886c44a082151ebf7b75594dbc6856b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a74b59b1cb02703834373fb7a3d09614e" id="r_a74b59b1cb02703834373fb7a3d09614e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1policy_1_1TemperatureDependentChainPolicy.html#a74b59b1cb02703834373fb7a3d09614e">~TemperatureDependentChainPolicy</a> () override=default</td></tr>
<tr class="memdesc:a74b59b1cb02703834373fb7a3d09614e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Virtual destructor. <br /></td></tr>
<tr class="separator:a74b59b1cb02703834373fb7a3d09614e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae93a5a2d753ddd32f2a4a5a750ef44b4" id="r_ae93a5a2d753ddd32f2a4a5a750ef44b4"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classgridfire_1_1reaction_1_1ReactionSet.html">reaction::ReactionSet</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1policy_1_1TemperatureDependentChainPolicy.html#ae93a5a2d753ddd32f2a4a5a750ef44b4">get_reactions</a> () const override</td></tr>
<tr class="memdesc:ae93a5a2d753ddd32f2a4a5a750ef44b4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the reactions that comprise the chain. <br /></td></tr>
<tr class="separator:ae93a5a2d753ddd32f2a4a5a750ef44b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8869287d36b3ff143e7f84799ef35dd9" id="r_a8869287d36b3ff143e7f84799ef35dd9"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1policy_1_1TemperatureDependentChainPolicy.html#a8869287d36b3ff143e7f84799ef35dd9">contains</a> (const std::string &amp;id) const override</td></tr>
<tr class="memdesc:a8869287d36b3ff143e7f84799ef35dd9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if a reaction or reaction ID is part of the chain. <br /></td></tr>
<tr class="separator:a8869287d36b3ff143e7f84799ef35dd9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8984d58dee6865d4bd98aedf31bb445e" id="r_a8984d58dee6865d4bd98aedf31bb445e"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1policy_1_1TemperatureDependentChainPolicy.html#a8984d58dee6865d4bd98aedf31bb445e">contains</a> (const <a class="el" href="classgridfire_1_1reaction_1_1Reaction.html">reaction::Reaction</a> &amp;reaction) const override</td></tr>
<tr class="memdesc:a8984d58dee6865d4bd98aedf31bb445e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if a reaction is part of the chain. <br /></td></tr>
<tr class="separator:a8984d58dee6865d4bd98aedf31bb445e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0b2c469f8e17ccba0f45632b19395731" id="r_a0b2c469f8e17ccba0f45632b19395731"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1policy_1_1TemperatureDependentChainPolicy.html#a0b2c469f8e17ccba0f45632b19395731">hash</a> (uint64_t seed) const override</td></tr>
<tr class="memdesc:a0b2c469f8e17ccba0f45632b19395731"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generate the hash for the reaction chain policy. <br /></td></tr>
<tr class="separator:a0b2c469f8e17ccba0f45632b19395731"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:add9c0230ad7c3e6e2cb182bdb4849c52" id="r_add9c0230ad7c3e6e2cb182bdb4849c52"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1policy_1_1TemperatureDependentChainPolicy.html#add9c0230ad7c3e6e2cb182bdb4849c52">operator==</a> (const <a class="el" href="classgridfire_1_1policy_1_1ReactionChainPolicy.html">ReactionChainPolicy</a> &amp;other) const override</td></tr>
<tr class="memdesc:add9c0230ad7c3e6e2cb182bdb4849c52"><td class="mdescLeft">&#160;</td><td class="mdescRight">Equality operator. <br /></td></tr>
<tr class="separator:add9c0230ad7c3e6e2cb182bdb4849c52"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a264dc45c3410ab3ec49a340633aa5950" id="r_a264dc45c3410ab3ec49a340633aa5950"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1policy_1_1TemperatureDependentChainPolicy.html#a264dc45c3410ab3ec49a340633aa5950">operator!=</a> (const <a class="el" href="classgridfire_1_1policy_1_1ReactionChainPolicy.html">ReactionChainPolicy</a> &amp;other) const override</td></tr>
<tr class="memdesc:a264dc45c3410ab3ec49a340633aa5950"><td class="mdescLeft">&#160;</td><td class="mdescRight">Inequality operator. <br /></td></tr>
<tr class="separator:a264dc45c3410ab3ec49a340633aa5950"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2e10b0f832b1addbaa90c14363732c7a" id="r_a2e10b0f832b1addbaa90c14363732c7a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1policy_1_1TemperatureDependentChainPolicy.html#a2e10b0f832b1addbaa90c14363732c7a">is_active</a> (double T9) const</td></tr>
<tr class="memdesc:a2e10b0f832b1addbaa90c14363732c7a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if the reaction chain is active at a given temperature. <br /></td></tr>
<tr class="separator:a2e10b0f832b1addbaa90c14363732c7a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classgridfire_1_1policy_1_1ReactionChainPolicy"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classgridfire_1_1policy_1_1ReactionChainPolicy')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classgridfire_1_1policy_1_1ReactionChainPolicy.html">gridfire::policy::ReactionChainPolicy</a></td></tr>
<tr class="memitem:aa3e6c1e4844fe788aeb08d272070ae13 inherit pub_methods_classgridfire_1_1policy_1_1ReactionChainPolicy" id="r_aa3e6c1e4844fe788aeb08d272070ae13"><td class="memItemLeft" align="right" valign="top">virtual&#160;</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 inherit pub_methods_classgridfire_1_1policy_1_1ReactionChainPolicy"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac24ff49b7715ad3eefea4bed1bf23686 inherit pub_methods_classgridfire_1_1policy_1_1ReactionChainPolicy" id="r_ac24ff49b7715ad3eefea4bed1bf23686"><td class="memItemLeft" align="right" valign="top">virtual std::unique_ptr&lt; <a class="el" href="classgridfire_1_1policy_1_1ReactionChainPolicy.html">ReactionChainPolicy</a> &gt;&#160;</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 inherit pub_methods_classgridfire_1_1policy_1_1ReactionChainPolicy"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a41758d921a2d7e83f446aa4fec00d598 inherit pub_methods_classgridfire_1_1policy_1_1ReactionChainPolicy" id="r_a41758d921a2d7e83f446aa4fec00d598"><td class="memItemLeft" align="right" valign="top">virtual std::string&#160;</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 inherit pub_methods_classgridfire_1_1policy_1_1ReactionChainPolicy"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-attribs" name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a22d731c0a0bf804f7c8b0e22cf13b688" id="r_a22d731c0a0bf804f7c8b0e22cf13b688"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structgridfire_1_1policy_1_1TemperatureDependentChainPolicy_1_1ActiveTempRange.html">ActiveTempRange</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1policy_1_1TemperatureDependentChainPolicy.html#a22d731c0a0bf804f7c8b0e22cf13b688">m_tempRange</a></td></tr>
<tr class="memdesc:a22d731c0a0bf804f7c8b0e22cf13b688"><td class="mdescLeft">&#160;</td><td class="mdescRight">Active temperature range for the reaction chain. <br /></td></tr>
<tr class="separator:a22d731c0a0bf804f7c8b0e22cf13b688"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a69882ddefb0f27b13433616411a1484a" id="r_a69882ddefb0f27b13433616411a1484a"><td class="memItemLeft" align="right" valign="top">std::vector&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1policy_1_1TemperatureDependentChainPolicy.html#a69882ddefb0f27b13433616411a1484a">m_reactionIDs</a></td></tr>
<tr class="memdesc:a69882ddefb0f27b13433616411a1484a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Vector of reaction IDs that comprise the chain. <br /></td></tr>
<tr class="separator:a69882ddefb0f27b13433616411a1484a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad9cd9e4826f60e066feda2ffc5d37338" id="r_ad9cd9e4826f60e066feda2ffc5d37338"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgridfire_1_1reaction_1_1ReactionSet.html">reaction::ReactionSet</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1policy_1_1TemperatureDependentChainPolicy.html#ad9cd9e4826f60e066feda2ffc5d37338">m_reactions</a></td></tr>
<tr class="memdesc:ad9cd9e4826f60e066feda2ffc5d37338"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set of reactions that comprise the chain. <br /></td></tr>
<tr class="separator:ad9cd9e4826f60e066feda2ffc5d37338"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Base class for reaction chain policies that are active only within specific temperature ranges. </p>
<p>Such chains may only operate effectively within certain temperature regimes, reflecting the physical conditions required for the reactions to proceed. This class allows defining such temperature-dependent behavior. This is one of the locations where domain specific knowledge is allowed within GridFire. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a07f5a057d382874ec641b3494338dc65" name="a07f5a057d382874ec641b3494338dc65"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a07f5a057d382874ec641b3494338dc65">&#9670;&#160;</a></span>TemperatureDependentChainPolicy() <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">gridfire::policy::TemperatureDependentChainPolicy::TemperatureDependentChainPolicy </td>
<td>(</td>
<td class="paramtype">const std::vector&lt; std::string &gt; &amp;&#160;</td>
<td class="paramname"><em>reactionIDs</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct a new Temperature Dependent Chain Policy object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">reactionIDs</td><td>Vector of reaction IDs that comprise the chain</td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>The chain is considered active at all temperatures if no min/max T9 are provided. </dd></dl>
</div>
</div>
<a id="ab7f64e19d0ce405aba55b518ed301b92" name="ab7f64e19d0ce405aba55b518ed301b92"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab7f64e19d0ce405aba55b518ed301b92">&#9670;&#160;</a></span>TemperatureDependentChainPolicy() <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">gridfire::policy::TemperatureDependentChainPolicy::TemperatureDependentChainPolicy </td>
<td>(</td>
<td class="paramtype">const std::vector&lt; std::string &gt; &amp;&#160;</td>
<td class="paramname"><em>reactionIDs</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::optional&lt; double &gt;&#160;</td>
<td class="paramname"><em>minT9</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct a new Temperature Dependent Chain Policy object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">reactionIDs</td><td>Vector of reaction IDs that comprise the chain </td></tr>
<tr><td class="paramname">minT9</td><td>Minimum temperature (in T9) for which the chain is active</td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>The chain is considered active at all temperatures above minT9. </dd></dl>
</div>
</div>
<a id="a4886c44a082151ebf7b75594dbc6856b" name="a4886c44a082151ebf7b75594dbc6856b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4886c44a082151ebf7b75594dbc6856b">&#9670;&#160;</a></span>TemperatureDependentChainPolicy() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">gridfire::policy::TemperatureDependentChainPolicy::TemperatureDependentChainPolicy </td>
<td>(</td>
<td class="paramtype">const std::vector&lt; std::string &gt; &amp;&#160;</td>
<td class="paramname"><em>reactionIDs</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::optional&lt; double &gt;&#160;</td>
<td class="paramname"><em>minT9</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::optional&lt; double &gt;&#160;</td>
<td class="paramname"><em>maxT9</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct a new Temperature Dependent Chain Policy object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">reactionIDs</td><td>Vector of reaction IDs that comprise the chain </td></tr>
<tr><td class="paramname">minT9</td><td>Minimum temperature (in T9) for which the chain is active </td></tr>
<tr><td class="paramname">maxT9</td><td>Maximum temperature (in T9) for which the chain is active </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a74b59b1cb02703834373fb7a3d09614e" name="a74b59b1cb02703834373fb7a3d09614e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a74b59b1cb02703834373fb7a3d09614e">&#9670;&#160;</a></span>~TemperatureDependentChainPolicy()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">gridfire::policy::TemperatureDependentChainPolicy::~TemperatureDependentChainPolicy </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Virtual destructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a8984d58dee6865d4bd98aedf31bb445e" name="a8984d58dee6865d4bd98aedf31bb445e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8984d58dee6865d4bd98aedf31bb445e">&#9670;&#160;</a></span>contains() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool gridfire::policy::TemperatureDependentChainPolicy::contains </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classgridfire_1_1reaction_1_1Reaction.html">reaction::Reaction</a> &amp;&#160;</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">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if a reaction is part of the chain. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">reaction</td><td>The reaction to check </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if the reaction is part of the chain, false otherwise </dd></dl>
<p>Implements <a class="el" href="classgridfire_1_1policy_1_1ReactionChainPolicy.html#a68239737ada169238251f1994680fc7e">gridfire::policy::ReactionChainPolicy</a>.</p>
</div>
</div>
<a id="a8869287d36b3ff143e7f84799ef35dd9" name="a8869287d36b3ff143e7f84799ef35dd9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8869287d36b3ff143e7f84799ef35dd9">&#9670;&#160;</a></span>contains() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool gridfire::policy::TemperatureDependentChainPolicy::contains </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</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">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if a reaction or reaction ID is part of the chain. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">id</td><td>The reaction ID to check </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if the reaction ID is part of the chain, false otherwise </dd></dl>
<p>Implements <a class="el" href="classgridfire_1_1policy_1_1ReactionChainPolicy.html#a0c9a42646920ac02c8d1e63dfe6f9461">gridfire::policy::ReactionChainPolicy</a>.</p>
</div>
</div>
<a id="ae93a5a2d753ddd32f2a4a5a750ef44b4" name="ae93a5a2d753ddd32f2a4a5a750ef44b4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae93a5a2d753ddd32f2a4a5a750ef44b4">&#9670;&#160;</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">const <a class="el" href="classgridfire_1_1reaction_1_1ReactionSet.html">reaction::ReactionSet</a> &amp; gridfire::policy::TemperatureDependentChainPolicy::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">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the reactions that comprise the chain. </p>
<dl class="section return"><dt>Returns</dt><dd>The set of reactions comprising the chain </dd></dl>
<p>Implements <a class="el" href="classgridfire_1_1policy_1_1ReactionChainPolicy.html#ad8bccf78e7fc99d08387aec5015e8849">gridfire::policy::ReactionChainPolicy</a>.</p>
</div>
</div>
<a id="a0b2c469f8e17ccba0f45632b19395731" name="a0b2c469f8e17ccba0f45632b19395731"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0b2c469f8e17ccba0f45632b19395731">&#9670;&#160;</a></span>hash()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint64_t gridfire::policy::TemperatureDependentChainPolicy::hash </td>
<td>(</td>
<td class="paramtype">uint64_t&#160;</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">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Generate the hash for the reaction chain policy. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">seed</td><td>Seed value for the hash </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Unique hash representing the reaction chain policy. XXHash64 is used internally for speed and collision resistance. </dd></dl>
<p>Implements <a class="el" href="classgridfire_1_1policy_1_1ReactionChainPolicy.html#a5d1b5640d654f49399145f912e77c19b">gridfire::policy::ReactionChainPolicy</a>.</p>
</div>
</div>
<a id="a2e10b0f832b1addbaa90c14363732c7a" name="a2e10b0f832b1addbaa90c14363732c7a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2e10b0f832b1addbaa90c14363732c7a">&#9670;&#160;</a></span>is_active()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool gridfire::policy::TemperatureDependentChainPolicy::is_active </td>
<td>(</td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>T9</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if the reaction chain is active at a given temperature. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">T9</td><td>Temperature in billions of Kelvin (T9) </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if the chain is active at the given temperature, false otherwise </dd></dl>
</div>
</div>
<a id="a264dc45c3410ab3ec49a340633aa5950" name="a264dc45c3410ab3ec49a340633aa5950"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a264dc45c3410ab3ec49a340633aa5950">&#9670;&#160;</a></span>operator!=()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool gridfire::policy::TemperatureDependentChainPolicy::operator!= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classgridfire_1_1policy_1_1ReactionChainPolicy.html">ReactionChainPolicy</a> &amp;&#160;</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">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Inequality operator. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">other</td><td>The other <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> to compare against </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if the two policies are not equal, false otherwise </dd></dl>
<p>Implements <a class="el" href="classgridfire_1_1policy_1_1ReactionChainPolicy.html#ac19e354a8bcd28f60783b70d8a761030">gridfire::policy::ReactionChainPolicy</a>.</p>
</div>
</div>
<a id="add9c0230ad7c3e6e2cb182bdb4849c52" name="add9c0230ad7c3e6e2cb182bdb4849c52"></a>
<h2 class="memtitle"><span class="permalink"><a href="#add9c0230ad7c3e6e2cb182bdb4849c52">&#9670;&#160;</a></span>operator==()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool gridfire::policy::TemperatureDependentChainPolicy::operator== </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classgridfire_1_1policy_1_1ReactionChainPolicy.html">ReactionChainPolicy</a> &amp;&#160;</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">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Equality operator. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">other</td><td>The other <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> to compare against </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if the two policies are equal, false otherwise </dd></dl>
<p>Implements <a class="el" href="classgridfire_1_1policy_1_1ReactionChainPolicy.html#a30420a3881779c822ab06c0405ea7b28">gridfire::policy::ReactionChainPolicy</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a69882ddefb0f27b13433616411a1484a" name="a69882ddefb0f27b13433616411a1484a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a69882ddefb0f27b13433616411a1484a">&#9670;&#160;</a></span>m_reactionIDs</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::vector&lt;std::string&gt; gridfire::policy::TemperatureDependentChainPolicy::m_reactionIDs</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Vector of reaction IDs that comprise the chain. </p>
</div>
</div>
<a id="ad9cd9e4826f60e066feda2ffc5d37338" name="ad9cd9e4826f60e066feda2ffc5d37338"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad9cd9e4826f60e066feda2ffc5d37338">&#9670;&#160;</a></span>m_reactions</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classgridfire_1_1reaction_1_1ReactionSet.html">reaction::ReactionSet</a> gridfire::policy::TemperatureDependentChainPolicy::m_reactions</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Set of reactions that comprise the chain. </p>
</div>
</div>
<a id="a22d731c0a0bf804f7c8b0e22cf13b688" name="a22d731c0a0bf804f7c8b0e22cf13b688"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a22d731c0a0bf804f7c8b0e22cf13b688">&#9670;&#160;</a></span>m_tempRange</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structgridfire_1_1policy_1_1TemperatureDependentChainPolicy_1_1ActiveTempRange.html">ActiveTempRange</a> gridfire::policy::TemperatureDependentChainPolicy::m_tempRange</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Active temperature range for the reaction chain. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>src/include/gridfire/policy/<a class="el" href="chains_8h.html">chains.h</a></li>
<li>src/lib/policy/<a class="el" href="chains_8cpp.html">chains.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_1policy.html">policy</a></li><li class="navelem"><a class="el" href="classgridfire_1_1policy_1_1TemperatureDependentChainPolicy.html">TemperatureDependentChainPolicy</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>
Reference in New Issue View Git Blame Copy Permalink