1324 lines
73 KiB
HTML
1324 lines
73 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.9.8"/>
|
||
|
|
<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>
|
||
|
|
<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>
|
||
|
|
<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.1_rc2</span>
|
||
|
|
</div>
|
||
|
|
<div id="projectbrief">General Purpose Nuclear Network</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<!-- end header part -->
|
||
|
|
<!-- Generated by Doxygen 1.9.8 -->
|
||
|
|
<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" 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');
|
||
|
|
$(document).ready(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 */
|
||
|
|
$(document).ready(function(){initNavTree('classPyDynamicEngine.html',''); initResizable(); });
|
||
|
|
/* @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="classPyDynamicEngine-members.html">List of all members</a> </div>
|
||
|
|
<div class="headertitle"><div class="title">PyDynamicEngine Class Reference<span class="mlabels"><span class="mlabel">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="classPyDynamicEngine__inherit__graph.svg" width="198" height="198"><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="classPyDynamicEngine__coll__graph.svg" width="374" height="227"><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:afc745e7ab5da5d8b3cf916044515cd7d" id="r_afc745e7ab5da5d8b3cf916044515cd7d"><td class="memItemLeft" align="right" valign="top">const std::vector< fourdst::atomic::Species > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classPyDynamicEngine.html#afc745e7ab5da5d8b3cf916044515cd7d">getNetworkSpecies</a> () const override</td></tr>
|
||
|
|
<tr class="memdesc:afc745e7ab5da5d8b3cf916044515cd7d"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classPyDynamicEngine.html">PyDynamicEngine</a> Implementation ///. <br /></td></tr>
|
||
|
|
<tr class="separator:afc745e7ab5da5d8b3cf916044515cd7d"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:aac1f2005c0a58befc4e01627c9357924" id="r_aac1f2005c0a58befc4e01627c9357924"><td class="memItemLeft" align="right" valign="top">std::expected< <a class="el" href="structgridfire_1_1engine_1_1StepDerivatives.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="classPyDynamicEngine.html#aac1f2005c0a58befc4e01627c9357924">calculateRHSAndEnergy</a> (const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const override</td></tr>
|
||
|
|
<tr class="memdesc:aac1f2005c0a58befc4e01627c9357924"><td class="mdescLeft"> </td><td class="mdescRight">Calculate the right-hand side (dY/dt) and energy generation. <br /></td></tr>
|
||
|
|
<tr class="separator:aac1f2005c0a58befc4e01627c9357924"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a298f700c647d2c3973d2a35d370c823e" id="r_a298f700c647d2c3973d2a35d370c823e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgridfire_1_1engine_1_1NetworkJacobian.html">gridfire::engine::NetworkJacobian</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPyDynamicEngine.html#a298f700c647d2c3973d2a35d370c823e">generateJacobianMatrix</a> (const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const override</td></tr>
|
||
|
|
<tr class="memdesc:a298f700c647d2c3973d2a35d370c823e"><td class="mdescLeft"> </td><td class="mdescRight">Generate the Jacobian matrix for the current state. <br /></td></tr>
|
||
|
|
<tr class="separator:a298f700c647d2c3973d2a35d370c823e"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a2b1c054b250abccc2af9a7275c68df4a" id="r_a2b1c054b250abccc2af9a7275c68df4a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgridfire_1_1engine_1_1NetworkJacobian.html">gridfire::engine::NetworkJacobian</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPyDynamicEngine.html#a2b1c054b250abccc2af9a7275c68df4a">generateJacobianMatrix</a> (const fourdst::composition::CompositionAbstract &comp, double T9, double rho, const std::vector< fourdst::atomic::Species > &activeSpecies) const override</td></tr>
|
||
|
|
<tr class="memdesc:a2b1c054b250abccc2af9a7275c68df4a"><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:a2b1c054b250abccc2af9a7275c68df4a"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a204643754cac3cf37c550ecd32f659fe" id="r_a204643754cac3cf37c550ecd32f659fe"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgridfire_1_1engine_1_1NetworkJacobian.html">gridfire::engine::NetworkJacobian</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPyDynamicEngine.html#a204643754cac3cf37c550ecd32f659fe">generateJacobianMatrix</a> (const fourdst::composition::CompositionAbstract &comp, double T9, double rho, const <a class="el" href="namespacegridfire_1_1engine.html#af5175018d2d1e78a8826dd33ec6d675f">gridfire::engine::SparsityPattern</a> &sparsityPattern) const override</td></tr>
|
||
|
|
<tr class="memdesc:a204643754cac3cf37c550ecd32f659fe"><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:a204643754cac3cf37c550ecd32f659fe"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a2066649ca11a869c054079ea12d8d0e9" id="r_a2066649ca11a869c054079ea12d8d0e9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPyDynamicEngine.html#a2066649ca11a869c054079ea12d8d0e9">generateStoichiometryMatrix</a> () override</td></tr>
|
||
|
|
<tr class="memdesc:a2066649ca11a869c054079ea12d8d0e9"><td class="mdescLeft"> </td><td class="mdescRight">Generate the stoichiometry matrix for the network. <br /></td></tr>
|
||
|
|
<tr class="separator:a2066649ca11a869c054079ea12d8d0e9"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a3dd5cf419f25e76e144af35df15a2067" id="r_a3dd5cf419f25e76e144af35df15a2067"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classPyDynamicEngine.html#a3dd5cf419f25e76e144af35df15a2067">getStoichiometryMatrixEntry</a> (const fourdst::atomic::Species &species, const <a class="el" href="classgridfire_1_1reaction_1_1Reaction.html">gridfire::reaction::Reaction</a> &reaction) const override</td></tr>
|
||
|
|
<tr class="memdesc:a3dd5cf419f25e76e144af35df15a2067"><td class="mdescLeft"> </td><td class="mdescRight">Get an entry from the stoichiometry matrix. <br /></td></tr>
|
||
|
|
<tr class="separator:a3dd5cf419f25e76e144af35df15a2067"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a8facba88b6df6e016ce53a0ff3cff125" id="r_a8facba88b6df6e016ce53a0ff3cff125"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classPyDynamicEngine.html#a8facba88b6df6e016ce53a0ff3cff125">calculateMolarReactionFlow</a> (const <a class="el" href="classgridfire_1_1reaction_1_1Reaction.html">gridfire::reaction::Reaction</a> &reaction, const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const override</td></tr>
|
||
|
|
<tr class="memdesc:a8facba88b6df6e016ce53a0ff3cff125"><td class="mdescLeft"> </td><td class="mdescRight">Calculate the molar reaction flow for a given reaction. <br /></td></tr>
|
||
|
|
<tr class="separator:a8facba88b6df6e016ce53a0ff3cff125"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a1d5143640666631501cf229bc491516e" id="r_a1d5143640666631501cf229bc491516e"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classgridfire_1_1reaction_1_1ReactionSet.html">gridfire::reaction::ReactionSet</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classPyDynamicEngine.html#a1d5143640666631501cf229bc491516e">getNetworkReactions</a> () const override</td></tr>
|
||
|
|
<tr class="memdesc:a1d5143640666631501cf229bc491516e"><td class="mdescLeft"> </td><td class="mdescRight">Get the set of logical reactions in the network. <br /></td></tr>
|
||
|
|
<tr class="separator:a1d5143640666631501cf229bc491516e"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:af469cba3be850d53f659ec173f0eb4e4" id="r_af469cba3be850d53f659ec173f0eb4e4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPyDynamicEngine.html#af469cba3be850d53f659ec173f0eb4e4">setNetworkReactions</a> (const <a class="el" href="classgridfire_1_1reaction_1_1ReactionSet.html">gridfire::reaction::ReactionSet</a> &reactions) override</td></tr>
|
||
|
|
<tr class="memdesc:af469cba3be850d53f659ec173f0eb4e4"><td class="mdescLeft"> </td><td class="mdescRight">Set the reactions for the network. <br /></td></tr>
|
||
|
|
<tr class="separator:af469cba3be850d53f659ec173f0eb4e4"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a71678a567bb0cedd8a97aff9ceddd814" id="r_a71678a567bb0cedd8a97aff9ceddd814"><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="classPyDynamicEngine.html#a71678a567bb0cedd8a97aff9ceddd814">getSpeciesTimescales</a> (const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const override</td></tr>
|
||
|
|
<tr class="memdesc:a71678a567bb0cedd8a97aff9ceddd814"><td class="mdescLeft"> </td><td class="mdescRight">Compute timescales for all species in the network. <br /></td></tr>
|
||
|
|
<tr class="separator:a71678a567bb0cedd8a97aff9ceddd814"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a8d34faa3d6ea804a3467979858d33535" id="r_a8d34faa3d6ea804a3467979858d33535"><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="classPyDynamicEngine.html#a8d34faa3d6ea804a3467979858d33535">getSpeciesDestructionTimescales</a> (const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const override</td></tr>
|
||
|
|
<tr class="memdesc:a8d34faa3d6ea804a3467979858d33535"><td class="mdescLeft"> </td><td class="mdescRight">Compute destruction timescales for all species in the network. <br /></td></tr>
|
||
|
|
<tr class="separator:a8d34faa3d6ea804a3467979858d33535"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:af8e6a8cd44f278535d7bcc9a896d6da8" id="r_af8e6a8cd44f278535d7bcc9a896d6da8"><td class="memItemLeft" align="right" valign="top">fourdst::composition::Composition </td><td class="memItemRight" valign="bottom"><a class="el" href="classPyDynamicEngine.html#af8e6a8cd44f278535d7bcc9a896d6da8">update</a> (const <a class="el" href="structgridfire_1_1NetIn.html">gridfire::NetIn</a> &netIn) override</td></tr>
|
||
|
|
<tr class="memdesc:af8e6a8cd44f278535d7bcc9a896d6da8"><td class="mdescLeft"> </td><td class="mdescRight">Update the internal state of the engine. <br /></td></tr>
|
||
|
|
<tr class="separator:af8e6a8cd44f278535d7bcc9a896d6da8"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a55bf19ed7534a312a36faf74753f7b14" id="r_a55bf19ed7534a312a36faf74753f7b14"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPyDynamicEngine.html#a55bf19ed7534a312a36faf74753f7b14">isStale</a> (const <a class="el" href="structgridfire_1_1NetIn.html">gridfire::NetIn</a> &netIn) override</td></tr>
|
||
|
|
<tr class="memdesc:a55bf19ed7534a312a36faf74753f7b14"><td class="mdescLeft"> </td><td class="mdescRight">Check if the engine's internal state is stale. <br /></td></tr>
|
||
|
|
<tr class="separator:a55bf19ed7534a312a36faf74753f7b14"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:afa3abfd612033336a656f092721c14ac" id="r_afa3abfd612033336a656f092721c14ac"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPyDynamicEngine.html#afa3abfd612033336a656f092721c14ac">setScreeningModel</a> (<a class="el" href="namespacegridfire_1_1screening.html#aa82aafbc4f8c28d0a75b60798e3a7d25">gridfire::screening::ScreeningType</a> model) override</td></tr>
|
||
|
|
<tr class="memdesc:afa3abfd612033336a656f092721c14ac"><td class="mdescLeft"> </td><td class="mdescRight">Set the electron screening model. <br /></td></tr>
|
||
|
|
<tr class="separator:afa3abfd612033336a656f092721c14ac"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ab4cfdca5e15957c5cef75ffa6dedeee5" id="r_ab4cfdca5e15957c5cef75ffa6dedeee5"><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="classPyDynamicEngine.html#ab4cfdca5e15957c5cef75ffa6dedeee5">getScreeningModel</a> () const override</td></tr>
|
||
|
|
<tr class="memdesc:ab4cfdca5e15957c5cef75ffa6dedeee5"><td class="mdescLeft"> </td><td class="mdescRight">Get the current electron screening model. <br /></td></tr>
|
||
|
|
<tr class="separator:ab4cfdca5e15957c5cef75ffa6dedeee5"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a95d10a7b240d543a1bc6c67ddf2dc8e0" id="r_a95d10a7b240d543a1bc6c67ddf2dc8e0"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classPyDynamicEngine.html#a95d10a7b240d543a1bc6c67ddf2dc8e0">getSpeciesIndex</a> (const fourdst::atomic::Species &species) const override</td></tr>
|
||
|
|
<tr class="memdesc:a95d10a7b240d543a1bc6c67ddf2dc8e0"><td class="mdescLeft"> </td><td class="mdescRight">Get the index of a species in the network. <br /></td></tr>
|
||
|
|
<tr class="separator:a95d10a7b240d543a1bc6c67ddf2dc8e0"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a61bb4b430fe740cfb2c24e5cc673e4ac" id="r_a61bb4b430fe740cfb2c24e5cc673e4ac"><td class="memItemLeft" align="right" valign="top">std::vector< double > </td><td class="memItemRight" valign="bottom"><a class="el" href="classPyDynamicEngine.html#a61bb4b430fe740cfb2c24e5cc673e4ac">mapNetInToMolarAbundanceVector</a> (const <a class="el" href="structgridfire_1_1NetIn.html">gridfire::NetIn</a> &netIn) const override</td></tr>
|
||
|
|
<tr class="memdesc:a61bb4b430fe740cfb2c24e5cc673e4ac"><td class="mdescLeft"> </td><td class="mdescRight">Map a NetIn object to a vector of molar abundances. <br /></td></tr>
|
||
|
|
<tr class="separator:a61bb4b430fe740cfb2c24e5cc673e4ac"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a6118af81e45d2850f7a2517891147274" id="r_a6118af81e45d2850f7a2517891147274"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structgridfire_1_1engine_1_1PrimingReport.html">gridfire::engine::PrimingReport</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPyDynamicEngine.html#a6118af81e45d2850f7a2517891147274">primeEngine</a> (const <a class="el" href="structgridfire_1_1NetIn.html">gridfire::NetIn</a> &netIn) override</td></tr>
|
||
|
|
<tr class="memdesc:a6118af81e45d2850f7a2517891147274"><td class="mdescLeft"> </td><td class="mdescRight">Prime the engine with initial conditions. <br /></td></tr>
|
||
|
|
<tr class="separator:a6118af81e45d2850f7a2517891147274"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a541cf022fe3253279f8f1309c10556d7" id="r_a541cf022fe3253279f8f1309c10556d7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacegridfire_1_1engine.html#a540b6420c7b6271717ec9b640140f6c0">gridfire::engine::BuildDepthType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPyDynamicEngine.html#a541cf022fe3253279f8f1309c10556d7">getDepth</a> () const override</td></tr>
|
||
|
|
<tr class="memdesc:a541cf022fe3253279f8f1309c10556d7"><td class="mdescLeft"> </td><td class="mdescRight">Get the depth of the network. <br /></td></tr>
|
||
|
|
<tr class="separator:a541cf022fe3253279f8f1309c10556d7"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a25e52496b36d731127603c31e9dcaa97" id="r_a25e52496b36d731127603c31e9dcaa97"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPyDynamicEngine.html#a25e52496b36d731127603c31e9dcaa97">rebuild</a> (const fourdst::composition::CompositionAbstract &comp, <a class="el" href="namespacegridfire_1_1engine.html#a540b6420c7b6271717ec9b640140f6c0">gridfire::engine::BuildDepthType</a> depth) override</td></tr>
|
||
|
|
<tr class="memdesc:a25e52496b36d731127603c31e9dcaa97"><td class="mdescLeft"> </td><td class="mdescRight">Rebuild the network with a specified depth. <br /></td></tr>
|
||
|
|
<tr class="separator:a25e52496b36d731127603c31e9dcaa97"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a6832a7898da51017a20f578e33cba729" id="r_a6832a7898da51017a20f578e33cba729"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structgridfire_1_1engine_1_1EnergyDerivatives.html">gridfire::engine::EnergyDerivatives</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPyDynamicEngine.html#a6832a7898da51017a20f578e33cba729">calculateEpsDerivatives</a> (const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const override</td></tr>
|
||
|
|
<tr class="memdesc:a6832a7898da51017a20f578e33cba729"><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:a6832a7898da51017a20f578e33cba729"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a239826d90cb5db236e68230f7ac84bcb" id="r_a239826d90cb5db236e68230f7ac84bcb"><td class="memItemLeft" align="right" valign="top">fourdst::composition::Composition </td><td class="memItemRight" valign="bottom"><a class="el" href="classPyDynamicEngine.html#a239826d90cb5db236e68230f7ac84bcb">collectComposition</a> (const fourdst::composition::CompositionAbstract &comp, double T9, double rho) const override</td></tr>
|
||
|
|
<tr class="memdesc:a239826d90cb5db236e68230f7ac84bcb"><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:a239826d90cb5db236e68230f7ac84bcb"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a2947824dca9662e113153de5c6516609" id="r_a2947824dca9662e113153de5c6516609"><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="classPyDynamicEngine.html#a2947824dca9662e113153de5c6516609">getSpeciesStatus</a> (const fourdst::atomic::Species &species) const override</td></tr>
|
||
|
|
<tr class="memdesc:a2947824dca9662e113153de5c6516609"><td class="mdescLeft"> </td><td class="mdescRight">Get the status of a species in the network. <br /></td></tr>
|
||
|
|
<tr class="separator:a2947824dca9662e113153de5c6516609"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="inherit_header pub_methods_classgridfire_1_1engine_1_1Engine"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classgridfire_1_1engine_1_1Engine')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classgridfire_1_1engine_1_1Engine.html">gridfire::engine::Engine</a></td></tr>
|
||
|
|
<tr class="memitem:af0ea99416c28933d364a872fc6aff556 inherit pub_methods_classgridfire_1_1engine_1_1Engine" 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_1Engine.html#af0ea99416c28933d364a872fc6aff556">~Engine</a> ()=default</td></tr>
|
||
|
|
<tr class="memdesc:af0ea99416c28933d364a872fc6aff556 inherit pub_methods_classgridfire_1_1engine_1_1Engine"><td class="mdescLeft"> </td><td class="mdescRight">Virtual destructor. <br /></td></tr>
|
||
|
|
<tr class="separator:af0ea99416c28933d364a872fc6aff556 inherit pub_methods_classgridfire_1_1engine_1_1Engine"><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="classPyDynamicEngine.html#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="a6832a7898da51017a20f578e33cba729" name="a6832a7898da51017a20f578e33cba729"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6832a7898da51017a20f578e33cba729">◆ </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_1EnergyDerivatives.html">gridfire::engine::EnergyDerivatives</a> PyDynamicEngine::calculateEpsDerivatives </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">const fourdst::composition::CompositionAbstract & </td>
|
||
|
|
<td class="paramname"><em>comp</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">double </td>
|
||
|
|
<td class="paramname"><em>T9</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">double </td>
|
||
|
|
<td class="paramname"><em>rho</em> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td> const</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">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_1DynamicEngine.html#ada6a1295a92c2aede841672ecae0cede">gridfire::engine::DynamicEngine</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a8facba88b6df6e016ce53a0ff3cff125" name="a8facba88b6df6e016ce53a0ff3cff125"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8facba88b6df6e016ce53a0ff3cff125">◆ </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">const <a class="el" href="classgridfire_1_1reaction_1_1Reaction.html">gridfire::reaction::Reaction</a> & </td>
|
||
|
|
<td class="paramname"><em>reaction</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">const fourdst::composition::CompositionAbstract & </td>
|
||
|
|
<td class="paramname"><em>comp</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">double </td>
|
||
|
|
<td class="paramname"><em>T9</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">double </td>
|
||
|
|
<td class="paramname"><em>rho</em> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td> const</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">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">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_1DynamicEngine.html#aa57fa5e58b98a03fba31bcddda8001d4">gridfire::engine::DynamicEngine</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="aac1f2005c0a58befc4e01627c9357924" name="aac1f2005c0a58befc4e01627c9357924"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aac1f2005c0a58befc4e01627c9357924">◆ </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_1StepDerivatives.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">const fourdst::composition::CompositionAbstract & </td>
|
||
|
|
<td class="paramname"><em>comp</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">double </td>
|
||
|
|
<td class="paramname"><em>T9</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">double </td>
|
||
|
|
<td class="paramname"><em>rho</em> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td> const</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">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>
|
||
|
|
</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_1Engine.html#a764fc091c72c12c8529105d7c96badb2">gridfire::engine::Engine</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a239826d90cb5db236e68230f7ac84bcb" name="a239826d90cb5db236e68230f7ac84bcb"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a239826d90cb5db236e68230f7ac84bcb">◆ </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">const fourdst::composition::CompositionAbstract & </td>
|
||
|
|
<td class="paramname"><em>comp</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">double </td>
|
||
|
|
<td class="paramname"><em>T9</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">double </td>
|
||
|
|
<td class="paramname"><em>rho</em> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td> const</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">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">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_1DynamicEngine.html#a41877719ae5e8de53c1692c7cf9bfbfc">gridfire::engine::DynamicEngine</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a298f700c647d2c3973d2a35d370c823e" name="a298f700c647d2c3973d2a35d370c823e"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a298f700c647d2c3973d2a35d370c823e">◆ </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_1NetworkJacobian.html">gridfire::engine::NetworkJacobian</a> PyDynamicEngine::generateJacobianMatrix </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">const fourdst::composition::CompositionAbstract & </td>
|
||
|
|
<td class="paramname"><em>comp</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">double </td>
|
||
|
|
<td class="paramname"><em>T9</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">double </td>
|
||
|
|
<td class="paramname"><em>rho</em> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td> const</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">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">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_1DynamicEngine.html#a53276f09346b531f8676db355e1219eb">gridfire::engine::DynamicEngine</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a204643754cac3cf37c550ecd32f659fe" name="a204643754cac3cf37c550ecd32f659fe"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a204643754cac3cf37c550ecd32f659fe">◆ </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_1NetworkJacobian.html">gridfire::engine::NetworkJacobian</a> PyDynamicEngine::generateJacobianMatrix </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">const fourdst::composition::CompositionAbstract & </td>
|
||
|
|
<td class="paramname"><em>comp</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">double </td>
|
||
|
|
<td class="paramname"><em>T9</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">double </td>
|
||
|
|
<td class="paramname"><em>rho</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">const <a class="el" href="namespacegridfire_1_1engine.html#af5175018d2d1e78a8826dd33ec6d675f">gridfire::engine::SparsityPattern</a> & </td>
|
||
|
|
<td class="paramname"><em>sparsityPattern</em> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td> const</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">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">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_1DynamicEngine.html#a51d55a21be28e372021b2b8e5ecdc551">gridfire::engine::DynamicEngine</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a2b1c054b250abccc2af9a7275c68df4a" name="a2b1c054b250abccc2af9a7275c68df4a"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2b1c054b250abccc2af9a7275c68df4a">◆ </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_1NetworkJacobian.html">gridfire::engine::NetworkJacobian</a> PyDynamicEngine::generateJacobianMatrix </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">const fourdst::composition::CompositionAbstract & </td>
|
||
|
|
<td class="paramname"><em>comp</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">double </td>
|
||
|
|
<td class="paramname"><em>T9</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">double </td>
|
||
|
|
<td class="paramname"><em>rho</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">const std::vector< fourdst::atomic::Species > & </td>
|
||
|
|
<td class="paramname"><em>activeSpecies</em> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td> const</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">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">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_1DynamicEngine.html#a15d53dac8b622a3b7d0f928a3995dbde">gridfire::engine::DynamicEngine</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a2066649ca11a869c054079ea12d8d0e9" name="a2066649ca11a869c054079ea12d8d0e9"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2066649ca11a869c054079ea12d8d0e9">◆ </a></span>generateStoichiometryMatrix()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">void PyDynamicEngine::generateStoichiometryMatrix </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Generate the stoichiometry matrix for the network. </p>
|
||
|
|
<p>This method must compute and store the stoichiometry matrix, which encodes the net change of each species in each reaction. </p>
|
||
|
|
|
||
|
|
<p>Implements <a class="el" href="classgridfire_1_1engine_1_1DynamicEngine.html#a5e2c45a3e415b53e41def8f743f93464">gridfire::engine::DynamicEngine</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a541cf022fe3253279f8f1309c10556d7" name="a541cf022fe3253279f8f1309c10556d7"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a541cf022fe3253279f8f1309c10556d7">◆ </a></span>getDepth()</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#a540b6420c7b6271717ec9b640140f6c0">gridfire::engine::BuildDepthType</a> PyDynamicEngine::getDepth </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td> const</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Get the depth of the network. </p>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>The depth of the network, which may indicate the level of detail or complexity in the reaction network.</dd></dl>
|
||
|
|
<p>This method is intended to provide information about the network's structure, such as how many layers of reactions or species are present. It can be useful for diagnostics and understanding the network's complexity. </p>
|
||
|
|
|
||
|
|
<p>Reimplemented from <a class="el" href="classgridfire_1_1engine_1_1DynamicEngine.html#ac5a0def6b6af0bd93bf9057c25f048ff">gridfire::engine::DynamicEngine</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a1d5143640666631501cf229bc491516e" name="a1d5143640666631501cf229bc491516e"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1d5143640666631501cf229bc491516e">◆ </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_1ReactionSet.html">gridfire::reaction::ReactionSet</a> & PyDynamicEngine::getNetworkReactions </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td> const</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">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_1DynamicEngine.html#a26b59a4c7622bf820c0eeec6a7522aa8">gridfire::engine::DynamicEngine</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="afc745e7ab5da5d8b3cf916044515cd7d" name="afc745e7ab5da5d8b3cf916044515cd7d"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afc745e7ab5da5d8b3cf916044515cd7d">◆ </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="paramname"></td><td>)</td>
|
||
|
|
<td> const</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p><a class="el" href="classPyDynamicEngine.html">PyDynamicEngine</a> Implementation ///. </p>
|
||
|
|
|
||
|
|
<p>Implements <a class="el" href="classgridfire_1_1engine_1_1Engine.html#a3263c3fde2509d5d8ec4da3b6e946c48">gridfire::engine::Engine</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="ab4cfdca5e15957c5cef75ffa6dedeee5" name="ab4cfdca5e15957c5cef75ffa6dedeee5"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab4cfdca5e15957c5cef75ffa6dedeee5">◆ </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="paramname"></td><td>)</td>
|
||
|
|
<td> const</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Get the current electron screening model. </p>
|
||
|
|
<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_1DynamicEngine.html#a24103027a38e02d4342161164554d332">gridfire::engine::DynamicEngine</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a8d34faa3d6ea804a3467979858d33535" name="a8d34faa3d6ea804a3467979858d33535"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8d34faa3d6ea804a3467979858d33535">◆ </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">const fourdst::composition::CompositionAbstract & </td>
|
||
|
|
<td class="paramname"><em>comp</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">double </td>
|
||
|
|
<td class="paramname"><em>T9</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">double </td>
|
||
|
|
<td class="paramname"><em>rho</em> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td> const</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">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">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_1DynamicEngine.html#aefc5d0f7842b27a108ba1e4ca346e9a0">gridfire::engine::DynamicEngine</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a95d10a7b240d543a1bc6c67ddf2dc8e0" name="a95d10a7b240d543a1bc6c67ddf2dc8e0"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a95d10a7b240d543a1bc6c67ddf2dc8e0">◆ </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">const fourdst::atomic::Species & </td>
|
||
|
|
<td class="paramname"><em>species</em></td><td>)</td>
|
||
|
|
<td> const</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">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">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_1DynamicEngine.html#ac0f40017603e8e6887b75dc7360d7c5e">gridfire::engine::DynamicEngine</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a2947824dca9662e113153de5c6516609" name="a2947824dca9662e113153de5c6516609"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2947824dca9662e113153de5c6516609">◆ </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">const fourdst::atomic::Species & </td>
|
||
|
|
<td class="paramname"><em>species</em></td><td>)</td>
|
||
|
|
<td> const</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">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_1DynamicEngine.html#a8aebefad50c1aa34207e118e92d7ccf0">gridfire::engine::DynamicEngine</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a71678a567bb0cedd8a97aff9ceddd814" name="a71678a567bb0cedd8a97aff9ceddd814"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a71678a567bb0cedd8a97aff9ceddd814">◆ </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">const fourdst::composition::CompositionAbstract & </td>
|
||
|
|
<td class="paramname"><em>comp</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">double </td>
|
||
|
|
<td class="paramname"><em>T9</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">double </td>
|
||
|
|
<td class="paramname"><em>rho</em> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td> const</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">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_1DynamicEngine.html#aef6ed91d922c0b1733fd7835e99d0efe">gridfire::engine::DynamicEngine</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a3dd5cf419f25e76e144af35df15a2067" name="a3dd5cf419f25e76e144af35df15a2067"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3dd5cf419f25e76e144af35df15a2067">◆ </a></span>getStoichiometryMatrixEntry()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">int PyDynamicEngine::getStoichiometryMatrixEntry </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">const fourdst::atomic::Species & </td>
|
||
|
|
<td class="paramname"><em>species</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">const <a class="el" href="classgridfire_1_1reaction_1_1Reaction.html">gridfire::reaction::Reaction</a> & </td>
|
||
|
|
<td class="paramname"><em>reaction</em> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td> const</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Get an entry from the stoichiometry matrix. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">species</td><td>species to look up stoichiometry for. </td></tr>
|
||
|
|
<tr><td class="paramname">reaction</td><td>reaction to find </td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>Stoichiometric coefficient for the species in the reaction.</dd></dl>
|
||
|
|
<p>The stoichiometry matrix must have been generated by <a class="el" href="classPyDynamicEngine.html#a2066649ca11a869c054079ea12d8d0e9" title="Generate the stoichiometry matrix for the network.">generateStoichiometryMatrix()</a>. </p>
|
||
|
|
|
||
|
|
<p>Implements <a class="el" href="classgridfire_1_1engine_1_1DynamicEngine.html#a5ce6ff370e3f0964c6b2688fb3f4bb7e">gridfire::engine::DynamicEngine</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a55bf19ed7534a312a36faf74753f7b14" name="a55bf19ed7534a312a36faf74753f7b14"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a55bf19ed7534a312a36faf74753f7b14">◆ </a></span>isStale()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">bool PyDynamicEngine::isStale </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">const <a class="el" href="structgridfire_1_1NetIn.html">gridfire::NetIn</a> & </td>
|
||
|
|
<td class="paramname"><em>netIn</em></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Check if the engine's internal state is stale. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<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>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>True if the engine's state is stale and needs to be updated; false otherwise.</dd></dl>
|
||
|
|
<p>This method allows derived classes to determine if their internal state is out-of-date with respect to the provided network conditions. If the engine is stale, it may require a call to <code><a class="el" href="classPyDynamicEngine.html#af8e6a8cd44f278535d7bcc9a896d6da8" title="Update the internal state of the engine.">update()</a></code> before performing calculations.</p>
|
||
|
|
<dl class="section user"><dt>Usage Example:</dt><dd><div class="fragment"><div class="line">NetIn input = { ... };</div>
|
||
|
|
<div class="line"><span class="keywordflow">if</span> (myEngine.isStale(input)) {</div>
|
||
|
|
<div class="line"> <span class="comment">// Update the engine before proceeding</span></div>
|
||
|
|
<div class="line">}</div>
|
||
|
|
</div><!-- fragment --> </dd></dl>
|
||
|
|
|
||
|
|
<p>Implements <a class="el" href="classgridfire_1_1engine_1_1DynamicEngine.html#a79423b9f67b4cac702547b4f1d8bd14c">gridfire::engine::DynamicEngine</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a61bb4b430fe740cfb2c24e5cc673e4ac" name="a61bb4b430fe740cfb2c24e5cc673e4ac"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a61bb4b430fe740cfb2c24e5cc673e4ac">◆ </a></span>mapNetInToMolarAbundanceVector()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">std::vector< double > PyDynamicEngine::mapNetInToMolarAbundanceVector </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">const <a class="el" href="structgridfire_1_1NetIn.html">gridfire::NetIn</a> & </td>
|
||
|
|
<td class="paramname"><em>netIn</em></td><td>)</td>
|
||
|
|
<td> const</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Map a NetIn object to a vector of molar abundances. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<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>A vector of molar abundances corresponding to the species in the network.</dd></dl>
|
||
|
|
<p>This method converts the input conditions into a vector of molar abundances, which can be used for further calculations or diagnostics. </p>
|
||
|
|
|
||
|
|
<p>Implements <a class="el" href="classgridfire_1_1engine_1_1DynamicEngine.html#aa9d55b81c1963113aad86aa60c19676f">gridfire::engine::DynamicEngine</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a6118af81e45d2850f7a2517891147274" name="a6118af81e45d2850f7a2517891147274"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6118af81e45d2850f7a2517891147274">◆ </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_1PrimingReport.html">gridfire::engine::PrimingReport</a> PyDynamicEngine::primeEngine </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">const <a class="el" href="structgridfire_1_1NetIn.html">gridfire::NetIn</a> & </td>
|
||
|
|
<td class="paramname"><em>netIn</em></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">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">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_1DynamicEngine.html#a70e270bb50910c0055a75575c1ef1e95">gridfire::engine::DynamicEngine</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a25e52496b36d731127603c31e9dcaa97" name="a25e52496b36d731127603c31e9dcaa97"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a25e52496b36d731127603c31e9dcaa97">◆ </a></span>rebuild()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">void PyDynamicEngine::rebuild </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">const fourdst::composition::CompositionAbstract & </td>
|
||
|
|
<td class="paramname"><em>comp</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype"><a class="el" href="namespacegridfire_1_1engine.html#a540b6420c7b6271717ec9b640140f6c0">gridfire::engine::BuildDepthType</a> </td>
|
||
|
|
<td class="paramname"><em>depth</em> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Rebuild the network with a specified depth. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">comp</td><td>The composition to rebuild the network with. </td></tr>
|
||
|
|
<tr><td class="paramname">depth</td><td>The desired depth of the network.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<p>This method is intended to allow dynamic adjustment of the network's depth, which may involve adding or removing species and reactions based on the specified depth. However, not all engines support this operation. </p>
|
||
|
|
|
||
|
|
<p>Reimplemented from <a class="el" href="classgridfire_1_1engine_1_1DynamicEngine.html#a2444b9ed3bc61920ce23c546444269e4">gridfire::engine::DynamicEngine</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="af469cba3be850d53f659ec173f0eb4e4" name="af469cba3be850d53f659ec173f0eb4e4"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af469cba3be850d53f659ec173f0eb4e4">◆ </a></span>setNetworkReactions()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">void PyDynamicEngine::setNetworkReactions </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">const <a class="el" href="classgridfire_1_1reaction_1_1ReactionSet.html">gridfire::reaction::ReactionSet</a> & </td>
|
||
|
|
<td class="paramname"><em>reactions</em></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Set the reactions for the network. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">reactions</td><td>The set of reactions to use in the network.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<p>This method replaces the current set of reactions in the network with the provided set. It marks the engine as stale, requiring regeneration of matrices and recalculation of rates. </p>
|
||
|
|
|
||
|
|
<p>Implements <a class="el" href="classgridfire_1_1engine_1_1DynamicEngine.html#ab321170954bffc53b1bedaf54f6976be">gridfire::engine::DynamicEngine</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="afa3abfd612033336a656f092721c14ac" name="afa3abfd612033336a656f092721c14ac"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afa3abfd612033336a656f092721c14ac">◆ </a></span>setScreeningModel()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">void PyDynamicEngine::setScreeningModel </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype"><a class="el" href="namespacegridfire_1_1screening.html#aa82aafbc4f8c28d0a75b60798e3a7d25">gridfire::screening::ScreeningType</a> </td>
|
||
|
|
<td class="paramname"><em>model</em></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Set the electron screening model. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">model</td><td>The type of screening model to use for reaction rate calculations.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<p>This method allows changing the screening model at runtime. Screening corrections account for the electrostatic shielding of nuclei by electrons, which affects reaction rates in dense stellar plasmas.</p>
|
||
|
|
<dl class="section user"><dt>Usage Example:</dt><dd><div class="fragment"><div class="line">myEngine.setScreeningModel(screening::ScreeningType::WEAK);</div>
|
||
|
|
</div><!-- fragment --></dd></dl>
|
||
|
|
<dl class="section post"><dt>Postcondition</dt><dd>The engine will use the specified screening model for subsequent rate calculations. </dd></dl>
|
||
|
|
|
||
|
|
<p>Implements <a class="el" href="classgridfire_1_1engine_1_1DynamicEngine.html#a50e76977d0dc3cc23d52b51842d35003">gridfire::engine::DynamicEngine</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="af8e6a8cd44f278535d7bcc9a896d6da8" name="af8e6a8cd44f278535d7bcc9a896d6da8"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af8e6a8cd44f278535d7bcc9a896d6da8">◆ </a></span>update()</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::update </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">const <a class="el" href="structgridfire_1_1NetIn.html">gridfire::NetIn</a> & </td>
|
||
|
|
<td class="paramname"><em>netIn</em></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Update the internal state of the engine. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<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_1DynamicEngine.html#a8dd85442ec54f20d91743c72364e36ff">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</span><span class="mlabel">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="classPyDynamicEngine.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.9.8 </li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|