tboudreaux/GridFire
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
7d611c56ade75ff62e826b0a85f6da9dc3d3ea0d
GridFire/docs/html/structgridfire__mod_1_1gridfire.html

668 lines
34 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.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('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:a883ee20a7735a1a11e12cda9a4f231a1" id="r_a883ee20a7735a1a11e12cda9a4f231a1"><td class="memItemLeft" align="right" valign="top">procedure&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a883ee20a7735a1a11e12cda9a4f231a1">gff_init</a> (self, type, zones)</td></tr>
<tr class="separator:a883ee20a7735a1a11e12cda9a4f231a1"><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:ab55f52e0ebb8785df56541afa631a354" id="r_ab55f52e0ebb8785df56541afa631a354"><td class="memItemLeft" align="right" valign="top">procedure&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab55f52e0ebb8785df56541afa631a354">gff_register_species</a> (self, species_list)</td></tr>
<tr class="separator:ab55f52e0ebb8785df56541afa631a354"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a008f81b5c059e82bd7a46f7d53e9e20f" id="r_a008f81b5c059e82bd7a46f7d53e9e20f"><td class="memItemLeft" align="right" valign="top">procedure&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a008f81b5c059e82bd7a46f7d53e9e20f">gff_setup_policy</a> (self, policy_name, abundances)</td></tr>
<tr class="separator:a008f81b5c059e82bd7a46f7d53e9e20f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7aab879c62f4cb920042ecdd6bc087e5" id="r_a7aab879c62f4cb920042ecdd6bc087e5"><td class="memItemLeft" align="right" valign="top">procedure&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a7aab879c62f4cb920042ecdd6bc087e5">gff_setup_solver</a> (self, solver_name)</td></tr>
<tr class="separator:a7aab879c62f4cb920042ecdd6bc087e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8bccaeec1800bf22aa5feb992ebb0991" id="r_a8bccaeec1800bf22aa5feb992ebb0991"><td class="memItemLeft" align="right" valign="top">procedure&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8bccaeec1800bf22aa5feb992ebb0991">gff_get_last_error</a> (self)</td></tr>
<tr class="separator:a8bccaeec1800bf22aa5feb992ebb0991"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a810642b2160b9fcec6aeb9da0b40b3a0" id="r_a810642b2160b9fcec6aeb9da0b40b3a0"><td class="memItemLeft" align="right" valign="top">procedure&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a810642b2160b9fcec6aeb9da0b40b3a0">gff_evolve_single</a> (self, y_in, t, rho, tmax, dt0, y_out, energy, dedt, dedrho, nu_e_loss, nu_flux, mass_lost, ierr)</td></tr>
<tr class="separator:a810642b2160b9fcec6aeb9da0b40b3a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad071c30fb2751b8c641dbf4ae29acfe9" id="r_ad071c30fb2751b8c641dbf4ae29acfe9"><td class="memItemLeft" align="right" valign="top">procedure&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad071c30fb2751b8c641dbf4ae29acfe9">gff_evolve_multi</a> (self, y_in, t, rho, tmax, dt0, y_out, energy, dedt, dedrho, nu_e_loss, nu_flux, mass_lost, ierr)</td></tr>
<tr class="separator:ad071c30fb2751b8c641dbf4ae29acfe9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3404cadb40ea5287e9cc3472129cd456" id="r_a3404cadb40ea5287e9cc3472129cd456"><td class="memItemLeft" align="right" valign="top">generic&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a3404cadb40ea5287e9cc3472129cd456">gff_evolve</a> (self, y_in, t, rho, tmax, dt0, y_out, energy, dedt, dedrho, nu_e_loss, nu_flux, mass_lost, ierr)</td></tr>
<tr class="separator:a3404cadb40ea5287e9cc3472129cd456"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3404cadb40ea5287e9cc3472129cd456" id="r_a3404cadb40ea5287e9cc3472129cd456"><td class="memItemLeft" align="right" valign="top">generic&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a3404cadb40ea5287e9cc3472129cd456">gff_evolve</a> (self, y_in, t, rho, tmax, dt0, y_out, energy, dedt, dedrho, nu_e_loss, nu_flux, mass_lost, ierr)</td></tr>
<tr class="separator:a3404cadb40ea5287e9cc3472129cd456"><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:aaebba95942c6db1d51b201d2fde78615" id="r_aaebba95942c6db1d51b201d2fde78615"><td class="memItemLeft" align="right" valign="top">integer(c_int)&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aaebba95942c6db1d51b201d2fde78615">ctx_type</a> = <a class="el" href="gridfire__extern_8h.html#aef130f2ece7c95a5d172559febbbd42da458c9dcd06d6bf0c8d6e3764725cad5e">SINGLE_ZONE</a>%value</td></tr>
<tr class="separator:aaebba95942c6db1d51b201d2fde78615"><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>
<tr class="memitem:a12753bdefdcd195baf0b72858e9f9ed4" id="r_a12753bdefdcd195baf0b72858e9f9ed4"><td class="memItemLeft" align="right" valign="top">integer(c_size_t)&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a12753bdefdcd195baf0b72858e9f9ed4">num_zones</a> = 1</td></tr>
<tr class="separator:a12753bdefdcd195baf0b72858e9f9ed4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Function/Subroutine Documentation</h2>
<a id="a3404cadb40ea5287e9cc3472129cd456" name="a3404cadb40ea5287e9cc3472129cd456"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3404cadb40ea5287e9cc3472129cd456">&#9670;&#160;</a></span>gff_evolve() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">generic gridfire_mod::gridfire::gff_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), intent(in)</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), intent(in)</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>tmax</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>dt0</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="a3404cadb40ea5287e9cc3472129cd456" name="a3404cadb40ea5287e9cc3472129cd456"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3404cadb40ea5287e9cc3472129cd456">&#9670;&#160;</a></span>gff_evolve() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">generic gridfire_mod::gridfire::gff_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), dimension(:), intent(in)</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), dimension(:), intent(in)</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>tmax</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>dt0</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), dimension(:), 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), dimension(:), 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), dimension(:), 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), dimension(:), 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), dimension(:), 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), dimension(:), 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="ad071c30fb2751b8c641dbf4ae29acfe9" name="ad071c30fb2751b8c641dbf4ae29acfe9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad071c30fb2751b8c641dbf4ae29acfe9">&#9670;&#160;</a></span>gff_evolve_multi()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">procedure gridfire_mod::gridfire::gff_evolve_multi </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), dimension(:), intent(in)</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), dimension(:), intent(in)</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>tmax</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>dt0</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), dimension(:), 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), dimension(:), 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), dimension(:), 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), dimension(:), 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), dimension(:), 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), dimension(:), 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="a810642b2160b9fcec6aeb9da0b40b3a0" name="a810642b2160b9fcec6aeb9da0b40b3a0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a810642b2160b9fcec6aeb9da0b40b3a0">&#9670;&#160;</a></span>gff_evolve_single()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">procedure gridfire_mod::gridfire::gff_evolve_single </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), intent(in)</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), intent(in)</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>tmax</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>dt0</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="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="a8bccaeec1800bf22aa5feb992ebb0991" name="a8bccaeec1800bf22aa5feb992ebb0991"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8bccaeec1800bf22aa5feb992ebb0991">&#9670;&#160;</a></span>gff_get_last_error()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">procedure gridfire_mod::gridfire::gff_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="a883ee20a7735a1a11e12cda9a4f231a1" name="a883ee20a7735a1a11e12cda9a4f231a1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a883ee20a7735a1a11e12cda9a4f231a1">&#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>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">type(<a class="el" href="structgridfire__mod_1_1gf__type.html">gf_type</a>), intent(in)</td> <td class="paramname"><span class="paramname"><em>type</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">integer(c_size_t), intent(in), optional</td> <td class="paramname"><span class="paramname"><em>zones</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ab55f52e0ebb8785df56541afa631a354" name="ab55f52e0ebb8785df56541afa631a354"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab55f52e0ebb8785df56541afa631a354">&#9670;&#160;</a></span>gff_register_species()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">procedure gridfire_mod::gridfire::gff_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="a008f81b5c059e82bd7a46f7d53e9e20f" name="a008f81b5c059e82bd7a46f7d53e9e20f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a008f81b5c059e82bd7a46f7d53e9e20f">&#9670;&#160;</a></span>gff_setup_policy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">procedure gridfire_mod::gridfire::gff_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="a7aab879c62f4cb920042ecdd6bc087e5" name="a7aab879c62f4cb920042ecdd6bc087e5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7aab879c62f4cb920042ecdd6bc087e5">&#9670;&#160;</a></span>gff_setup_solver()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">procedure gridfire_mod::gridfire::gff_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="aaebba95942c6db1d51b201d2fde78615" name="aaebba95942c6db1d51b201d2fde78615"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaebba95942c6db1d51b201d2fde78615">&#9670;&#160;</a></span>ctx_type</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">integer(c_int) gridfire_mod::gridfire::ctx_type = <a class="el" href="gridfire__extern_8h.html#aef130f2ece7c95a5d172559febbbd42da458c9dcd06d6bf0c8d6e3764725cad5e">SINGLE_ZONE</a>%value</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>
<a id="a12753bdefdcd195baf0b72858e9f9ed4" name="a12753bdefdcd195baf0b72858e9f9ed4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a12753bdefdcd195baf0b72858e9f9ed4">&#9670;&#160;</a></span>num_zones</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">integer(c_size_t) gridfire_mod::gridfire::num_zones = 1</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