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

docs(docs): rebuilt for version v0.7.1_rc2

Browse Source
This commit is contained in:
Emily M. Boudreaux
2025-11-28 09:46:00 -05:00
parent 033c5a083d
commit a472dc5214
2480 changed files with 231104 additions and 76191 deletions
Download Patch File Download Diff File Expand all files Collapse all files

135
docs/html/structgridfire__mod_1_1gridfire.html
View File

@@ -3,18 +3,16 @@
<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="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>GridFire: gridfire_mod::gridfire Type 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="resize.js"></script>
<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>
@@ -29,7 +27,7 @@
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">GridFire<span id="projectnumber">&#160;v0.7.0_rc2</span>
<div id="projectname">GridFire<span id="projectnumber">&#160;v0.7.1_rc2</span>
</div>
<div id="projectbrief">General Purpose Nuclear Network</div>
</td>
@@ -38,24 +36,19 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.13.2 -->
<!-- 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">
/* @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(); });
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
@@ -73,7 +66,7 @@ $(function() {
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('structgridfire__mod_1_1gridfire.html',''); initResizable(true); });
$(document).ready(function(){initNavTree('structgridfire__mod_1_1gridfire.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
@@ -106,29 +99,34 @@ $(function(){initNavTree('structgridfire__mod_1_1gridfire.html',''); initResizab
<div class="headertitle"><div class="title">gridfire_mod::gridfire Type Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Collaboration diagram for gridfire_mod::gridfire:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="structgridfire__mod_1_1gridfire__coll__graph.svg" width="170" height="124"><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>
<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:a72415e2f4ff6b74cbc38316a4df8792f" id="r_a72415e2f4ff6b74cbc38316a4df8792f"><td class="memItemLeft" align="right" valign="top">procedure&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a72415e2f4ff6b74cbc38316a4df8792f">gff_init</a> (self)</td></tr>
<tr class="memitem:a72415e2f4ff6b74cbc38316a4df8792f" id="r_a72415e2f4ff6b74cbc38316a4df8792f"><td class="memItemLeft" align="right" valign="top">procedure&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgridfire__mod_1_1gridfire.html#a72415e2f4ff6b74cbc38316a4df8792f">gff_init</a> (self)</td></tr>
<tr class="separator:a72415e2f4ff6b74cbc38316a4df8792f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a86de88c6b7d6c181361e1bce220c7f46" id="r_a86de88c6b7d6c181361e1bce220c7f46"><td class="memItemLeft" align="right" valign="top">procedure&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a86de88c6b7d6c181361e1bce220c7f46">gff_free</a> (self)</td></tr>
<tr class="memitem:a86de88c6b7d6c181361e1bce220c7f46" id="r_a86de88c6b7d6c181361e1bce220c7f46"><td class="memItemLeft" align="right" valign="top">procedure&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgridfire__mod_1_1gridfire.html#a86de88c6b7d6c181361e1bce220c7f46">gff_free</a> (self)</td></tr>
<tr class="separator:a86de88c6b7d6c181361e1bce220c7f46"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abfe3f8c818080814a6d45a0cab83107c" id="r_abfe3f8c818080814a6d45a0cab83107c"><td class="memItemLeft" align="right" valign="top">procedure&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#abfe3f8c818080814a6d45a0cab83107c">register_species</a> (self, species_list)</td></tr>
<tr class="memitem:abfe3f8c818080814a6d45a0cab83107c" id="r_abfe3f8c818080814a6d45a0cab83107c"><td class="memItemLeft" align="right" valign="top">procedure&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgridfire__mod_1_1gridfire.html#abfe3f8c818080814a6d45a0cab83107c">register_species</a> (self, species_list)</td></tr>
<tr class="separator:abfe3f8c818080814a6d45a0cab83107c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2537a8b237e390fefea02ae2da46f851" id="r_a2537a8b237e390fefea02ae2da46f851"><td class="memItemLeft" align="right" valign="top">procedure&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a2537a8b237e390fefea02ae2da46f851">setup_policy</a> (self, policy_name, abundances)</td></tr>
<tr class="memitem:a2537a8b237e390fefea02ae2da46f851" id="r_a2537a8b237e390fefea02ae2da46f851"><td class="memItemLeft" align="right" valign="top">procedure&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgridfire__mod_1_1gridfire.html#a2537a8b237e390fefea02ae2da46f851">setup_policy</a> (self, policy_name, abundances)</td></tr>
<tr class="separator:a2537a8b237e390fefea02ae2da46f851"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a973855fa1cc81b0afd5a599cec1d6fcf" id="r_a973855fa1cc81b0afd5a599cec1d6fcf"><td class="memItemLeft" align="right" valign="top">procedure&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a973855fa1cc81b0afd5a599cec1d6fcf">setup_solver</a> (self, solver_name)</td></tr>
<tr class="memitem:a973855fa1cc81b0afd5a599cec1d6fcf" id="r_a973855fa1cc81b0afd5a599cec1d6fcf"><td class="memItemLeft" align="right" valign="top">procedure&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgridfire__mod_1_1gridfire.html#a973855fa1cc81b0afd5a599cec1d6fcf">setup_solver</a> (self, solver_name)</td></tr>
<tr class="separator:a973855fa1cc81b0afd5a599cec1d6fcf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6d864e135a5c93f3c57eafbc3622a6aa" id="r_a6d864e135a5c93f3c57eafbc3622a6aa"><td class="memItemLeft" align="right" valign="top">procedure&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a6d864e135a5c93f3c57eafbc3622a6aa">evolve</a> (self, y_in, t, rho, dt, y_out, energy, dedt, dedrho, nu_e_loss, nu_flux, mass_lost, ierr)</td></tr>
<tr class="memitem:a6d864e135a5c93f3c57eafbc3622a6aa" id="r_a6d864e135a5c93f3c57eafbc3622a6aa"><td class="memItemLeft" align="right" valign="top">procedure&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgridfire__mod_1_1gridfire.html#a6d864e135a5c93f3c57eafbc3622a6aa">evolve</a> (self, y_in, t, rho, dt, y_out, energy, dedt, dedrho, nu_e_loss, nu_flux, mass_lost, ierr)</td></tr>
<tr class="separator:a6d864e135a5c93f3c57eafbc3622a6aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa88436f1a449988744973e43fe70e76b" id="r_aa88436f1a449988744973e43fe70e76b"><td class="memItemLeft" align="right" valign="top">procedure&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa88436f1a449988744973e43fe70e76b">get_last_error</a> (self)</td></tr>
<tr class="memitem:aa88436f1a449988744973e43fe70e76b" id="r_aa88436f1a449988744973e43fe70e76b"><td class="memItemLeft" align="right" valign="top">procedure&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgridfire__mod_1_1gridfire.html#aa88436f1a449988744973e43fe70e76b">get_last_error</a> (self)</td></tr>
<tr class="separator:aa88436f1a449988744973e43fe70e76b"><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:a8e15e0b0839783747bc7b046c56b3610" id="r_a8e15e0b0839783747bc7b046c56b3610"><td class="memItemLeft" align="right" valign="top">type(c_ptr)&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8e15e0b0839783747bc7b046c56b3610">ctx</a> = c_null_ptr</td></tr>
<tr class="memitem:a8e15e0b0839783747bc7b046c56b3610" id="r_a8e15e0b0839783747bc7b046c56b3610"><td class="memItemLeft" align="right" valign="top">type(c_ptr)&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgridfire__mod_1_1gridfire.html#a8e15e0b0839783747bc7b046c56b3610">ctx</a> = c_null_ptr</td></tr>
<tr class="separator:a8e15e0b0839783747bc7b046c56b3610"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad4e967702e2d02d33589d23ecf0234d4" id="r_ad4e967702e2d02d33589d23ecf0234d4"><td class="memItemLeft" align="right" valign="top">integer(c_size_t)&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad4e967702e2d02d33589d23ecf0234d4">num_species</a> = 0</td></tr>
<tr class="memitem:ad4e967702e2d02d33589d23ecf0234d4" id="r_ad4e967702e2d02d33589d23ecf0234d4"><td class="memItemLeft" align="right" valign="top">integer(c_size_t)&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgridfire__mod_1_1gridfire.html#ad4e967702e2d02d33589d23ecf0234d4">num_species</a> = 0</td></tr>
<tr class="separator:ad4e967702e2d02d33589d23ecf0234d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Function/Subroutine Documentation</h2>
@@ -141,67 +139,85 @@ Public Attributes</h2></td></tr>
<tr>
<td class="memname">procedure gridfire_mod::gridfire::evolve </td>
<td>(</td>
<td class="paramtype">class(<a class="el" href="structgridfire__mod_1_1gridfire.html">gridfire</a>), intent(in)</td> <td class="paramname"><span class="paramname"><em>self</em></span>, </td>
<td class="paramtype">class(<a class="el" href="structgridfire__mod_1_1gridfire.html">gridfire</a>), intent(in)&#160;</td>
<td class="paramname"><em>self</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">real(c_double), dimension(:), intent(in)</td> <td class="paramname"><span class="paramname"><em>y_in</em></span>, </td>
<td class="paramtype">real(c_double), dimension(:), intent(in)&#160;</td>
<td class="paramname"><em>y_in</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">real(c_double), value</td> <td class="paramname"><span class="paramname"><em>t</em></span>, </td>
<td class="paramtype">real(c_double), value&#160;</td>
<td class="paramname"><em>t</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">real(c_double), value</td> <td class="paramname"><span class="paramname"><em>rho</em></span>, </td>
<td class="paramtype">real(c_double), value&#160;</td>
<td class="paramname"><em>rho</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">real(c_double), value</td> <td class="paramname"><span class="paramname"><em>dt</em></span>, </td>
<td class="paramtype">real(c_double), value&#160;</td>
<td class="paramname"><em>dt</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">real(c_double), dimension(:), intent(out)</td> <td class="paramname"><span class="paramname"><em>y_out</em></span>, </td>
<td class="paramtype">real(c_double), dimension(:), intent(out)&#160;</td>
<td class="paramname"><em>y_out</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">real(c_double), intent(out)</td> <td class="paramname"><span class="paramname"><em>energy</em></span>, </td>
<td class="paramtype">real(c_double), intent(out)&#160;</td>
<td class="paramname"><em>energy</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">real(c_double), intent(out)</td> <td class="paramname"><span class="paramname"><em>dedt</em></span>, </td>
<td class="paramtype">real(c_double), intent(out)&#160;</td>
<td class="paramname"><em>dedt</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">real(c_double), intent(out)</td> <td class="paramname"><span class="paramname"><em>dedrho</em></span>, </td>
<td class="paramtype">real(c_double), intent(out)&#160;</td>
<td class="paramname"><em>dedrho</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">real(c_double), intent(out)</td> <td class="paramname"><span class="paramname"><em>nu_e_loss</em></span>, </td>
<td class="paramtype">real(c_double), intent(out)&#160;</td>
<td class="paramname"><em>nu_e_loss</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">real(c_double), intent(out)</td> <td class="paramname"><span class="paramname"><em>nu_flux</em></span>, </td>
<td class="paramtype">real(c_double), intent(out)&#160;</td>
<td class="paramname"><em>nu_flux</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">real(c_double), intent(out)</td> <td class="paramname"><span class="paramname"><em>mass_lost</em></span>, </td>
<td class="paramtype">real(c_double), intent(out)&#160;</td>
<td class="paramname"><em>mass_lost</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">integer, intent(out)</td> <td class="paramname"><span class="paramname"><em>ierr</em></span>&#160;)</td>
<td class="paramtype">integer, intent(out)&#160;</td>
<td class="paramname"><em>ierr</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
@@ -217,7 +233,8 @@ Public Attributes</h2></td></tr>
<tr>
<td class="memname">procedure gridfire_mod::gridfire::get_last_error </td>
<td>(</td>
<td class="paramtype">class(<a class="el" href="structgridfire__mod_1_1gridfire.html">gridfire</a>), intent(in)</td> <td class="paramname"><span class="paramname"><em>self</em></span></td><td>)</td>
<td class="paramtype">class(<a class="el" href="structgridfire__mod_1_1gridfire.html">gridfire</a>), intent(in)&#160;</td>
<td class="paramname"><em>self</em></td><td>)</td>
<td></td>
</tr>
</table>
@@ -234,7 +251,8 @@ Public Attributes</h2></td></tr>
<tr>
<td class="memname">procedure gridfire_mod::gridfire::gff_free </td>
<td>(</td>
<td class="paramtype">class(<a class="el" href="structgridfire__mod_1_1gridfire.html">gridfire</a>), intent(inout)</td> <td class="paramname"><span class="paramname"><em>self</em></span></td><td>)</td>
<td class="paramtype">class(<a class="el" href="structgridfire__mod_1_1gridfire.html">gridfire</a>), intent(inout)&#160;</td>
<td class="paramname"><em>self</em></td><td>)</td>
<td></td>
</tr>
</table>
@@ -251,7 +269,8 @@ Public Attributes</h2></td></tr>
<tr>
<td class="memname">procedure gridfire_mod::gridfire::gff_init </td>
<td>(</td>
<td class="paramtype">class(<a class="el" href="structgridfire__mod_1_1gridfire.html">gridfire</a>), intent(out)</td> <td class="paramname"><span class="paramname"><em>self</em></span></td><td>)</td>
<td class="paramtype">class(<a class="el" href="structgridfire__mod_1_1gridfire.html">gridfire</a>), intent(out)&#160;</td>
<td class="paramname"><em>self</em></td><td>)</td>
<td></td>
</tr>
</table>
@@ -268,12 +287,19 @@ Public Attributes</h2></td></tr>
<tr>
<td class="memname">procedure gridfire_mod::gridfire::register_species </td>
<td>(</td>
<td class="paramtype">class(<a class="el" href="structgridfire__mod_1_1gridfire.html">gridfire</a>), intent(inout)</td> <td class="paramname"><span class="paramname"><em>self</em></span>, </td>
<td class="paramtype">class(<a class="el" href="structgridfire__mod_1_1gridfire.html">gridfire</a>), intent(inout)&#160;</td>
<td class="paramname"><em>self</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">character(len=*), dimension(:), intent(in)</td> <td class="paramname"><span class="paramname"><em>species_list</em></span>&#160;)</td>
<td class="paramtype">character(len=*), dimension(:), intent(in)&#160;</td>
<td class="paramname"><em>species_list</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
@@ -289,17 +315,25 @@ Public Attributes</h2></td></tr>
<tr>
<td class="memname">procedure gridfire_mod::gridfire::setup_policy </td>
<td>(</td>
<td class="paramtype">class(<a class="el" href="structgridfire__mod_1_1gridfire.html">gridfire</a>), intent(in)</td> <td class="paramname"><span class="paramname"><em>self</em></span>, </td>
<td class="paramtype">class(<a class="el" href="structgridfire__mod_1_1gridfire.html">gridfire</a>), intent(in)&#160;</td>
<td class="paramname"><em>self</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">character(len=*), intent(in)</td> <td class="paramname"><span class="paramname"><em>policy_name</em></span>, </td>
<td class="paramtype">character(len=*), intent(in)&#160;</td>
<td class="paramname"><em>policy_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">real(c_double), dimension(:), intent(in)</td> <td class="paramname"><span class="paramname"><em>abundances</em></span>&#160;)</td>
<td class="paramtype">real(c_double), dimension(:), intent(in)&#160;</td>
<td class="paramname"><em>abundances</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
@@ -315,12 +349,19 @@ Public Attributes</h2></td></tr>
<tr>
<td class="memname">procedure gridfire_mod::gridfire::setup_solver </td>
<td>(</td>
<td class="paramtype">class(<a class="el" href="structgridfire__mod_1_1gridfire.html">gridfire</a>), intent(in)</td> <td class="paramname"><span class="paramname"><em>self</em></span>, </td>
<td class="paramtype">class(<a class="el" href="structgridfire__mod_1_1gridfire.html">gridfire</a>), intent(in)&#160;</td>
<td class="paramname"><em>self</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">character(len=*), intent(in)</td> <td class="paramname"><span class="paramname"><em>solver_name</em></span>&#160;)</td>
<td class="paramtype">character(len=*), intent(in)&#160;</td>
<td class="paramname"><em>solver_name</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
@@ -365,7 +406,7 @@ Public Attributes</h2></td></tr>
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespacegridfire__mod.html">gridfire_mod</a></li><li class="navelem"><a class="el" href="structgridfire__mod_1_1gridfire.html">gridfire</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>
<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>