Files
GridFire/docs/html/struct_g_f_point_context.html

304 lines
19 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.13.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>GridFire: GFPointContext 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>
<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">&#160;v0.7.6rc4.0</span>
</div>
<div id="projectbrief">General Purpose Nuclear Network</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.13.2 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;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&amp;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&amp;dn=expat.txt MIT */
$(function(){initNavTree('struct_g_f_point_context.html',''); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="struct_g_f_point_context-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">GFPointContext Struct Reference<span class="mlabels"><span class="mlabel final">final</span></span></div></div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;gridfire_context.h&gt;</code></p>
<div class="dynheader">
Inheritance diagram for GFPointContext:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="struct_g_f_point_context__inherit__graph.svg" width="127" height="111"><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 GFPointContext:</div>
<div class="dyncontent">
<div class="center"><div class="zoom"><iframe scrolling="no" frameborder="0" src="struct_g_f_point_context__coll__graph.svg" width="100%" height="600"><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:a0fc95dc7b98865f7821ff945e809635a" id="r_a0fc95dc7b98865f7821ff945e809635a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0fc95dc7b98865f7821ff945e809635a">init_solver_from_engine</a> () override</td></tr>
<tr class="separator:a0fc95dc7b98865f7821ff945e809635a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac1ea5f9d1e909636228d66bb52e94889" id="r_ac1ea5f9d1e909636228d66bb52e94889"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac1ea5f9d1e909636228d66bb52e94889">evolve</a> (const double *Y_in, size_t num_species, double T, double rho, double tMax, double dt0, double *Y_out, double &amp;energy_out, double &amp;dEps_dT, double &amp;dEps_dRho, double &amp;specific_neutrino_energy_loss, double &amp;specific_neutrino_flux, double &amp;mass_lost) const</td></tr>
<tr class="separator:ac1ea5f9d1e909636228d66bb52e94889"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_struct_g_f_context"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_struct_g_f_context')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="struct_g_f_context.html">GFContext</a></td></tr>
<tr class="memitem:a4da09184145ea3bddef5dee206dea458 inherit pub_methods_struct_g_f_context" id="r_a4da09184145ea3bddef5dee206dea458"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_g_f_context.html#a4da09184145ea3bddef5dee206dea458">~GFContext</a> ()=default</td></tr>
<tr class="separator:a4da09184145ea3bddef5dee206dea458 inherit pub_methods_struct_g_f_context"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad3067d7c133f7e60849e8214fad6ed4e inherit pub_methods_struct_g_f_context" id="r_ad3067d7c133f7e60849e8214fad6ed4e"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_g_f_context.html#ad3067d7c133f7e60849e8214fad6ed4e">init_species_map</a> (const std::vector&lt; std::string &gt; &amp;species_names)</td></tr>
<tr class="separator:ad3067d7c133f7e60849e8214fad6ed4e inherit pub_methods_struct_g_f_context"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a18aab1769f5e3071d768753141f15c6c inherit pub_methods_struct_g_f_context" id="r_a18aab1769f5e3071d768753141f15c6c"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_g_f_context.html#a18aab1769f5e3071d768753141f15c6c">init_engine_from_policy</a> (const std::string &amp;policy_name, const double *abundances, size_t num_species)</td></tr>
<tr class="separator:a18aab1769f5e3071d768753141f15c6c inherit pub_methods_struct_g_f_context"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4aa31d479303659b475558ef2df30cbe inherit pub_methods_struct_g_f_context" id="r_a4aa31d479303659b475558ef2df30cbe"><td class="memItemLeft" align="right" valign="top">fourdst::composition::Composition&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_g_f_context.html#a4aa31d479303659b475558ef2df30cbe">init_composition_from_abundance_vector</a> (const std::vector&lt; double &gt; &amp;abundances, size_t num_species) const</td></tr>
<tr class="separator:a4aa31d479303659b475558ef2df30cbe inherit pub_methods_struct_g_f_context"><td class="memSeparator" colspan="2">&#160;</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:a05d85e0dc718ba0c8854e831a574f6ac" id="r_a05d85e0dc718ba0c8854e831a574f6ac"><td class="memItemLeft" align="right" valign="top">std::unique_ptr&lt; <a class="el" href="namespacegridfire_1_1solver.html#a3ba32e30d3e30cbbca5ffb22dff077ee">gridfire::solver::SingleZoneDynamicNetworkSolver</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a05d85e0dc718ba0c8854e831a574f6ac">solver</a></td></tr>
<tr class="separator:a05d85e0dc718ba0c8854e831a574f6ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5158bd7c67f4a0e4395b78ce4009f275" id="r_a5158bd7c67f4a0e4395b78ce4009f275"><td class="memItemLeft" align="right" valign="top">std::unique_ptr&lt; <a class="el" href="structgridfire_1_1solver_1_1_solver_context_base.html">gridfire::solver::SolverContextBase</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5158bd7c67f4a0e4395b78ce4009f275">solver_ctx</a></td></tr>
<tr class="separator:a5158bd7c67f4a0e4395b78ce4009f275"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_attribs_struct_g_f_context"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_attribs_struct_g_f_context')"><img src="closed.png" alt="-"/>&#160;Public Attributes inherited from <a class="el" href="struct_g_f_context.html">GFContext</a></td></tr>
<tr class="memitem:a6d053d819a80084fcda10cb00d06f9f8 inherit pub_attribs_struct_g_f_context" id="r_a6d053d819a80084fcda10cb00d06f9f8"><td class="memItemLeft" align="right" valign="top">std::unique_ptr&lt; <a class="el" href="classgridfire_1_1policy_1_1_network_policy.html">gridfire::policy::NetworkPolicy</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_g_f_context.html#a6d053d819a80084fcda10cb00d06f9f8">policy</a></td></tr>
<tr class="separator:a6d053d819a80084fcda10cb00d06f9f8 inherit pub_attribs_struct_g_f_context"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab566b9194a7869f6b69ba7adc67d5d34 inherit pub_attribs_struct_g_f_context" id="r_ab566b9194a7869f6b69ba7adc67d5d34"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classgridfire_1_1engine_1_1_dynamic_engine.html">gridfire::engine::DynamicEngine</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_g_f_context.html#ab566b9194a7869f6b69ba7adc67d5d34">engine</a></td></tr>
<tr class="separator:ab566b9194a7869f6b69ba7adc67d5d34 inherit pub_attribs_struct_g_f_context"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af77eab6a1ee3b0c1ebf50b7200040dfa inherit pub_attribs_struct_g_f_context" id="r_af77eab6a1ee3b0c1ebf50b7200040dfa"><td class="memItemLeft" align="right" valign="top">std::unique_ptr&lt; <a class="el" href="classgridfire_1_1engine_1_1scratch_1_1_state_blob.html">gridfire::engine::scratch::StateBlob</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_g_f_context.html#af77eab6a1ee3b0c1ebf50b7200040dfa">engine_ctx</a></td></tr>
<tr class="separator:af77eab6a1ee3b0c1ebf50b7200040dfa inherit pub_attribs_struct_g_f_context"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad65d2f34696aa6368a49768fc5c0ebf7 inherit pub_attribs_struct_g_f_context" id="r_ad65d2f34696aa6368a49768fc5c0ebf7"><td class="memItemLeft" align="right" valign="top">std::vector&lt; fourdst::atomic::Species &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_g_f_context.html#ad65d2f34696aa6368a49768fc5c0ebf7">speciesList</a></td></tr>
<tr class="separator:ad65d2f34696aa6368a49768fc5c0ebf7 inherit pub_attribs_struct_g_f_context"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a82e384a1c565caee2f23eaeccd701a58 inherit pub_attribs_struct_g_f_context" id="r_a82e384a1c565caee2f23eaeccd701a58"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_g_f_context.html#a82e384a1c565caee2f23eaeccd701a58">last_error</a></td></tr>
<tr class="separator:a82e384a1c565caee2f23eaeccd701a58 inherit pub_attribs_struct_g_f_context"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ac1ea5f9d1e909636228d66bb52e94889" name="ac1ea5f9d1e909636228d66bb52e94889"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac1ea5f9d1e909636228d66bb52e94889">&#9670;&#160;</a></span>evolve()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int GFPointContext::evolve </td>
<td>(</td>
<td class="paramtype">const double *</td> <td class="paramname"><span class="paramname"><em>Y_in</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>num_species</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double</td> <td class="paramname"><span class="paramname"><em>T</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double</td> <td class="paramname"><span class="paramname"><em>rho</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double</td> <td class="paramname"><span class="paramname"><em>tMax</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double</td> <td class="paramname"><span class="paramname"><em>dt0</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double *</td> <td class="paramname"><span class="paramname"><em>Y_out</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double &amp;</td> <td class="paramname"><span class="paramname"><em>energy_out</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double &amp;</td> <td class="paramname"><span class="paramname"><em>dEps_dT</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double &amp;</td> <td class="paramname"><span class="paramname"><em>dEps_dRho</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double &amp;</td> <td class="paramname"><span class="paramname"><em>specific_neutrino_energy_loss</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double &amp;</td> <td class="paramname"><span class="paramname"><em>specific_neutrino_flux</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double &amp;</td> <td class="paramname"><span class="paramname"><em>mass_lost</em></span>&#160;) const</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a0fc95dc7b98865f7821ff945e809635a" name="a0fc95dc7b98865f7821ff945e809635a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0fc95dc7b98865f7821ff945e809635a">&#9670;&#160;</a></span>init_solver_from_engine()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void GFPointContext::init_solver_from_engine </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel override">override</span><span class="mlabel virtual">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implements <a class="el" href="struct_g_f_context.html#ae1d09e19a43ddca42a1c3d360daf548e">GFContext</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a05d85e0dc718ba0c8854e831a574f6ac" name="a05d85e0dc718ba0c8854e831a574f6ac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a05d85e0dc718ba0c8854e831a574f6ac">&#9670;&#160;</a></span>solver</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::unique_ptr&lt;<a class="el" href="namespacegridfire_1_1solver.html#a3ba32e30d3e30cbbca5ffb22dff077ee">gridfire::solver::SingleZoneDynamicNetworkSolver</a>&gt; GFPointContext::solver</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a5158bd7c67f4a0e4395b78ce4009f275" name="a5158bd7c67f4a0e4395b78ce4009f275"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5158bd7c67f4a0e4395b78ce4009f275">&#9670;&#160;</a></span>solver_ctx</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::unique_ptr&lt;<a class="el" href="structgridfire_1_1solver_1_1_solver_context_base.html">gridfire::solver::SolverContextBase</a>&gt; GFPointContext::solver_ctx</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<hr/>The documentation for this struct was generated from the following files:<ul>
<li>src/extern/include/gridfire/extern/<a class="el" href="gridfire__context_8h.html">gridfire_context.h</a></li>
<li>src/extern/lib/<a class="el" href="gridfire__context_8cpp.html">gridfire_context.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="struct_g_f_point_context.html">GFPointContext</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>