1058 lines
68 KiB
HTML
1058 lines
68 KiB
HTML
<!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: PyDynamicEngine Class 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"> v0.7.6rc4.0</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&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&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&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&dn=expat.txt MIT */
|
|
$(function(){initNavTree('class_py_dynamic_engine.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> |
|
|
<a href="#pri-attribs">Private Attributes</a> |
|
|
<a href="class_py_dynamic_engine-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">PyDynamicEngine Class Reference<span class="mlabels"><span class="mlabel final">final</span></span></div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p><code>#include <py_engine.h></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for PyDynamicEngine:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><iframe scrolling="no" frameborder="0" src="class_py_dynamic_engine__inherit__graph.svg" width="178" height="199"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
|
|
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
|
|
<div class="dynheader">
|
|
Collaboration diagram for PyDynamicEngine:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><iframe scrolling="no" frameborder="0" src="class_py_dynamic_engine__coll__graph.svg" width="358" height="215"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
|
|
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></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:a75450cd1eee0d9d79b23eafbf452aa02" id="r_a75450cd1eee0d9d79b23eafbf452aa02"><td class="memItemLeft" align="right" valign="top">const std::vector< fourdst::atomic::Species > & </td><td class="memItemRight" valign="bottom"><a class="el" href="#a75450cd1eee0d9d79b23eafbf452aa02">getNetworkSpecies</a> (<a class="el" href="classgridfire_1_1engine_1_1scratch_1_1_state_blob.html">gridfire::engine::scratch::StateBlob</a> &ctx) const override</td></tr>
|
|
<tr class="memdesc:a75450cd1eee0d9d79b23eafbf452aa02"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="class_py_dynamic_engine.html">PyDynamicEngine</a> Implementation ///. <br /></td></tr>
|
|
<tr class="separator:a75450cd1eee0d9d79b23eafbf452aa02"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1331900141bb079e634151abdea075dc" id="r_a1331900141bb079e634151abdea075dc"><td class="memItemLeft" align="right" valign="top">std::expected< <a class="el" href="structgridfire_1_1engine_1_1_step_derivatives.html">gridfire::engine::StepDerivatives</a>< double >, <a class="el" href="namespacegridfire_1_1engine.html#a4d057e41b489bf20744dfa8d2958ad5a">gridfire::engine::EngineStatus</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="#a1331900141bb079e634151abdea075dc">calculateRHSAndEnergy</a> (<a class="el" href="classgridfire_1_1engine_1_1scratch_1_1_state_blob.html">gridfire::engine::scratch::StateBlob</a> &ctx, const fourdst::composition::CompositionAbstract &comp, double T9, double rho, bool trust) const override</td></tr>
|
|
<tr class="memdesc:a1331900141bb079e634151abdea075dc"><td class="mdescLeft"> </td><td class="mdescRight">Calculate the right-hand side (dY/dt) and energy generation. <br /></td></tr>
|
|
<tr class="separator:a1331900141bb079e634151abdea075dc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a13b42a3a523e4c14e06820a43f15041b" id="r_a13b42a3a523e4c14e06820a43f15041b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgridfire_1_1engine_1_1_network_jacobian.html">gridfire::engine::NetworkJacobian</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a13b42a3a523e4c14e06820a43f15041b">generateJacobianMatrix</a> (<a class="el" href="classgridfire_1_1engine_1_1scratch_1_1_state_blob.html">gridfire::engine::scratch::StateBlob</a> &ctx, const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const override</td></tr>
|
|
<tr class="memdesc:a13b42a3a523e4c14e06820a43f15041b"><td class="mdescLeft"> </td><td class="mdescRight">Generate the Jacobian matrix for the current state. <br /></td></tr>
|
|
<tr class="separator:a13b42a3a523e4c14e06820a43f15041b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5a2697b43cddeef2aeb40b604a0de933" id="r_a5a2697b43cddeef2aeb40b604a0de933"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgridfire_1_1engine_1_1_network_jacobian.html">gridfire::engine::NetworkJacobian</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a5a2697b43cddeef2aeb40b604a0de933">generateJacobianMatrix</a> (<a class="el" href="classgridfire_1_1engine_1_1scratch_1_1_state_blob.html">gridfire::engine::scratch::StateBlob</a> &ctx, const fourdst::composition::CompositionAbstract &comp, double T9, double rho, const std::vector< fourdst::atomic::Species > &activeSpecies) const override</td></tr>
|
|
<tr class="memdesc:a5a2697b43cddeef2aeb40b604a0de933"><td class="mdescLeft"> </td><td class="mdescRight">Generate the Jacobian matrix for the current state using a subset of active species. <br /></td></tr>
|
|
<tr class="separator:a5a2697b43cddeef2aeb40b604a0de933"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af9c4725bfc2cc8c85c63790e2385d55b" id="r_af9c4725bfc2cc8c85c63790e2385d55b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgridfire_1_1engine_1_1_network_jacobian.html">gridfire::engine::NetworkJacobian</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#af9c4725bfc2cc8c85c63790e2385d55b">generateJacobianMatrix</a> (<a class="el" href="classgridfire_1_1engine_1_1scratch_1_1_state_blob.html">gridfire::engine::scratch::StateBlob</a> &ctx, const fourdst::composition::CompositionAbstract &comp, double T9, double rho, const <a class="el" href="namespacegridfire_1_1engine.html#a9de1791ec719c0a9b76b835703336870">gridfire::engine::SparsityPattern</a> &sparsityPattern) const override</td></tr>
|
|
<tr class="memdesc:af9c4725bfc2cc8c85c63790e2385d55b"><td class="mdescLeft"> </td><td class="mdescRight">Generate the Jacobian matrix for the current state with a specified sparsity pattern. <br /></td></tr>
|
|
<tr class="separator:af9c4725bfc2cc8c85c63790e2385d55b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2f723f732e9a83c24c1e654885ec7eea" id="r_a2f723f732e9a83c24c1e654885ec7eea"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="#a2f723f732e9a83c24c1e654885ec7eea">calculateMolarReactionFlow</a> (<a class="el" href="classgridfire_1_1engine_1_1scratch_1_1_state_blob.html">gridfire::engine::scratch::StateBlob</a> &ctx, const <a class="el" href="classgridfire_1_1reaction_1_1_reaction.html">gridfire::reaction::Reaction</a> &reaction, const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const override</td></tr>
|
|
<tr class="memdesc:a2f723f732e9a83c24c1e654885ec7eea"><td class="mdescLeft"> </td><td class="mdescRight">Calculate the molar reaction flow for a given reaction. <br /></td></tr>
|
|
<tr class="separator:a2f723f732e9a83c24c1e654885ec7eea"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a78d0b8501591667f8593a929a5439692" id="r_a78d0b8501591667f8593a929a5439692"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classgridfire_1_1reaction_1_1_reaction_set.html">gridfire::reaction::ReactionSet</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="#a78d0b8501591667f8593a929a5439692">getNetworkReactions</a> (<a class="el" href="classgridfire_1_1engine_1_1scratch_1_1_state_blob.html">gridfire::engine::scratch::StateBlob</a> &ctx) const override</td></tr>
|
|
<tr class="memdesc:a78d0b8501591667f8593a929a5439692"><td class="mdescLeft"> </td><td class="mdescRight">Get the set of logical reactions in the network. <br /></td></tr>
|
|
<tr class="separator:a78d0b8501591667f8593a929a5439692"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a688269fb742d37ce15926ced80fa3f70" id="r_a688269fb742d37ce15926ced80fa3f70"><td class="memItemLeft" align="right" valign="top">std::expected< std::unordered_map< fourdst::atomic::Species, double >, <a class="el" href="namespacegridfire_1_1engine.html#a4d057e41b489bf20744dfa8d2958ad5a">gridfire::engine::EngineStatus</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="#a688269fb742d37ce15926ced80fa3f70">getSpeciesTimescales</a> (<a class="el" href="classgridfire_1_1engine_1_1scratch_1_1_state_blob.html">gridfire::engine::scratch::StateBlob</a> &ctx, const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const override</td></tr>
|
|
<tr class="memdesc:a688269fb742d37ce15926ced80fa3f70"><td class="mdescLeft"> </td><td class="mdescRight">Compute timescales for all species in the network. <br /></td></tr>
|
|
<tr class="separator:a688269fb742d37ce15926ced80fa3f70"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af5f39c10cfc932d006c08e4bd1c1bcad" id="r_af5f39c10cfc932d006c08e4bd1c1bcad"><td class="memItemLeft" align="right" valign="top">std::expected< std::unordered_map< fourdst::atomic::Species, double >, <a class="el" href="namespacegridfire_1_1engine.html#a4d057e41b489bf20744dfa8d2958ad5a">gridfire::engine::EngineStatus</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="#af5f39c10cfc932d006c08e4bd1c1bcad">getSpeciesDestructionTimescales</a> (<a class="el" href="classgridfire_1_1engine_1_1scratch_1_1_state_blob.html">gridfire::engine::scratch::StateBlob</a> &ctx, const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const override</td></tr>
|
|
<tr class="memdesc:af5f39c10cfc932d006c08e4bd1c1bcad"><td class="mdescLeft"> </td><td class="mdescRight">Compute destruction timescales for all species in the network. <br /></td></tr>
|
|
<tr class="separator:af5f39c10cfc932d006c08e4bd1c1bcad"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abe31184ce7e63f7428b4a31ab39e7a8d" id="r_abe31184ce7e63f7428b4a31ab39e7a8d"><td class="memItemLeft" align="right" valign="top">fourdst::composition::Composition </td><td class="memItemRight" valign="bottom"><a class="el" href="#abe31184ce7e63f7428b4a31ab39e7a8d">project</a> (<a class="el" href="classgridfire_1_1engine_1_1scratch_1_1_state_blob.html">gridfire::engine::scratch::StateBlob</a> &ctx, const <a class="el" href="structgridfire_1_1_net_in.html">gridfire::NetIn</a> &netIn) const override</td></tr>
|
|
<tr class="memdesc:abe31184ce7e63f7428b4a31ab39e7a8d"><td class="mdescLeft"> </td><td class="mdescRight">Update the thread local scratch pad state of a network. <br /></td></tr>
|
|
<tr class="separator:abe31184ce7e63f7428b4a31ab39e7a8d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae36830f13ee730dccc3a5a8b3e4d603c" id="r_ae36830f13ee730dccc3a5a8b3e4d603c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacegridfire_1_1screening.html#aa82aafbc4f8c28d0a75b60798e3a7d25">gridfire::screening::ScreeningType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ae36830f13ee730dccc3a5a8b3e4d603c">getScreeningModel</a> (<a class="el" href="classgridfire_1_1engine_1_1scratch_1_1_state_blob.html">gridfire::engine::scratch::StateBlob</a> &ctx) const override</td></tr>
|
|
<tr class="memdesc:ae36830f13ee730dccc3a5a8b3e4d603c"><td class="mdescLeft"> </td><td class="mdescRight">Get the current electron screening model. <br /></td></tr>
|
|
<tr class="separator:ae36830f13ee730dccc3a5a8b3e4d603c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abd2f90dc6bd506c2fd92045ba2a9e6cf" id="r_abd2f90dc6bd506c2fd92045ba2a9e6cf"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="#abd2f90dc6bd506c2fd92045ba2a9e6cf">getSpeciesIndex</a> (<a class="el" href="classgridfire_1_1engine_1_1scratch_1_1_state_blob.html">gridfire::engine::scratch::StateBlob</a> &ctx, const fourdst::atomic::Species &species) const override</td></tr>
|
|
<tr class="memdesc:abd2f90dc6bd506c2fd92045ba2a9e6cf"><td class="mdescLeft"> </td><td class="mdescRight">Get the index of a species in the network. <br /></td></tr>
|
|
<tr class="separator:abd2f90dc6bd506c2fd92045ba2a9e6cf"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a25d827397e97c638cd87223684effebc" id="r_a25d827397e97c638cd87223684effebc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structgridfire_1_1engine_1_1_priming_report.html">gridfire::engine::PrimingReport</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a25d827397e97c638cd87223684effebc">primeEngine</a> (<a class="el" href="classgridfire_1_1engine_1_1scratch_1_1_state_blob.html">gridfire::engine::scratch::StateBlob</a> &ctx, const <a class="el" href="structgridfire_1_1_net_in.html">gridfire::NetIn</a> &netIn) const override</td></tr>
|
|
<tr class="memdesc:a25d827397e97c638cd87223684effebc"><td class="mdescLeft"> </td><td class="mdescRight">Prime the engine with initial conditions. <br /></td></tr>
|
|
<tr class="separator:a25d827397e97c638cd87223684effebc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a01c0ea8802358c2cbc6d8571a145775a" id="r_a01c0ea8802358c2cbc6d8571a145775a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structgridfire_1_1engine_1_1_energy_derivatives.html">gridfire::engine::EnergyDerivatives</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a01c0ea8802358c2cbc6d8571a145775a">calculateEpsDerivatives</a> (<a class="el" href="classgridfire_1_1engine_1_1scratch_1_1_state_blob.html">gridfire::engine::scratch::StateBlob</a> &ctx, const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const override</td></tr>
|
|
<tr class="memdesc:a01c0ea8802358c2cbc6d8571a145775a"><td class="mdescLeft"> </td><td class="mdescRight">Calculate the derivatives of the energy generation rate with respect to T and rho. <br /></td></tr>
|
|
<tr class="separator:a01c0ea8802358c2cbc6d8571a145775a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a60445db14a6bfd0eeef7c0a62d458a60" id="r_a60445db14a6bfd0eeef7c0a62d458a60"><td class="memItemLeft" align="right" valign="top">fourdst::composition::Composition </td><td class="memItemRight" valign="bottom"><a class="el" href="#a60445db14a6bfd0eeef7c0a62d458a60">collectComposition</a> (<a class="el" href="classgridfire_1_1engine_1_1scratch_1_1_state_blob.html">gridfire::engine::scratch::StateBlob</a> &ctx, const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const override</td></tr>
|
|
<tr class="memdesc:a60445db14a6bfd0eeef7c0a62d458a60"><td class="mdescLeft"> </td><td class="mdescRight">Recursively collect composition from current engine and any sub engines if they exist. <br /></td></tr>
|
|
<tr class="separator:a60445db14a6bfd0eeef7c0a62d458a60"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac7232a79df901309c8f8b0b78788afe8" id="r_ac7232a79df901309c8f8b0b78788afe8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacegridfire_1_1engine.html#a83c9d755597668bba3cf00cd0ea10ee3">gridfire::engine::SpeciesStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ac7232a79df901309c8f8b0b78788afe8">getSpeciesStatus</a> (<a class="el" href="classgridfire_1_1engine_1_1scratch_1_1_state_blob.html">gridfire::engine::scratch::StateBlob</a> &ctx, const fourdst::atomic::Species &species) const override</td></tr>
|
|
<tr class="memdesc:ac7232a79df901309c8f8b0b78788afe8"><td class="mdescLeft"> </td><td class="mdescRight">Get the status of a species in the network. <br /></td></tr>
|
|
<tr class="separator:ac7232a79df901309c8f8b0b78788afe8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6db6bfd45e74517f837c1b83a9919924" id="r_a6db6bfd45e74517f837c1b83a9919924"><td class="memItemLeft" align="right" valign="top">std::optional< <a class="el" href="structgridfire_1_1engine_1_1_step_derivatives.html">gridfire::engine::StepDerivatives</a>< double > > </td><td class="memItemRight" valign="bottom"><a class="el" href="#a6db6bfd45e74517f837c1b83a9919924">getMostRecentRHSCalculation</a> (<a class="el" href="classgridfire_1_1engine_1_1scratch_1_1_state_blob.html">gridfire::engine::scratch::StateBlob</a> &ctx) const override</td></tr>
|
|
<tr class="separator:a6db6bfd45e74517f837c1b83a9919924"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6dc693583383d7237b3cede639b41f5f" id="r_a6dc693583383d7237b3cede639b41f5f"><td class="memItemLeft" align="right" valign="top">std::unique_ptr< <a class="el" href="classgridfire_1_1engine_1_1scratch_1_1_state_blob.html">gridfire::engine::scratch::StateBlob</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="#a6dc693583383d7237b3cede639b41f5f">constructStateBlob</a> (const <a class="el" href="classgridfire_1_1engine_1_1scratch_1_1_state_blob.html">gridfire::engine::scratch::StateBlob</a> *blob) const override</td></tr>
|
|
<tr class="separator:a6dc693583383d7237b3cede639b41f5f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_classgridfire_1_1engine_1_1_dynamic_engine"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_classgridfire_1_1engine_1_1_dynamic_engine')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classgridfire_1_1engine_1_1_dynamic_engine.html">gridfire::engine::DynamicEngine</a></td></tr>
|
|
<tr class="memitem:ac87099ff654ca30a8d8224f4779e1a15 inherit pub_methods_classgridfire_1_1engine_1_1_dynamic_engine" id="r_ac87099ff654ca30a8d8224f4779e1a15"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classgridfire_1_1reaction_1_1_reaction_set.html">reaction::ReactionSet</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1engine_1_1_dynamic_engine.html#ac87099ff654ca30a8d8224f4779e1a15">getInactiveNetworkReactions</a> (<a class="el" href="classgridfire_1_1engine_1_1scratch_1_1_state_blob.html">scratch::StateBlob</a> &ctx) const</td></tr>
|
|
<tr class="memdesc:ac87099ff654ca30a8d8224f4779e1a15 inherit pub_methods_classgridfire_1_1engine_1_1_dynamic_engine"><td class="mdescLeft"> </td><td class="mdescRight">Get the set of inactive reactions in the network. <br /></td></tr>
|
|
<tr class="separator:ac87099ff654ca30a8d8224f4779e1a15 inherit pub_methods_classgridfire_1_1engine_1_1_dynamic_engine"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adc0a33fa6e9d8de3b433fef55f3a6972 inherit pub_methods_classgridfire_1_1engine_1_1_dynamic_engine" id="r_adc0a33fa6e9d8de3b433fef55f3a6972"><td class="memItemLeft" align="right" valign="top">virtual double </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1engine_1_1_dynamic_engine.html#adc0a33fa6e9d8de3b433fef55f3a6972">getInactiveReactionMolarReactionFlow</a> (<a class="el" href="classgridfire_1_1engine_1_1scratch_1_1_state_blob.html">scratch::StateBlob</a> &ctx, const <a class="el" href="classgridfire_1_1reaction_1_1_reaction.html">reaction::Reaction</a> &reaction, const fourdst::composition::CompositionAbstract &comp, const double T9, const double rho) const</td></tr>
|
|
<tr class="separator:adc0a33fa6e9d8de3b433fef55f3a6972 inherit pub_methods_classgridfire_1_1engine_1_1_dynamic_engine"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_classgridfire_1_1engine_1_1_engine"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_classgridfire_1_1engine_1_1_engine')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classgridfire_1_1engine_1_1_engine.html">gridfire::engine::Engine</a></td></tr>
|
|
<tr class="memitem:af0ea99416c28933d364a872fc6aff556 inherit pub_methods_classgridfire_1_1engine_1_1_engine" id="r_af0ea99416c28933d364a872fc6aff556"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1engine_1_1_engine.html#af0ea99416c28933d364a872fc6aff556">~Engine</a> ()=default</td></tr>
|
|
<tr class="memdesc:af0ea99416c28933d364a872fc6aff556 inherit pub_methods_classgridfire_1_1engine_1_1_engine"><td class="mdescLeft"> </td><td class="mdescRight">Virtual destructor. <br /></td></tr>
|
|
<tr class="separator:af0ea99416c28933d364a872fc6aff556 inherit pub_methods_classgridfire_1_1engine_1_1_engine"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-attribs" name="pri-attribs"></a>
|
|
Private Attributes</h2></td></tr>
|
|
<tr class="memitem:a2246382b1c98ba69cdb419bba63a6d03" id="r_a2246382b1c98ba69cdb419bba63a6d03"><td class="memItemLeft" align="right" valign="top">std::vector< fourdst::atomic::Species > </td><td class="memItemRight" valign="bottom"><a class="el" href="#a2246382b1c98ba69cdb419bba63a6d03">m_species_cache</a></td></tr>
|
|
<tr class="separator:a2246382b1c98ba69cdb419bba63a6d03"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a01c0ea8802358c2cbc6d8571a145775a" name="a01c0ea8802358c2cbc6d8571a145775a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a01c0ea8802358c2cbc6d8571a145775a">◆ </a></span>calculateEpsDerivatives()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="structgridfire_1_1engine_1_1_energy_derivatives.html">gridfire::engine::EnergyDerivatives</a> PyDynamicEngine::calculateEpsDerivatives </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classgridfire_1_1engine_1_1scratch_1_1_state_blob.html">gridfire::engine::scratch::StateBlob</a> &</td> <td class="paramname"><span class="paramname"><em>ctx</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const fourdst::composition::CompositionAbstract &</td> <td class="paramname"><span class="paramname"><em>comp</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">double</td> <td class="paramname"><span class="paramname"><em>T9</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">double</td> <td class="paramname"><span class="paramname"><em>rho</em></span> ) const</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>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Calculate the derivatives of the energy generation rate with respect to T and rho. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">comp</td><td>Composition object containing current abundances. </td></tr>
|
|
<tr><td class="paramname">T9</td><td>Temperature in units of 10^9 K. </td></tr>
|
|
<tr><td class="paramname">rho</td><td>Density in g/cm^3. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>EnergyDerivatives containing dEps/dT and dEps/dRho.</dd></dl>
|
|
<p>This method computes the partial derivatives of the specific nuclear energy generation rate with respect to temperature and density for the current state. </p>
|
|
|
|
<p>Implements <a class="el" href="classgridfire_1_1engine_1_1_dynamic_engine.html#a3fd5d4f3c58d1790b7a517b5ef888eaf">gridfire::engine::DynamicEngine</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2f723f732e9a83c24c1e654885ec7eea" name="a2f723f732e9a83c24c1e654885ec7eea"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2f723f732e9a83c24c1e654885ec7eea">◆ </a></span>calculateMolarReactionFlow()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">double PyDynamicEngine::calculateMolarReactionFlow </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classgridfire_1_1engine_1_1scratch_1_1_state_blob.html">gridfire::engine::scratch::StateBlob</a> &</td> <td class="paramname"><span class="paramname"><em>ctx</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="classgridfire_1_1reaction_1_1_reaction.html">gridfire::reaction::Reaction</a> &</td> <td class="paramname"><span class="paramname"><em>reaction</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const fourdst::composition::CompositionAbstract &</td> <td class="paramname"><span class="paramname"><em>comp</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">double</td> <td class="paramname"><span class="paramname"><em>T9</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">double</td> <td class="paramname"><span class="paramname"><em>rho</em></span> ) const</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>Calculate the molar reaction flow for a given reaction. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ctx</td><td>The scratchpad context for the current state. </td></tr>
|
|
<tr><td class="paramname">reaction</td><td>The reaction for which to calculate the flow. </td></tr>
|
|
<tr><td class="paramname">comp</td><td>Composition object containing current abundances. </td></tr>
|
|
<tr><td class="paramname">T9</td><td>Temperature in units of 10^9 K. </td></tr>
|
|
<tr><td class="paramname">rho</td><td>Density in g/cm^3. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Molar flow rate for the reaction (e.g., mol/g/s).</dd></dl>
|
|
<p>This method computes the net rate at which the given reaction proceeds under the current state. </p>
|
|
|
|
<p>Implements <a class="el" href="classgridfire_1_1engine_1_1_dynamic_engine.html#abf0f13b9eae66da6119e6fca826379e8">gridfire::engine::DynamicEngine</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1331900141bb079e634151abdea075dc" name="a1331900141bb079e634151abdea075dc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1331900141bb079e634151abdea075dc">◆ </a></span>calculateRHSAndEnergy()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::expected< <a class="el" href="structgridfire_1_1engine_1_1_step_derivatives.html">gridfire::engine::StepDerivatives</a>< double >, <a class="el" href="namespacegridfire_1_1engine.html#a4d057e41b489bf20744dfa8d2958ad5a">gridfire::engine::EngineStatus</a> > PyDynamicEngine::calculateRHSAndEnergy </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classgridfire_1_1engine_1_1scratch_1_1_state_blob.html">gridfire::engine::scratch::StateBlob</a> &</td> <td class="paramname"><span class="paramname"><em></em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const fourdst::composition::CompositionAbstract &</td> <td class="paramname"><span class="paramname"><em>comp</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">double</td> <td class="paramname"><span class="paramname"><em>T9</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">double</td> <td class="paramname"><span class="paramname"><em>rho</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool</td> <td class="paramname"><span class="paramname"><em>trust</em></span> ) const</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>Calculate the right-hand side (dY/dt) and energy generation. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">comp</td><td>Composition object containing current abundances. </td></tr>
|
|
<tr><td class="paramname">T9</td><td>Temperature in units of 10^9 K. </td></tr>
|
|
<tr><td class="paramname">rho</td><td>Density in g/cm^3. </td></tr>
|
|
<tr><td class="paramname">trust</td><td>If true, indicates that the engine should trust the passed composition has already been collected. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>expected<StepDerivatives<double>> containing either dY/dt and energy generation rate or a stale engine error indicating that the engine must be updated</dd></dl>
|
|
<p>This function must be implemented by derived classes to compute the time derivatives of all species and the specific nuclear energy generation rate for the current state. </p>
|
|
|
|
<p>Implements <a class="el" href="classgridfire_1_1engine_1_1_engine.html#a71c9ed5e0810799cd6af1d8ffbc8a918">gridfire::engine::Engine</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a60445db14a6bfd0eeef7c0a62d458a60" name="a60445db14a6bfd0eeef7c0a62d458a60"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a60445db14a6bfd0eeef7c0a62d458a60">◆ </a></span>collectComposition()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">fourdst::composition::Composition PyDynamicEngine::collectComposition </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classgridfire_1_1engine_1_1scratch_1_1_state_blob.html">gridfire::engine::scratch::StateBlob</a> &</td> <td class="paramname"><span class="paramname"><em>ctx</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const fourdst::composition::CompositionAbstract &</td> <td class="paramname"><span class="paramname"><em>comp</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">double</td> <td class="paramname"><span class="paramname"><em>T9</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">double</td> <td class="paramname"><span class="paramname"><em>rho</em></span> ) const</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>Recursively collect composition from current engine and any sub engines if they exist. </p>
|
|
<p>If species i is defined in comp and in any sub engine or self composition then the molar abundance of species i in the returned composition will be that defined in comp. If there are species defined in sub engine compositions which are not defined in comp then their molar abundances will be based on the reported values from each sub engine. </p><dl class="section note"><dt>Note</dt><dd>It is up to each engine to decide how to handle filling in the return composition. </dd>
|
|
<dd>
|
|
These methods return an unfinalized composition which must then be finalized by the caller </dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ctx</td><td>The scratchpad context for the current state. </td></tr>
|
|
<tr><td class="paramname">comp</td><td>Input composition to "normalize". </td></tr>
|
|
<tr><td class="paramname">T9</td><td></td></tr>
|
|
<tr><td class="paramname">rho</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>An updated composition which is a superset of comp. This may contain species which were culled, for example, by either QSE partitioning or reaction flow rate culling </dd></dl>
|
|
|
|
<p>Implements <a class="el" href="classgridfire_1_1engine_1_1_dynamic_engine.html#a078a16d21f2d7de9636c5bc6a05ddfec">gridfire::engine::DynamicEngine</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6dc693583383d7237b3cede639b41f5f" name="a6dc693583383d7237b3cede639b41f5f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6dc693583383d7237b3cede639b41f5f">◆ </a></span>constructStateBlob()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::unique_ptr< <a class="el" href="classgridfire_1_1engine_1_1scratch_1_1_state_blob.html">gridfire::engine::scratch::StateBlob</a> > PyDynamicEngine::constructStateBlob </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classgridfire_1_1engine_1_1scratch_1_1_state_blob.html">gridfire::engine::scratch::StateBlob</a> *</td> <td class="paramname"><span class="paramname"><em>blob</em></span></td><td>)</td>
|
|
<td> const</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="classgridfire_1_1engine_1_1_dynamic_engine.html#a675024091dc64f8784204a78bab46d90">gridfire::engine::DynamicEngine</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a13b42a3a523e4c14e06820a43f15041b" name="a13b42a3a523e4c14e06820a43f15041b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a13b42a3a523e4c14e06820a43f15041b">◆ </a></span>generateJacobianMatrix() <span class="overload">[1/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classgridfire_1_1engine_1_1_network_jacobian.html">gridfire::engine::NetworkJacobian</a> PyDynamicEngine::generateJacobianMatrix </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classgridfire_1_1engine_1_1scratch_1_1_state_blob.html">gridfire::engine::scratch::StateBlob</a> &</td> <td class="paramname"><span class="paramname"><em>ctx</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const fourdst::composition::CompositionAbstract &</td> <td class="paramname"><span class="paramname"><em>comp</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">double</td> <td class="paramname"><span class="paramname"><em>T9</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">double</td> <td class="paramname"><span class="paramname"><em>rho</em></span> ) const</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>Generate the Jacobian matrix for the current state. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ctx</td><td>The scratchpad context for the current state. </td></tr>
|
|
<tr><td class="paramname">comp</td><td>Composition object containing current abundances. </td></tr>
|
|
<tr><td class="paramname">T9</td><td>Temperature in units of 10^9 K. </td></tr>
|
|
<tr><td class="paramname">rho</td><td>Density in g/cm^3.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>This method must compute and store the Jacobian matrix (∂(dY/dt)_i/∂Y_j) for the current state. The matrix can then be accessed via getJacobianMatrixEntry(). </p>
|
|
|
|
<p>Implements <a class="el" href="classgridfire_1_1engine_1_1_dynamic_engine.html#ab6d95491f017feb4c43d9fa05739fcd0">gridfire::engine::DynamicEngine</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af9c4725bfc2cc8c85c63790e2385d55b" name="af9c4725bfc2cc8c85c63790e2385d55b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af9c4725bfc2cc8c85c63790e2385d55b">◆ </a></span>generateJacobianMatrix() <span class="overload">[2/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classgridfire_1_1engine_1_1_network_jacobian.html">gridfire::engine::NetworkJacobian</a> PyDynamicEngine::generateJacobianMatrix </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classgridfire_1_1engine_1_1scratch_1_1_state_blob.html">gridfire::engine::scratch::StateBlob</a> &</td> <td class="paramname"><span class="paramname"><em>ctx</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const fourdst::composition::CompositionAbstract &</td> <td class="paramname"><span class="paramname"><em>comp</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">double</td> <td class="paramname"><span class="paramname"><em>T9</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">double</td> <td class="paramname"><span class="paramname"><em>rho</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="namespacegridfire_1_1engine.html#a9de1791ec719c0a9b76b835703336870">gridfire::engine::SparsityPattern</a> &</td> <td class="paramname"><span class="paramname"><em>sparsityPattern</em></span> ) const</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>Generate the Jacobian matrix for the current state with a specified sparsity pattern. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ctx</td><td>Get the scratchpad context for the current state. </td></tr>
|
|
<tr><td class="paramname">comp</td><td>Composition object containing current abundances. </td></tr>
|
|
<tr><td class="paramname">T9</td><td>Temperature in units of 10^9 K. </td></tr>
|
|
<tr><td class="paramname">rho</td><td>Density in g/cm^3. </td></tr>
|
|
<tr><td class="paramname">sparsityPattern</td><td>The sparsity pattern to use for the Jacobian matrix.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>This method must compute and store the Jacobian matrix (∂(dY/dt)_i/∂Y_j) for the current state using automatic differentiation, taking into account the provided sparsity pattern. The matrix can then be accessed via <code>getJacobianMatrixEntry()</code>.</p>
|
|
<dl class="section see"><dt>See also</dt><dd>getJacobianMatrixEntry() </dd></dl>
|
|
|
|
<p>Implements <a class="el" href="classgridfire_1_1engine_1_1_dynamic_engine.html#a78f7b315bfa0a1f34d8fd5ab652b6934">gridfire::engine::DynamicEngine</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5a2697b43cddeef2aeb40b604a0de933" name="a5a2697b43cddeef2aeb40b604a0de933"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5a2697b43cddeef2aeb40b604a0de933">◆ </a></span>generateJacobianMatrix() <span class="overload">[3/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classgridfire_1_1engine_1_1_network_jacobian.html">gridfire::engine::NetworkJacobian</a> PyDynamicEngine::generateJacobianMatrix </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classgridfire_1_1engine_1_1scratch_1_1_state_blob.html">gridfire::engine::scratch::StateBlob</a> &</td> <td class="paramname"><span class="paramname"><em>ctx</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const fourdst::composition::CompositionAbstract &</td> <td class="paramname"><span class="paramname"><em>comp</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">double</td> <td class="paramname"><span class="paramname"><em>T9</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">double</td> <td class="paramname"><span class="paramname"><em>rho</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::vector< fourdst::atomic::Species > &</td> <td class="paramname"><span class="paramname"><em>activeSpecies</em></span> ) const</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>Generate the Jacobian matrix for the current state using a subset of active species. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ctx</td><td>The scratchpad context for the current state. </td></tr>
|
|
<tr><td class="paramname">comp</td><td>Composition object containing current abundances. </td></tr>
|
|
<tr><td class="paramname">T9</td><td>Temperature in units of 10^9 K. </td></tr>
|
|
<tr><td class="paramname">rho</td><td>Density in g/cm^3. </td></tr>
|
|
<tr><td class="paramname">activeSpecies</td><td>The set of species to include in the Jacobian calculation.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>This method must compute and store the Jacobian matrix (∂(dY/dt)_i/∂Y_j) for the current state, considering only the specified subset of active species. The matrix can then be accessed via getJacobianMatrixEntry(). </p>
|
|
|
|
<p>Implements <a class="el" href="classgridfire_1_1engine_1_1_dynamic_engine.html#a983551b5fef4610799c062cb5be2b1c7">gridfire::engine::DynamicEngine</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6db6bfd45e74517f837c1b83a9919924" name="a6db6bfd45e74517f837c1b83a9919924"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6db6bfd45e74517f837c1b83a9919924">◆ </a></span>getMostRecentRHSCalculation()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::optional< <a class="el" href="structgridfire_1_1engine_1_1_step_derivatives.html">gridfire::engine::StepDerivatives</a>< double > > PyDynamicEngine::getMostRecentRHSCalculation </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classgridfire_1_1engine_1_1scratch_1_1_state_blob.html">gridfire::engine::scratch::StateBlob</a> &</td> <td class="paramname"><span class="paramname"><em>ctx</em></span></td><td>)</td>
|
|
<td> const</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="classgridfire_1_1engine_1_1_dynamic_engine.html#a30cc7809d53540bd3407d971de8eec48">gridfire::engine::DynamicEngine</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a78d0b8501591667f8593a929a5439692" name="a78d0b8501591667f8593a929a5439692"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a78d0b8501591667f8593a929a5439692">◆ </a></span>getNetworkReactions()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const <a class="el" href="classgridfire_1_1reaction_1_1_reaction_set.html">gridfire::reaction::ReactionSet</a> & PyDynamicEngine::getNetworkReactions </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classgridfire_1_1engine_1_1scratch_1_1_state_blob.html">gridfire::engine::scratch::StateBlob</a> &</td> <td class="paramname"><span class="paramname"><em>ctx</em></span></td><td>)</td>
|
|
<td> const</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>Get the set of logical reactions in the network. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Reference to the LogicalReactionSet containing all reactions. </dd></dl>
|
|
|
|
<p>Implements <a class="el" href="classgridfire_1_1engine_1_1_dynamic_engine.html#a77a889cbc3791beca4abb95cb663a4d6">gridfire::engine::DynamicEngine</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a75450cd1eee0d9d79b23eafbf452aa02" name="a75450cd1eee0d9d79b23eafbf452aa02"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a75450cd1eee0d9d79b23eafbf452aa02">◆ </a></span>getNetworkSpecies()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const std::vector< fourdst::atomic::Species > & PyDynamicEngine::getNetworkSpecies </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classgridfire_1_1engine_1_1scratch_1_1_state_blob.html">gridfire::engine::scratch::StateBlob</a> &</td> <td class="paramname"><span class="paramname"><em>ctx</em></span></td><td>)</td>
|
|
<td> const</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><a class="el" href="class_py_dynamic_engine.html">PyDynamicEngine</a> Implementation ///. </p>
|
|
|
|
<p>Implements <a class="el" href="classgridfire_1_1engine_1_1_engine.html#afa8b1970e20f4bab61e4d31ead09f930">gridfire::engine::Engine</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae36830f13ee730dccc3a5a8b3e4d603c" name="ae36830f13ee730dccc3a5a8b3e4d603c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae36830f13ee730dccc3a5a8b3e4d603c">◆ </a></span>getScreeningModel()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="namespacegridfire_1_1screening.html#aa82aafbc4f8c28d0a75b60798e3a7d25">gridfire::screening::ScreeningType</a> PyDynamicEngine::getScreeningModel </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classgridfire_1_1engine_1_1scratch_1_1_state_blob.html">gridfire::engine::scratch::StateBlob</a> &</td> <td class="paramname"><span class="paramname"><em>ctx</em></span></td><td>)</td>
|
|
<td> const</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>Get the current electron screening model. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ctx</td><td>The scratchpad context for the current state.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The currently active screening model type.</dd></dl>
|
|
<dl class="section user"><dt>Usage Example:</dt><dd><div class="fragment"><div class="line">screening::ScreeningType currentModel = myEngine.getScreeningModel();</div>
|
|
</div><!-- fragment --> </dd></dl>
|
|
|
|
<p>Implements <a class="el" href="classgridfire_1_1engine_1_1_dynamic_engine.html#a60834e4bcfb2e4ec21a9cbf7bb9f7363">gridfire::engine::DynamicEngine</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af5f39c10cfc932d006c08e4bd1c1bcad" name="af5f39c10cfc932d006c08e4bd1c1bcad"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af5f39c10cfc932d006c08e4bd1c1bcad">◆ </a></span>getSpeciesDestructionTimescales()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::expected< std::unordered_map< fourdst::atomic::Species, double >, <a class="el" href="namespacegridfire_1_1engine.html#a4d057e41b489bf20744dfa8d2958ad5a">gridfire::engine::EngineStatus</a> > PyDynamicEngine::getSpeciesDestructionTimescales </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classgridfire_1_1engine_1_1scratch_1_1_state_blob.html">gridfire::engine::scratch::StateBlob</a> &</td> <td class="paramname"><span class="paramname"><em>ctx</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const fourdst::composition::CompositionAbstract &</td> <td class="paramname"><span class="paramname"><em>comp</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">double</td> <td class="paramname"><span class="paramname"><em>T9</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">double</td> <td class="paramname"><span class="paramname"><em>rho</em></span> ) const</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>Compute destruction timescales for all species in the network. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ctx</td><td>The scratchpad context for the current state. </td></tr>
|
|
<tr><td class="paramname">comp</td><td>Composition object containing current abundances. </td></tr>
|
|
<tr><td class="paramname">T9</td><td>Temperature in units of 10^9 K. </td></tr>
|
|
<tr><td class="paramname">rho</td><td>Density in g/cm^3. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Map from Species to their destruction timescales (s).</dd></dl>
|
|
<p>This method estimates the destruction timescale for each species, which can be useful for understanding reaction flows and equilibrium states. </p>
|
|
|
|
<p>Implements <a class="el" href="classgridfire_1_1engine_1_1_dynamic_engine.html#a128dd0a7f738f93092c437eeda983fdf">gridfire::engine::DynamicEngine</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abd2f90dc6bd506c2fd92045ba2a9e6cf" name="abd2f90dc6bd506c2fd92045ba2a9e6cf"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abd2f90dc6bd506c2fd92045ba2a9e6cf">◆ </a></span>getSpeciesIndex()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">size_t PyDynamicEngine::getSpeciesIndex </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classgridfire_1_1engine_1_1scratch_1_1_state_blob.html">gridfire::engine::scratch::StateBlob</a> &</td> <td class="paramname"><span class="paramname"><em>ctx</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const fourdst::atomic::Species &</td> <td class="paramname"><span class="paramname"><em>species</em></span> ) const</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>Get the index of a species in the network. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ctx</td><td>The scratchpad context for the current state. </td></tr>
|
|
<tr><td class="paramname">species</td><td>The species to look up.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>This method allows querying the index of a specific species in the engine's internal representation. It is useful for accessing species data efficiently. </p>
|
|
|
|
<p>Implements <a class="el" href="classgridfire_1_1engine_1_1_dynamic_engine.html#a16bd2fae51fa738da62f2a767f6875d2">gridfire::engine::DynamicEngine</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac7232a79df901309c8f8b0b78788afe8" name="ac7232a79df901309c8f8b0b78788afe8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac7232a79df901309c8f8b0b78788afe8">◆ </a></span>getSpeciesStatus()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="namespacegridfire_1_1engine.html#a83c9d755597668bba3cf00cd0ea10ee3">gridfire::engine::SpeciesStatus</a> PyDynamicEngine::getSpeciesStatus </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classgridfire_1_1engine_1_1scratch_1_1_state_blob.html">gridfire::engine::scratch::StateBlob</a> &</td> <td class="paramname"><span class="paramname"><em>ctx</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const fourdst::atomic::Species &</td> <td class="paramname"><span class="paramname"><em>species</em></span> ) const</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>Get the status of a species in the network. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">species</td><td>The species to check. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>SpeciesStatus indicating whether the species is active, inactive, or culled.</dd></dl>
|
|
<p>This method allows querying the current status of a specific species within the engine's network. </p>
|
|
|
|
<p>Implements <a class="el" href="classgridfire_1_1engine_1_1_dynamic_engine.html#a1fefd34491959f9936b7a065fc2d6274">gridfire::engine::DynamicEngine</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a688269fb742d37ce15926ced80fa3f70" name="a688269fb742d37ce15926ced80fa3f70"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a688269fb742d37ce15926ced80fa3f70">◆ </a></span>getSpeciesTimescales()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::expected< std::unordered_map< fourdst::atomic::Species, double >, <a class="el" href="namespacegridfire_1_1engine.html#a4d057e41b489bf20744dfa8d2958ad5a">gridfire::engine::EngineStatus</a> > PyDynamicEngine::getSpeciesTimescales </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classgridfire_1_1engine_1_1scratch_1_1_state_blob.html">gridfire::engine::scratch::StateBlob</a> &</td> <td class="paramname"><span class="paramname"><em>ctx</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const fourdst::composition::CompositionAbstract &</td> <td class="paramname"><span class="paramname"><em>comp</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">double</td> <td class="paramname"><span class="paramname"><em>T9</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">double</td> <td class="paramname"><span class="paramname"><em>rho</em></span> ) const</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>Compute timescales for all species in the network. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">comp</td><td>Composition object containing current abundances. </td></tr>
|
|
<tr><td class="paramname">T9</td><td>Temperature in units of 10^9 K. </td></tr>
|
|
<tr><td class="paramname">rho</td><td>Density in g/cm^3. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Map from Species to their characteristic timescales (s).</dd></dl>
|
|
<p>This method estimates the timescale for abundance change of each species, which can be used for timestep control, diagnostics, and reaction network culling. </p>
|
|
|
|
<p>Implements <a class="el" href="classgridfire_1_1engine_1_1_dynamic_engine.html#a92be21f072b61fcf291559246045801f">gridfire::engine::DynamicEngine</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a25d827397e97c638cd87223684effebc" name="a25d827397e97c638cd87223684effebc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a25d827397e97c638cd87223684effebc">◆ </a></span>primeEngine()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="structgridfire_1_1engine_1_1_priming_report.html">gridfire::engine::PrimingReport</a> PyDynamicEngine::primeEngine </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classgridfire_1_1engine_1_1scratch_1_1_state_blob.html">gridfire::engine::scratch::StateBlob</a> &</td> <td class="paramname"><span class="paramname"><em>ctx</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="structgridfire_1_1_net_in.html">gridfire::NetIn</a> &</td> <td class="paramname"><span class="paramname"><em>netIn</em></span> ) const</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>Prime the engine with initial conditions. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ctx</td><td>The scratchpad context for the current state. </td></tr>
|
|
<tr><td class="paramname">netIn</td><td>The input conditions for the network. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>PrimingReport containing information about the priming process.</dd></dl>
|
|
<p>This method is used to prepare the engine for calculations by setting up initial conditions, reactions, and species. It may involve compiling reaction rates, initializing internal data structures, and performing any necessary pre-computation. </p>
|
|
|
|
<p>Implements <a class="el" href="classgridfire_1_1engine_1_1_dynamic_engine.html#a30df09678c3de1a55b7c6ac5eae35004">gridfire::engine::DynamicEngine</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abe31184ce7e63f7428b4a31ab39e7a8d" name="abe31184ce7e63f7428b4a31ab39e7a8d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abe31184ce7e63f7428b4a31ab39e7a8d">◆ </a></span>project()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">fourdst::composition::Composition PyDynamicEngine::project </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classgridfire_1_1engine_1_1scratch_1_1_state_blob.html">gridfire::engine::scratch::StateBlob</a> &</td> <td class="paramname"><span class="paramname"><em>ctx</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="structgridfire_1_1_net_in.html">gridfire::NetIn</a> &</td> <td class="paramname"><span class="paramname"><em>netIn</em></span> ) const</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>Update the thread local scratch pad state of a network. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ctx</td><td>The scratchpad context for the current state. </td></tr>
|
|
<tr><td class="paramname">netIn</td><td>A struct containing the current network input, such as temperature, density, and composition.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>This method is intended to be implemented by derived classes to update their internal state based on the provided network conditions. For example, an adaptive engine might use this to re-evaluate which reactions and species are active. For other engines that do not support manually updating, this method might do nothing.</p>
|
|
<dl class="section user"><dt>Usage Example:</dt><dd><div class="fragment"><div class="line">NetIn input = { ... };</div>
|
|
<div class="line">myEngine.update(input);</div>
|
|
</div><!-- fragment --></dd></dl>
|
|
<dl class="section post"><dt>Postcondition</dt><dd>The internal state of the engine is updated to reflect the new conditions. </dd></dl>
|
|
|
|
<p>Implements <a class="el" href="classgridfire_1_1engine_1_1_dynamic_engine.html#a260d36cc1e14ca8eda0309745e9134d9">gridfire::engine::DynamicEngine</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Data Documentation</h2>
|
|
<a id="a2246382b1c98ba69cdb419bba63a6d03" name="a2246382b1c98ba69cdb419bba63a6d03"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2246382b1c98ba69cdb419bba63a6d03">◆ </a></span>m_species_cache</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::vector<fourdst::atomic::Species> PyDynamicEngine::m_species_cache</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel mutable">mutable</span><span class="mlabel private">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li>src/python/engine/trampoline/<a class="el" href="py__engine_8h.html">py_engine.h</a></li>
|
|
<li>src/python/engine/trampoline/<a class="el" href="py__engine_8cpp.html">py_engine.cpp</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="class_py_dynamic_engine.html">PyDynamicEngine</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>
|