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

183 lines
9.7 KiB
HTML
Raw Normal View History

docs(docs): added doxygen html directory
2025-07-01 07:24:18 -04:00
<!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: gridfire::approx8::Jacobian Struct 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">
feat(solver): added callback functions to solver in C++ and python
2025-07-31 15:04:57 -04:00
<div id="projectname">GridFire<span id="projectnumber">&#160;0.6.0</span>
docs(docs): added doxygen html directory
2025-07-01 07:24:18 -04:00
</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&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(); });
});
/* @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 */
$(function(){initNavTree('structgridfire_1_1approx8_1_1_jacobian.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="#pub-methods">Public Member Functions</a> &#124;
<a href="structgridfire_1_1approx8_1_1_jacobian-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">gridfire::approx8::Jacobian Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Functor to calculate the <a class="el" href="structgridfire_1_1approx8_1_1_jacobian.html" title="Functor to calculate the Jacobian matrix for implicit solvers.">Jacobian</a> matrix for implicit solvers.
<a href="#details">More...</a></p>
docs(docs): rebuilt
2025-07-31 10:54:31 -04:00
<p><code>#include &lt;engine_approx8.h&gt;</code></p>
docs(docs): added doxygen html directory
2025-07-01 07:24:18 -04:00
<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:a548431915b5895082eb96ce66d5494fa" id="r_a548431915b5895082eb96ce66d5494fa"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a548431915b5895082eb96ce66d5494fa">operator()</a> (const <a class="el" href="namespacegridfire_1_1approx8.html#aa04f907d4ef6a1b6b2a9a28d4bb53882">vector_type</a> &amp;y, <a class="el" href="namespacegridfire_1_1approx8.html#a275aecf94e3145c2ff3d1756deda54ce">matrix_type</a> &amp;J, double, <a class="el" href="namespacegridfire_1_1approx8.html#aa04f907d4ef6a1b6b2a9a28d4bb53882">vector_type</a> &amp;dfdt) const</td></tr>
<tr class="memdesc:a548431915b5895082eb96ce66d5494fa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calculates the <a class="el" href="structgridfire_1_1approx8_1_1_jacobian.html" title="Functor to calculate the Jacobian matrix for implicit solvers.">Jacobian</a> matrix. <br /></td></tr>
<tr class="separator:a548431915b5895082eb96ce66d5494fa"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Functor to calculate the <a class="el" href="structgridfire_1_1approx8_1_1_jacobian.html" title="Functor to calculate the Jacobian matrix for implicit solvers.">Jacobian</a> matrix for implicit solvers. </p>
docs(docs): asdded and cleaned up docs
2025-07-24 11:10:45 -04:00
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="_2_users_2tboudreaux_2_programming_24_d_s_t_a_r_2_grid_fire_2src_2include_2gridfire_2engine_2engine_approx8_8h-example.html#_a1">/Users/tboudreaux/Programming/4DSTAR/GridFire/src/include/gridfire/engine/engine_approx8.h</a>.</dd>
docs(docs): added doxygen html directory
2025-07-01 07:24:18 -04:00
</dl>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a548431915b5895082eb96ce66d5494fa" name="a548431915b5895082eb96ce66d5494fa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a548431915b5895082eb96ce66d5494fa">&#9670;&#160;</a></span>operator()()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gridfire::approx8::Jacobian::operator() </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacegridfire_1_1approx8.html#aa04f907d4ef6a1b6b2a9a28d4bb53882">vector_type</a> &amp;</td> <td class="paramname"><span class="paramname"><em>y</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespacegridfire_1_1approx8.html#a275aecf94e3145c2ff3d1756deda54ce">matrix_type</a> &amp;</td> <td class="paramname"><span class="paramname"><em>J</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double</td> <td class="paramname"><span class="paramname"><em></em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespacegridfire_1_1approx8.html#aa04f907d4ef6a1b6b2a9a28d4bb53882">vector_type</a> &amp;</td> <td class="paramname"><span class="paramname"><em>dfdt</em></span>&#160;) const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Calculates the <a class="el" href="structgridfire_1_1approx8_1_1_jacobian.html" title="Functor to calculate the Jacobian matrix for implicit solvers.">Jacobian</a> matrix. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">y</td><td>State vector. </td></tr>
<tr><td class="paramname">J</td><td><a class="el" href="structgridfire_1_1approx8_1_1_jacobian.html" title="Functor to calculate the Jacobian matrix for implicit solvers.">Jacobian</a> matrix. </td></tr>
<tr><td class="paramname">dfdt</td><td>Derivative of the state vector. </td></tr>
</table>
</dd>
</dl>
docs(docs): asdded and cleaned up docs
2025-07-24 11:10:45 -04:00
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="_2_users_2tboudreaux_2_programming_24_d_s_t_a_r_2_grid_fire_2src_2include_2gridfire_2engine_2engine_approx8_8h-example.html#a38">/Users/tboudreaux/Programming/4DSTAR/GridFire/src/include/gridfire/engine/engine_approx8.h</a>.</dd>
docs(docs): added doxygen html directory
2025-07-01 07:24:18 -04:00
</dl>
</div>
</div>
<hr/>The documentation for this struct was generated from the following files:<ul>
docs(docs): rebuilt
2025-07-31 10:54:31 -04:00
<li>src/include/gridfire/engine/<a class="el" href="engine__approx8_8h.html">engine_approx8.h</a></li>
<li>src/lib/engine/<a class="el" href="engine__approx8_8cpp.html">engine_approx8.cpp</a></li>
docs(docs): added doxygen html directory
2025-07-01 07:24:18 -04:00
</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_1approx8.html">approx8</a></li><li class="navelem"><a class="el" href="structgridfire_1_1approx8_1_1_jacobian.html">Jacobian</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>
Reference in New Issue Copy Permalink