229 lines
16 KiB
HTML
229 lines
16 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: PyDynamicNetworkSolverStrategy Class 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"> 0.0.1a</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('class_py_dynamic_network_solver_strategy.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="#pri-methods">Private Member Functions</a> |
|
|
<a href="class_py_dynamic_network_solver_strategy-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">PyDynamicNetworkSolverStrategy Class Reference<span class="mlabels"><span class="mlabel final">final</span></span></div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p><code>#include <py_solver.h></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for PyDynamicNetworkSolverStrategy:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="class_py_dynamic_network_solver_strategy.png" usemap="#PyDynamicNetworkSolverStrategy_map" alt=""/>
|
|
<map id="PyDynamicNetworkSolverStrategy_map" name="PyDynamicNetworkSolverStrategy_map">
|
|
<area href="classgridfire_1_1solver_1_1_network_solver_strategy.html" alt="gridfire::solver::NetworkSolverStrategy< DynamicEngine >" shape="rect" coords="0,0,342,24"/>
|
|
</map>
|
|
</div></div>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-methods" name="pri-methods"></a>
|
|
Private Member Functions</h2></td></tr>
|
|
<tr class="memitem:a4a3fce2a9853e7192354834bf2b36159" id="r_a4a3fce2a9853e7192354834bf2b36159"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a4a3fce2a9853e7192354834bf2b36159">PyDynamicNetworkSolverStrategy</a> (<a class="el" href="classgridfire_1_1_dynamic_engine.html">gridfire::DynamicEngine</a> &engine)</td></tr>
|
|
<tr class="separator:a4a3fce2a9853e7192354834bf2b36159"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2095abb83ed6229ebb27b4883cec51c4" id="r_a2095abb83ed6229ebb27b4883cec51c4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structgridfire_1_1_net_out.html">gridfire::NetOut</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a2095abb83ed6229ebb27b4883cec51c4">evaluate</a> (const <a class="el" href="structgridfire_1_1_net_in.html">gridfire::NetIn</a> &netIn) override</td></tr>
|
|
<tr class="memdesc:a2095abb83ed6229ebb27b4883cec51c4"><td class="mdescLeft"> </td><td class="mdescRight">Evaluates the network for a given timestep. <br /></td></tr>
|
|
<tr class="separator:a2095abb83ed6229ebb27b4883cec51c4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a>
|
|
Additional Inherited Members</h2></td></tr>
|
|
<tr class="inherit_header pub_methods_classgridfire_1_1solver_1_1_network_solver_strategy"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_classgridfire_1_1solver_1_1_network_solver_strategy')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classgridfire_1_1solver_1_1_network_solver_strategy.html">gridfire::solver::NetworkSolverStrategy< DynamicEngine ></a></td></tr>
|
|
<tr class="memitem:a01cbbec0eb5c3a60f50da38cdaf66505 inherit pub_methods_classgridfire_1_1solver_1_1_network_solver_strategy" id="r_a01cbbec0eb5c3a60f50da38cdaf66505"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1solver_1_1_network_solver_strategy.html#a01cbbec0eb5c3a60f50da38cdaf66505">NetworkSolverStrategy</a> (<a class="el" href="classgridfire_1_1_dynamic_engine.html">DynamicEngine</a> &engine)</td></tr>
|
|
<tr class="memdesc:a01cbbec0eb5c3a60f50da38cdaf66505 inherit pub_methods_classgridfire_1_1solver_1_1_network_solver_strategy"><td class="mdescLeft"> </td><td class="mdescRight">Constructor for the <a class="el" href="classgridfire_1_1solver_1_1_network_solver_strategy.html" title="Abstract base class for network solver strategies.">NetworkSolverStrategy</a>. <br /></td></tr>
|
|
<tr class="separator:a01cbbec0eb5c3a60f50da38cdaf66505 inherit pub_methods_classgridfire_1_1solver_1_1_network_solver_strategy"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1693dc93f63599c89587d729aca8e318 inherit pub_methods_classgridfire_1_1solver_1_1_network_solver_strategy" id="r_a1693dc93f63599c89587d729aca8e318"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1solver_1_1_network_solver_strategy.html#a1693dc93f63599c89587d729aca8e318">~NetworkSolverStrategy</a> ()=default</td></tr>
|
|
<tr class="memdesc:a1693dc93f63599c89587d729aca8e318 inherit pub_methods_classgridfire_1_1solver_1_1_network_solver_strategy"><td class="mdescLeft"> </td><td class="mdescRight">Virtual destructor. <br /></td></tr>
|
|
<tr class="separator:a1693dc93f63599c89587d729aca8e318 inherit pub_methods_classgridfire_1_1solver_1_1_network_solver_strategy"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a01cbbec0eb5c3a60f50da38cdaf66505 inherit pub_methods_classgridfire_1_1solver_1_1_network_solver_strategy" id="r_a01cbbec0eb5c3a60f50da38cdaf66505"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1solver_1_1_network_solver_strategy.html#a01cbbec0eb5c3a60f50da38cdaf66505">NetworkSolverStrategy</a> (<a class="el" href="classgridfire_1_1_dynamic_engine.html">DynamicEngine</a> &engine)</td></tr>
|
|
<tr class="memdesc:a01cbbec0eb5c3a60f50da38cdaf66505 inherit pub_methods_classgridfire_1_1solver_1_1_network_solver_strategy"><td class="mdescLeft"> </td><td class="mdescRight">Constructor for the <a class="el" href="classgridfire_1_1solver_1_1_network_solver_strategy.html" title="Abstract base class for network solver strategies.">NetworkSolverStrategy</a>. <br /></td></tr>
|
|
<tr class="separator:a01cbbec0eb5c3a60f50da38cdaf66505 inherit pub_methods_classgridfire_1_1solver_1_1_network_solver_strategy"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1693dc93f63599c89587d729aca8e318 inherit pub_methods_classgridfire_1_1solver_1_1_network_solver_strategy" id="r_a1693dc93f63599c89587d729aca8e318"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1solver_1_1_network_solver_strategy.html#a1693dc93f63599c89587d729aca8e318">~NetworkSolverStrategy</a> ()=default</td></tr>
|
|
<tr class="memdesc:a1693dc93f63599c89587d729aca8e318 inherit pub_methods_classgridfire_1_1solver_1_1_network_solver_strategy"><td class="mdescLeft"> </td><td class="mdescRight">Virtual destructor. <br /></td></tr>
|
|
<tr class="separator:a1693dc93f63599c89587d729aca8e318 inherit pub_methods_classgridfire_1_1solver_1_1_network_solver_strategy"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pro_attribs_classgridfire_1_1solver_1_1_network_solver_strategy"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pro_attribs_classgridfire_1_1solver_1_1_network_solver_strategy')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="classgridfire_1_1solver_1_1_network_solver_strategy.html">gridfire::solver::NetworkSolverStrategy< DynamicEngine ></a></td></tr>
|
|
<tr class="memitem:a724924d94eaf82b67d9988a55c3261e8 inherit pro_attribs_classgridfire_1_1solver_1_1_network_solver_strategy" id="r_a724924d94eaf82b67d9988a55c3261e8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgridfire_1_1_dynamic_engine.html">DynamicEngine</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1solver_1_1_network_solver_strategy.html#a724924d94eaf82b67d9988a55c3261e8">m_engine</a></td></tr>
|
|
<tr class="memdesc:a724924d94eaf82b67d9988a55c3261e8 inherit pro_attribs_classgridfire_1_1solver_1_1_network_solver_strategy"><td class="mdescLeft"> </td><td class="mdescRight">The engine used by this solver strategy. <br /></td></tr>
|
|
<tr class="separator:a724924d94eaf82b67d9988a55c3261e8 inherit pro_attribs_classgridfire_1_1solver_1_1_network_solver_strategy"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a724924d94eaf82b67d9988a55c3261e8 inherit pro_attribs_classgridfire_1_1solver_1_1_network_solver_strategy" id="r_a724924d94eaf82b67d9988a55c3261e8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgridfire_1_1_dynamic_engine.html">DynamicEngine</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1solver_1_1_network_solver_strategy.html#a724924d94eaf82b67d9988a55c3261e8">m_engine</a></td></tr>
|
|
<tr class="memdesc:a724924d94eaf82b67d9988a55c3261e8 inherit pro_attribs_classgridfire_1_1solver_1_1_network_solver_strategy"><td class="mdescLeft"> </td><td class="mdescRight">The engine used by this solver strategy. <br /></td></tr>
|
|
<tr class="separator:a724924d94eaf82b67d9988a55c3261e8 inherit pro_attribs_classgridfire_1_1solver_1_1_network_solver_strategy"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a4a3fce2a9853e7192354834bf2b36159" name="a4a3fce2a9853e7192354834bf2b36159"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4a3fce2a9853e7192354834bf2b36159">◆ </a></span>PyDynamicNetworkSolverStrategy()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">PyDynamicNetworkSolverStrategy::PyDynamicNetworkSolverStrategy </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classgridfire_1_1_dynamic_engine.html">gridfire::DynamicEngine</a> &</td> <td class="paramname"><span class="paramname"><em>engine</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel explicit">explicit</span><span class="mlabel private">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a2095abb83ed6229ebb27b4883cec51c4" name="a2095abb83ed6229ebb27b4883cec51c4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2095abb83ed6229ebb27b4883cec51c4">◆ </a></span>evaluate()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="structgridfire_1_1_net_out.html">gridfire::NetOut</a> PyDynamicNetworkSolverStrategy::evaluate </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="structgridfire_1_1_net_in.html">gridfire::NetIn</a> &</td> <td class="paramname"><span class="paramname"><em>netIn</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel override">override</span><span class="mlabel private">private</span><span class="mlabel virtual">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Evaluates the network for a given timestep. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">netIn</td><td>The input conditions for the network. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The output conditions after the timestep. </dd></dl>
|
|
|
|
<p>Implements <a class="el" href="classgridfire_1_1solver_1_1_network_solver_strategy.html#ace539b0482db171845ff1bd38d76b70f">gridfire::solver::NetworkSolverStrategy< DynamicEngine ></a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li>src/python/solver/trampoline/<a class="el" href="py__solver_8h.html">py_solver.h</a></li>
|
|
<li>src/python/solver/trampoline/<a class="el" href="py__solver_8cpp.html">py_solver.cpp</a></li>
|
|
</ul>
|
|
</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="class_py_dynamic_network_solver_strategy.html">PyDynamicNetworkSolverStrategy</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>
|