763 lines
46 KiB
HTML
763 lines
46 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::MainSequencePolicy 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_1MainSequencePolicy.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="#pri-methods">Private Member Functions</a> |
|
|
<a href="#pri-static-methods">Static Private Member Functions</a> |
|
|
<a href="#pri-attribs">Private Attributes</a> |
|
|
<a href="classgridfire_1_1policy_1_1MainSequencePolicy-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">gridfire::policy::MainSequencePolicy Class Reference<span class="mlabels"><span class="mlabel">final</span></span></div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>A <a class="el" href="classgridfire_1_1policy_1_1NetworkPolicy.html" title="Abstract interface for policies that construct DynamicEngine networks from a seed composition.">NetworkPolicy</a> for building reaction networks suitable for low-mass main-sequence stars.
|
|
<a href="classgridfire_1_1policy_1_1MainSequencePolicy.html#details">More...</a></p>
|
|
|
|
<p><code>#include <stellar_policy.h></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for gridfire::policy::MainSequencePolicy:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><iframe scrolling="no" frameborder="0" src="classgridfire_1_1policy_1_1MainSequencePolicy__inherit__graph.svg" width="228" height="139"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></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::MainSequencePolicy:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><div class="zoom"><iframe scrolling="no" frameborder="0" src="classgridfire_1_1policy_1_1MainSequencePolicy__coll__graph.svg" width="100%" height="580"><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:acd3224e5781f3d19a8ff300b7fd9a21c" id="r_acd3224e5781f3d19a8ff300b7fd9a21c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1policy_1_1MainSequencePolicy.html#acd3224e5781f3d19a8ff300b7fd9a21c">MainSequencePolicy</a> (const fourdst::composition::Composition &composition)</td></tr>
|
|
<tr class="memdesc:acd3224e5781f3d19a8ff300b7fd9a21c"><td class="mdescLeft"> </td><td class="mdescRight">Constructs the policy from an existing composition object. <br /></td></tr>
|
|
<tr class="separator:acd3224e5781f3d19a8ff300b7fd9a21c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0fcac0f9d41917f888788a772daaaebc" id="r_a0fcac0f9d41917f888788a772daaaebc"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1policy_1_1MainSequencePolicy.html#a0fcac0f9d41917f888788a772daaaebc">MainSequencePolicy</a> (std::vector< fourdst::atomic::Species > seed_species, const std::vector< double > &mass_fractions)</td></tr>
|
|
<tr class="memdesc:a0fcac0f9d41917f888788a772daaaebc"><td class="mdescLeft"> </td><td class="mdescRight">Constructs the policy from a list of species and their mass fractions. <br /></td></tr>
|
|
<tr class="separator:a0fcac0f9d41917f888788a772daaaebc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6520ddfead2ba2700e2b1329774b4ff6" id="r_a6520ddfead2ba2700e2b1329774b4ff6"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1policy_1_1MainSequencePolicy.html#a6520ddfead2ba2700e2b1329774b4ff6">name</a> () const override</td></tr>
|
|
<tr class="memdesc:a6520ddfead2ba2700e2b1329774b4ff6"><td class="mdescLeft"> </td><td class="mdescRight">Returns the name of the policy. <br /></td></tr>
|
|
<tr class="separator:a6520ddfead2ba2700e2b1329774b4ff6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a041b0a99120efdc6abae312c568a9e15" id="r_a041b0a99120efdc6abae312c568a9e15"><td class="memItemLeft" align="right" valign="top">const std::set< fourdst::atomic::Species > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1policy_1_1MainSequencePolicy.html#a041b0a99120efdc6abae312c568a9e15">get_seed_species</a> () const override</td></tr>
|
|
<tr class="memdesc:a041b0a99120efdc6abae312c568a9e15"><td class="mdescLeft"> </td><td class="mdescRight">Returns the set of seed species required by this policy. <br /></td></tr>
|
|
<tr class="separator:a041b0a99120efdc6abae312c568a9e15"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adcefccb171b339350a9b4a61d89adbbc" id="r_adcefccb171b339350a9b4a61d89adbbc"><td class="memItemLeft" align="right" valign="top">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_1MainSequencePolicy.html#adcefccb171b339350a9b4a61d89adbbc">get_seed_reactions</a> () const override</td></tr>
|
|
<tr class="memdesc:adcefccb171b339350a9b4a61d89adbbc"><td class="mdescLeft"> </td><td class="mdescRight">Returns the set of seed reactions required by this policy (from the PP and CNO chains). <br /></td></tr>
|
|
<tr class="separator:adcefccb171b339350a9b4a61d89adbbc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa9b4e39dacada73756bfd78885da60bd" id="r_aa9b4e39dacada73756bfd78885da60bd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgridfire_1_1engine_1_1DynamicEngine.html">engine::DynamicEngine</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1policy_1_1MainSequencePolicy.html#aa9b4e39dacada73756bfd78885da60bd">construct</a> () override</td></tr>
|
|
<tr class="memdesc:aa9b4e39dacada73756bfd78885da60bd"><td class="mdescLeft"> </td><td class="mdescRight">Constructs and returns the complete, multi-layered dynamic engine. <br /></td></tr>
|
|
<tr class="separator:aa9b4e39dacada73756bfd78885da60bd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1ecfb6ea2e18e8cf55228f80ee5c50ed" id="r_a1ecfb6ea2e18e8cf55228f80ee5c50ed"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacegridfire_1_1policy.html#a0f52cd334fb84998d9c68430a41f6109">NetworkPolicyStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1policy_1_1MainSequencePolicy.html#a1ecfb6ea2e18e8cf55228f80ee5c50ed">get_status</a> () const override</td></tr>
|
|
<tr class="memdesc:a1ecfb6ea2e18e8cf55228f80ee5c50ed"><td class="mdescLeft"> </td><td class="mdescRight">Gets the current status of the policy. <br /></td></tr>
|
|
<tr class="separator:a1ecfb6ea2e18e8cf55228f80ee5c50ed"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a43724347608826a613f6c65385050186" id="r_a43724347608826a613f6c65385050186"><td class="memItemLeft" align="right" valign="top">const std::vector< std::unique_ptr< <a class="el" href="classgridfire_1_1engine_1_1DynamicEngine.html">engine::DynamicEngine</a> > > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1policy_1_1MainSequencePolicy.html#a43724347608826a613f6c65385050186">get_engine_stack</a> () const override</td></tr>
|
|
<tr class="separator:a43724347608826a613f6c65385050186"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a70c617ea5b13a1cdc62fbfe21963098c" id="r_a70c617ea5b13a1cdc62fbfe21963098c"><td class="memItemLeft" align="right" valign="top">std::vector< <a class="el" href="namespacegridfire_1_1engine.html#a5387db1ec0b039955487fbc4c0034854">engine::EngineTypes</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1policy_1_1MainSequencePolicy.html#a70c617ea5b13a1cdc62fbfe21963098c">get_engine_types_stack</a> () const override</td></tr>
|
|
<tr class="separator:a70c617ea5b13a1cdc62fbfe21963098c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8dbef0e799968af4103e184b6e30c221" id="r_a8dbef0e799968af4103e184b6e30c221"><td class="memItemLeft" align="right" valign="top">const std::unique_ptr< <a class="el" href="classgridfire_1_1partition_1_1PartitionFunction.html">partition::PartitionFunction</a> > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1policy_1_1MainSequencePolicy.html#a8dbef0e799968af4103e184b6e30c221">get_partition_function</a> () const override</td></tr>
|
|
<tr class="separator:a8dbef0e799968af4103e184b6e30c221"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_classgridfire_1_1policy_1_1NetworkPolicy"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classgridfire_1_1policy_1_1NetworkPolicy')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classgridfire_1_1policy_1_1NetworkPolicy.html">gridfire::policy::NetworkPolicy</a></td></tr>
|
|
<tr class="memitem:a0d32c22a2d3794c328e8dd24d2cda2be inherit pub_methods_classgridfire_1_1policy_1_1NetworkPolicy" id="r_a0d32c22a2d3794c328e8dd24d2cda2be"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1policy_1_1NetworkPolicy.html#a0d32c22a2d3794c328e8dd24d2cda2be">~NetworkPolicy</a> ()=default</td></tr>
|
|
<tr class="separator:a0d32c22a2d3794c328e8dd24d2cda2be inherit pub_methods_classgridfire_1_1policy_1_1NetworkPolicy"><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:af5101829bcb344aa29ea65983732333d" id="r_af5101829bcb344aa29ea65983732333d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacegridfire_1_1policy.html#a0f52cd334fb84998d9c68430a41f6109">NetworkPolicyStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1policy_1_1MainSequencePolicy.html#af5101829bcb344aa29ea65983732333d">check_status</a> () const</td></tr>
|
|
<tr class="separator:af5101829bcb344aa29ea65983732333d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-static-methods" name="pri-static-methods"></a>
|
|
Static Private Member Functions</h2></td></tr>
|
|
<tr class="memitem:a5f38cd1549544854e60c2c7a847c0ea7" id="r_a5f38cd1549544854e60c2c7a847c0ea7"><td class="memItemLeft" align="right" valign="top">static std::unique_ptr< <a class="el" href="classgridfire_1_1partition_1_1PartitionFunction.html">partition::PartitionFunction</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1policy_1_1MainSequencePolicy.html#a5f38cd1549544854e60c2c7a847c0ea7">build_partition_function</a> ()</td></tr>
|
|
<tr class="separator:a5f38cd1549544854e60c2c7a847c0ea7"><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:a67cda11c3ef95f5ac2ff384965c5a500" id="r_a67cda11c3ef95f5ac2ff384965c5a500"><td class="memItemLeft" align="right" valign="top">std::set< fourdst::atomic::Species > </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1policy_1_1MainSequencePolicy.html#a67cda11c3ef95f5ac2ff384965c5a500">m_seed_species</a></td></tr>
|
|
<tr class="memdesc:a67cda11c3ef95f5ac2ff384965c5a500"><td class="mdescLeft"> </td><td class="mdescRight">The set of seed species required by this policy. These are H-1, He-3, He-4, C-12, N-14, O-16, Ne-20, Mg-24. <br /></td></tr>
|
|
<tr class="separator:a67cda11c3ef95f5ac2ff384965c5a500"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a145fe245a253e8ecd4da9726b9379b3c" id="r_a145fe245a253e8ecd4da9726b9379b3c"><td class="memItemLeft" align="right" valign="top">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_1MainSequencePolicy.html#a145fe245a253e8ecd4da9726b9379b3c">m_reaction_policy</a> = std::make_unique<<a class="el" href="classgridfire_1_1policy_1_1MainSequenceReactionChainPolicy.html">MainSequenceReactionChainPolicy</a>>()</td></tr>
|
|
<tr class="memdesc:a145fe245a253e8ecd4da9726b9379b3c"><td class="mdescLeft"> </td><td class="mdescRight">The composed reaction chain policy (PP-chain + CNO-cycle). <br /></td></tr>
|
|
<tr class="separator:a145fe245a253e8ecd4da9726b9379b3c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9b55ccd1a059ede5127b07a18274f6e9" id="r_a9b55ccd1a059ede5127b07a18274f6e9"><td class="memItemLeft" align="right" valign="top">fourdst::composition::Composition </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1policy_1_1MainSequencePolicy.html#a9b55ccd1a059ede5127b07a18274f6e9">m_initializing_composition</a></td></tr>
|
|
<tr class="memdesc:a9b55ccd1a059ede5127b07a18274f6e9"><td class="mdescLeft"> </td><td class="mdescRight">The initial composition used to build the network. <br /></td></tr>
|
|
<tr class="separator:a9b55ccd1a059ede5127b07a18274f6e9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a57a7bbb55eb6f96396d87811f34cc0a4" id="r_a57a7bbb55eb6f96396d87811f34cc0a4"><td class="memItemLeft" align="right" valign="top">std::unique_ptr< <a class="el" href="classgridfire_1_1partition_1_1PartitionFunction.html">partition::PartitionFunction</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1policy_1_1MainSequencePolicy.html#a57a7bbb55eb6f96396d87811f34cc0a4">m_partition_function</a></td></tr>
|
|
<tr class="memdesc:a57a7bbb55eb6f96396d87811f34cc0a4"><td class="mdescLeft"> </td><td class="mdescRight">The partition function used in network construction. <br /></td></tr>
|
|
<tr class="separator:a57a7bbb55eb6f96396d87811f34cc0a4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0416e55a72362487212a92b3d18dfb14" id="r_a0416e55a72362487212a92b3d18dfb14"><td class="memItemLeft" align="right" valign="top">std::vector< std::unique_ptr< <a class="el" href="classgridfire_1_1engine_1_1DynamicEngine.html">engine::DynamicEngine</a> > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1policy_1_1MainSequencePolicy.html#a0416e55a72362487212a92b3d18dfb14">m_network_stack</a></td></tr>
|
|
<tr class="memdesc:a0416e55a72362487212a92b3d18dfb14"><td class="mdescLeft"> </td><td class="mdescRight">The stack of dynamic engines constructed by the policy. <br /></td></tr>
|
|
<tr class="separator:a0416e55a72362487212a92b3d18dfb14"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a023a7cbb9971a787713abaf344848211" id="r_a023a7cbb9971a787713abaf344848211"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacegridfire_1_1policy.html#a0f52cd334fb84998d9c68430a41f6109">NetworkPolicyStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1policy_1_1MainSequencePolicy.html#a023a7cbb9971a787713abaf344848211">m_status</a> = <a class="el" href="namespacegridfire_1_1policy.html#a0f52cd334fb84998d9c68430a41f6109add652546039b18970b8dcf2cff824268">NetworkPolicyStatus::UNINITIALIZED</a></td></tr>
|
|
<tr class="memdesc:a023a7cbb9971a787713abaf344848211"><td class="mdescLeft"> </td><td class="mdescRight">The current status of the policy. <br /></td></tr>
|
|
<tr class="separator:a023a7cbb9971a787713abaf344848211"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>A <a class="el" href="classgridfire_1_1policy_1_1NetworkPolicy.html" title="Abstract interface for policies that construct DynamicEngine networks from a seed composition.">NetworkPolicy</a> for building reaction networks suitable for low-mass main-sequence stars. </p>
|
|
<p>This policy ensures that a constructed network contains all necessary species and reactions for modeling the core hydrogen burning phase in low-mass stars, primarily the PP-chain and the CNO-cycle.</p>
|
|
<p>The <code><a class="el" href="classgridfire_1_1policy_1_1MainSequencePolicy.html#aa9b4e39dacada73756bfd78885da60bd" title="Constructs and returns the complete, multi-layered dynamic engine.">construct()</a></code> method builds a stack of engine views (<code>GraphEngine</code> -> <code>MultiscalePartitioningEngineView</code> -> <code>AdaptiveEngineView</code>) to provide a dynamically adjusting, performance-optimized reaction network.</p>
|
|
<p>This policy requires the following seed species:</p><ul>
|
|
<li>H-1</li>
|
|
<li>He-3</li>
|
|
<li>He-4</li>
|
|
<li>C-12</li>
|
|
<li>N-14</li>
|
|
<li>O-16</li>
|
|
<li>Ne-20</li>
|
|
<li>Mg-24</li>
|
|
</ul>
|
|
<p>This policy composes the <code><a class="el" href="classgridfire_1_1policy_1_1ProtonProtonChainPolicy.html" title="Proton-Proton Chain Policy.">ProtonProtonChainPolicy</a></code> and <code><a class="el" href="classgridfire_1_1policy_1_1CNOChainPolicy.html" title="CNO Chain Policy.">CNOChainPolicy</a></code> to define the required reactions. </p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="acd3224e5781f3d19a8ff300b7fd9a21c" name="acd3224e5781f3d19a8ff300b7fd9a21c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#acd3224e5781f3d19a8ff300b7fd9a21c">◆ </a></span>MainSequencePolicy() <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">gridfire::policy::MainSequencePolicy::MainSequencePolicy </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const fourdst::composition::Composition & </td>
|
|
<td class="paramname"><em>composition</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>Constructs the policy from an existing composition object. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">composition</td><td>The initial composition, which must contain all seed species required by the policy.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="exception"><dt>Exceptions</dt><dd>
|
|
<table class="exception">
|
|
<tr><td class="paramname"><a class="el" href="classgridfire_1_1exceptions_1_1MissingSeedSpeciesError.html" title="Exception thrown when a required seed species is not found in the initial composition.">exceptions::MissingSeedSpeciesError</a></td><td>if the provided <code>composition</code> is missing a required species.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section user"><dt>Example</dt><dd><div class="fragment"><div class="line">fourdst::composition::Composition comp;</div>
|
|
<div class="line"><span class="comment">// ... populate composition ...</span></div>
|
|
<div class="line">LowMassMainSequencePolicy policy(comp);</div>
|
|
</div><!-- fragment --> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0fcac0f9d41917f888788a772daaaebc" name="a0fcac0f9d41917f888788a772daaaebc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0fcac0f9d41917f888788a772daaaebc">◆ </a></span>MainSequencePolicy() <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">gridfire::policy::MainSequencePolicy::MainSequencePolicy </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::vector< fourdst::atomic::Species > </td>
|
|
<td class="paramname"><em>seed_species</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::vector< double > & </td>
|
|
<td class="paramname"><em>mass_fractions</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">explicit</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Constructs the policy from a list of species and their mass fractions. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">seed_species</td><td>A vector of atomic species. </td></tr>
|
|
<tr><td class="paramname">mass_fractions</td><td>A vector of corresponding mass fractions.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="exception"><dt>Exceptions</dt><dd>
|
|
<table class="exception">
|
|
<tr><td class="paramname"><a class="el" href="classgridfire_1_1exceptions_1_1MissingSeedSpeciesError.html" title="Exception thrown when a required seed species is not found in the initial composition.">exceptions::MissingSeedSpeciesError</a></td><td>if the provided species list is missing a required seed species. </td></tr>
|
|
<tr><td class="paramname">fourdst::composition::exceptions::CompositionNotFinalizedError</td><td>if the internal composition fails to finalize.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section user"><dt>Example</dt><dd><div class="fragment"><div class="line"><span class="keyword">using namespace </span>fourdst::atomic;</div>
|
|
<div class="line">std::vector<Species> species = {H_1, He_4, C_12, O_16};</div>
|
|
<div class="line">std::vector<double> mass_fractions = {0.7, 0.28, 0.01, 0.01};</div>
|
|
<div class="line">LowMassMainSequencePolicy policy(species, mass_fractions);</div>
|
|
</div><!-- fragment --> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a5f38cd1549544854e60c2c7a847c0ea7" name="a5f38cd1549544854e60c2c7a847c0ea7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5f38cd1549544854e60c2c7a847c0ea7">◆ </a></span>build_partition_function()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::unique_ptr< <a class="el" href="classgridfire_1_1partition_1_1PartitionFunction.html">partition::PartitionFunction</a> > gridfire::policy::MainSequencePolicy::build_partition_function </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af5101829bcb344aa29ea65983732333d" name="af5101829bcb344aa29ea65983732333d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af5101829bcb344aa29ea65983732333d">◆ </a></span>check_status()</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="namespacegridfire_1_1policy.html#a0f52cd334fb84998d9c68430a41f6109">NetworkPolicyStatus</a> gridfire::policy::MainSequencePolicy::check_status </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">inline</span><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa9b4e39dacada73756bfd78885da60bd" name="aa9b4e39dacada73756bfd78885da60bd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa9b4e39dacada73756bfd78885da60bd">◆ </a></span>construct()</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_1engine_1_1DynamicEngine.html">engine::DynamicEngine</a> & gridfire::policy::MainSequencePolicy::construct </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">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Constructs and returns the complete, multi-layered dynamic engine. </p>
|
|
<p>This method builds the full network engine stack:</p><ul>
|
|
<li>A base <code>GraphEngine</code> is created with the initial composition. This is constructed three layers deep which is sufficient to capture all required reactions. Further a composite ground state and Rauscher Thielemann partition function is used.</li>
|
|
<li>A <code>MultiscalePartitioningEngineView</code> is layered on top for performance optimization. This will put some species into equilibrium groups based on their reaction timescales.</li>
|
|
<li>An <code>AdaptiveEngineView</code> is added as the final layer to dynamically cull reaction pathways based on molar reaction flows.</li>
|
|
</ul>
|
|
<p>After construction, it verifies that the resulting network meets the policy's requirements.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>DynamicEngine& A reference to the top-level <code>AdaptiveEngineView</code>.</dd></dl>
|
|
<dl class="exception"><dt>Exceptions</dt><dd>
|
|
<table class="exception">
|
|
<tr><td class="paramname"><a class="el" href="classgridfire_1_1exceptions_1_1MissingKeyReactionError.html" title="Exception thrown when a constructed network fails to include a key reaction required by the policy.">exceptions::MissingKeyReactionError</a></td><td>if the final network is missing a required reaction. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="classgridfire_1_1exceptions_1_1MissingSeedSpeciesError.html" title="Exception thrown when a required seed species is not found in the initial composition.">exceptions::MissingSeedSpeciesError</a></td><td>if the final network is missing a required species. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="classgridfire_1_1exceptions_1_1PolicyError.html" title="Base class for all exceptions related to network policy operations.">exceptions::PolicyError</a></td><td>on other verification failures.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section user"><dt>Example</dt><dd><div class="fragment"><div class="line">LowMassMainSequencePolicy enginePolicy(composition);</div>
|
|
<div class="line">DynamicEngine& engine = enginePolicy.construct();</div>
|
|
<div class="line"><a class="code hl_class" href="classgridfire_1_1solver_1_1CVODESolverStrategy.html">solver::CVODESolverStrategy</a> solver(engine);</div>
|
|
<div class="line"><span class="comment">// ... run solver ...</span></div>
|
|
<div class="ttc" id="aclassgridfire_1_1solver_1_1CVODESolverStrategy_html"><div class="ttname"><a href="classgridfire_1_1solver_1_1CVODESolverStrategy.html">gridfire::solver::CVODESolverStrategy</a></div><div class="ttdoc">Stiff ODE integrator backed by SUNDIALS CVODE (BDF) for network + energy.</div><div class="ttdef"><b>Definition</b> CVODE_solver_strategy.h:81</div></div>
|
|
</div><!-- fragment --> </dd></dl>
|
|
|
|
<p>Implements <a class="el" href="classgridfire_1_1policy_1_1NetworkPolicy.html#a13cd74c967592392b01d8fe9a5b34d88">gridfire::policy::NetworkPolicy</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a43724347608826a613f6c65385050186" name="a43724347608826a613f6c65385050186"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a43724347608826a613f6c65385050186">◆ </a></span>get_engine_stack()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const std::vector< std::unique_ptr< <a class="el" href="classgridfire_1_1engine_1_1DynamicEngine.html">engine::DynamicEngine</a> > > & gridfire::policy::MainSequencePolicy::get_engine_stack </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>Implements <a class="el" href="classgridfire_1_1policy_1_1NetworkPolicy.html#a92891fe37b8684fe9f1c5958674de2d5">gridfire::policy::NetworkPolicy</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a70c617ea5b13a1cdc62fbfe21963098c" name="a70c617ea5b13a1cdc62fbfe21963098c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a70c617ea5b13a1cdc62fbfe21963098c">◆ </a></span>get_engine_types_stack()</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="namespacegridfire_1_1engine.html#a5387db1ec0b039955487fbc4c0034854">engine::EngineTypes</a> > gridfire::policy::MainSequencePolicy::get_engine_types_stack </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>Implements <a class="el" href="classgridfire_1_1policy_1_1NetworkPolicy.html#aac63625678d287d0ca36c98f51e86dd2">gridfire::policy::NetworkPolicy</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8dbef0e799968af4103e184b6e30c221" name="a8dbef0e799968af4103e184b6e30c221"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8dbef0e799968af4103e184b6e30c221">◆ </a></span>get_partition_function()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const std::unique_ptr< <a class="el" href="classgridfire_1_1partition_1_1PartitionFunction.html">partition::PartitionFunction</a> > & gridfire::policy::MainSequencePolicy::get_partition_function </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>Implements <a class="el" href="classgridfire_1_1policy_1_1NetworkPolicy.html#a1c395eb83b0bcf728db230e7772aabcf">gridfire::policy::NetworkPolicy</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="adcefccb171b339350a9b4a61d89adbbc" name="adcefccb171b339350a9b4a61d89adbbc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#adcefccb171b339350a9b4a61d89adbbc">◆ </a></span>get_seed_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> & gridfire::policy::MainSequencePolicy::get_seed_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">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the set of seed reactions required by this policy (from the PP and CNO chains). </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>const <a class="el" href="classgridfire_1_1reaction_1_1ReactionSet.html">reaction::ReactionSet</a>& </dd></dl>
|
|
|
|
<p>Implements <a class="el" href="classgridfire_1_1policy_1_1NetworkPolicy.html#aa33fcee020f5acd8e14aadaf3758ad2f">gridfire::policy::NetworkPolicy</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a041b0a99120efdc6abae312c568a9e15" name="a041b0a99120efdc6abae312c568a9e15"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a041b0a99120efdc6abae312c568a9e15">◆ </a></span>get_seed_species()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const std::set< fourdst::atomic::Species > & gridfire::policy::MainSequencePolicy::get_seed_species </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">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the set of seed species required by this policy. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>const std::set<fourdst::atomic::Species>& </dd></dl>
|
|
|
|
<p>Implements <a class="el" href="classgridfire_1_1policy_1_1NetworkPolicy.html#afb599d76b423f7a39b322c967302b49b">gridfire::policy::NetworkPolicy</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1ecfb6ea2e18e8cf55228f80ee5c50ed" name="a1ecfb6ea2e18e8cf55228f80ee5c50ed"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1ecfb6ea2e18e8cf55228f80ee5c50ed">◆ </a></span>get_status()</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="namespacegridfire_1_1policy.html#a0f52cd334fb84998d9c68430a41f6109">NetworkPolicyStatus</a> gridfire::policy::MainSequencePolicy::get_status </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">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the current status of the policy. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>NetworkPolicyStatus The construction and verification status. </dd></dl>
|
|
|
|
<p>Implements <a class="el" href="classgridfire_1_1policy_1_1NetworkPolicy.html#a3d0f2aee8ead71da4d421fb659fb30f7">gridfire::policy::NetworkPolicy</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6520ddfead2ba2700e2b1329774b4ff6" name="a6520ddfead2ba2700e2b1329774b4ff6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6520ddfead2ba2700e2b1329774b4ff6">◆ </a></span>name()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::string gridfire::policy::MainSequencePolicy::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">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the name of the policy. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>"MainSequencePolicy" </dd></dl>
|
|
|
|
<p>Implements <a class="el" href="classgridfire_1_1policy_1_1NetworkPolicy.html#aa59c1baf7077a5d35d45ff753b32a565">gridfire::policy::NetworkPolicy</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Data Documentation</h2>
|
|
<a id="a9b55ccd1a059ede5127b07a18274f6e9" name="a9b55ccd1a059ede5127b07a18274f6e9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9b55ccd1a059ede5127b07a18274f6e9">◆ </a></span>m_initializing_composition</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">fourdst::composition::Composition gridfire::policy::MainSequencePolicy::m_initializing_composition</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>The initial composition used to build the network. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0416e55a72362487212a92b3d18dfb14" name="a0416e55a72362487212a92b3d18dfb14"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0416e55a72362487212a92b3d18dfb14">◆ </a></span>m_network_stack</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::unique_ptr<<a class="el" href="classgridfire_1_1engine_1_1DynamicEngine.html">engine::DynamicEngine</a>> > gridfire::policy::MainSequencePolicy::m_network_stack</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>The stack of dynamic engines constructed by the policy. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a57a7bbb55eb6f96396d87811f34cc0a4" name="a57a7bbb55eb6f96396d87811f34cc0a4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a57a7bbb55eb6f96396d87811f34cc0a4">◆ </a></span>m_partition_function</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::unique_ptr<<a class="el" href="classgridfire_1_1partition_1_1PartitionFunction.html">partition::PartitionFunction</a>> gridfire::policy::MainSequencePolicy::m_partition_function</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>The partition function used in network construction. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a145fe245a253e8ecd4da9726b9379b3c" name="a145fe245a253e8ecd4da9726b9379b3c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a145fe245a253e8ecd4da9726b9379b3c">◆ </a></span>m_reaction_policy</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::unique_ptr<<a class="el" href="classgridfire_1_1policy_1_1ReactionChainPolicy.html">ReactionChainPolicy</a>> gridfire::policy::MainSequencePolicy::m_reaction_policy = std::make_unique<<a class="el" href="classgridfire_1_1policy_1_1MainSequenceReactionChainPolicy.html">MainSequenceReactionChainPolicy</a>>()</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>The composed reaction chain policy (PP-chain + CNO-cycle). </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a67cda11c3ef95f5ac2ff384965c5a500" name="a67cda11c3ef95f5ac2ff384965c5a500"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a67cda11c3ef95f5ac2ff384965c5a500">◆ </a></span>m_seed_species</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::set<fourdst::atomic::Species> gridfire::policy::MainSequencePolicy::m_seed_species</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>The set of seed species required by this policy. These are H-1, He-3, He-4, C-12, N-14, O-16, Ne-20, Mg-24. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a023a7cbb9971a787713abaf344848211" name="a023a7cbb9971a787713abaf344848211"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a023a7cbb9971a787713abaf344848211">◆ </a></span>m_status</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="namespacegridfire_1_1policy.html#a0f52cd334fb84998d9c68430a41f6109">NetworkPolicyStatus</a> gridfire::policy::MainSequencePolicy::m_status = <a class="el" href="namespacegridfire_1_1policy.html#a0f52cd334fb84998d9c68430a41f6109add652546039b18970b8dcf2cff824268">NetworkPolicyStatus::UNINITIALIZED</a></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>The current status of the policy. </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="stellar__policy_8h.html">stellar_policy.h</a></li>
|
|
<li>src/lib/policy/<a class="el" href="stellar__policy_8cpp.html">stellar_policy.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_1MainSequencePolicy.html">MainSequencePolicy</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>
|