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

docs(docs): rebuilt docs

Browse Source
This commit is contained in:
Emily Boudreaux
2025-11-24 09:08:28 -05:00
parent 9fab4fbfae
commit 22c0329de0
2410 changed files with 309008 additions and 146081 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
docs/html/policy__abstract_8h.html
View File

@@ -109,12 +109,13 @@ $(function(){initNavTree('policy__abstract_8h.html',''); initResizable(true); })
<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 />
<div class="textblock"><code>#include &quot;fourdst/atomic/atomicSpecies.h&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 &quot;<a class="el" href="partition_8h.html">gridfire/partition/partition.h</a>&quot;</code><br />
<code>#include &lt;string&gt;</code><br />
<code>#include &lt;set&gt;</code><br />
<code>#include &quot;<a class="el" href="engine__types_8h.html">gridfire/engine/types/engine_types.h</a>&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for policy_abstract.h:</div>
<div class="dyncontent">
@@ -123,20 +124,17 @@ Include dependency graph for policy_abstract.h:</div>
</div><div class="textblock"><div class="dynheader">
This graph shows which files directly or indirectly include this file:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="policy__abstract_8h__dep__incl.svg" width="207" height="230"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
<div class="center"><iframe scrolling="no" frameborder="0" src="policy__abstract_8h__dep__incl.svg" width="532" height="495"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
</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="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Abstract interface for policies that construct DynamicEngine 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>
@@ -164,19 +162,8 @@ Enumerations</h2></td></tr>
<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>
<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 -->