tboudreaux/GridFire
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(docs): rebuilt

Browse Source
This commit is contained in:
Emily Boudreaux
2025-11-27 15:06:27 -05:00
parent 30a5a4d803
commit 07b2cfd055
1537 changed files with 90658 additions and 47822 deletions
Download Patch File Download Diff File Expand all files Collapse all files

402
docs/html/struct_grid_fire_context.html Normal file
View File

@@ -0,0 +1,402 @@
<!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: GridFireContext 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.0_rc2</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_grid_fire_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_grid_fire_context-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">GridFireContext Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;gridfire_context.h&gt;</code></p>
<div class="dynheader">
Collaboration diagram for GridFireContext:</div>
<div class="dyncontent">
<div class="center"><div class="zoom"><iframe scrolling="no" frameborder="0" src="struct_grid_fire_context__coll__graph.svg" width="100%" height="539"><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:aedfc79fcb51a71f8b3ef74fe771f9918" id="r_aedfc79fcb51a71f8b3ef74fe771f9918"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aedfc79fcb51a71f8b3ef74fe771f9918">init_species_map</a> (const std::vector&lt; std::string &gt; &amp;species_names)</td></tr>
<tr class="separator:aedfc79fcb51a71f8b3ef74fe771f9918"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a69ed916218fd480536157b243ef2a5bc" id="r_a69ed916218fd480536157b243ef2a5bc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a69ed916218fd480536157b243ef2a5bc">init_engine_from_policy</a> (const std::string &amp;policy_name, const double *abundances, size_t num_species)</td></tr>
<tr class="separator:a69ed916218fd480536157b243ef2a5bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6bf34e315a577e366220b13b0e577338" id="r_a6bf34e315a577e366220b13b0e577338"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a6bf34e315a577e366220b13b0e577338">init_solver_from_engine</a> (const std::string &amp;solver_name)</td></tr>
<tr class="separator:a6bf34e315a577e366220b13b0e577338"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae3df28c7f511f08361447608658b1482" id="r_ae3df28c7f511f08361447608658b1482"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae3df28c7f511f08361447608658b1482">init_composition_from_abundance_vector</a> (const double *abundances, size_t num_species)</td></tr>
<tr class="separator:ae3df28c7f511f08361447608658b1482"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1b75911fd12ec1cd83d20d91df621bee" id="r_a1b75911fd12ec1cd83d20d91df621bee"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a1b75911fd12ec1cd83d20d91df621bee">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)</td></tr>
<tr class="separator:a1b75911fd12ec1cd83d20d91df621bee"><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:af2c2beed9c6710d8e2fb39fc8ac0eb60" id="r_af2c2beed9c6710d8e2fb39fc8ac0eb60"><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="#af2c2beed9c6710d8e2fb39fc8ac0eb60">policy</a></td></tr>
<tr class="separator:af2c2beed9c6710d8e2fb39fc8ac0eb60"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad3e84807850731ccdafe782aa5a81622" id="r_ad3e84807850731ccdafe782aa5a81622"><td class="memItemLeft" align="right" valign="top"><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="#ad3e84807850731ccdafe782aa5a81622">engine</a></td></tr>
<tr class="separator:ad3e84807850731ccdafe782aa5a81622"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a958e9c99e8759bf8388df5689fd45baa" id="r_a958e9c99e8759bf8388df5689fd45baa"><td class="memItemLeft" align="right" valign="top">std::unique_ptr&lt; <a class="el" href="namespacegridfire_1_1solver.html#ade01aa38cf726210f9d2a8f8567d6633">gridfire::solver::DynamicNetworkSolverStrategy</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a958e9c99e8759bf8388df5689fd45baa">solver</a></td></tr>
<tr class="separator:a958e9c99e8759bf8388df5689fd45baa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af6c7cfb326dd3540ce615ecb67935959" id="r_af6c7cfb326dd3540ce615ecb67935959"><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="#af6c7cfb326dd3540ce615ecb67935959">speciesList</a></td></tr>
<tr class="separator:af6c7cfb326dd3540ce615ecb67935959"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8b8c3451f5fee848e4d552ba05be12a0" id="r_a8b8c3451f5fee848e4d552ba05be12a0"><td class="memItemLeft" align="right" valign="top">fourdst::composition::Composition&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8b8c3451f5fee848e4d552ba05be12a0">working_comp</a></td></tr>
<tr class="separator:a8b8c3451f5fee848e4d552ba05be12a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a62b3e9b15e0892339d1f7af0d063dc89" id="r_a62b3e9b15e0892339d1f7af0d063dc89"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a62b3e9b15e0892339d1f7af0d063dc89">last_error</a></td></tr>
<tr class="separator:a62b3e9b15e0892339d1f7af0d063dc89"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a1b75911fd12ec1cd83d20d91df621bee" name="a1b75911fd12ec1cd83d20d91df621bee"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1b75911fd12ec1cd83d20d91df621bee">&#9670;&#160;</a></span>evolve()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int GridFireContext::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;)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ae3df28c7f511f08361447608658b1482" name="ae3df28c7f511f08361447608658b1482"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae3df28c7f511f08361447608658b1482">&#9670;&#160;</a></span>init_composition_from_abundance_vector()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void GridFireContext::init_composition_from_abundance_vector </td>
<td>(</td>
<td class="paramtype">const double *</td> <td class="paramname"><span class="paramname"><em>abundances</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>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a69ed916218fd480536157b243ef2a5bc" name="a69ed916218fd480536157b243ef2a5bc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a69ed916218fd480536157b243ef2a5bc">&#9670;&#160;</a></span>init_engine_from_policy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void GridFireContext::init_engine_from_policy </td>
<td>(</td>
<td class="paramtype">const std::string &amp;</td> <td class="paramname"><span class="paramname"><em>policy_name</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const double *</td> <td class="paramname"><span class="paramname"><em>abundances</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>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a6bf34e315a577e366220b13b0e577338" name="a6bf34e315a577e366220b13b0e577338"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6bf34e315a577e366220b13b0e577338">&#9670;&#160;</a></span>init_solver_from_engine()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void GridFireContext::init_solver_from_engine </td>
<td>(</td>
<td class="paramtype">const std::string &amp;</td> <td class="paramname"><span class="paramname"><em>solver_name</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="aedfc79fcb51a71f8b3ef74fe771f9918" name="aedfc79fcb51a71f8b3ef74fe771f9918"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aedfc79fcb51a71f8b3ef74fe771f9918">&#9670;&#160;</a></span>init_species_map()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void GridFireContext::init_species_map </td>
<td>(</td>
<td class="paramtype">const std::vector&lt; std::string &gt; &amp;</td> <td class="paramname"><span class="paramname"><em>species_names</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="ad3e84807850731ccdafe782aa5a81622" name="ad3e84807850731ccdafe782aa5a81622"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad3e84807850731ccdafe782aa5a81622">&#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_1_dynamic_engine.html">gridfire::engine::DynamicEngine</a>* GridFireContext::engine</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a62b3e9b15e0892339d1f7af0d063dc89" name="a62b3e9b15e0892339d1f7af0d063dc89"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a62b3e9b15e0892339d1f7af0d063dc89">&#9670;&#160;</a></span>last_error</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string GridFireContext::last_error</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="af2c2beed9c6710d8e2fb39fc8ac0eb60" name="af2c2beed9c6710d8e2fb39fc8ac0eb60"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af2c2beed9c6710d8e2fb39fc8ac0eb60">&#9670;&#160;</a></span>policy</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::unique_ptr&lt;<a class="el" href="classgridfire_1_1policy_1_1_network_policy.html">gridfire::policy::NetworkPolicy</a>&gt; GridFireContext::policy</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a958e9c99e8759bf8388df5689fd45baa" name="a958e9c99e8759bf8388df5689fd45baa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a958e9c99e8759bf8388df5689fd45baa">&#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#ade01aa38cf726210f9d2a8f8567d6633">gridfire::solver::DynamicNetworkSolverStrategy</a>&gt; GridFireContext::solver</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="af6c7cfb326dd3540ce615ecb67935959" name="af6c7cfb326dd3540ce615ecb67935959"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af6c7cfb326dd3540ce615ecb67935959">&#9670;&#160;</a></span>speciesList</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::vector&lt;fourdst::atomic::Species&gt; GridFireContext::speciesList</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a8b8c3451f5fee848e4d552ba05be12a0" name="a8b8c3451f5fee848e4d552ba05be12a0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8b8c3451f5fee848e4d552ba05be12a0">&#9670;&#160;</a></span>working_comp</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">fourdst::composition::Composition GridFireContext::working_comp</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_grid_fire_context.html">GridFireContext</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>