501 lines
30 KiB
HTML
501 lines
30 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: gridfire::solver::CVODESolverStrategy::TimestepContext 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"> 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('structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext.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="#pub-attribs">Public Attributes</a> |
|
|
<a href="structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">gridfire::solver::CVODESolverStrategy::TimestepContext Struct Reference<span class="mlabels"><span class="mlabel">final</span></span></div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Immutable view of the current integration state passed to callbacks.
|
|
<a href="structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext.html#details">More...</a></p>
|
|
|
|
<p><code>#include <CVODE_solver_strategy.h></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for gridfire::solver::CVODESolverStrategy::TimestepContext:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><iframe scrolling="no" frameborder="0" src="structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext__inherit__graph.svg" width="222" height="139"><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 gridfire::solver::CVODESolverStrategy::TimestepContext:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><div class="zoom"><iframe scrolling="no" frameborder="0" src="structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext__coll__graph.svg" width="100%" height="504"><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-methods" name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a04c4ce00c6a0a62ba6d1e6fb1a0a53be" id="r_a04c4ce00c6a0a62ba6d1e6fb1a0a53be"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext.html#a04c4ce00c6a0a62ba6d1e6fb1a0a53be">TimestepContext</a> (double <a class="el" href="structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext.html#a0b39f0d207181840efacb64417b492ae">t</a>, const N_Vector &<a class="el" href="structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext.html#aaae3c42b9172be4d501f022e67f5a6f6">state</a>, double <a class="el" href="structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext.html#a6442d15673e6385bb6fdd11e1179c487">dt</a>, double <a class="el" href="structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext.html#a4a92187c15b7bcb90adebecc87e1436a">last_step_time</a>, double t9, double <a class="el" href="structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext.html#a4a25afbc9f8a907304992e144dfa3529">rho</a>, size_t <a class="el" href="structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext.html#a51e86d2721053055d8479662b864e367">num_steps</a>, const <a class="el" href="classgridfire_1_1engine_1_1DynamicEngine.html">engine::DynamicEngine</a> &<a class="el" href="structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext.html#a5a457651dcb9d4a66ed219ddf7095313">engine</a>, const std::vector< fourdst::atomic::Species > &<a class="el" href="structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext.html#a75d7e32c9df3d8a047069fe2d64cd089">networkSpecies</a>, size_t currentConvergenceFailure, size_t <a class="el" href="structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext.html#aefa6b183bf963f6e01c5157b7c0f158a">currentNonlinearIterations</a>, const std::map< fourdst::atomic::Species, std::unordered_map< std::string, double > > &<a class="el" href="structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext.html#aaad8a2e08769b629086133d3b079e3b1">reactionContributionMap</a>)</td></tr>
|
|
<tr class="memdesc:a04c4ce00c6a0a62ba6d1e6fb1a0a53be"><td class="mdescLeft"> </td><td class="mdescRight">Construct a context snapshot. <br /></td></tr>
|
|
<tr class="separator:a04c4ce00c6a0a62ba6d1e6fb1a0a53be"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae3c6320ce7a8f41c9ae36c42d62b4204" id="r_ae3c6320ce7a8f41c9ae36c42d62b4204"><td class="memItemLeft" align="right" valign="top">std::vector< std::tuple< std::string, std::string > > </td><td class="memItemRight" valign="bottom"><a class="el" href="structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext.html#ae3c6320ce7a8f41c9ae36c42d62b4204">describe</a> () const override</td></tr>
|
|
<tr class="memdesc:ae3c6320ce7a8f41c9ae36c42d62b4204"><td class="mdescLeft"> </td><td class="mdescRight">Human-readable description of the context fields. <br /></td></tr>
|
|
<tr class="separator:ae3c6320ce7a8f41c9ae36c42d62b4204"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_classgridfire_1_1solver_1_1SolverContextBase"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classgridfire_1_1solver_1_1SolverContextBase')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classgridfire_1_1solver_1_1SolverContextBase.html">gridfire::solver::SolverContextBase</a></td></tr>
|
|
<tr class="memitem:ab1abf9e5ff7f53a6cebe5e00ea5fc0c8 inherit pub_methods_classgridfire_1_1solver_1_1SolverContextBase" id="r_ab1abf9e5ff7f53a6cebe5e00ea5fc0c8"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1solver_1_1SolverContextBase.html#ab1abf9e5ff7f53a6cebe5e00ea5fc0c8">~SolverContextBase</a> ()=default</td></tr>
|
|
<tr class="separator:ab1abf9e5ff7f53a6cebe5e00ea5fc0c8 inherit pub_methods_classgridfire_1_1solver_1_1SolverContextBase"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><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:a0b39f0d207181840efacb64417b492ae" id="r_a0b39f0d207181840efacb64417b492ae"><td class="memItemLeft" align="right" valign="top">const double </td><td class="memItemRight" valign="bottom"><a class="el" href="structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext.html#a0b39f0d207181840efacb64417b492ae">t</a></td></tr>
|
|
<tr class="memdesc:a0b39f0d207181840efacb64417b492ae"><td class="mdescLeft"> </td><td class="mdescRight">Current integration time [s]. <br /></td></tr>
|
|
<tr class="separator:a0b39f0d207181840efacb64417b492ae"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aaae3c42b9172be4d501f022e67f5a6f6" id="r_aaae3c42b9172be4d501f022e67f5a6f6"><td class="memItemLeft" align="right" valign="top">const N_Vector & </td><td class="memItemRight" valign="bottom"><a class="el" href="structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext.html#aaae3c42b9172be4d501f022e67f5a6f6">state</a></td></tr>
|
|
<tr class="memdesc:aaae3c42b9172be4d501f022e67f5a6f6"><td class="mdescLeft"> </td><td class="mdescRight">Current CVODE state vector (N_Vector). <br /></td></tr>
|
|
<tr class="separator:aaae3c42b9172be4d501f022e67f5a6f6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6442d15673e6385bb6fdd11e1179c487" id="r_a6442d15673e6385bb6fdd11e1179c487"><td class="memItemLeft" align="right" valign="top">const double </td><td class="memItemRight" valign="bottom"><a class="el" href="structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext.html#a6442d15673e6385bb6fdd11e1179c487">dt</a></td></tr>
|
|
<tr class="memdesc:a6442d15673e6385bb6fdd11e1179c487"><td class="mdescLeft"> </td><td class="mdescRight">Last step size [s]. <br /></td></tr>
|
|
<tr class="separator:a6442d15673e6385bb6fdd11e1179c487"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4a92187c15b7bcb90adebecc87e1436a" id="r_a4a92187c15b7bcb90adebecc87e1436a"><td class="memItemLeft" align="right" valign="top">const double </td><td class="memItemRight" valign="bottom"><a class="el" href="structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext.html#a4a92187c15b7bcb90adebecc87e1436a">last_step_time</a></td></tr>
|
|
<tr class="memdesc:a4a92187c15b7bcb90adebecc87e1436a"><td class="mdescLeft"> </td><td class="mdescRight">Time at last callback [s]. <br /></td></tr>
|
|
<tr class="separator:a4a92187c15b7bcb90adebecc87e1436a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a25743a21ed801ed4288309f35dc9a289" id="r_a25743a21ed801ed4288309f35dc9a289"><td class="memItemLeft" align="right" valign="top">const double </td><td class="memItemRight" valign="bottom"><a class="el" href="structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext.html#a25743a21ed801ed4288309f35dc9a289">T9</a></td></tr>
|
|
<tr class="memdesc:a25743a21ed801ed4288309f35dc9a289"><td class="mdescLeft"> </td><td class="mdescRight">Temperature in GK. <br /></td></tr>
|
|
<tr class="separator:a25743a21ed801ed4288309f35dc9a289"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4a25afbc9f8a907304992e144dfa3529" id="r_a4a25afbc9f8a907304992e144dfa3529"><td class="memItemLeft" align="right" valign="top">const double </td><td class="memItemRight" valign="bottom"><a class="el" href="structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext.html#a4a25afbc9f8a907304992e144dfa3529">rho</a></td></tr>
|
|
<tr class="memdesc:a4a25afbc9f8a907304992e144dfa3529"><td class="mdescLeft"> </td><td class="mdescRight">Density [g cm^-3]. <br /></td></tr>
|
|
<tr class="separator:a4a25afbc9f8a907304992e144dfa3529"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a51e86d2721053055d8479662b864e367" id="r_a51e86d2721053055d8479662b864e367"><td class="memItemLeft" align="right" valign="top">const size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext.html#a51e86d2721053055d8479662b864e367">num_steps</a></td></tr>
|
|
<tr class="memdesc:a51e86d2721053055d8479662b864e367"><td class="mdescLeft"> </td><td class="mdescRight">Number of CVODE steps taken so far. <br /></td></tr>
|
|
<tr class="separator:a51e86d2721053055d8479662b864e367"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5a457651dcb9d4a66ed219ddf7095313" id="r_a5a457651dcb9d4a66ed219ddf7095313"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classgridfire_1_1engine_1_1DynamicEngine.html">engine::DynamicEngine</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext.html#a5a457651dcb9d4a66ed219ddf7095313">engine</a></td></tr>
|
|
<tr class="memdesc:a5a457651dcb9d4a66ed219ddf7095313"><td class="mdescLeft"> </td><td class="mdescRight">Reference to the engine. <br /></td></tr>
|
|
<tr class="separator:a5a457651dcb9d4a66ed219ddf7095313"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a75d7e32c9df3d8a047069fe2d64cd089" id="r_a75d7e32c9df3d8a047069fe2d64cd089"><td class="memItemLeft" align="right" valign="top">const std::vector< fourdst::atomic::Species > & </td><td class="memItemRight" valign="bottom"><a class="el" href="structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext.html#a75d7e32c9df3d8a047069fe2d64cd089">networkSpecies</a></td></tr>
|
|
<tr class="memdesc:a75d7e32c9df3d8a047069fe2d64cd089"><td class="mdescLeft"> </td><td class="mdescRight">Species layout. <br /></td></tr>
|
|
<tr class="separator:a75d7e32c9df3d8a047069fe2d64cd089"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adef40af49e162d2429db1030f6341d96" id="r_adef40af49e162d2429db1030f6341d96"><td class="memItemLeft" align="right" valign="top">const size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext.html#adef40af49e162d2429db1030f6341d96">currentConvergenceFailures</a></td></tr>
|
|
<tr class="memdesc:adef40af49e162d2429db1030f6341d96"><td class="mdescLeft"> </td><td class="mdescRight">Total number of convergence failures. <br /></td></tr>
|
|
<tr class="separator:adef40af49e162d2429db1030f6341d96"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aefa6b183bf963f6e01c5157b7c0f158a" id="r_aefa6b183bf963f6e01c5157b7c0f158a"><td class="memItemLeft" align="right" valign="top">const size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext.html#aefa6b183bf963f6e01c5157b7c0f158a">currentNonlinearIterations</a></td></tr>
|
|
<tr class="memdesc:aefa6b183bf963f6e01c5157b7c0f158a"><td class="mdescLeft"> </td><td class="mdescRight">Total number of non-linear iterations. <br /></td></tr>
|
|
<tr class="separator:aefa6b183bf963f6e01c5157b7c0f158a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aaad8a2e08769b629086133d3b079e3b1" id="r_aaad8a2e08769b629086133d3b079e3b1"><td class="memItemLeft" align="right" valign="top">const std::map< fourdst::atomic::Species, std::unordered_map< std::string, double > > & </td><td class="memItemRight" valign="bottom"><a class="el" href="structgridfire_1_1solver_1_1CVODESolverStrategy_1_1TimestepContext.html#aaad8a2e08769b629086133d3b079e3b1">reactionContributionMap</a></td></tr>
|
|
<tr class="memdesc:aaad8a2e08769b629086133d3b079e3b1"><td class="mdescLeft"> </td><td class="mdescRight">Map of reaction contributions for the current step. <br /></td></tr>
|
|
<tr class="separator:aaad8a2e08769b629086133d3b079e3b1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Immutable view of the current integration state passed to callbacks. </p>
|
|
<p>Fields capture CVODE time/state, step size, thermodynamic state, the engine reference, and the list of network species used to interpret the state vector layout. </p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a04c4ce00c6a0a62ba6d1e6fb1a0a53be" name="a04c4ce00c6a0a62ba6d1e6fb1a0a53be"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a04c4ce00c6a0a62ba6d1e6fb1a0a53be">◆ </a></span>TimestepContext()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">gridfire::solver::CVODESolverStrategy::TimestepContext::TimestepContext </td>
|
|
<td>(</td>
|
|
<td class="paramtype">double </td>
|
|
<td class="paramname"><em>t</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const N_Vector & </td>
|
|
<td class="paramname"><em>state</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">double </td>
|
|
<td class="paramname"><em>dt</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">double </td>
|
|
<td class="paramname"><em>last_step_time</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">size_t </td>
|
|
<td class="paramname"><em>num_steps</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="classgridfire_1_1engine_1_1DynamicEngine.html">engine::DynamicEngine</a> & </td>
|
|
<td class="paramname"><em>engine</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::vector< fourdst::atomic::Species > & </td>
|
|
<td class="paramname"><em>networkSpecies</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>currentConvergenceFailure</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>currentNonlinearIterations</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::map< fourdst::atomic::Species, std::unordered_map< std::string, double > > & </td>
|
|
<td class="paramname"><em>reactionContributionMap</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Construct a context snapshot. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="ae3c6320ce7a8f41c9ae36c42d62b4204" name="ae3c6320ce7a8f41c9ae36c42d62b4204"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae3c6320ce7a8f41c9ae36c42d62b4204">◆ </a></span>describe()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::vector< std::tuple< std::string, std::string > > gridfire::solver::CVODESolverStrategy::TimestepContext::describe </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>Human-readable description of the context fields. </p>
|
|
|
|
<p>Implements <a class="el" href="classgridfire_1_1solver_1_1SolverContextBase.html#a9cbef3cabc8524e542613ee50d8860c6">gridfire::solver::SolverContextBase</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Data Documentation</h2>
|
|
<a id="adef40af49e162d2429db1030f6341d96" name="adef40af49e162d2429db1030f6341d96"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#adef40af49e162d2429db1030f6341d96">◆ </a></span>currentConvergenceFailures</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const size_t gridfire::solver::CVODESolverStrategy::TimestepContext::currentConvergenceFailures</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Total number of convergence failures. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aefa6b183bf963f6e01c5157b7c0f158a" name="aefa6b183bf963f6e01c5157b7c0f158a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aefa6b183bf963f6e01c5157b7c0f158a">◆ </a></span>currentNonlinearIterations</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const size_t gridfire::solver::CVODESolverStrategy::TimestepContext::currentNonlinearIterations</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Total number of non-linear iterations. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6442d15673e6385bb6fdd11e1179c487" name="a6442d15673e6385bb6fdd11e1179c487"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6442d15673e6385bb6fdd11e1179c487">◆ </a></span>dt</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const double gridfire::solver::CVODESolverStrategy::TimestepContext::dt</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Last step size [s]. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5a457651dcb9d4a66ed219ddf7095313" name="a5a457651dcb9d4a66ed219ddf7095313"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5a457651dcb9d4a66ed219ddf7095313">◆ </a></span>engine</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const <a class="el" href="classgridfire_1_1engine_1_1DynamicEngine.html">engine::DynamicEngine</a>& gridfire::solver::CVODESolverStrategy::TimestepContext::engine</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Reference to the engine. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4a92187c15b7bcb90adebecc87e1436a" name="a4a92187c15b7bcb90adebecc87e1436a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4a92187c15b7bcb90adebecc87e1436a">◆ </a></span>last_step_time</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const double gridfire::solver::CVODESolverStrategy::TimestepContext::last_step_time</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Time at last callback [s]. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a75d7e32c9df3d8a047069fe2d64cd089" name="a75d7e32c9df3d8a047069fe2d64cd089"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a75d7e32c9df3d8a047069fe2d64cd089">◆ </a></span>networkSpecies</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const std::vector<fourdst::atomic::Species>& gridfire::solver::CVODESolverStrategy::TimestepContext::networkSpecies</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Species layout. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a51e86d2721053055d8479662b864e367" name="a51e86d2721053055d8479662b864e367"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a51e86d2721053055d8479662b864e367">◆ </a></span>num_steps</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const size_t gridfire::solver::CVODESolverStrategy::TimestepContext::num_steps</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Number of CVODE steps taken so far. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aaad8a2e08769b629086133d3b079e3b1" name="aaad8a2e08769b629086133d3b079e3b1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aaad8a2e08769b629086133d3b079e3b1">◆ </a></span>reactionContributionMap</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const std::map<fourdst::atomic::Species, std::unordered_map<std::string, double> >& gridfire::solver::CVODESolverStrategy::TimestepContext::reactionContributionMap</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Map of reaction contributions for the current step. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4a25afbc9f8a907304992e144dfa3529" name="a4a25afbc9f8a907304992e144dfa3529"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4a25afbc9f8a907304992e144dfa3529">◆ </a></span>rho</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const double gridfire::solver::CVODESolverStrategy::TimestepContext::rho</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Density [g cm^-3]. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aaae3c42b9172be4d501f022e67f5a6f6" name="aaae3c42b9172be4d501f022e67f5a6f6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aaae3c42b9172be4d501f022e67f5a6f6">◆ </a></span>state</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const N_Vector& gridfire::solver::CVODESolverStrategy::TimestepContext::state</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Current CVODE state vector (N_Vector). </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0b39f0d207181840efacb64417b492ae" name="a0b39f0d207181840efacb64417b492ae"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0b39f0d207181840efacb64417b492ae">◆ </a></span>t</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const double gridfire::solver::CVODESolverStrategy::TimestepContext::t</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Current integration time [s]. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a25743a21ed801ed4288309f35dc9a289" name="a25743a21ed801ed4288309f35dc9a289"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a25743a21ed801ed4288309f35dc9a289">◆ </a></span>T9</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const double gridfire::solver::CVODESolverStrategy::TimestepContext::T9</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Temperature in GK. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this struct was generated from the following files:<ul>
|
|
<li>src/include/gridfire/solver/strategies/<a class="el" href="CVODE__solver__strategy_8h.html">CVODE_solver_strategy.h</a></li>
|
|
<li>src/lib/solver/strategies/<a class="el" href="CVODE__solver__strategy_8cpp.html">CVODE_solver_strategy.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="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_1TimestepContext.html">TimestepContext</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>
|