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

291 lines
17 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>GridFire: gridfire::solver::CVODESolverStrategy::CVODEUserData Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<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">&#160;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&amp;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&amp;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&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODEUserData.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-attribs">Public Attributes</a> &#124;
<a href="structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODEUserData-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">gridfire::solver::CVODESolverStrategy::CVODEUserData Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p>A helper struct to pass C++ context to C-style CVODE callbacks.
<a href="structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODEUserData.html#details">More...</a></p>
<div class="dynheader">
Collaboration diagram for gridfire::solver::CVODESolverStrategy::CVODEUserData:</div>
<div class="dyncontent">
<div class="center"><div class="zoom"><iframe scrolling="no" frameborder="0" src="structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODEUserData__coll__graph.svg" width="100%" height="501"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div></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-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:ad7f3eb9caae25ef25357c41c23d6b392" id="r_ad7f3eb9caae25ef25357c41c23d6b392"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgridfire_1_1solver_1_1CVODESolverStrategy.html">CVODESolverStrategy</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODEUserData.html#ad7f3eb9caae25ef25357c41c23d6b392">solver_instance</a> {}</td></tr>
<tr class="separator:ad7f3eb9caae25ef25357c41c23d6b392"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a657f34d754521a6991351e29e0942ed6" id="r_a657f34d754521a6991351e29e0942ed6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgridfire_1_1engine_1_1DynamicEngine.html">engine::DynamicEngine</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODEUserData.html#a657f34d754521a6991351e29e0942ed6">engine</a> {}</td></tr>
<tr class="separator:a657f34d754521a6991351e29e0942ed6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0b27605ac3211a1805d7910c899bbcce" id="r_a0b27605ac3211a1805d7910c899bbcce"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODEUserData.html#a0b27605ac3211a1805d7910c899bbcce">T9</a> {}</td></tr>
<tr class="separator:a0b27605ac3211a1805d7910c899bbcce"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afdc510f8160693806737c4ab517058b8" id="r_afdc510f8160693806737c4ab517058b8"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODEUserData.html#afdc510f8160693806737c4ab517058b8">rho</a> {}</td></tr>
<tr class="separator:afdc510f8160693806737c4ab517058b8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1fb4ca773aaad8d1d958a3a0e82d8edd" id="r_a1fb4ca773aaad8d1d958a3a0e82d8edd"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODEUserData.html#a1fb4ca773aaad8d1d958a3a0e82d8edd">energy</a> {}</td></tr>
<tr class="separator:a1fb4ca773aaad8d1d958a3a0e82d8edd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a41a5bc46358cb59373f62c791e1bc29c" id="r_a41a5bc46358cb59373f62c791e1bc29c"><td class="memItemLeft" align="right" valign="top">const std::vector&lt; fourdst::atomic::Species &gt; *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODEUserData.html#a41a5bc46358cb59373f62c791e1bc29c">networkSpecies</a> {}</td></tr>
<tr class="separator:a41a5bc46358cb59373f62c791e1bc29c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a574e03aef08e1d3c9f4914bda1ad78c6" id="r_a574e03aef08e1d3c9f4914bda1ad78c6"><td class="memItemLeft" align="right" valign="top">std::unique_ptr&lt; <a class="el" href="classgridfire_1_1exceptions_1_1EngineError.html">exceptions::EngineError</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODEUserData.html#a574e03aef08e1d3c9f4914bda1ad78c6">captured_exception</a> = nullptr</td></tr>
<tr class="separator:a574e03aef08e1d3c9f4914bda1ad78c6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7c0adecacbb007c513d1b6c82e30d165" id="r_a7c0adecacbb007c513d1b6c82e30d165"><td class="memItemLeft" align="right" valign="top">std::optional&lt; std::map&lt; fourdst::atomic::Species, std::unordered_map&lt; std::string, double &gt; &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODEUserData.html#a7c0adecacbb007c513d1b6c82e30d165">reaction_contribution_map</a></td></tr>
<tr class="separator:a7c0adecacbb007c513d1b6c82e30d165"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a309e36605c79136e96f91f89dcde06d6" id="r_a309e36605c79136e96f91f89dcde06d6"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODEUserData.html#a309e36605c79136e96f91f89dcde06d6">neutrino_energy_loss_rate</a> = 0.0</td></tr>
<tr class="separator:a309e36605c79136e96f91f89dcde06d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7a495c5df9e1da7f2e7182511f6a95c8" id="r_a7a495c5df9e1da7f2e7182511f6a95c8"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODEUserData.html#a7a495c5df9e1da7f2e7182511f6a95c8">total_neutrino_flux</a> = 0.0</td></tr>
<tr class="separator:a7a495c5df9e1da7f2e7182511f6a95c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A helper struct to pass C++ context to C-style CVODE callbacks. </p>
<p>Carries pointers back to the solver instance and engine, the current thermodynamic state, energy accumulator, and a slot to capture a copy of exceptions::StaleEngineTrigger from RHS evaluation. The RHS wrapper treats this as a recoverable failure and returns 1 to CVODE, then the driver loop inspects and rethrows. </p>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a id="a574e03aef08e1d3c9f4914bda1ad78c6" name="a574e03aef08e1d3c9f4914bda1ad78c6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a574e03aef08e1d3c9f4914bda1ad78c6">&#9670;&#160;</a></span>captured_exception</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::unique_ptr&lt;<a class="el" href="classgridfire_1_1exceptions_1_1EngineError.html">exceptions::EngineError</a>&gt; gridfire::solver::CVODESolverStrategy::CVODEUserData::captured_exception = nullptr</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a1fb4ca773aaad8d1d958a3a0e82d8edd" name="a1fb4ca773aaad8d1d958a3a0e82d8edd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1fb4ca773aaad8d1d958a3a0e82d8edd">&#9670;&#160;</a></span>energy</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double gridfire::solver::CVODESolverStrategy::CVODEUserData::energy {}</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a657f34d754521a6991351e29e0942ed6" name="a657f34d754521a6991351e29e0942ed6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a657f34d754521a6991351e29e0942ed6">&#9670;&#160;</a></span>engine</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classgridfire_1_1engine_1_1DynamicEngine.html">engine::DynamicEngine</a>* gridfire::solver::CVODESolverStrategy::CVODEUserData::engine {}</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a41a5bc46358cb59373f62c791e1bc29c" name="a41a5bc46358cb59373f62c791e1bc29c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a41a5bc46358cb59373f62c791e1bc29c">&#9670;&#160;</a></span>networkSpecies</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::vector&lt;fourdst::atomic::Species&gt;* gridfire::solver::CVODESolverStrategy::CVODEUserData::networkSpecies {}</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a309e36605c79136e96f91f89dcde06d6" name="a309e36605c79136e96f91f89dcde06d6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a309e36605c79136e96f91f89dcde06d6">&#9670;&#160;</a></span>neutrino_energy_loss_rate</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double gridfire::solver::CVODESolverStrategy::CVODEUserData::neutrino_energy_loss_rate = 0.0</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a7c0adecacbb007c513d1b6c82e30d165" name="a7c0adecacbb007c513d1b6c82e30d165"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7c0adecacbb007c513d1b6c82e30d165">&#9670;&#160;</a></span>reaction_contribution_map</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::optional&lt;std::map&lt;fourdst::atomic::Species, std::unordered_map&lt;std::string, double&gt; &gt; &gt; gridfire::solver::CVODESolverStrategy::CVODEUserData::reaction_contribution_map</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="afdc510f8160693806737c4ab517058b8" name="afdc510f8160693806737c4ab517058b8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afdc510f8160693806737c4ab517058b8">&#9670;&#160;</a></span>rho</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double gridfire::solver::CVODESolverStrategy::CVODEUserData::rho {}</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ad7f3eb9caae25ef25357c41c23d6b392" name="ad7f3eb9caae25ef25357c41c23d6b392"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad7f3eb9caae25ef25357c41c23d6b392">&#9670;&#160;</a></span>solver_instance</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classgridfire_1_1solver_1_1CVODESolverStrategy.html">CVODESolverStrategy</a>* gridfire::solver::CVODESolverStrategy::CVODEUserData::solver_instance {}</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a0b27605ac3211a1805d7910c899bbcce" name="a0b27605ac3211a1805d7910c899bbcce"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0b27605ac3211a1805d7910c899bbcce">&#9670;&#160;</a></span>T9</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double gridfire::solver::CVODESolverStrategy::CVODEUserData::T9 {}</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a7a495c5df9e1da7f2e7182511f6a95c8" name="a7a495c5df9e1da7f2e7182511f6a95c8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7a495c5df9e1da7f2e7182511f6a95c8">&#9670;&#160;</a></span>total_neutrino_flux</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double gridfire::solver::CVODESolverStrategy::CVODEUserData::total_neutrino_flux = 0.0</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>src/include/gridfire/solver/strategies/<a class="el" href="CVODE__solver__strategy_8h.html">CVODE_solver_strategy.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespacegridfire.html">gridfire</a></li><li class="navelem"><a class="el" href="namespacegridfire_1_1solver.html">solver</a></li><li class="navelem"><a class="el" href="classgridfire_1_1solver_1_1CVODESolverStrategy.html">CVODESolverStrategy</a></li><li class="navelem"><a class="el" href="structgridfire_1_1solver_1_1CVODESolverStrategy_1_1CVODEUserData.html">CVODEUserData</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>
Reference in New Issue View Git Blame Copy Permalink