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

496 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.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>GridFire: gridfire_mod Module 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>
<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>
<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.1_rc2</span>
</div>
<div id="projectbrief">General Purpose Nuclear Network</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- 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" 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');
$(document).ready(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 */
$(document).ready(function(){initNavTree('namespacegridfire__mod.html',''); initResizable(); });
/* @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="#nested-classes">Data Types</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions/Subroutines</a> </div>
<div class="headertitle"><div class="title">gridfire_mod Module Reference</div></div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Data Types</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">interface &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfacegridfire__mod_1_1gf__construct__engine__from__policy.html">gf_construct_engine_from_policy</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">interface &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfacegridfire__mod_1_1gf__construct__solver__from__engine.html">gf_construct_solver_from_engine</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">interface &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfacegridfire__mod_1_1gf__evolve.html">gf_evolve</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">interface &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfacegridfire__mod_1_1gf__free.html">gf_free</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">interface &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfacegridfire__mod_1_1gf__get__last__error__message.html">gf_get_last_error_message</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">interface &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfacegridfire__mod_1_1gf__init.html">gf_init</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">interface &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfacegridfire__mod_1_1gf__register__species.html">gf_register_species</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">type &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgridfire__mod_1_1gridfire.html">gridfire</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a244769a94919381fd624416c41519147" id="r_a244769a94919381fd624416c41519147"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom">{ <br />
&#160;&#160;<a class="el" href="namespacegridfire__mod.html#a244769a94919381fd624416c41519147af119a4af62898ce36809c39a9f3e2616">fdsse_non_4dstar_error</a> = -102
, <a class="el" href="namespacegridfire__mod.html#a244769a94919381fd624416c41519147a2bd70933e1183dbae21d1754a301697b">fdsse_unknown_error</a> = -101
, <a class="el" href="namespacegridfire__mod.html#a244769a94919381fd624416c41519147a76184b02b2a2947ae8628e091824b0b0">fdsse_success</a> = 1
, <a class="el" href="namespacegridfire__mod.html#a244769a94919381fd624416c41519147a5488d8506bf12a5bc573052dae0993da">fdsse_unknown_symbol_error</a> = 100
, <br />
&#160;&#160;<a class="el" href="namespacegridfire__mod.html#a244769a94919381fd624416c41519147a9d6657b793d36330f0c9301452de425e">fdsse_species_error</a> = 101
, <a class="el" href="namespacegridfire__mod.html#a244769a94919381fd624416c41519147ade71d6ffeb5785f4a94dfb4957972c6b">fdsse_invalid_composition_error</a> = 102
, <a class="el" href="namespacegridfire__mod.html#a244769a94919381fd624416c41519147a6af8e4f88ac4de0a6713500ed47924a3">fdsse_composition_error</a> = 103
, <a class="el" href="namespacegridfire__mod.html#a244769a94919381fd624416c41519147a6fb105c630638f3cf26c1d9b869c6b9b">gf_non_gridfire_error</a> = -2
, <br />
&#160;&#160;<a class="el" href="namespacegridfire__mod.html#a244769a94919381fd624416c41519147ab4343c4611fdcdfbff141a6967f99731">gf_unknown_error</a> = -1
, <a class="el" href="namespacegridfire__mod.html#a244769a94919381fd624416c41519147afcd18f5d78d9f7b0b6418eec99888bdc">gf_success</a> = 0
, <a class="el" href="namespacegridfire__mod.html#a244769a94919381fd624416c41519147adb3204164d360916830dcf46d7c7639f">gf_invalid_qse_solution_error</a> = 5
, <a class="el" href="namespacegridfire__mod.html#a244769a94919381fd624416c41519147acf5bc28581819a8b7fe22be97176a7db">gf_failed_to_partition_error</a> = 6
, <br />
&#160;&#160;<a class="el" href="namespacegridfire__mod.html#a244769a94919381fd624416c41519147a31df7fd44862d2e4470c395224c788f8">gf_network_resized_error</a> = 7
, <a class="el" href="namespacegridfire__mod.html#a244769a94919381fd624416c41519147ab2c0ad54897923d2ea73b561c238dd4b">gf_unable_to_set_network_reactions_error</a> = 8
, <a class="el" href="namespacegridfire__mod.html#a244769a94919381fd624416c41519147a0c0949689c7b4d78cbfe62ac6643d496">gf_bad_collection_error</a> = 9
, <a class="el" href="namespacegridfire__mod.html#a244769a94919381fd624416c41519147abe6ea56c41227a3b163bd65c14483604">gf_bad_rhs_enigne_error</a> = 10
, <br />
&#160;&#160;<a class="el" href="namespacegridfire__mod.html#a244769a94919381fd624416c41519147abd7d07be0ca380f6adc4b3598d0553ab">gf_stale_jacobian_error</a> = 11
, <a class="el" href="namespacegridfire__mod.html#a244769a94919381fd624416c41519147a0b824fddd8a1a84d70ee4354d003a2a1">gf_uninitialized_jacobian_error</a> = 12
, <a class="el" href="namespacegridfire__mod.html#a244769a94919381fd624416c41519147a11dcf7bd1e827e2084683d84dd7be472">gf_unknonwn_jacobian_error</a> = 13
, <a class="el" href="namespacegridfire__mod.html#a244769a94919381fd624416c41519147a7ea5db4261227ae7a38f37cc523263e4">gf_jacobian_error</a> = 14
, <br />
&#160;&#160;<a class="el" href="namespacegridfire__mod.html#a244769a94919381fd624416c41519147af42c69c27486dc40c6981e1692157aa1">gf_engine_error</a> = 15
, <a class="el" href="namespacegridfire__mod.html#a244769a94919381fd624416c41519147a356f5d6f229750bfade0fb3e7428bafe">gf_missing_base_reaction_error</a> = 16
, <a class="el" href="namespacegridfire__mod.html#a244769a94919381fd624416c41519147a234d2433915d095cb023087d7505d8b7">gf_missing_seed_species_error</a> = 17
, <a class="el" href="namespacegridfire__mod.html#a244769a94919381fd624416c41519147af6b177def1d11c5f53a258d9f64a441e">gf_missing_key_reaction_error</a> = 18
, <br />
&#160;&#160;<a class="el" href="namespacegridfire__mod.html#a244769a94919381fd624416c41519147a815bd46a92d34d6477f1fee5438feaaa">gf_policy_error</a> = 19
, <a class="el" href="namespacegridfire__mod.html#a244769a94919381fd624416c41519147a01eddf0f5d3c19271ad9b23b066c1e7a">gf_reaction_parsing_error</a> = 20
, <a class="el" href="namespacegridfire__mod.html#a244769a94919381fd624416c41519147ab6dd69f49d4a5293a27ce54886d51162">gf_reactoion_error</a> = 21
, <a class="el" href="namespacegridfire__mod.html#a244769a94919381fd624416c41519147a039f9342bd11e28e0afab4e572ce1cb8">gf_singular_jacobian_error</a> = 22
, <br />
&#160;&#160;<a class="el" href="namespacegridfire__mod.html#a244769a94919381fd624416c41519147a20b3e042050a94181300e1c25a562390">gf_ill_conditioned_jacobian_error</a> = 23
, <a class="el" href="namespacegridfire__mod.html#a244769a94919381fd624416c41519147a9ec6f5abf7d3bd58d9f67ee2de11f611">gf_cvode_solver_failure_error</a> = 24
, <a class="el" href="namespacegridfire__mod.html#a244769a94919381fd624416c41519147af0951e8fed46bd965b51e05e210b0972">gf_kinsol_solver_failure_error</a> = 25
, <a class="el" href="namespacegridfire__mod.html#a244769a94919381fd624416c41519147a725f00c38fc963c156fa376da295616a">gf_sundials_error</a> = 26
, <br />
&#160;&#160;<a class="el" href="namespacegridfire__mod.html#a244769a94919381fd624416c41519147a0faadea5fc310fab10b0b39aaa14be56">gf_solver_error</a> = 27
, <a class="el" href="namespacegridfire__mod.html#a244769a94919381fd624416c41519147a5478182be8d9b2102536cab3557e8b19">gf_hashing_error</a> = 28
, <a class="el" href="namespacegridfire__mod.html#a244769a94919381fd624416c41519147a5594f6ed43fe0a6153437e9ee8cd936f">gf_utility_error</a> = 29
, <a class="el" href="namespacegridfire__mod.html#a244769a94919381fd624416c41519147a6c28e3b538fc7c36730f1dd68c742163">gf_debug_errror</a> = 30
, <br />
&#160;&#160;<a class="el" href="namespacegridfire__mod.html#a244769a94919381fd624416c41519147ad37197a22840f8c0fe846a5c7f1d8b4e">gf_gridfire_error</a> = 31
<br />
}</td></tr>
<tr class="separator:a244769a94919381fd624416c41519147"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions/Subroutines</h2></td></tr>
<tr class="memitem:aa7a417138a7967e7eacd2d79339850eb" id="r_aa7a417138a7967e7eacd2d79339850eb"><td class="memItemLeft" align="right" valign="top">subroutine&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire__mod.html#aa7a417138a7967e7eacd2d79339850eb">gff_init</a> (self)</td></tr>
<tr class="separator:aa7a417138a7967e7eacd2d79339850eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a64b4012b59c5ddf025073c6a8bf467c3" id="r_a64b4012b59c5ddf025073c6a8bf467c3"><td class="memItemLeft" align="right" valign="top">subroutine&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire__mod.html#a64b4012b59c5ddf025073c6a8bf467c3">gff_free</a> (self)</td></tr>
<tr class="separator:a64b4012b59c5ddf025073c6a8bf467c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afdb6d3ff7765f7bec167afab2797ebac" id="r_afdb6d3ff7765f7bec167afab2797ebac"><td class="memItemLeft" align="right" valign="top">character(len=:) function, allocatable&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire__mod.html#afdb6d3ff7765f7bec167afab2797ebac">get_last_error</a> (self)</td></tr>
<tr class="separator:afdb6d3ff7765f7bec167afab2797ebac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac1514859bc529604aebece037f93cd3f" id="r_ac1514859bc529604aebece037f93cd3f"><td class="memItemLeft" align="right" valign="top">subroutine&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire__mod.html#ac1514859bc529604aebece037f93cd3f">register_species</a> (self, species_list)</td></tr>
<tr class="separator:ac1514859bc529604aebece037f93cd3f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a76639df018b589884f5ea173a8ba6561" id="r_a76639df018b589884f5ea173a8ba6561"><td class="memItemLeft" align="right" valign="top">subroutine&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire__mod.html#a76639df018b589884f5ea173a8ba6561">setup_policy</a> (self, policy_name, abundances)</td></tr>
<tr class="separator:a76639df018b589884f5ea173a8ba6561"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6ef21ebd4c28993a28ef2745cbeae022" id="r_a6ef21ebd4c28993a28ef2745cbeae022"><td class="memItemLeft" align="right" valign="top">subroutine&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire__mod.html#a6ef21ebd4c28993a28ef2745cbeae022">setup_solver</a> (self, solver_name)</td></tr>
<tr class="separator:a6ef21ebd4c28993a28ef2745cbeae022"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa4e2323274c9a492027a34979ffed973" id="r_aa4e2323274c9a492027a34979ffed973"><td class="memItemLeft" align="right" valign="top">subroutine&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire__mod.html#aa4e2323274c9a492027a34979ffed973">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:aa4e2323274c9a492027a34979ffed973"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="a244769a94919381fd624416c41519147" name="a244769a94919381fd624416c41519147"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a244769a94919381fd624416c41519147">&#9670;&#160;</a></span>anonymous enum</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">anonymous enum</td>
</tr>
</table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a244769a94919381fd624416c41519147af119a4af62898ce36809c39a9f3e2616" name="a244769a94919381fd624416c41519147af119a4af62898ce36809c39a9f3e2616"></a>fdsse_non_4dstar_error&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a244769a94919381fd624416c41519147a2bd70933e1183dbae21d1754a301697b" name="a244769a94919381fd624416c41519147a2bd70933e1183dbae21d1754a301697b"></a>fdsse_unknown_error&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a244769a94919381fd624416c41519147a76184b02b2a2947ae8628e091824b0b0" name="a244769a94919381fd624416c41519147a76184b02b2a2947ae8628e091824b0b0"></a>fdsse_success&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a244769a94919381fd624416c41519147a5488d8506bf12a5bc573052dae0993da" name="a244769a94919381fd624416c41519147a5488d8506bf12a5bc573052dae0993da"></a>fdsse_unknown_symbol_error&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a244769a94919381fd624416c41519147a9d6657b793d36330f0c9301452de425e" name="a244769a94919381fd624416c41519147a9d6657b793d36330f0c9301452de425e"></a>fdsse_species_error&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a244769a94919381fd624416c41519147ade71d6ffeb5785f4a94dfb4957972c6b" name="a244769a94919381fd624416c41519147ade71d6ffeb5785f4a94dfb4957972c6b"></a>fdsse_invalid_composition_error&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a244769a94919381fd624416c41519147a6af8e4f88ac4de0a6713500ed47924a3" name="a244769a94919381fd624416c41519147a6af8e4f88ac4de0a6713500ed47924a3"></a>fdsse_composition_error&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a244769a94919381fd624416c41519147a6fb105c630638f3cf26c1d9b869c6b9b" name="a244769a94919381fd624416c41519147a6fb105c630638f3cf26c1d9b869c6b9b"></a>gf_non_gridfire_error&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a244769a94919381fd624416c41519147ab4343c4611fdcdfbff141a6967f99731" name="a244769a94919381fd624416c41519147ab4343c4611fdcdfbff141a6967f99731"></a>gf_unknown_error&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a244769a94919381fd624416c41519147afcd18f5d78d9f7b0b6418eec99888bdc" name="a244769a94919381fd624416c41519147afcd18f5d78d9f7b0b6418eec99888bdc"></a>gf_success&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a244769a94919381fd624416c41519147adb3204164d360916830dcf46d7c7639f" name="a244769a94919381fd624416c41519147adb3204164d360916830dcf46d7c7639f"></a>gf_invalid_qse_solution_error&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a244769a94919381fd624416c41519147acf5bc28581819a8b7fe22be97176a7db" name="a244769a94919381fd624416c41519147acf5bc28581819a8b7fe22be97176a7db"></a>gf_failed_to_partition_error&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a244769a94919381fd624416c41519147a31df7fd44862d2e4470c395224c788f8" name="a244769a94919381fd624416c41519147a31df7fd44862d2e4470c395224c788f8"></a>gf_network_resized_error&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a244769a94919381fd624416c41519147ab2c0ad54897923d2ea73b561c238dd4b" name="a244769a94919381fd624416c41519147ab2c0ad54897923d2ea73b561c238dd4b"></a>gf_unable_to_set_network_reactions_error&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a244769a94919381fd624416c41519147a0c0949689c7b4d78cbfe62ac6643d496" name="a244769a94919381fd624416c41519147a0c0949689c7b4d78cbfe62ac6643d496"></a>gf_bad_collection_error&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a244769a94919381fd624416c41519147abe6ea56c41227a3b163bd65c14483604" name="a244769a94919381fd624416c41519147abe6ea56c41227a3b163bd65c14483604"></a>gf_bad_rhs_enigne_error&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a244769a94919381fd624416c41519147abd7d07be0ca380f6adc4b3598d0553ab" name="a244769a94919381fd624416c41519147abd7d07be0ca380f6adc4b3598d0553ab"></a>gf_stale_jacobian_error&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a244769a94919381fd624416c41519147a0b824fddd8a1a84d70ee4354d003a2a1" name="a244769a94919381fd624416c41519147a0b824fddd8a1a84d70ee4354d003a2a1"></a>gf_uninitialized_jacobian_error&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a244769a94919381fd624416c41519147a11dcf7bd1e827e2084683d84dd7be472" name="a244769a94919381fd624416c41519147a11dcf7bd1e827e2084683d84dd7be472"></a>gf_unknonwn_jacobian_error&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a244769a94919381fd624416c41519147a7ea5db4261227ae7a38f37cc523263e4" name="a244769a94919381fd624416c41519147a7ea5db4261227ae7a38f37cc523263e4"></a>gf_jacobian_error&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a244769a94919381fd624416c41519147af42c69c27486dc40c6981e1692157aa1" name="a244769a94919381fd624416c41519147af42c69c27486dc40c6981e1692157aa1"></a>gf_engine_error&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a244769a94919381fd624416c41519147a356f5d6f229750bfade0fb3e7428bafe" name="a244769a94919381fd624416c41519147a356f5d6f229750bfade0fb3e7428bafe"></a>gf_missing_base_reaction_error&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a244769a94919381fd624416c41519147a234d2433915d095cb023087d7505d8b7" name="a244769a94919381fd624416c41519147a234d2433915d095cb023087d7505d8b7"></a>gf_missing_seed_species_error&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a244769a94919381fd624416c41519147af6b177def1d11c5f53a258d9f64a441e" name="a244769a94919381fd624416c41519147af6b177def1d11c5f53a258d9f64a441e"></a>gf_missing_key_reaction_error&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a244769a94919381fd624416c41519147a815bd46a92d34d6477f1fee5438feaaa" name="a244769a94919381fd624416c41519147a815bd46a92d34d6477f1fee5438feaaa"></a>gf_policy_error&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a244769a94919381fd624416c41519147a01eddf0f5d3c19271ad9b23b066c1e7a" name="a244769a94919381fd624416c41519147a01eddf0f5d3c19271ad9b23b066c1e7a"></a>gf_reaction_parsing_error&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a244769a94919381fd624416c41519147ab6dd69f49d4a5293a27ce54886d51162" name="a244769a94919381fd624416c41519147ab6dd69f49d4a5293a27ce54886d51162"></a>gf_reactoion_error&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a244769a94919381fd624416c41519147a039f9342bd11e28e0afab4e572ce1cb8" name="a244769a94919381fd624416c41519147a039f9342bd11e28e0afab4e572ce1cb8"></a>gf_singular_jacobian_error&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a244769a94919381fd624416c41519147a20b3e042050a94181300e1c25a562390" name="a244769a94919381fd624416c41519147a20b3e042050a94181300e1c25a562390"></a>gf_ill_conditioned_jacobian_error&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a244769a94919381fd624416c41519147a9ec6f5abf7d3bd58d9f67ee2de11f611" name="a244769a94919381fd624416c41519147a9ec6f5abf7d3bd58d9f67ee2de11f611"></a>gf_cvode_solver_failure_error&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a244769a94919381fd624416c41519147af0951e8fed46bd965b51e05e210b0972" name="a244769a94919381fd624416c41519147af0951e8fed46bd965b51e05e210b0972"></a>gf_kinsol_solver_failure_error&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a244769a94919381fd624416c41519147a725f00c38fc963c156fa376da295616a" name="a244769a94919381fd624416c41519147a725f00c38fc963c156fa376da295616a"></a>gf_sundials_error&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a244769a94919381fd624416c41519147a0faadea5fc310fab10b0b39aaa14be56" name="a244769a94919381fd624416c41519147a0faadea5fc310fab10b0b39aaa14be56"></a>gf_solver_error&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a244769a94919381fd624416c41519147a5478182be8d9b2102536cab3557e8b19" name="a244769a94919381fd624416c41519147a5478182be8d9b2102536cab3557e8b19"></a>gf_hashing_error&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a244769a94919381fd624416c41519147a5594f6ed43fe0a6153437e9ee8cd936f" name="a244769a94919381fd624416c41519147a5594f6ed43fe0a6153437e9ee8cd936f"></a>gf_utility_error&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a244769a94919381fd624416c41519147a6c28e3b538fc7c36730f1dd68c742163" name="a244769a94919381fd624416c41519147a6c28e3b538fc7c36730f1dd68c742163"></a>gf_debug_errror&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a244769a94919381fd624416c41519147ad37197a22840f8c0fe846a5c7f1d8b4e" name="a244769a94919381fd624416c41519147ad37197a22840f8c0fe846a5c7f1d8b4e"></a>gf_gridfire_error&#160;</td><td class="fielddoc"></td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function/Subroutine Documentation</h2>
<a id="aa4e2323274c9a492027a34979ffed973" name="aa4e2323274c9a492027a34979ffed973"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa4e2323274c9a492027a34979ffed973">&#9670;&#160;</a></span>evolve()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">subroutine gridfire_mod::evolve </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>
</tr>
<tr>
<td class="paramkey"></td>
<td></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&#160;</td>
<td class="paramname"><em>t</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></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&#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)&#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)&#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)&#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)&#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)&#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)&#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)&#160;</td>
<td class="paramname"><em>mass_lost</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></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">
</div>
</div>
<a id="afdb6d3ff7765f7bec167afab2797ebac" name="afdb6d3ff7765f7bec167afab2797ebac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afdb6d3ff7765f7bec167afab2797ebac">&#9670;&#160;</a></span>get_last_error()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">character(len=:) function, allocatable gridfire_mod::get_last_error </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>
</div><div class="memdoc">
</div>
</div>
<a id="a64b4012b59c5ddf025073c6a8bf467c3" name="a64b4012b59c5ddf025073c6a8bf467c3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a64b4012b59c5ddf025073c6a8bf467c3">&#9670;&#160;</a></span>gff_free()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">subroutine gridfire_mod::gff_free </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>
</div><div class="memdoc">
</div>
</div>
<a id="aa7a417138a7967e7eacd2d79339850eb" name="aa7a417138a7967e7eacd2d79339850eb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa7a417138a7967e7eacd2d79339850eb">&#9670;&#160;</a></span>gff_init()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">subroutine gridfire_mod::gff_init </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>
</div><div class="memdoc">
</div>
</div>
<a id="ac1514859bc529604aebece037f93cd3f" name="ac1514859bc529604aebece037f93cd3f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac1514859bc529604aebece037f93cd3f">&#9670;&#160;</a></span>register_species()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">subroutine gridfire_mod::register_species </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>
</tr>
<tr>
<td class="paramkey"></td>
<td></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">
</div>
</div>
<a id="a76639df018b589884f5ea173a8ba6561" name="a76639df018b589884f5ea173a8ba6561"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a76639df018b589884f5ea173a8ba6561">&#9670;&#160;</a></span>setup_policy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">subroutine gridfire_mod::setup_policy </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>
</tr>
<tr>
<td class="paramkey"></td>
<td></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)&#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">
</div>
</div>
<a id="a6ef21ebd4c28993a28ef2745cbeae022" name="a6ef21ebd4c28993a28ef2745cbeae022"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6ef21ebd4c28993a28ef2745cbeae022">&#9670;&#160;</a></span>setup_solver()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">subroutine gridfire_mod::setup_solver </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>
</tr>
<tr>
<td class="paramkey"></td>
<td></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">
</div>
</div>
</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="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>
</html>
Reference in New Issue View Git Blame Copy Permalink