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

docs(docs): rebuilt docs

Browse Source
This commit is contained in:
Emily Boudreaux
2025-11-24 09:08:28 -05:00
parent 9fab4fbfae
commit 22c0329de0
2410 changed files with 309008 additions and 146081 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
docs/html/class_py_dynamic_network_solver_strategy.html
View File

@@ -120,7 +120,7 @@ Collaboration diagram for PyDynamicNetworkSolverStrategy:</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">&#160;</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> &amp;engine)</td></tr>
<tr class="memitem:a4a3fce2a9853e7192354834bf2b36159" id="r_a4a3fce2a9853e7192354834bf2b36159"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4a3fce2a9853e7192354834bf2b36159">PyDynamicNetworkSolverStrategy</a> (gridfire::DynamicEngine &amp;engine)</td></tr>
<tr class="separator:a4a3fce2a9853e7192354834bf2b36159"><td class="memSeparator" colspan="2">&#160;</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>&#160;</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> &amp;netIn) override</td></tr>
<tr class="memdesc:a2095abb83ed6229ebb27b4883cec51c4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Evaluates the network for a given timestep. <br /></td></tr>
@@ -134,24 +134,24 @@ Private Member Functions</h2></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="-"/>&#160;Public Member Functions inherited from <a class="el" href="classgridfire_1_1solver_1_1_network_solver_strategy.html">gridfire::solver::NetworkSolverStrategy&lt; DynamicEngine &gt;</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">&#160;</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> &amp;engine)</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="-"/>&#160;Public Member Functions inherited from <a class="el" href="classgridfire_1_1solver_1_1_network_solver_strategy.html">gridfire::solver::NetworkSolverStrategy&lt; engine::DynamicEngine &gt;</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">&#160;</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_1engine_1_1_dynamic_engine.html">engine::DynamicEngine</a> &amp;engine)</td></tr>
<tr class="memdesc:a01cbbec0eb5c3a60f50da38cdaf66505 inherit pub_methods_classgridfire_1_1solver_1_1_network_solver_strategy"><td class="mdescLeft">&#160;</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">&#160;</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&#160;</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">&#160;</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">&#160;</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">&#160;</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> &amp;engine)</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">&#160;</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_1engine_1_1_dynamic_engine.html">engine::DynamicEngine</a> &amp;engine)</td></tr>
<tr class="memdesc:a01cbbec0eb5c3a60f50da38cdaf66505 inherit pub_methods_classgridfire_1_1solver_1_1_network_solver_strategy"><td class="mdescLeft">&#160;</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">&#160;</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&#160;</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">&#160;</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">&#160;</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="-"/>&#160;Protected Attributes inherited from <a class="el" href="classgridfire_1_1solver_1_1_network_solver_strategy.html">gridfire::solver::NetworkSolverStrategy&lt; DynamicEngine &gt;</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> &amp;&#160;</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="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="-"/>&#160;Protected Attributes inherited from <a class="el" href="classgridfire_1_1solver_1_1_network_solver_strategy.html">gridfire::solver::NetworkSolverStrategy&lt; engine::DynamicEngine &gt;</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_1engine_1_1_dynamic_engine.html">engine::DynamicEngine</a> &amp;&#160;</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">&#160;</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">&#160;</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> &amp;&#160;</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="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_1engine_1_1_dynamic_engine.html">engine::DynamicEngine</a> &amp;&#160;</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">&#160;</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">&#160;</td></tr>
</table>
@@ -168,7 +168,7 @@ Additional Inherited Members</h2></td></tr>
<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> &amp;</td> <td class="paramname"><span class="paramname"><em>engine</em></span></td><td>)</td>
<td class="paramtype">gridfire::DynamicEngine &amp;</td> <td class="paramname"><span class="paramname"><em>engine</em></span></td><td>)</td>
<td></td>
</tr>
</table>
@@ -209,7 +209,7 @@ Additional Inherited Members</h2></td></tr>
<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>Implements <a class="el" href="classgridfire_1_1solver_1_1_network_solver_strategy.html#ae09169769774f17df8701c42a64ed656">gridfire::solver::NetworkSolverStrategy&lt; DynamicEngine &gt;</a>.</p>
<p>Implements <a class="el" href="classgridfire_1_1solver_1_1_network_solver_strategy.html#ae09169769774f17df8701c42a64ed656">gridfire::solver::NetworkSolverStrategy&lt; engine::DynamicEngine &gt;</a>.</p>
</div>
</div>
@@ -245,7 +245,7 @@ Additional Inherited Members</h2></td></tr>
</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&lt; DynamicEngine &gt;</a>.</p>
<p>Implements <a class="el" href="classgridfire_1_1solver_1_1_network_solver_strategy.html#ace539b0482db171845ff1bd38d76b70f">gridfire::solver::NetworkSolverStrategy&lt; engine::DynamicEngine &gt;</a>.</p>
</div>
</div>
@@ -281,7 +281,7 @@ Additional Inherited Members</h2></td></tr>
</dd>
</dl>
<p>Implements <a class="el" href="classgridfire_1_1solver_1_1_network_solver_strategy.html#a4d97ee85933d5e5f90d4194bb021a1dc">gridfire::solver::NetworkSolverStrategy&lt; DynamicEngine &gt;</a>.</p>
<p>Implements <a class="el" href="classgridfire_1_1solver_1_1_network_solver_strategy.html#a4d97ee85933d5e5f90d4194bb021a1dc">gridfire::solver::NetworkSolverStrategy&lt; engine::DynamicEngine &gt;</a>.</p>
</div>
</div>