tboudreaux/GridFire
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
75a88b97207e31ec8695e619f5392ccbcc6af3ab
GridFire/docs/html/classgridfire_1_1solver_1_1NetworkSolverStrategy.html

366 lines
20 KiB
HTML
Raw Blame History

<!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.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>GridFire: gridfire::solver::NetworkSolverStrategy&lt; EngineT &gt; Class Template 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>
<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>
<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">&#160;v0.7.1_rc2</span>
</div>
<div id="projectbrief">General Purpose Nuclear Network</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- 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" 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(); });
});
/* @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&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('classgridfire_1_1solver_1_1NetworkSolverStrategy.html',''); initResizable(); });
/* @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="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classgridfire_1_1solver_1_1NetworkSolverStrategy-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">gridfire::solver::NetworkSolverStrategy&lt; EngineT &gt; Class Template Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div></div>
</div><!--header-->
<div class="contents">
<p>Abstract base class for network solver strategies.
<a href="classgridfire_1_1solver_1_1NetworkSolverStrategy.html#details">More...</a></p>
<p><code>#include &lt;strategy_abstract.h&gt;</code></p>
<div class="dynheader">
Inheritance diagram for gridfire::solver::NetworkSolverStrategy&lt; EngineT &gt;:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classgridfire_1_1solver_1_1NetworkSolverStrategy__inherit__graph.svg" width="492" height="139"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a01cbbec0eb5c3a60f50da38cdaf66505" id="r_a01cbbec0eb5c3a60f50da38cdaf66505"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1solver_1_1NetworkSolverStrategy.html#a01cbbec0eb5c3a60f50da38cdaf66505">NetworkSolverStrategy</a> (EngineT &amp;engine)</td></tr>
<tr class="memdesc:a01cbbec0eb5c3a60f50da38cdaf66505"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor for the <a class="el" href="classgridfire_1_1solver_1_1NetworkSolverStrategy.html" title="Abstract base class for network solver strategies.">NetworkSolverStrategy</a>. <br /></td></tr>
<tr class="separator:a01cbbec0eb5c3a60f50da38cdaf66505"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1693dc93f63599c89587d729aca8e318" id="r_a1693dc93f63599c89587d729aca8e318"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1solver_1_1NetworkSolverStrategy.html#a1693dc93f63599c89587d729aca8e318">~NetworkSolverStrategy</a> ()=default</td></tr>
<tr class="memdesc:a1693dc93f63599c89587d729aca8e318"><td class="mdescLeft">&#160;</td><td class="mdescRight">Virtual destructor. <br /></td></tr>
<tr class="separator:a1693dc93f63599c89587d729aca8e318"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ace539b0482db171845ff1bd38d76b70f" id="r_ace539b0482db171845ff1bd38d76b70f"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="structgridfire_1_1NetOut.html">NetOut</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1solver_1_1NetworkSolverStrategy.html#ace539b0482db171845ff1bd38d76b70f">evaluate</a> (const <a class="el" href="structgridfire_1_1NetIn.html">NetIn</a> &amp;netIn)=0</td></tr>
<tr class="memdesc:ace539b0482db171845ff1bd38d76b70f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Evaluates the network for a given timestep. <br /></td></tr>
<tr class="separator:ace539b0482db171845ff1bd38d76b70f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4d97ee85933d5e5f90d4194bb021a1dc" id="r_a4d97ee85933d5e5f90d4194bb021a1dc"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1solver_1_1NetworkSolverStrategy.html#a4d97ee85933d5e5f90d4194bb021a1dc">set_callback</a> (const std::any &amp;callback)=0</td></tr>
<tr class="memdesc:a4d97ee85933d5e5f90d4194bb021a1dc"><td class="mdescLeft">&#160;</td><td class="mdescRight">set the callback function to be called at the end of each timestep. <br /></td></tr>
<tr class="separator:a4d97ee85933d5e5f90d4194bb021a1dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae09169769774f17df8701c42a64ed656" id="r_ae09169769774f17df8701c42a64ed656"><td class="memItemLeft" align="right" valign="top">virtual std::vector&lt; std::tuple&lt; std::string, std::string &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1solver_1_1NetworkSolverStrategy.html#ae09169769774f17df8701c42a64ed656">describe_callback_context</a> () const =0</td></tr>
<tr class="memdesc:ae09169769774f17df8701c42a64ed656"><td class="mdescLeft">&#160;</td><td class="mdescRight">Describe the context that will be passed to the callback function. <br /></td></tr>
<tr class="separator:ae09169769774f17df8701c42a64ed656"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-attribs" name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a724924d94eaf82b67d9988a55c3261e8" id="r_a724924d94eaf82b67d9988a55c3261e8"><td class="memItemLeft" align="right" valign="top">EngineT &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1solver_1_1NetworkSolverStrategy.html#a724924d94eaf82b67d9988a55c3261e8">m_engine</a></td></tr>
<tr class="memdesc:a724924d94eaf82b67d9988a55c3261e8"><td class="mdescLeft">&#160;</td><td class="mdescRight">The engine used by this solver strategy. <br /></td></tr>
<tr class="separator:a724924d94eaf82b67d9988a55c3261e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><div class="compoundTemplParams">template&lt;typename EngineT&gt;<br />
class gridfire::solver::NetworkSolverStrategy&lt; EngineT &gt;</div><p>Abstract base class for network solver strategies. </p>
<p>This class defines the interface for network solver strategies, which are responsible for integrating the reaction network ODEs over a given timestep. It is templated on the engine type to allow for different engine implementations to be used with the same solver.</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">EngineT</td><td>The type of engine to use with this solver strategy. Must inherit from Engine. </td></tr>
</table>
</dd>
</dl>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a01cbbec0eb5c3a60f50da38cdaf66505" name="a01cbbec0eb5c3a60f50da38cdaf66505"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a01cbbec0eb5c3a60f50da38cdaf66505">&#9670;&#160;</a></span>NetworkSolverStrategy()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename EngineT &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classgridfire_1_1solver_1_1NetworkSolverStrategy.html">gridfire::solver::NetworkSolverStrategy</a>&lt; EngineT &gt;::NetworkSolverStrategy </td>
<td>(</td>
<td class="paramtype">EngineT &amp;&#160;</td>
<td class="paramname"><em>engine</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor for the <a class="el" href="classgridfire_1_1solver_1_1NetworkSolverStrategy.html" title="Abstract base class for network solver strategies.">NetworkSolverStrategy</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">engine</td><td>The engine to use for evaluating the network. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a1693dc93f63599c89587d729aca8e318" name="a1693dc93f63599c89587d729aca8e318"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1693dc93f63599c89587d729aca8e318">&#9670;&#160;</a></span>~NetworkSolverStrategy()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename EngineT &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classgridfire_1_1solver_1_1NetworkSolverStrategy.html">gridfire::solver::NetworkSolverStrategy</a>&lt; EngineT &gt;::~<a class="el" href="classgridfire_1_1solver_1_1NetworkSolverStrategy.html">NetworkSolverStrategy</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Virtual destructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ae09169769774f17df8701c42a64ed656" name="ae09169769774f17df8701c42a64ed656"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae09169769774f17df8701c42a64ed656">&#9670;&#160;</a></span>describe_callback_context()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename EngineT &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual std::vector&lt; std::tuple&lt; std::string, std::string &gt; &gt; <a class="el" href="classgridfire_1_1solver_1_1NetworkSolverStrategy.html">gridfire::solver::NetworkSolverStrategy</a>&lt; EngineT &gt;::describe_callback_context </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Describe the context that will be passed to the callback function. </p>
<dl class="section return"><dt>Returns</dt><dd>A vector of tuples, each containing a string for the parameter's name and a string for its type.</dd></dl>
<p>This method should be overridden by derived classes to provide a description of the context that will be passed to the callback function. The intent of this method is that an end user can investigate the context that will be passed to the callback function, and use this information to craft their own callback function. </p>
<p>Implemented in <a class="el" href="classgridfire_1_1solver_1_1CVODESolverStrategy.html#a5dfb7a2ce0008d41dee4aa596a4e1ce4">gridfire::solver::CVODESolverStrategy</a>, and <a class="el" href="classPyDynamicNetworkSolverStrategy.html#a147a0a543268427a5930143902217ac3">PyDynamicNetworkSolverStrategy</a>.</p>
</div>
</div>
<a id="ace539b0482db171845ff1bd38d76b70f" name="ace539b0482db171845ff1bd38d76b70f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ace539b0482db171845ff1bd38d76b70f">&#9670;&#160;</a></span>evaluate()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename EngineT &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="structgridfire_1_1NetOut.html">NetOut</a> <a class="el" href="classgridfire_1_1solver_1_1NetworkSolverStrategy.html">gridfire::solver::NetworkSolverStrategy</a>&lt; EngineT &gt;::evaluate </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structgridfire_1_1NetIn.html">NetIn</a> &amp;&#160;</td>
<td class="paramname"><em>netIn</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure 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>Implemented in <a class="el" href="classPyDynamicNetworkSolverStrategy.html#a2095abb83ed6229ebb27b4883cec51c4">PyDynamicNetworkSolverStrategy</a>, and <a class="el" href="classgridfire_1_1solver_1_1CVODESolverStrategy.html#ab8224d205ea3a28d9c723631c2f00b53">gridfire::solver::CVODESolverStrategy</a>.</p>
</div>
</div>
<a id="a4d97ee85933d5e5f90d4194bb021a1dc" name="a4d97ee85933d5e5f90d4194bb021a1dc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4d97ee85933d5e5f90d4194bb021a1dc">&#9670;&#160;</a></span>set_callback()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename EngineT &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void <a class="el" href="classgridfire_1_1solver_1_1NetworkSolverStrategy.html">gridfire::solver::NetworkSolverStrategy</a>&lt; EngineT &gt;::set_callback </td>
<td>(</td>
<td class="paramtype">const std::any &amp;&#160;</td>
<td class="paramname"><em>callback</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>set the callback function to be called at the end of each timestep. </p>
<p>This function allows the user to set a callback function that will be called at the end of each timestep. The callback function will receive a <a class="el" href="namespacegridfire_1_1solver.html">gridfire::solver</a>::&lt;SOMESOLVER&gt;::TimestepContext object. Note that depending on the solver, this context may contain different information. Further, the exact signature of the callback function is left up to each solver. Every solver should provide a type or type alias TimestepCallback that defines the signature of the callback function so that the user can easily get that type information.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">callback</td><td>The callback function to be called at the end of each timestep. </td></tr>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="classgridfire_1_1solver_1_1CVODESolverStrategy.html#a77638ef3d2279009e5a57bbd3f0eb63b">gridfire::solver::CVODESolverStrategy</a>, and <a class="el" href="classPyDynamicNetworkSolverStrategy.html#a112a7babc03858a69d6994a7155370d3">PyDynamicNetworkSolverStrategy</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a724924d94eaf82b67d9988a55c3261e8" name="a724924d94eaf82b67d9988a55c3261e8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a724924d94eaf82b67d9988a55c3261e8">&#9670;&#160;</a></span>m_engine</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename EngineT &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">EngineT&amp; <a class="el" href="classgridfire_1_1solver_1_1NetworkSolverStrategy.html">gridfire::solver::NetworkSolverStrategy</a>&lt; EngineT &gt;::m_engine</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The engine used by this solver strategy. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/include/gridfire/solver/strategies/<a class="el" href="strategy__abstract_8h.html">strategy_abstract.h</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="namespacegridfire.html">gridfire</a></li><li class="navelem"><a class="el" href="namespacegridfire_1_1solver.html">solver</a></li><li class="navelem"><a class="el" href="classgridfire_1_1solver_1_1NetworkSolverStrategy.html">NetworkSolverStrategy</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>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink