tboudreaux/GridFire
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
08a031f30c33673fc52fb4da37c04f2b36973a39
GridFire/docs/html/structgridfire__mod_1_1gridfire.html
Emily Boudreaux 07b2cfd055 docs(docs): rebuilt
2025-11-27 15:06:27 -05:00

373 lines
19 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.13.2"/>
<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="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('structgridfire__mod_1_1gridfire.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="structgridfire__mod_1_1gridfire-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">gridfire_mod::gridfire Type Reference</div></div>
</div><!--header-->
<div class="contents">
<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="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="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="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="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="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="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="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="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="separator:ad4e967702e2d02d33589d23ecf0234d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Function/Subroutine Documentation</h2>
<a id="a6d864e135a5c93f3c57eafbc3622a6aa" name="a6d864e135a5c93f3c57eafbc3622a6aa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6d864e135a5c93f3c57eafbc3622a6aa">&#9670;&#160;</a></span>evolve()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<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>
</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>
</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>
</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>
</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>
</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>
</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>
</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>
</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>
</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>
</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>
</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>
</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>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="aa88436f1a449988744973e43fe70e76b" name="aa88436f1a449988744973e43fe70e76b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa88436f1a449988744973e43fe70e76b">&#9670;&#160;</a></span>get_last_error()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<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></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a86de88c6b7d6c181361e1bce220c7f46" name="a86de88c6b7d6c181361e1bce220c7f46"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a86de88c6b7d6c181361e1bce220c7f46">&#9670;&#160;</a></span>gff_free()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<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></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a72415e2f4ff6b74cbc38316a4df8792f" name="a72415e2f4ff6b74cbc38316a4df8792f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a72415e2f4ff6b74cbc38316a4df8792f">&#9670;&#160;</a></span>gff_init()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<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></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="abfe3f8c818080814a6d45a0cab83107c" name="abfe3f8c818080814a6d45a0cab83107c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abfe3f8c818080814a6d45a0cab83107c">&#9670;&#160;</a></span>register_species()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<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>
</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>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a2537a8b237e390fefea02ae2da46f851" name="a2537a8b237e390fefea02ae2da46f851"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2537a8b237e390fefea02ae2da46f851">&#9670;&#160;</a></span>setup_policy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<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>
</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>
</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>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a973855fa1cc81b0afd5a599cec1d6fcf" name="a973855fa1cc81b0afd5a599cec1d6fcf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a973855fa1cc81b0afd5a599cec1d6fcf">&#9670;&#160;</a></span>setup_solver()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<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>
</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>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a8e15e0b0839783747bc7b046c56b3610" name="a8e15e0b0839783747bc7b046c56b3610"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8e15e0b0839783747bc7b046c56b3610">&#9670;&#160;</a></span>ctx</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">type(c_ptr) gridfire_mod::gridfire::ctx = c_null_ptr</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ad4e967702e2d02d33589d23ecf0234d4" name="ad4e967702e2d02d33589d23ecf0234d4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad4e967702e2d02d33589d23ecf0234d4">&#9670;&#160;</a></span>num_species</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">integer(c_size_t) gridfire_mod::gridfire::num_species = 0</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<hr/>The documentation for this type was generated from the following file:<ul>
<li>src/extern/fortran/<a class="el" href="gridfire__mod_8f90.html">gridfire_mod.f90</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__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>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink