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

docs(docs): rebuilt for version v0.7.1_rc2

Browse Source
This commit is contained in:
Emily M. Boudreaux
2025-11-28 09:46:00 -05:00
parent 033c5a083d
commit a472dc5214
2480 changed files with 231104 additions and 76191 deletions
Download Patch File Download Diff File Expand all files Collapse all files

56
docs/html/namespacegridfire_1_1io_1_1gen.html
View File

@@ -3,18 +3,16 @@
<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="generator" content="Doxygen 1.9.8"/>
<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>
@@ -29,7 +27,7 @@
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">GridFire<span id="projectnumber">&#160;v0.7.0_rc2</span>
<div id="projectname">GridFire<span id="projectnumber">&#160;v0.7.1_rc2</span>
</div>
<div id="projectbrief">General Purpose Nuclear Network</div>
</td>
@@ -38,24 +36,19 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.13.2 -->
<!-- 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">
/* @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(); });
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
@@ -73,7 +66,7 @@ $(function() {
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('namespacegridfire_1_1io_1_1gen.html',''); initResizable(true); });
$(document).ready(function(){initNavTree('namespacegridfire_1_1io_1_1gen.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
@@ -107,23 +100,23 @@ $(function(){initNavTree('namespacegridfire_1_1io_1_1gen.html',''); initResizabl
<div class="contents">
<p>Namespace for generative input/output functionalities.
<a href="#details">More...</a></p>
<a href="namespacegridfire_1_1io_1_1gen.html#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_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="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="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_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="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="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="#a597ff691fb592f7306af96a269117631">exportEngineToPy</a> (const <a class="el" href="classgridfire_1_1engine_1_1_dynamic_engine.html">engine::DynamicEngine</a> &amp;engine)</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="#ac192d690214100bf8d938bffaeefbe64">exportEngineToPy</a> (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="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>
</table>
@@ -140,7 +133,8 @@ 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_1_dynamic_engine.html">engine::DynamicEngine</a> &amp;</td> <td class="paramname"><span class="paramname"><em>engine</em></span></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></td>
</tr>
</table>
@@ -167,12 +161,19 @@ Functions</h2></td></tr>
<tr>
<td class="memname">void gridfire::io::gen::exportEngineToPy </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>
<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;</td> <td class="paramname"><span class="paramname"><em>fileName</em></span>&#160;)</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">
@@ -196,9 +197,10 @@ Functions</h2></td></tr>
<div class="memproto">
<table class="memname">
<tr>
<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 class="memname"><a class="el" href="structgridfire_1_1io_1_1gen_1_1PyFunctionDef.html">PyFunctionDef</a> gridfire::io::gen::exportReactionToPy </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 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></td>
</tr>
</table>
@@ -211,7 +213,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_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>
<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>
<p>This function converts the given reaction into a Python function definition, including the necessary code and module requirements. </p>
</div>
@@ -222,7 +224,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.13.2 </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>