tboudreaux/GridFire
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(docs): rebuilt

Browse Source
This commit is contained in:
Emily Boudreaux
2025-11-05 18:38:07 -05:00
parent 18d289da7e
commit ba306523d6
202 changed files with 11748 additions and 3895 deletions
Download Patch File Download Diff File Expand all files Collapse all files

180
docs/html/policy__abstract_8h.html Normal file
View File

@@ -0,0 +1,180 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.13.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>GridFire: src/include/gridfire/policy/policy_abstract.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome-sidebar-only.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">GridFire<span id="projectnumber">&#160;v0.7.0-alpha</span>
</div>
<div id="projectbrief">General Purpose Nuclear Network</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.13.2 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search',true);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('policy__abstract_8h.html',''); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#namespaces">Namespaces</a> &#124;
<a href="#enum-members">Enumerations</a> </div>
<div class="headertitle"><div class="title">policy_abstract.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Abstract policy interfaces used to construct reaction networks (DynamicEngine) from seed compositions.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;fourdst/composition/atomicSpecies.h&quot;</code><br />
<code>#include &quot;<a class="el" href="building_8h.html">gridfire/engine/types/building.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="reaction_8h.html">gridfire/reaction/reaction.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="engine__abstract_8h.html">gridfire/engine/engine_abstract.h</a>&quot;</code><br />
<code>#include &lt;string&gt;</code><br />
<code>#include &lt;set&gt;</code><br />
</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">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1policy_1_1_network_policy.html">gridfire::policy::NetworkPolicy</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Abstract interface for policies that construct <a class="el" href="classgridfire_1_1_dynamic_engine.html" title="Abstract class for engines supporting Jacobian and stoichiometry operations.">DynamicEngine</a> networks from a seed composition. <a href="classgridfire_1_1policy_1_1_network_policy.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1policy_1_1_reaction_chain_policy.html">gridfire::policy::ReactionChainPolicy</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Abstract interface encapsulating a set of reactions representing a single chain or pathway. <a href="classgridfire_1_1policy_1_1_reaction_chain_policy.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1policy_1_1_multi_reaction_chain_policy.html">gridfire::policy::MultiReactionChainPolicy</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A <a class="el" href="classgridfire_1_1policy_1_1_reaction_chain_policy.html" title="Abstract interface encapsulating a set of reactions representing a single chain or pathway.">ReactionChainPolicy</a> composed of multiple child <a class="el" href="classgridfire_1_1policy_1_1_reaction_chain_policy.html" title="Abstract interface encapsulating a set of reactions representing a single chain or pathway.">ReactionChainPolicy</a> instances. <a href="classgridfire_1_1policy_1_1_multi_reaction_chain_policy.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="namespaces" name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire.html">gridfire</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire_1_1policy.html">gridfire::policy</a></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="enum-members" name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a0f52cd334fb84998d9c68430a41f6109" id="r_a0f52cd334fb84998d9c68430a41f6109"><td class="memItemLeft" align="right" valign="top">enum class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire_1_1policy.html#a0f52cd334fb84998d9c68430a41f6109">gridfire::policy::NetworkPolicyStatus</a> { <br />
&#160;&#160;<a class="el" href="namespacegridfire_1_1policy.html#a0f52cd334fb84998d9c68430a41f6109add652546039b18970b8dcf2cff824268">gridfire::policy::UNINITIALIZED</a>
, <a class="el" href="namespacegridfire_1_1policy.html#a0f52cd334fb84998d9c68430a41f6109af8392674ffb9a1455835c2cd5eb3f5ae">gridfire::policy::INITIALIZED_UNVERIFIED</a>
, <a class="el" href="namespacegridfire_1_1policy.html#a0f52cd334fb84998d9c68430a41f6109a2f017cce8fa4a6b50e2034ff16d1eda3">gridfire::policy::MISSING_KEY_REACTION</a>
, <a class="el" href="namespacegridfire_1_1policy.html#a0f52cd334fb84998d9c68430a41f6109ae0584675cd48c19691ed09c98b2d2730">gridfire::policy::MISSING_KEY_SPECIES</a>
, <br />
&#160;&#160;<a class="el" href="namespacegridfire_1_1policy.html#a0f52cd334fb84998d9c68430a41f6109aff6473ea13033c0680a084b372f5755e">gridfire::policy::INITIALIZED_VERIFIED</a>
<br />
}</td></tr>
<tr class="memdesc:a0f52cd334fb84998d9c68430a41f6109"><td class="mdescLeft">&#160;</td><td class="mdescRight">Lifecycle/verification status for a NetworkPolicy instance. <a href="namespacegridfire_1_1policy.html#a0f52cd334fb84998d9c68430a41f6109">More...</a><br /></td></tr>
<tr class="separator:a0f52cd334fb84998d9c68430a41f6109"><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>Abstract policy interfaces used to construct reaction networks (DynamicEngine) from seed compositions. </p>
<p>This header declares the base interfaces for high-level "policies" that drive automatic network construction and verification. A NetworkPolicy encapsulates the information required to build a production-ready reaction network from an initial composition (seed species and seed reactions) and to return a constructed DynamicEngine ready for use by the solvers.</p>
<p>Concrete policy implementations live in this directory and provide the real behaviour. See for example:</p><ul>
<li><a class="el" href="stellar__policy_8h.html" title="High-level concrete NetworkPolicy for specific stellar environments.">gridfire/policy/stellar_policy.h</a> (concrete stellar network policy used in many examples)</li>
<li><a class="el" href="chains_8h.html" title="Concrete implementations of ReactionChainPolicy for key stellar reaction chains.">gridfire/policy/chains.h</a> (reaction-chain helper policies such as proton-proton, CNO)</li>
</ul>
<p>An example of using a concrete policy to construct and run an engine is available at:</p><ul>
<li>tests/graphnet_sandbox/main.cpp</li>
</ul>
<dl class="section note"><dt>Note</dt><dd>Doxygen comments on public methods include </dd></dl>
<dl class="section user"><dt>Example usage blocks. Methods that may</dt><dd>throw in concrete implementations include </dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">tags.</td><td></td></tr>
</table>
</dd>
</dl>
</div></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="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_b0856f6b0d80ccb263b2f415c91f9e17.html">include</a></li><li class="navelem"><a class="el" href="dir_3626e0c0e3c5d7812d6b277dfa4ec364.html">gridfire</a></li><li class="navelem"><a class="el" href="dir_2adadb1daf94a265dd4b6962493aba6e.html">policy</a></li><li class="navelem"><a class="el" href="policy__abstract_8h.html">policy_abstract.h</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.13.2 </li>
</ul>
</div>
</body>
</html>