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

docs(rebuilt-docs): rebuild docs for v0.7.6rc4.0

Browse Source
This commit is contained in:
Emily Boudreaux
2026-04-20 12:45:31 -04:00
parent cf26983fe2
commit 7d611c56ad
2879 changed files with 341584 additions and 181414 deletions
Download Patch File Download Diff File Expand all files Collapse all files

159
docs/html/namespacegridfire_1_1io_1_1gen.html
View File

@@ -3,16 +3,18 @@
<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="generator" content="Doxygen 1.13.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>GridFire: gridfire::io::gen Namespace 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="resize.js"></script>
<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>
@@ -27,7 +29,7 @@
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">GridFire<span id="projectnumber">&#160;v0.7.1_rc2</span>
<div id="projectname">GridFire<span id="projectnumber">&#160;v0.7.6rc4.0</span>
</div>
<div id="projectbrief">General Purpose Nuclear Network</div>
</td>
@@ -36,19 +38,24 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<!-- 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');
$(document).ready(function() { init_search(); });
initMenu('',true,false,'search.php','Search',true);
$(function() { init_search(); });
});
/* @license-end */
</script>
@@ -66,7 +73,7 @@ $(function() {
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('namespacegridfire_1_1io_1_1gen.html',''); initResizable(); });
$(function(){initNavTree('namespacegridfire_1_1io_1_1gen.html',''); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
@@ -100,32 +107,34 @@ $(document).ready(function(){initNavTree('namespacegridfire_1_1io_1_1gen.html','
<div class="contents">
<p>Namespace for generative input/output functionalities.
<a href="namespacegridfire_1_1io_1_1gen.html#details">More...</a></p>
<a href="#details">More...</a></p>
<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_1io_1_1gen_1_1PyFunctionDef.html">PyFunctionDef</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Structure representing a Python function definition. <a href="structgridfire_1_1io_1_1gen_1_1PyFunctionDef.html#details">More...</a><br /></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_1io_1_1gen_1_1_py_function_def.html">PyFunctionDef</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Structure representing a Python function definition. <a href="structgridfire_1_1io_1_1gen_1_1_py_function_def.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="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:aed61026cbd83e7a15565e4a0ad0849b9" id="r_aed61026cbd83e7a15565e4a0ad0849b9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structgridfire_1_1io_1_1gen_1_1PyFunctionDef.html">PyFunctionDef</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire_1_1io_1_1gen.html#aed61026cbd83e7a15565e4a0ad0849b9">exportReactionToPy</a> (const <a class="el" href="classgridfire_1_1reaction_1_1Reaction.html">reaction::Reaction</a> &amp;reaction)</td></tr>
<tr class="memitem:aed61026cbd83e7a15565e4a0ad0849b9" id="r_aed61026cbd83e7a15565e4a0ad0849b9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structgridfire_1_1io_1_1gen_1_1_py_function_def.html">PyFunctionDef</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aed61026cbd83e7a15565e4a0ad0849b9">exportReactionToPy</a> (const <a class="el" href="classgridfire_1_1reaction_1_1_reaction.html">reaction::Reaction</a> &amp;reaction)</td></tr>
<tr class="memdesc:aed61026cbd83e7a15565e4a0ad0849b9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Exports a reaction to a Python function definition. <br /></td></tr>
<tr class="separator:aed61026cbd83e7a15565e4a0ad0849b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a597ff691fb592f7306af96a269117631" id="r_a597ff691fb592f7306af96a269117631"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire_1_1io_1_1gen.html#a597ff691fb592f7306af96a269117631">exportEngineToPy</a> (const <a class="el" href="classgridfire_1_1engine_1_1DynamicEngine.html">engine::DynamicEngine</a> &amp;engine)</td></tr>
<tr class="memdesc:a597ff691fb592f7306af96a269117631"><td class="mdescLeft">&#160;</td><td class="mdescRight">Exports a dynamic engine to a Python script. <br /></td></tr>
<tr class="separator:a597ff691fb592f7306af96a269117631"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac192d690214100bf8d938bffaeefbe64" id="r_ac192d690214100bf8d938bffaeefbe64"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire_1_1io_1_1gen.html#ac192d690214100bf8d938bffaeefbe64">exportEngineToPy</a> (const <a class="el" href="classgridfire_1_1engine_1_1DynamicEngine.html">engine::DynamicEngine</a> &amp;engine, const std::string &amp;fileName)</td></tr>
<tr class="memdesc:ac192d690214100bf8d938bffaeefbe64"><td class="mdescLeft">&#160;</td><td class="mdescRight">Exports a dynamic engine to a Python file. <br /></td></tr>
<tr class="separator:ac192d690214100bf8d938bffaeefbe64"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4b6cc430d1b8c3b9d329914b915869c6" id="r_a4b6cc430d1b8c3b9d329914b915869c6"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4b6cc430d1b8c3b9d329914b915869c6">exportEngineToPy</a> (<a class="el" href="classgridfire_1_1engine_1_1scratch_1_1_state_blob.html">engine::scratch::StateBlob</a> &amp;ctx, <a class="el" href="classgridfire_1_1engine_1_1_dynamic_engine.html">engine::DynamicEngine</a> &amp;engine)</td></tr>
<tr class="memdesc:a4b6cc430d1b8c3b9d329914b915869c6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Exports a dynamic engine to a Python script. <br /></td></tr>
<tr class="separator:a4b6cc430d1b8c3b9d329914b915869c6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0db8d917f808ba348672780f63b6c717" id="r_a0db8d917f808ba348672780f63b6c717"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0db8d917f808ba348672780f63b6c717">exportEngineToPy</a> (<a class="el" href="classgridfire_1_1engine_1_1scratch_1_1_state_blob.html">engine::scratch::StateBlob</a> &amp;ctx, const <a class="el" href="classgridfire_1_1engine_1_1_dynamic_engine.html">engine::DynamicEngine</a> &amp;engine, const std::string &amp;fileName)</td></tr>
<tr class="memdesc:a0db8d917f808ba348672780f63b6c717"><td class="mdescLeft">&#160;</td><td class="mdescRight">Exports a dynamic engine to a Python file. <br /></td></tr>
<tr class="separator:a0db8d917f808ba348672780f63b6c717"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a00babb7b1a925815729d61065bbcdf67" id="r_a00babb7b1a925815729d61065bbcdf67"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a00babb7b1a925815729d61065bbcdf67">exportEngineToPy</a> (<a class="el" href="classgridfire_1_1engine_1_1scratch_1_1_state_blob.html">engine::scratch::StateBlob</a> &amp;ctx, const <a class="el" href="classgridfire_1_1engine_1_1_dynamic_engine.html">engine::DynamicEngine</a> &amp;engine)</td></tr>
<tr class="separator:a00babb7b1a925815729d61065bbcdf67"><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>Namespace for generative input/output functionalities. </p>
<p>This namespace contains functions and structures related to exporting reactions and engines to Python code. It provides tools to convert internal representations of reactions and engines into Python functions and scripts that can be used for further analysis or integration with Python-based workflows. </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a597ff691fb592f7306af96a269117631" name="a597ff691fb592f7306af96a269117631"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a597ff691fb592f7306af96a269117631">&#9670;&#160;</a></span>exportEngineToPy() <span class="overload">[1/2]</span></h2>
<a id="a00babb7b1a925815729d61065bbcdf67" name="a00babb7b1a925815729d61065bbcdf67"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a00babb7b1a925815729d61065bbcdf67">&#9670;&#160;</a></span>exportEngineToPy() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
@@ -133,9 +142,70 @@ Functions</h2></td></tr>
<tr>
<td class="memname">std::string gridfire::io::gen::exportEngineToPy </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classgridfire_1_1engine_1_1DynamicEngine.html">engine::DynamicEngine</a> &amp;&#160;</td>
<td class="paramname"><em>engine</em></td><td>)</td>
<td class="paramtype"><a class="el" href="classgridfire_1_1engine_1_1scratch_1_1_state_blob.html">engine::scratch::StateBlob</a> &amp;</td> <td class="paramname"><span class="paramname"><em>ctx</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classgridfire_1_1engine_1_1_dynamic_engine.html">engine::DynamicEngine</a> &amp;</td> <td class="paramname"><span class="paramname"><em>engine</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a0db8d917f808ba348672780f63b6c717" name="a0db8d917f808ba348672780f63b6c717"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0db8d917f808ba348672780f63b6c717">&#9670;&#160;</a></span>exportEngineToPy() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gridfire::io::gen::exportEngineToPy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classgridfire_1_1engine_1_1scratch_1_1_state_blob.html">engine::scratch::StateBlob</a> &amp;</td> <td class="paramname"><span class="paramname"><em>ctx</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classgridfire_1_1engine_1_1_dynamic_engine.html">engine::DynamicEngine</a> &amp;</td> <td class="paramname"><span class="paramname"><em>engine</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;</td> <td class="paramname"><span class="paramname"><em>fileName</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Exports a dynamic engine to a Python file. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ctx</td><td></td></tr>
<tr><td class="paramname">engine</td><td>The dynamic engine to export. </td></tr>
<tr><td class="paramname">fileName</td><td>The name of the file to write the Python script to.</td></tr>
</table>
</dd>
</dl>
<p>This function writes the Python script representation of the given dynamic engine to the specified file. </p>
</div>
</div>
<a id="a4b6cc430d1b8c3b9d329914b915869c6" name="a4b6cc430d1b8c3b9d329914b915869c6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4b6cc430d1b8c3b9d329914b915869c6">&#9670;&#160;</a></span>exportEngineToPy() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string gridfire::io::gen::exportEngineToPy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classgridfire_1_1engine_1_1scratch_1_1_state_blob.html">engine::scratch::StateBlob</a> &amp;</td> <td class="paramname"><span class="paramname"><em>ctx</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classgridfire_1_1engine_1_1_dynamic_engine.html">engine::DynamicEngine</a> &amp;</td> <td class="paramname"><span class="paramname"><em>engine</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
@@ -150,44 +220,6 @@ Functions</h2></td></tr>
<dl class="section return"><dt>Returns</dt><dd>A string containing the Python script representation of the engine.</dd></dl>
<p>This function converts the given dynamic engine into a Python script that can be used to recreate the engine's functionality in Python. </p>
</div>
</div>
<a id="ac192d690214100bf8d938bffaeefbe64" name="ac192d690214100bf8d938bffaeefbe64"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac192d690214100bf8d938bffaeefbe64">&#9670;&#160;</a></span>exportEngineToPy() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gridfire::io::gen::exportEngineToPy </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classgridfire_1_1engine_1_1DynamicEngine.html">engine::DynamicEngine</a> &amp;&#160;</td>
<td class="paramname"><em>engine</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>fileName</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Exports a dynamic engine to a Python file. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">engine</td><td>The dynamic engine to export. </td></tr>
<tr><td class="paramname">fileName</td><td>The name of the file to write the Python script to.</td></tr>
</table>
</dd>
</dl>
<p>This function writes the Python script representation of the given dynamic engine to the specified file. </p>
</div>
</div>
<a id="aed61026cbd83e7a15565e4a0ad0849b9" name="aed61026cbd83e7a15565e4a0ad0849b9"></a>
@@ -197,10 +229,9 @@ Functions</h2></td></tr>
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structgridfire_1_1io_1_1gen_1_1PyFunctionDef.html">PyFunctionDef</a> gridfire::io::gen::exportReactionToPy </td>
<td class="memname"><a class="el" href="structgridfire_1_1io_1_1gen_1_1_py_function_def.html">PyFunctionDef</a> gridfire::io::gen::exportReactionToPy </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 class="paramtype">const <a class="el" href="classgridfire_1_1reaction_1_1_reaction.html">reaction::Reaction</a> &amp;</td> <td class="paramname"><span class="paramname"><em>reaction</em></span></td><td>)</td>
<td></td>
</tr>
</table>
@@ -213,7 +244,7 @@ Functions</h2></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A <a class="el" href="structgridfire_1_1io_1_1gen_1_1PyFunctionDef.html" title="Structure representing a Python function definition.">PyFunctionDef</a> structure containing the Python function representation of the reaction.</dd></dl>
<dl class="section return"><dt>Returns</dt><dd>A <a class="el" href="structgridfire_1_1io_1_1gen_1_1_py_function_def.html" title="Structure representing a Python function definition.">PyFunctionDef</a> structure containing the Python function representation of the reaction.</dd></dl>
<p>This function converts the given reaction into a Python function definition, including the necessary code and module requirements. </p>
</div>
@@ -224,7 +255,7 @@ Functions</h2></td></tr>
<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_1io.html">io</a></li><li class="navelem"><a class="el" href="namespacegridfire_1_1io_1_1gen.html">gen</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>
<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>