230 lines
12 KiB
HTML
230 lines
12 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.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="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"> v0.7.0_rc2</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&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&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&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&dn=expat.txt MIT */
|
|
$(function(){initNavTree('namespacegridfire_1_1io_1_1gen.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> |
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle"><div class="title">gridfire::io::gen Namespace Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Namespace for generative input/output functionalities.
|
|
<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  </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"> </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"> </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> </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> &reaction)</td></tr>
|
|
<tr class="memdesc:aed61026cbd83e7a15565e4a0ad0849b9"><td class="mdescLeft"> </td><td class="mdescRight">Exports a reaction to a Python function definition. <br /></td></tr>
|
|
<tr class="separator:aed61026cbd83e7a15565e4a0ad0849b9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a597ff691fb592f7306af96a269117631" id="r_a597ff691fb592f7306af96a269117631"><td class="memItemLeft" align="right" valign="top">std::string </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> &engine)</td></tr>
|
|
<tr class="memdesc:a597ff691fb592f7306af96a269117631"><td class="mdescLeft"> </td><td class="mdescRight">Exports a dynamic engine to a Python script. <br /></td></tr>
|
|
<tr class="separator:a597ff691fb592f7306af96a269117631"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac192d690214100bf8d938bffaeefbe64" id="r_ac192d690214100bf8d938bffaeefbe64"><td class="memItemLeft" align="right" valign="top">void </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> &engine, const std::string &fileName)</td></tr>
|
|
<tr class="memdesc:ac192d690214100bf8d938bffaeefbe64"><td class="mdescLeft"> </td><td class="mdescRight">Exports a dynamic engine to a Python file. <br /></td></tr>
|
|
<tr class="separator:ac192d690214100bf8d938bffaeefbe64"><td class="memSeparator" colspan="2"> </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">◆ </a></span>exportEngineToPy() <span class="overload">[1/2]</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">const <a class="el" href="classgridfire_1_1engine_1_1_dynamic_engine.html">engine::DynamicEngine</a> &</td> <td class="paramname"><span class="paramname"><em>engine</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Exports a dynamic engine to a Python script. </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>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<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">◆ </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_1_dynamic_engine.html">engine::DynamicEngine</a> &</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 &</td> <td class="paramname"><span class="paramname"><em>fileName</em></span> )</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>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aed61026cbd83e7a15565e4a0ad0849b9">◆ </a></span>exportReactionToPy()</h2>
|
|
|
|
<div class="memitem">
|
|
<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>(</td>
|
|
<td class="paramtype">const <a class="el" href="classgridfire_1_1reaction_1_1_reaction.html">reaction::Reaction</a> &</td> <td class="paramname"><span class="paramname"><em>reaction</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Exports a reaction to a Python function definition. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">reaction</td><td>The reaction to export. </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>
|
|
<p>This function converts the given reaction into a Python function definition, including the necessary code and module requirements. </p>
|
|
|
|
</div>
|
|
</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="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>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|