docs(docs): asdded and cleaned up docs
This commit is contained in:
229
docs/html/py__engine_8h_source.html
Normal file
229
docs/html/py__engine_8h_source.html
Normal file
@@ -0,0 +1,229 @@
|
||||
<!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: src/python/engine/trampoline/py_engine.h Source File</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"> 0.0.1a</span>
|
||||
</div>
|
||||
<div id="projectbrief">General Purpose Nuclear Network</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.13.2 -->
|
||||
<script type="text/javascript">
|
||||
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&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('py__engine_8h_source.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="headertitle"><div class="title">py_engine.h</div></div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
<a href="py__engine_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#pragma once</span></div>
|
||||
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span> </div>
|
||||
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="preprocessor">#include "<a class="code" href="engine_8h.html">gridfire/engine/engine.h</a>"</span></div>
|
||||
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include "<a class="code" href="expected__engine_8h.html">gridfire/expectations/expected_engine.h</a>"</span></div>
|
||||
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span> </div>
|
||||
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#include "fourdst/composition/atomicSpecies.h"</span></div>
|
||||
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span> </div>
|
||||
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include <vector></span></div>
|
||||
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include <expected></span></div>
|
||||
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> </div>
|
||||
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> </div>
|
||||
<div class="foldopen" id="foldopen00012" data-start="{" data-end="};">
|
||||
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"><a class="line" href="class_py_engine.html"> 12</a></span><span class="keyword">class </span><a class="code hl_class" href="class_py_engine.html">PyEngine</a> final : <span class="keyword">public</span> <a class="code hl_class" href="classgridfire_1_1_engine.html">gridfire::Engine</a> {</div>
|
||||
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="keyword">public</span>:</div>
|
||||
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> <span class="keyword">const</span> std::vector<fourdst::atomic::Species>& <a class="code hl_function" href="class_py_engine.html#a2d240423899e039c2ca688e96f8af1f2">getNetworkSpecies</a>() <span class="keyword">const override</span>;</div>
|
||||
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> std::expected<gridfire::StepDerivatives<double>,<a class="code hl_struct" href="structgridfire_1_1expectations_1_1_stale_engine_error.html">gridfire::expectations::StaleEngineError</a>> <a class="code hl_function" href="class_py_engine.html#a2f92602ecf210414b46838fc0a9ae26d">calculateRHSAndEnergy</a>(<span class="keyword">const</span> std::vector<double> &Y, <span class="keywordtype">double</span> T9, <span class="keywordtype">double</span> rho) <span class="keyword">const override</span>;</div>
|
||||
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="keyword">private</span>:</div>
|
||||
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"><a class="line" href="class_py_engine.html#a73caaa7606e2cdfd1aa82729a78ebb73"> 17</a></span> <span class="keyword">mutable</span> std::vector<fourdst::atomic::Species> <a class="code hl_variable" href="class_py_engine.html#a73caaa7606e2cdfd1aa82729a78ebb73">m_species_cache</a>;</div>
|
||||
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span>};</div>
|
||||
</div>
|
||||
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div>
|
||||
<div class="foldopen" id="foldopen00020" data-start="{" data-end="};">
|
||||
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"><a class="line" href="class_py_dynamic_engine.html"> 20</a></span><span class="keyword">class </span><a class="code hl_class" href="class_py_dynamic_engine.html">PyDynamicEngine</a> final : <span class="keyword">public</span> <a class="code hl_class" href="classgridfire_1_1_dynamic_engine.html">gridfire::DynamicEngine</a> {</div>
|
||||
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="keyword">public</span>:</div>
|
||||
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> <span class="keyword">const</span> std::vector<fourdst::atomic::Species>& <a class="code hl_function" href="class_py_dynamic_engine.html#afc745e7ab5da5d8b3cf916044515cd7d">getNetworkSpecies</a>() <span class="keyword">const override</span>;</div>
|
||||
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> std::expected<gridfire::StepDerivatives<double>,<a class="code hl_struct" href="structgridfire_1_1expectations_1_1_stale_engine_error.html">gridfire::expectations::StaleEngineError</a>> <a class="code hl_function" href="class_py_dynamic_engine.html#a5b7f0cfe327c634ec125303256de8b9a">calculateRHSAndEnergy</a>(<span class="keyword">const</span> std::vector<double> &Y, <span class="keywordtype">double</span> T9, <span class="keywordtype">double</span> rho) <span class="keyword">const override</span>;</div>
|
||||
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_py_dynamic_engine.html#a5bd40c752db1badcd600797c9113121d">generateJacobianMatrix</a>(<span class="keyword">const</span> std::vector<double> &Y_dynamic, <span class="keywordtype">double</span> T9, <span class="keywordtype">double</span> rho) <span class="keyword">const override</span>;</div>
|
||||
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_py_dynamic_engine.html#a5bd40c752db1badcd600797c9113121d">generateJacobianMatrix</a>(<span class="keyword">const</span> std::vector<double> &Y_dynamic, <span class="keywordtype">double</span> T9, <span class="keywordtype">double</span> rho, <span class="keyword">const</span> <a class="code hl_typedef" href="namespacegridfire.html#a898dfe22579e649935645cbd6f073178">gridfire::SparsityPattern</a> &sparsityPattern) <span class="keyword">const override</span>;</div>
|
||||
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> <span class="keywordtype">double</span> <a class="code hl_function" href="class_py_dynamic_engine.html#a1c888bbc0618f1ae02d9a53e45f3c159">getJacobianMatrixEntry</a>(<span class="keywordtype">int</span> i, <span class="keywordtype">int</span> j) <span class="keyword">const override</span>;</div>
|
||||
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_py_dynamic_engine.html#a2066649ca11a869c054079ea12d8d0e9">generateStoichiometryMatrix</a>() <span class="keyword">override</span>;</div>
|
||||
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> <span class="keywordtype">int</span> <a class="code hl_function" href="class_py_dynamic_engine.html#ab48ef6db18da20024aa563a91fa16f83">getStoichiometryMatrixEntry</a>(<span class="keywordtype">int</span> speciesIndex, <span class="keywordtype">int</span> reactionIndex) <span class="keyword">const override</span>;</div>
|
||||
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> <span class="keywordtype">double</span> <a class="code hl_function" href="class_py_dynamic_engine.html#a6224f546ba66b1257506b1fc9f47195a">calculateMolarReactionFlow</a>(<span class="keyword">const</span> <a class="code hl_class" href="classgridfire_1_1reaction_1_1_reaction.html">gridfire::reaction::Reaction</a> &reaction, <span class="keyword">const</span> std::vector<double> &Y, <span class="keywordtype">double</span> T9, <span class="keywordtype">double</span> rho) <span class="keyword">const override</span>;</div>
|
||||
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">const</span> <a class="code hl_typedef" href="namespacegridfire_1_1reaction.html#aa86f08712565f278adacc7cd2361eb31">gridfire::reaction::LogicalReactionSet</a>& <a class="code hl_function" href="class_py_dynamic_engine.html#a5988cfba247631ba6c00795cafda9a38">getNetworkReactions</a>() <span class="keyword">const override</span>;</div>
|
||||
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_py_dynamic_engine.html#afd818c408c64d207e71b1a90426328d6">setNetworkReactions</a>(<span class="keyword">const</span> <a class="code hl_typedef" href="namespacegridfire_1_1reaction.html#aa86f08712565f278adacc7cd2361eb31">gridfire::reaction::LogicalReactionSet</a>& reactions) <span class="keyword">override</span>;</div>
|
||||
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> std::expected<std::unordered_map<fourdst::atomic::Species, double>, <a class="code hl_struct" href="structgridfire_1_1expectations_1_1_stale_engine_error.html">gridfire::expectations::StaleEngineError</a>> <a class="code hl_function" href="class_py_dynamic_engine.html#a02a4c86c9637a3c9c9ca8ddd82ecff22">getSpeciesTimescales</a>(<span class="keyword">const</span> std::vector<double> &Y, <span class="keywordtype">double</span> T9, <span class="keywordtype">double</span> rho) <span class="keyword">const override</span>;</div>
|
||||
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> std::expected<std::unordered_map<fourdst::atomic::Species, double>, <a class="code hl_struct" href="structgridfire_1_1expectations_1_1_stale_engine_error.html">gridfire::expectations::StaleEngineError</a>> <a class="code hl_function" href="class_py_dynamic_engine.html#a020044829e0146427ed4830e5b02c4f3">getSpeciesDestructionTimescales</a>(<span class="keyword">const</span> std::vector<double> &Y, <span class="keywordtype">double</span> T9, <span class="keywordtype">double</span> rho) <span class="keyword">const override</span>;</div>
|
||||
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> fourdst::composition::Composition <a class="code hl_function" href="class_py_dynamic_engine.html#af8e6a8cd44f278535d7bcc9a896d6da8">update</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structgridfire_1_1_net_in.html">gridfire::NetIn</a> &netIn) <span class="keyword">override</span>;</div>
|
||||
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="class_py_dynamic_engine.html#a55bf19ed7534a312a36faf74753f7b14">isStale</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structgridfire_1_1_net_in.html">gridfire::NetIn</a> &netIn) <span class="keyword">override</span>;</div>
|
||||
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_py_dynamic_engine.html#afa3abfd612033336a656f092721c14ac">setScreeningModel</a>(<a class="code hl_enumeration" href="namespacegridfire_1_1screening.html#aa82aafbc4f8c28d0a75b60798e3a7d25">gridfire::screening::ScreeningType</a> model) <span class="keyword">override</span>;</div>
|
||||
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> <a class="code hl_enumeration" href="namespacegridfire_1_1screening.html#aa82aafbc4f8c28d0a75b60798e3a7d25">gridfire::screening::ScreeningType</a> <a class="code hl_function" href="class_py_dynamic_engine.html#ab4cfdca5e15957c5cef75ffa6dedeee5">getScreeningModel</a>() <span class="keyword">const override</span>;</div>
|
||||
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> <span class="keywordtype">int</span> <a class="code hl_function" href="class_py_dynamic_engine.html#a2ee1d745c1c21b9fcb652c96c42f1091">getSpeciesIndex</a>(<span class="keyword">const</span> fourdst::atomic::Species &species) <span class="keyword">const override</span>;</div>
|
||||
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> std::vector<double> <a class="code hl_function" href="class_py_dynamic_engine.html#a61bb4b430fe740cfb2c24e5cc673e4ac">mapNetInToMolarAbundanceVector</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structgridfire_1_1_net_in.html">gridfire::NetIn</a> &netIn) <span class="keyword">const override</span>;</div>
|
||||
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> <a class="code hl_struct" href="structgridfire_1_1_priming_report.html">gridfire::PrimingReport</a> <a class="code hl_function" href="class_py_dynamic_engine.html#ac22a10412be6649bf379e6d61113c878">primeEngine</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structgridfire_1_1_net_in.html">gridfire::NetIn</a> &netIn) <span class="keyword">override</span>;</div>
|
||||
<div class="foldopen" id="foldopen00041" data-start="{" data-end="}">
|
||||
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"><a class="line" href="class_py_dynamic_engine.html#adba68716d832b6100e08d32fbc36f13c"> 41</a></span> <a class="code hl_typedef" href="namespacegridfire.html#a3b1f70dc7ff5b501809330a97079e4f6">gridfire::BuildDepthType</a> <a class="code hl_function" href="class_py_dynamic_engine.html#adba68716d832b6100e08d32fbc36f13c">getDepth</a>()<span class="keyword"> const override </span>{</div>
|
||||
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> <span class="keywordflow">throw</span> std::logic_error(<span class="stringliteral">"Network depth not supported by this engine."</span>);</div>
|
||||
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> }</div>
|
||||
</div>
|
||||
<div class="foldopen" id="foldopen00044" data-start="{" data-end="}">
|
||||
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"><a class="line" href="class_py_dynamic_engine.html#a3d30a9116825ab2c5c209bc2712126bc"> 44</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_py_dynamic_engine.html#a3d30a9116825ab2c5c209bc2712126bc">rebuild</a>(<span class="keyword">const</span> fourdst::composition::Composition& comp, <a class="code hl_typedef" href="namespacegridfire.html#a3b1f70dc7ff5b501809330a97079e4f6">gridfire::BuildDepthType</a> depth)<span class="keyword"> override </span>{</div>
|
||||
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> <span class="keywordflow">throw</span> std::logic_error(<span class="stringliteral">"Setting network depth not supported by this engine."</span>);</div>
|
||||
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> }</div>
|
||||
</div>
|
||||
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span><span class="keyword">private</span>:</div>
|
||||
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"><a class="line" href="class_py_dynamic_engine.html#a2246382b1c98ba69cdb419bba63a6d03"> 48</a></span> <span class="keyword">mutable</span> std::vector<fourdst::atomic::Species> <a class="code hl_variable" href="class_py_dynamic_engine.html#a2246382b1c98ba69cdb419bba63a6d03">m_species_cache</a>;</div>
|
||||
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> </div>
|
||||
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> </div>
|
||||
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span>};</div>
|
||||
</div>
|
||||
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> </div>
|
||||
<div class="foldopen" id="foldopen00053" data-start="{" data-end="};">
|
||||
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"><a class="line" href="class_py_engine_view.html"> 53</a></span><span class="keyword">class </span><a class="code hl_class" href="class_py_engine_view.html">PyEngineView</a> final : <span class="keyword">public</span> <a class="code hl_class" href="classgridfire_1_1_engine_view.html">gridfire::EngineView</a><gridfire::Engine> {</div>
|
||||
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> <span class="keyword">const</span> <a class="code hl_class" href="classgridfire_1_1_engine.html">gridfire::Engine</a>& <a class="code hl_function" href="class_py_engine_view.html#a3cd83dc57b521c65a14edf70357a8845">getBaseEngine</a>() <span class="keyword">const override</span>;</div>
|
||||
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span>};</div>
|
||||
</div>
|
||||
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> </div>
|
||||
<div class="foldopen" id="foldopen00057" data-start="{" data-end="};">
|
||||
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"><a class="line" href="class_py_dynamic_engine_view.html"> 57</a></span><span class="keyword">class </span><a class="code hl_class" href="class_py_dynamic_engine_view.html">PyDynamicEngineView</a> final : <span class="keyword">public</span> <a class="code hl_class" href="classgridfire_1_1_engine_view.html">gridfire::EngineView</a><gridfire::DynamicEngine> {</div>
|
||||
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> <span class="keyword">const</span> <a class="code hl_class" href="classgridfire_1_1_dynamic_engine.html">gridfire::DynamicEngine</a>& <a class="code hl_function" href="class_py_dynamic_engine_view.html#a51680b135cfc3eea40daf9ef5aa903e0">getBaseEngine</a>() <span class="keyword">const override</span>;</div>
|
||||
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span>};</div>
|
||||
</div>
|
||||
<div class="ttc" id="aclass_py_dynamic_engine_html"><div class="ttname"><a href="class_py_dynamic_engine.html">PyDynamicEngine</a></div><div class="ttdef"><b>Definition</b> <a href="#l00020">py_engine.h:20</a></div></div>
|
||||
<div class="ttc" id="aclass_py_dynamic_engine_html_a020044829e0146427ed4830e5b02c4f3"><div class="ttname"><a href="class_py_dynamic_engine.html#a020044829e0146427ed4830e5b02c4f3">PyDynamicEngine::getSpeciesDestructionTimescales</a></div><div class="ttdeci">std::expected< std::unordered_map< fourdst::atomic::Species, double >, gridfire::expectations::StaleEngineError > getSpeciesDestructionTimescales(const std::vector< double > &Y, double T9, double rho) const override</div><div class="ttdef"><b>Definition</b> <a href="py__engine_8cpp_source.html#l00158">py_engine.cpp:158</a></div></div>
|
||||
<div class="ttc" id="aclass_py_dynamic_engine_html_a02a4c86c9637a3c9c9ca8ddd82ecff22"><div class="ttname"><a href="class_py_dynamic_engine.html#a02a4c86c9637a3c9c9ca8ddd82ecff22">PyDynamicEngine::getSpeciesTimescales</a></div><div class="ttdeci">std::expected< std::unordered_map< fourdst::atomic::Species, double >, gridfire::expectations::StaleEngineError > getSpeciesTimescales(const std::vector< double > &Y, double T9, double rho) const override</div><div class="ttdoc">Compute timescales for all species in the network.</div><div class="ttdef"><b>Definition</b> <a href="py__engine_8cpp_source.html#l00149">py_engine.cpp:149</a></div></div>
|
||||
<div class="ttc" id="aclass_py_dynamic_engine_html_a1c888bbc0618f1ae02d9a53e45f3c159"><div class="ttname"><a href="class_py_dynamic_engine.html#a1c888bbc0618f1ae02d9a53e45f3c159">PyDynamicEngine::getJacobianMatrixEntry</a></div><div class="ttdeci">double getJacobianMatrixEntry(int i, int j) const override</div><div class="ttdoc">Get an entry from the previously generated Jacobian matrix.</div><div class="ttdef"><b>Definition</b> <a href="py__engine_8cpp_source.html#l00097">py_engine.cpp:97</a></div></div>
|
||||
<div class="ttc" id="aclass_py_dynamic_engine_html_a2066649ca11a869c054079ea12d8d0e9"><div class="ttname"><a href="class_py_dynamic_engine.html#a2066649ca11a869c054079ea12d8d0e9">PyDynamicEngine::generateStoichiometryMatrix</a></div><div class="ttdeci">void generateStoichiometryMatrix() override</div><div class="ttdoc">Generate the stoichiometry matrix for the network.</div><div class="ttdef"><b>Definition</b> <a href="py__engine_8cpp_source.html#l00106">py_engine.cpp:106</a></div></div>
|
||||
<div class="ttc" id="aclass_py_dynamic_engine_html_a2246382b1c98ba69cdb419bba63a6d03"><div class="ttname"><a href="class_py_dynamic_engine.html#a2246382b1c98ba69cdb419bba63a6d03">PyDynamicEngine::m_species_cache</a></div><div class="ttdeci">std::vector< fourdst::atomic::Species > m_species_cache</div><div class="ttdef"><b>Definition</b> <a href="#l00048">py_engine.h:48</a></div></div>
|
||||
<div class="ttc" id="aclass_py_dynamic_engine_html_a2ee1d745c1c21b9fcb652c96c42f1091"><div class="ttname"><a href="class_py_dynamic_engine.html#a2ee1d745c1c21b9fcb652c96c42f1091">PyDynamicEngine::getSpeciesIndex</a></div><div class="ttdeci">int getSpeciesIndex(const fourdst::atomic::Species &species) const override</div><div class="ttdef"><b>Definition</b> <a href="py__engine_8cpp_source.html#l00202">py_engine.cpp:202</a></div></div>
|
||||
<div class="ttc" id="aclass_py_dynamic_engine_html_a3d30a9116825ab2c5c209bc2712126bc"><div class="ttname"><a href="class_py_dynamic_engine.html#a3d30a9116825ab2c5c209bc2712126bc">PyDynamicEngine::rebuild</a></div><div class="ttdeci">void rebuild(const fourdst::composition::Composition &comp, gridfire::BuildDepthType depth) override</div><div class="ttdef"><b>Definition</b> <a href="#l00044">py_engine.h:44</a></div></div>
|
||||
<div class="ttc" id="aclass_py_dynamic_engine_html_a55bf19ed7534a312a36faf74753f7b14"><div class="ttname"><a href="class_py_dynamic_engine.html#a55bf19ed7534a312a36faf74753f7b14">PyDynamicEngine::isStale</a></div><div class="ttdeci">bool isStale(const gridfire::NetIn &netIn) override</div><div class="ttdef"><b>Definition</b> <a href="py__engine_8cpp_source.html#l00176">py_engine.cpp:176</a></div></div>
|
||||
<div class="ttc" id="aclass_py_dynamic_engine_html_a5988cfba247631ba6c00795cafda9a38"><div class="ttname"><a href="class_py_dynamic_engine.html#a5988cfba247631ba6c00795cafda9a38">PyDynamicEngine::getNetworkReactions</a></div><div class="ttdeci">const gridfire::reaction::LogicalReactionSet & getNetworkReactions() const override</div><div class="ttdoc">Get the set of logical reactions in the network.</div><div class="ttdef"><b>Definition</b> <a href="py__engine_8cpp_source.html#l00132">py_engine.cpp:132</a></div></div>
|
||||
<div class="ttc" id="aclass_py_dynamic_engine_html_a5b7f0cfe327c634ec125303256de8b9a"><div class="ttname"><a href="class_py_dynamic_engine.html#a5b7f0cfe327c634ec125303256de8b9a">PyDynamicEngine::calculateRHSAndEnergy</a></div><div class="ttdeci">std::expected< gridfire::StepDerivatives< double >, gridfire::expectations::StaleEngineError > calculateRHSAndEnergy(const std::vector< double > &Y, double T9, double rho) const override</div><div class="ttdoc">Calculate the right-hand side (dY/dt) and energy generation.</div><div class="ttdef"><b>Definition</b> <a href="py__engine_8cpp_source.html#l00070">py_engine.cpp:70</a></div></div>
|
||||
<div class="ttc" id="aclass_py_dynamic_engine_html_a5bd40c752db1badcd600797c9113121d"><div class="ttname"><a href="class_py_dynamic_engine.html#a5bd40c752db1badcd600797c9113121d">PyDynamicEngine::generateJacobianMatrix</a></div><div class="ttdeci">void generateJacobianMatrix(const std::vector< double > &Y_dynamic, double T9, double rho) const override</div><div class="ttdoc">Generate the Jacobian matrix for the current state.</div><div class="ttdef"><b>Definition</b> <a href="py__engine_8cpp_source.html#l00079">py_engine.cpp:79</a></div></div>
|
||||
<div class="ttc" id="aclass_py_dynamic_engine_html_a61bb4b430fe740cfb2c24e5cc673e4ac"><div class="ttname"><a href="class_py_dynamic_engine.html#a61bb4b430fe740cfb2c24e5cc673e4ac">PyDynamicEngine::mapNetInToMolarAbundanceVector</a></div><div class="ttdeci">std::vector< double > mapNetInToMolarAbundanceVector(const gridfire::NetIn &netIn) const override</div><div class="ttdef"><b>Definition</b> <a href="py__engine_8cpp_source.html#l00211">py_engine.cpp:211</a></div></div>
|
||||
<div class="ttc" id="aclass_py_dynamic_engine_html_a6224f546ba66b1257506b1fc9f47195a"><div class="ttname"><a href="class_py_dynamic_engine.html#a6224f546ba66b1257506b1fc9f47195a">PyDynamicEngine::calculateMolarReactionFlow</a></div><div class="ttdeci">double calculateMolarReactionFlow(const gridfire::reaction::Reaction &reaction, const std::vector< double > &Y, double T9, double rho) const override</div><div class="ttdoc">Calculate the molar reaction flow for a given reaction.</div><div class="ttdef"><b>Definition</b> <a href="py__engine_8cpp_source.html#l00123">py_engine.cpp:123</a></div></div>
|
||||
<div class="ttc" id="aclass_py_dynamic_engine_html_ab48ef6db18da20024aa563a91fa16f83"><div class="ttname"><a href="class_py_dynamic_engine.html#ab48ef6db18da20024aa563a91fa16f83">PyDynamicEngine::getStoichiometryMatrixEntry</a></div><div class="ttdeci">int getStoichiometryMatrixEntry(int speciesIndex, int reactionIndex) const override</div><div class="ttdoc">Get an entry from the stoichiometry matrix.</div><div class="ttdef"><b>Definition</b> <a href="py__engine_8cpp_source.html#l00114">py_engine.cpp:114</a></div></div>
|
||||
<div class="ttc" id="aclass_py_dynamic_engine_html_ab4cfdca5e15957c5cef75ffa6dedeee5"><div class="ttname"><a href="class_py_dynamic_engine.html#ab4cfdca5e15957c5cef75ffa6dedeee5">PyDynamicEngine::getScreeningModel</a></div><div class="ttdeci">gridfire::screening::ScreeningType getScreeningModel() const override</div><div class="ttdoc">Get the current electron screening model.</div><div class="ttdef"><b>Definition</b> <a href="py__engine_8cpp_source.html#l00194">py_engine.cpp:194</a></div></div>
|
||||
<div class="ttc" id="aclass_py_dynamic_engine_html_ac22a10412be6649bf379e6d61113c878"><div class="ttname"><a href="class_py_dynamic_engine.html#ac22a10412be6649bf379e6d61113c878">PyDynamicEngine::primeEngine</a></div><div class="ttdeci">gridfire::PrimingReport primeEngine(const gridfire::NetIn &netIn) override</div><div class="ttdef"><b>Definition</b> <a href="py__engine_8cpp_source.html#l00220">py_engine.cpp:220</a></div></div>
|
||||
<div class="ttc" id="aclass_py_dynamic_engine_html_adba68716d832b6100e08d32fbc36f13c"><div class="ttname"><a href="class_py_dynamic_engine.html#adba68716d832b6100e08d32fbc36f13c">PyDynamicEngine::getDepth</a></div><div class="ttdeci">gridfire::BuildDepthType getDepth() const override</div><div class="ttdef"><b>Definition</b> <a href="#l00041">py_engine.h:41</a></div></div>
|
||||
<div class="ttc" id="aclass_py_dynamic_engine_html_af8e6a8cd44f278535d7bcc9a896d6da8"><div class="ttname"><a href="class_py_dynamic_engine.html#af8e6a8cd44f278535d7bcc9a896d6da8">PyDynamicEngine::update</a></div><div class="ttdeci">fourdst::composition::Composition update(const gridfire::NetIn &netIn) override</div><div class="ttdoc">Update the internal state of the engine.</div><div class="ttdef"><b>Definition</b> <a href="py__engine_8cpp_source.html#l00167">py_engine.cpp:167</a></div></div>
|
||||
<div class="ttc" id="aclass_py_dynamic_engine_html_afa3abfd612033336a656f092721c14ac"><div class="ttname"><a href="class_py_dynamic_engine.html#afa3abfd612033336a656f092721c14ac">PyDynamicEngine::setScreeningModel</a></div><div class="ttdeci">void setScreeningModel(gridfire::screening::ScreeningType model) override</div><div class="ttdoc">Set the electron screening model.</div><div class="ttdef"><b>Definition</b> <a href="py__engine_8cpp_source.html#l00185">py_engine.cpp:185</a></div></div>
|
||||
<div class="ttc" id="aclass_py_dynamic_engine_html_afc745e7ab5da5d8b3cf916044515cd7d"><div class="ttname"><a href="class_py_dynamic_engine.html#afc745e7ab5da5d8b3cf916044515cd7d">PyDynamicEngine::getNetworkSpecies</a></div><div class="ttdeci">const std::vector< fourdst::atomic::Species > & getNetworkSpecies() const override</div><div class="ttdoc">PyDynamicEngine Implementation ///.</div><div class="ttdef"><b>Definition</b> <a href="py__engine_8cpp_source.html#l00050">py_engine.cpp:50</a></div></div>
|
||||
<div class="ttc" id="aclass_py_dynamic_engine_html_afd818c408c64d207e71b1a90426328d6"><div class="ttname"><a href="class_py_dynamic_engine.html#afd818c408c64d207e71b1a90426328d6">PyDynamicEngine::setNetworkReactions</a></div><div class="ttdeci">void setNetworkReactions(const gridfire::reaction::LogicalReactionSet &reactions) override</div><div class="ttdef"><b>Definition</b> <a href="py__engine_8cpp_source.html#l00140">py_engine.cpp:140</a></div></div>
|
||||
<div class="ttc" id="aclass_py_dynamic_engine_view_html"><div class="ttname"><a href="class_py_dynamic_engine_view.html">PyDynamicEngineView</a></div><div class="ttdef"><b>Definition</b> <a href="#l00057">py_engine.h:57</a></div></div>
|
||||
<div class="ttc" id="aclass_py_dynamic_engine_view_html_a51680b135cfc3eea40daf9ef5aa903e0"><div class="ttname"><a href="class_py_dynamic_engine_view.html#a51680b135cfc3eea40daf9ef5aa903e0">PyDynamicEngineView::getBaseEngine</a></div><div class="ttdeci">const gridfire::DynamicEngine & getBaseEngine() const override</div><div class="ttdoc">Access the underlying engine instance.</div><div class="ttdef"><b>Definition</b> <a href="py__engine_8cpp_source.html#l00237">py_engine.cpp:237</a></div></div>
|
||||
<div class="ttc" id="aclass_py_engine_html"><div class="ttname"><a href="class_py_engine.html">PyEngine</a></div><div class="ttdef"><b>Definition</b> <a href="#l00012">py_engine.h:12</a></div></div>
|
||||
<div class="ttc" id="aclass_py_engine_html_a2d240423899e039c2ca688e96f8af1f2"><div class="ttname"><a href="class_py_engine.html#a2d240423899e039c2ca688e96f8af1f2">PyEngine::getNetworkSpecies</a></div><div class="ttdeci">const std::vector< fourdst::atomic::Species > & getNetworkSpecies() const override</div><div class="ttdoc">Get the list of species in the network.</div><div class="ttdef"><b>Definition</b> <a href="py__engine_8cpp_source.html#l00016">py_engine.cpp:16</a></div></div>
|
||||
<div class="ttc" id="aclass_py_engine_html_a2f92602ecf210414b46838fc0a9ae26d"><div class="ttname"><a href="class_py_engine.html#a2f92602ecf210414b46838fc0a9ae26d">PyEngine::calculateRHSAndEnergy</a></div><div class="ttdeci">std::expected< gridfire::StepDerivatives< double >, gridfire::expectations::StaleEngineError > calculateRHSAndEnergy(const std::vector< double > &Y, double T9, double rho) const override</div><div class="ttdoc">Calculate the right-hand side (dY/dt) and energy generation.</div><div class="ttdef"><b>Definition</b> <a href="py__engine_8cpp_source.html#l00037">py_engine.cpp:37</a></div></div>
|
||||
<div class="ttc" id="aclass_py_engine_html_a73caaa7606e2cdfd1aa82729a78ebb73"><div class="ttname"><a href="class_py_engine.html#a73caaa7606e2cdfd1aa82729a78ebb73">PyEngine::m_species_cache</a></div><div class="ttdeci">std::vector< fourdst::atomic::Species > m_species_cache</div><div class="ttdef"><b>Definition</b> <a href="#l00017">py_engine.h:17</a></div></div>
|
||||
<div class="ttc" id="aclass_py_engine_view_html"><div class="ttname"><a href="class_py_engine_view.html">PyEngineView</a></div><div class="ttdef"><b>Definition</b> <a href="#l00053">py_engine.h:53</a></div></div>
|
||||
<div class="ttc" id="aclass_py_engine_view_html_a3cd83dc57b521c65a14edf70357a8845"><div class="ttname"><a href="class_py_engine_view.html#a3cd83dc57b521c65a14edf70357a8845">PyEngineView::getBaseEngine</a></div><div class="ttdeci">const gridfire::Engine & getBaseEngine() const override</div><div class="ttdoc">Access the underlying engine instance.</div><div class="ttdef"><b>Definition</b> <a href="py__engine_8cpp_source.html#l00229">py_engine.cpp:229</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_dynamic_engine_html"><div class="ttname"><a href="classgridfire_1_1_dynamic_engine.html">gridfire::DynamicEngine</a></div><div class="ttdoc">Abstract class for engines supporting Jacobian and stoichiometry operations.</div><div class="ttdef"><b>Definition</b> <a href="engine__abstract_8h_source.html#l00130">engine_abstract.h:130</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_engine_html"><div class="ttname"><a href="classgridfire_1_1_engine.html">gridfire::Engine</a></div><div class="ttdoc">Abstract base class for a reaction network engine.</div><div class="ttdef"><b>Definition</b> <a href="engine__abstract_8h_source.html#l00084">engine_abstract.h:84</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_engine_view_html"><div class="ttname"><a href="classgridfire_1_1_engine_view.html">gridfire::EngineView</a></div><div class="ttdoc">Abstract base class for a "view" of a reaction network engine.</div><div class="ttdef"><b>Definition</b> <a href="engine__view__abstract_8h_source.html#l00074">engine_view_abstract.h:74</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1reaction_1_1_reaction_html"><div class="ttname"><a href="classgridfire_1_1reaction_1_1_reaction.html">gridfire::reaction::Reaction</a></div><div class="ttdoc">Represents a single nuclear reaction from a specific data source.</div><div class="ttdef"><b>Definition</b> <a href="reaction_8h_source.html#l00072">reaction.h:72</a></div></div>
|
||||
<div class="ttc" id="aengine_8h_html"><div class="ttname"><a href="engine_8h.html">engine.h</a></div><div class="ttdoc">Core header for the GridFire reaction network engine module.</div></div>
|
||||
<div class="ttc" id="aexpected__engine_8h_html"><div class="ttname"><a href="expected__engine_8h.html">expected_engine.h</a></div></div>
|
||||
<div class="ttc" id="anamespacegridfire_1_1reaction_html_aa86f08712565f278adacc7cd2361eb31"><div class="ttname"><a href="namespacegridfire_1_1reaction.html#aa86f08712565f278adacc7cd2361eb31">gridfire::reaction::LogicalReactionSet</a></div><div class="ttdeci">TemplatedReactionSet< LogicalReaction > LogicalReactionSet</div><div class="ttdoc">A set of logical reactions.</div><div class="ttdef"><b>Definition</b> <a href="reaction_8h_source.html#l00563">reaction.h:563</a></div></div>
|
||||
<div class="ttc" id="anamespacegridfire_1_1screening_html_aa82aafbc4f8c28d0a75b60798e3a7d25"><div class="ttname"><a href="namespacegridfire_1_1screening.html#aa82aafbc4f8c28d0a75b60798e3a7d25">gridfire::screening::ScreeningType</a></div><div class="ttdeci">ScreeningType</div><div class="ttdoc">Enumerates the available plasma screening models.</div><div class="ttdef"><b>Definition</b> <a href="screening__types_8h_source.html#l00015">screening_types.h:15</a></div></div>
|
||||
<div class="ttc" id="anamespacegridfire_html_a3b1f70dc7ff5b501809330a97079e4f6"><div class="ttname"><a href="namespacegridfire.html#a3b1f70dc7ff5b501809330a97079e4f6">gridfire::BuildDepthType</a></div><div class="ttdeci">std::variant< NetworkBuildDepth, int > BuildDepthType</div><div class="ttdoc">Variant specifying either a predefined NetworkBuildDepth or a custom integer depth.</div><div class="ttdef"><b>Definition</b> <a href="building_8h_source.html#l00037">building.h:37</a></div></div>
|
||||
<div class="ttc" id="anamespacegridfire_html_a898dfe22579e649935645cbd6f073178"><div class="ttname"><a href="namespacegridfire.html#a898dfe22579e649935645cbd6f073178">gridfire::SparsityPattern</a></div><div class="ttdeci">std::vector< std::pair< size_t, size_t > > SparsityPattern</div><div class="ttdef"><b>Definition</b> <a href="engine__abstract_8h_source.html#l00065">engine_abstract.h:65</a></div></div>
|
||||
<div class="ttc" id="astructgridfire_1_1_net_in_html"><div class="ttname"><a href="structgridfire_1_1_net_in.html">gridfire::NetIn</a></div><div class="ttdef"><b>Definition</b> <a href="network_8h_source.html#l00053">network.h:53</a></div></div>
|
||||
<div class="ttc" id="astructgridfire_1_1_priming_report_html"><div class="ttname"><a href="structgridfire_1_1_priming_report.html">gridfire::PrimingReport</a></div><div class="ttdoc">Captures the result of a network priming operation.</div><div class="ttdef"><b>Definition</b> <a href="reporting_8h_source.html#l00067">reporting.h:67</a></div></div>
|
||||
<div class="ttc" id="astructgridfire_1_1expectations_1_1_stale_engine_error_html"><div class="ttname"><a href="structgridfire_1_1expectations_1_1_stale_engine_error.html">gridfire::expectations::StaleEngineError</a></div><div class="ttdef"><b>Definition</b> <a href="expected__engine_8h_source.html#l00044">expected_engine.h:44</a></div></div>
|
||||
</div><!-- fragment --></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="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_5c0d64f70903e893b1efe571a4b8de29.html">python</a></li><li class="navelem"><a class="el" href="dir_d0a49494bbb6e91de214e6669adf5efa.html">engine</a></li><li class="navelem"><a class="el" href="dir_736d89e8e2b688d729ae4656e8c69720.html">trampoline</a></li><li class="navelem"><a class="el" href="py__engine_8h.html">py_engine.h</a></li>
|
||||
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.13.2 </li>
|
||||
</ul>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user