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

docs(rebuilt-docs): rebuild docs for v0.7.6rc4.0

Browse Source
This commit is contained in:
Emily Boudreaux
2026-04-20 12:45:31 -04:00
parent cf26983fe2
commit 7d611c56ad
2879 changed files with 341584 additions and 181414 deletions
Download Patch File Download Diff File Expand all files Collapse all files

85
docs/html/class_py_solver_context_base.html
View File

@@ -29,7 +29,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.6rc4.0</span>
</div>
<div id="projectbrief">General Purpose Nuclear Network</div>
</td>
@@ -120,16 +120,19 @@ Collaboration diagram for PySolverContextBase:</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:af18f517d550c037d56c44144c07f1ee8" id="r_af18f517d550c037d56c44144c07f1ee8"><td class="memItemLeft" align="right" valign="top">std::vector&lt; std::tuple&lt; std::string, std::string &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af18f517d550c037d56c44144c07f1ee8">describe</a> () const override</td></tr>
<tr class="memdesc:af18f517d550c037d56c44144c07f1ee8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Describe the context for callback functions. <br /></td></tr>
<tr class="separator:af18f517d550c037d56c44144c07f1ee8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classgridfire_1_1solver_1_1_solver_context_base"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_classgridfire_1_1solver_1_1_solver_context_base')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classgridfire_1_1solver_1_1_solver_context_base.html">gridfire::solver::SolverContextBase</a></td></tr>
<tr class="memitem:ab1abf9e5ff7f53a6cebe5e00ea5fc0c8 inherit pub_methods_classgridfire_1_1solver_1_1_solver_context_base" id="r_ab1abf9e5ff7f53a6cebe5e00ea5fc0c8"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1solver_1_1_solver_context_base.html#ab1abf9e5ff7f53a6cebe5e00ea5fc0c8">~SolverContextBase</a> ()=default</td></tr>
<tr class="separator:ab1abf9e5ff7f53a6cebe5e00ea5fc0c8 inherit pub_methods_classgridfire_1_1solver_1_1_solver_context_base"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac68080cd0e7aa2884ce628925e8cf932" id="r_ac68080cd0e7aa2884ce628925e8cf932"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac68080cd0e7aa2884ce628925e8cf932">init</a> () override</td></tr>
<tr class="separator:ac68080cd0e7aa2884ce628925e8cf932"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af8f861a94e0a6654a8f9b752a28ad0e7" id="r_af8f861a94e0a6654a8f9b752a28ad0e7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af8f861a94e0a6654a8f9b752a28ad0e7">set_stdout_logging</a> (bool enable) override</td></tr>
<tr class="separator:af8f861a94e0a6654a8f9b752a28ad0e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2400e5ab20fe2e5c31a712cb9b24aebe" id="r_a2400e5ab20fe2e5c31a712cb9b24aebe"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a2400e5ab20fe2e5c31a712cb9b24aebe">set_detailed_logging</a> (bool enable) override</td></tr>
<tr class="separator:a2400e5ab20fe2e5c31a712cb9b24aebe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_structgridfire_1_1solver_1_1_solver_context_base"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_structgridfire_1_1solver_1_1_solver_context_base')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="structgridfire_1_1solver_1_1_solver_context_base.html">gridfire::solver::SolverContextBase</a></td></tr>
<tr class="memitem:ab1abf9e5ff7f53a6cebe5e00ea5fc0c8 inherit pub_methods_structgridfire_1_1solver_1_1_solver_context_base" id="r_ab1abf9e5ff7f53a6cebe5e00ea5fc0c8"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgridfire_1_1solver_1_1_solver_context_base.html#ab1abf9e5ff7f53a6cebe5e00ea5fc0c8">~SolverContextBase</a> ()=default</td></tr>
<tr class="separator:ab1abf9e5ff7f53a6cebe5e00ea5fc0c8 inherit pub_methods_structgridfire_1_1solver_1_1_solver_context_base"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="af18f517d550c037d56c44144c07f1ee8" name="af18f517d550c037d56c44144c07f1ee8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af18f517d550c037d56c44144c07f1ee8">&#9670;&#160;</a></span>describe()</h2>
<a id="ac68080cd0e7aa2884ce628925e8cf932" name="ac68080cd0e7aa2884ce628925e8cf932"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac68080cd0e7aa2884ce628925e8cf932">&#9670;&#160;</a></span>init()</h2>
<div class="memitem">
<div class="memproto">
@@ -138,24 +141,74 @@ Public Member Functions</h2></td></tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::vector&lt; std::tuple&lt; std::string, std::string &gt; &gt; PySolverContextBase::describe </td>
<td class="memname">void PySolverContextBase::init </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel nodiscard">nodiscard</span><span class="mlabel override">override</span><span class="mlabel virtual">virtual</span></span> </td>
<span class="mlabels"><span class="mlabel override">override</span><span class="mlabel virtual">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Describe the context for callback functions. </p>
<dl class="section return"><dt>Returns</dt><dd>A vector of tuples, each containing a string for the parameters 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="structgridfire_1_1solver_1_1_solver_context_base.html#ae324568d7ca41599f1ea924f06284da0">gridfire::solver::SolverContextBase</a>.</p>
<p>Implements <a class="el" href="classgridfire_1_1solver_1_1_solver_context_base.html#a9cbef3cabc8524e542613ee50d8860c6">gridfire::solver::SolverContextBase</a>.</p>
</div>
</div>
<a id="a2400e5ab20fe2e5c31a712cb9b24aebe" name="a2400e5ab20fe2e5c31a712cb9b24aebe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2400e5ab20fe2e5c31a712cb9b24aebe">&#9670;&#160;</a></span>set_detailed_logging()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void PySolverContextBase::set_detailed_logging </td>
<td>(</td>
<td class="paramtype">bool</td> <td class="paramname"><span class="paramname"><em>enable</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 virtual">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implements <a class="el" href="structgridfire_1_1solver_1_1_solver_context_base.html#a4b8185f8b9d46d19d0b0c2bfba16391f">gridfire::solver::SolverContextBase</a>.</p>
</div>
</div>
<a id="af8f861a94e0a6654a8f9b752a28ad0e7" name="af8f861a94e0a6654a8f9b752a28ad0e7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af8f861a94e0a6654a8f9b752a28ad0e7">&#9670;&#160;</a></span>set_stdout_logging()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void PySolverContextBase::set_stdout_logging </td>
<td>(</td>
<td class="paramtype">bool</td> <td class="paramname"><span class="paramname"><em>enable</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 virtual">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implements <a class="el" href="structgridfire_1_1solver_1_1_solver_context_base.html#a693d8ad4649456ff3cf956072614a2e7">gridfire::solver::SolverContextBase</a>.</p>
</div>
</div>