docs(docs): rebuilt for version v0.7.1_rc2

This commit is contained in:
2025-11-28 09:46:00 -05:00
parent 033c5a083d
commit a472dc5214
2480 changed files with 231104 additions and 76191 deletions

View File

@@ -3,18 +3,16 @@
<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="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>GridFire: src/include/gridfire/engine/types/jacobian.h File 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="resize.js"></script>
<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>
@@ -29,7 +27,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.1_rc2</span>
</div>
<div id="projectbrief">General Purpose Nuclear Network</div>
</td>
@@ -38,24 +36,19 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.13.2 -->
<!-- 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">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;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&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search',true);
$(function() { init_search(); });
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
@@ -73,7 +66,7 @@ $(function() {
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('jacobian_8h.html',''); initResizable(true); });
$(document).ready(function(){initNavTree('jacobian_8h.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
@@ -132,26 +125,26 @@ This graph shows which files directly or indirectly include this file:</div>
</div><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">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1engine_1_1_network_jacobian.html">gridfire::engine::NetworkJacobian</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A wrapper class for handling the network Jacobian matrix. <a href="classgridfire_1_1engine_1_1_network_jacobian.html#details">More...</a><br /></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1engine_1_1NetworkJacobian.html">gridfire::engine::NetworkJacobian</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A wrapper class for handling the network Jacobian matrix. <a href="classgridfire_1_1engine_1_1NetworkJacobian.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="namespaces" name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire.html">gridfire</a></td></tr>
<tr class="memitem:namespacegridfire" id="r_namespacegridfire"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire.html">gridfire</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire_1_1engine.html">gridfire::engine</a></td></tr>
<tr class="memitem:namespacegridfire_1_1engine" id="r_namespacegridfire_1_1engine"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire_1_1engine.html">gridfire::engine</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:aa7b127f4fe99188e3d94ff11608d54f0" id="r_aa7b127f4fe99188e3d94ff11608d54f0"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire_1_1engine.html#aa7b127f4fe99188e3d94ff11608d54f0">gridfire::engine::JacobianEntry</a> = std::pair&lt;std::pair&lt;fourdst::atomic::Species, fourdst::atomic::Species&gt;, double&gt;</td></tr>
<tr class="memdesc:aa7b127f4fe99188e3d94ff11608d54f0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Represents an entry in the Jacobian matrix. <br /></td></tr>
<tr class="separator:aa7b127f4fe99188e3d94ff11608d54f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac7974616b5fd465c4a42e3d882cdde6e" id="r_ac7974616b5fd465c4a42e3d882cdde6e"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire_1_1engine.html#ac7974616b5fd465c4a42e3d882cdde6e">gridfire::engine::JacobianEntry</a> = std::pair&lt; std::pair&lt; fourdst::atomic::Species, fourdst::atomic::Species &gt;, double &gt;</td></tr>
<tr class="memdesc:ac7974616b5fd465c4a42e3d882cdde6e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Represents an entry in the Jacobian matrix. <br /></td></tr>
<tr class="separator:ac7974616b5fd465c4a42e3d882cdde6e"><td class="memSeparator" colspan="2">&#160;</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:afacda3b01618f041a81fa516547564fa" id="r_afacda3b01618f041a81fa516547564fa"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgridfire_1_1engine_1_1_network_jacobian.html">NetworkJacobian</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire_1_1engine.html#afacda3b01618f041a81fa516547564fa">gridfire::engine::regularize_jacobian</a> (const <a class="el" href="classgridfire_1_1engine_1_1_network_jacobian.html">NetworkJacobian</a> &amp;jacobian, const fourdst::composition::CompositionAbstract &amp;comp, std::optional&lt; quill::Logger * &gt; logger=std::nullopt)</td></tr>
<tr class="memitem:afacda3b01618f041a81fa516547564fa" id="r_afacda3b01618f041a81fa516547564fa"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgridfire_1_1engine_1_1NetworkJacobian.html">NetworkJacobian</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire_1_1engine.html#afacda3b01618f041a81fa516547564fa">gridfire::engine::regularize_jacobian</a> (const <a class="el" href="classgridfire_1_1engine_1_1NetworkJacobian.html">NetworkJacobian</a> &amp;jacobian, const fourdst::composition::CompositionAbstract &amp;comp, std::optional&lt; quill::Logger * &gt; logger=std::nullopt)</td></tr>
<tr class="memdesc:afacda3b01618f041a81fa516547564fa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Regularizes the given Jacobian matrix based on the provided composition. <br /></td></tr>
<tr class="separator:afacda3b01618f041a81fa516547564fa"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
@@ -169,7 +162,7 @@ Variables</h2></td></tr>
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_b0856f6b0d80ccb263b2f415c91f9e17.html">include</a></li><li class="navelem"><a class="el" href="dir_3626e0c0e3c5d7812d6b277dfa4ec364.html">gridfire</a></li><li class="navelem"><a class="el" href="dir_aff155d61c3b73b9ab7dcdc908c4d49e.html">engine</a></li><li class="navelem"><a class="el" href="dir_80d0745b866022f2047f807b3376dff7.html">types</a></li><li class="navelem"><a class="el" href="jacobian_8h.html">jacobian.h</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>
<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>