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

198 lines
11 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.13.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>GridFire: gridfire::StepDerivatives&lt; T &gt; Struct 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>
<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">
<div id="projectname">GridFire<span id="projectnumber">&#160;0.0.1a</span>
</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_1_step_derivatives.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-attribs">Public Attributes</a> &#124;
<a href="structgridfire_1_1_step_derivatives-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">gridfire::StepDerivatives&lt; T &gt; Struct Template Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Structure holding derivatives and energy generation for a network step.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="engine__abstract_8h_source.html">engine_abstract.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:ae0de268b86c2404379409c4feae0b34d" id="r_ae0de268b86c2404379409c4feae0b34d"><td class="memItemLeft" align="right" valign="top">std::vector&lt; T &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae0de268b86c2404379409c4feae0b34d">dydt</a></td></tr>
<tr class="memdesc:ae0de268b86c2404379409c4feae0b34d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Derivatives of abundances (dY/dt for each species). <br /></td></tr>
<tr class="separator:ae0de268b86c2404379409c4feae0b34d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab4aeb41be952c7b5844e1ee81fef9008" id="r_ab4aeb41be952c7b5844e1ee81fef9008"><td class="memItemLeft" align="right" valign="top">T&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab4aeb41be952c7b5844e1ee81fef9008">nuclearEnergyGenerationRate</a> = T(0.0)</td></tr>
<tr class="memdesc:ab4aeb41be952c7b5844e1ee81fef9008"><td class="mdescLeft">&#160;</td><td class="mdescRight">Specific energy generation rate (e.g., erg/g/s). <br /></td></tr>
<tr class="separator:ab4aeb41be952c7b5844e1ee81fef9008"><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;IsArithmeticOrAD T&gt;<br />
struct gridfire::StepDerivatives&lt; T &gt;</div><p>Structure holding derivatives and energy generation for a network step. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>Numeric type (double or CppAD::AD&lt;double&gt;).</td></tr>
</table>
</dd>
</dl>
<p>This struct is used to return both the time derivatives of all species abundances and the specific nuclear energy generation rate for a single network evaluation.</p>
<p>Example usage: </p><div class="fragment"><div class="line"><a class="code hl_struct" href="structgridfire_1_1_step_derivatives.html">StepDerivatives&lt;double&gt;</a> result = engine.calculateRHSAndEnergy(Y, T9, rho);</div>
<div class="line"><span class="keywordflow">for</span> (<span class="keywordtype">double</span> dydt_i : result.<a class="code hl_variable" href="#ae0de268b86c2404379409c4feae0b34d">dydt</a>) {</div>
<div class="line"> <span class="comment">// Use derivative</span></div>
<div class="line">}</div>
<div class="line"><span class="keywordtype">double</span> energyRate = result.<a class="code hl_variable" href="#ab4aeb41be952c7b5844e1ee81fef9008">nuclearEnergyGenerationRate</a>;</div>
<div class="ttc" id="astructgridfire_1_1_step_derivatives_html"><div class="ttname"><a href="structgridfire_1_1_step_derivatives.html">gridfire::StepDerivatives</a></div><div class="ttdoc">Structure holding derivatives and energy generation for a network step.</div><div class="ttdef"><b>Definition</b> <a href="engine__abstract_8h_source.html#l00060">engine_abstract.h:60</a></div></div>
<div class="ttc" id="astructgridfire_1_1_step_derivatives_html_ab4aeb41be952c7b5844e1ee81fef9008"><div class="ttname"><a href="#ab4aeb41be952c7b5844e1ee81fef9008">gridfire::StepDerivatives::nuclearEnergyGenerationRate</a></div><div class="ttdeci">T nuclearEnergyGenerationRate</div><div class="ttdoc">Specific energy generation rate (e.g., erg/g/s).</div><div class="ttdef"><b>Definition</b> <a href="engine__abstract_8h_source.html#l00062">engine_abstract.h:62</a></div></div>
<div class="ttc" id="astructgridfire_1_1_step_derivatives_html_ae0de268b86c2404379409c4feae0b34d"><div class="ttname"><a href="#ae0de268b86c2404379409c4feae0b34d">gridfire::StepDerivatives::dydt</a></div><div class="ttdeci">std::vector&lt; T &gt; dydt</div><div class="ttdoc">Derivatives of abundances (dY/dt for each species).</div><div class="ttdef"><b>Definition</b> <a href="engine__abstract_8h_source.html#l00061">engine_abstract.h:61</a></div></div>
</div><!-- fragment -->
<p class="definition">Definition at line <a class="el" href="engine__abstract_8h_source.html#l00060">60</a> of file <a class="el" href="engine__abstract_8h_source.html">engine_abstract.h</a>.</p>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a id="ae0de268b86c2404379409c4feae0b34d" name="ae0de268b86c2404379409c4feae0b34d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae0de268b86c2404379409c4feae0b34d">&#9670;&#160;</a></span>dydt</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;IsArithmeticOrAD T&gt; </div>
<table class="memname">
<tr>
<td class="memname">std::vector&lt;T&gt; <a class="el" href="structgridfire_1_1_step_derivatives.html">gridfire::StepDerivatives</a>&lt; T &gt;::dydt</td>
</tr>
</table>
</div><div class="memdoc">
<p>Derivatives of abundances (dY/dt for each species). </p>
<p class="definition">Definition at line <a class="el" href="engine__abstract_8h_source.html#l00061">61</a> of file <a class="el" href="engine__abstract_8h_source.html">engine_abstract.h</a>.</p>
</div>
</div>
<a id="ab4aeb41be952c7b5844e1ee81fef9008" name="ab4aeb41be952c7b5844e1ee81fef9008"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab4aeb41be952c7b5844e1ee81fef9008">&#9670;&#160;</a></span>nuclearEnergyGenerationRate</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;IsArithmeticOrAD T&gt; </div>
<table class="memname">
<tr>
<td class="memname">T <a class="el" href="structgridfire_1_1_step_derivatives.html">gridfire::StepDerivatives</a>&lt; T &gt;::nuclearEnergyGenerationRate = T(0.0)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Specific energy generation rate (e.g., erg/g/s). </p>
<p class="definition">Definition at line <a class="el" href="engine__abstract_8h_source.html#l00062">62</a> of file <a class="el" href="engine__abstract_8h_source.html">engine_abstract.h</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>src/include/gridfire/engine/<a class="el" href="engine__abstract_8h_source.html">engine_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="structgridfire_1_1_step_derivatives.html">StepDerivatives</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 View Git Blame Copy Permalink