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

414 lines
21 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: src/extern/lib/gridfire_extern.cpp File 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('gridfire__extern_8cpp.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="#concepts">Concepts</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">gridfire_extern.cpp File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;<a class="el" href="gridfire_8h.html">gridfire/gridfire.h</a>&quot;</code><br />
<code>#include &quot;fourdst/composition/exceptions/exceptions_composition.h&quot;</code><br />
<code>#include &quot;<a class="el" href="gridfire__context_8h.html">gridfire/extern/gridfire_context.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="gridfire__extern_8h.html">gridfire/extern/gridfire_extern.h</a>&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for gridfire_extern.cpp:</div>
<div class="dyncontent">
<div class="center"><div class="zoom"><iframe scrolling="no" frameborder="0" src="gridfire__extern_8cpp__incl.svg" width="100%" height="600"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div></div>
</div>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="concepts" name="concepts"></a>
Concepts</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">concept &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="concept_0d076141075253251206006125172343113355315141050267_1_1_error_trackable.html">@076141075253251206006125172343113355315141050267::ErrorTrackable</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="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a0d42f6060caa8e73b2ef36f591a12034" id="r_a0d42f6060caa8e73b2ef36f591a12034"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0d42f6060caa8e73b2ef36f591a12034">gf_init</a> (const enum <a class="el" href="gridfire__extern_8h.html#aef130f2ece7c95a5d172559febbbd42d">GF_TYPE</a> type)</td></tr>
<tr class="separator:a0d42f6060caa8e73b2ef36f591a12034"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1a963d1279164f2a870be4e9e1dba1d5" id="r_a1a963d1279164f2a870be4e9e1dba1d5"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a1a963d1279164f2a870be4e9e1dba1d5">gf_free</a> (const enum <a class="el" href="gridfire__extern_8h.html#aef130f2ece7c95a5d172559febbbd42d">GF_TYPE</a> type, void *ctx)</td></tr>
<tr class="separator:a1a963d1279164f2a870be4e9e1dba1d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a541a743ca349b42f627a357dff5a7d18" id="r_a541a743ca349b42f627a357dff5a7d18"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a541a743ca349b42f627a357dff5a7d18">gf_set_num_zones</a> (const enum <a class="el" href="gridfire__extern_8h.html#aef130f2ece7c95a5d172559febbbd42d">GF_TYPE</a> type, void *ptr, const size_t num_zones)</td></tr>
<tr class="separator:a541a743ca349b42f627a357dff5a7d18"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af7e09bf5cf979211260e715faaa3a680" id="r_af7e09bf5cf979211260e715faaa3a680"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af7e09bf5cf979211260e715faaa3a680">gf_register_species</a> (void *ptr, const int num_species, const char **species_names)</td></tr>
<tr class="separator:af7e09bf5cf979211260e715faaa3a680"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aba493cbe050ed688d5850914998d145e" id="r_aba493cbe050ed688d5850914998d145e"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aba493cbe050ed688d5850914998d145e">gf_construct_engine_from_policy</a> (void *ptr, const char *policy_name, const double *abundances, const size_t num_species)</td></tr>
<tr class="separator:aba493cbe050ed688d5850914998d145e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aed17ad088b2c25c0c2bf5549527e53fd" id="r_aed17ad088b2c25c0c2bf5549527e53fd"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aed17ad088b2c25c0c2bf5549527e53fd">gf_construct_solver_from_engine</a> (void *ptr)</td></tr>
<tr class="separator:aed17ad088b2c25c0c2bf5549527e53fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9b8f950c57fe06a352002f1b52b0f59f" id="r_a9b8f950c57fe06a352002f1b52b0f59f"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a9b8f950c57fe06a352002f1b52b0f59f">gf_evolve</a> (const enum <a class="el" href="gridfire__extern_8h.html#aef130f2ece7c95a5d172559febbbd42d">GF_TYPE</a> type, void *ptr, const void *Y_in, const size_t num_species, const void *T, const void *rho, const double tMax, const double dt0, void *Y_out, void *energy_out, void *dEps_dT, void *dEps_dRho, void *specific_neutrino_energy_loss, void *specific_neutrino_flux, void *mass_lost)</td></tr>
<tr class="separator:a9b8f950c57fe06a352002f1b52b0f59f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a851d8c23bdc73852988b870c5f409639" id="r_a851d8c23bdc73852988b870c5f409639"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a851d8c23bdc73852988b870c5f409639">gf_get_last_error_message</a> (void *ptr)</td></tr>
<tr class="separator:a851d8c23bdc73852988b870c5f409639"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a45e1894a8f62c10d8b239613705a420a" id="r_a45e1894a8f62c10d8b239613705a420a"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a45e1894a8f62c10d8b239613705a420a">gf_error_code_to_string</a> (const int error_code)</td></tr>
<tr class="separator:a45e1894a8f62c10d8b239613705a420a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="aba493cbe050ed688d5850914998d145e" name="aba493cbe050ed688d5850914998d145e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aba493cbe050ed688d5850914998d145e">&#9670;&#160;</a></span>gf_construct_engine_from_policy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int gf_construct_engine_from_policy </td>
<td>(</td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>ptr</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>policy_name</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const double *</td> <td class="paramname"><span class="paramname"><em>abundances</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const size_t</td> <td class="paramname"><span class="paramname"><em>num_species</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="aed17ad088b2c25c0c2bf5549527e53fd" name="aed17ad088b2c25c0c2bf5549527e53fd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aed17ad088b2c25c0c2bf5549527e53fd">&#9670;&#160;</a></span>gf_construct_solver_from_engine()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int gf_construct_solver_from_engine </td>
<td>(</td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>ptr</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a45e1894a8f62c10d8b239613705a420a" name="a45e1894a8f62c10d8b239613705a420a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a45e1894a8f62c10d8b239613705a420a">&#9670;&#160;</a></span>gf_error_code_to_string()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char * gf_error_code_to_string </td>
<td>(</td>
<td class="paramtype">const int</td> <td class="paramname"><span class="paramname"><em>error_code</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a9b8f950c57fe06a352002f1b52b0f59f" name="a9b8f950c57fe06a352002f1b52b0f59f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9b8f950c57fe06a352002f1b52b0f59f">&#9670;&#160;</a></span>gf_evolve()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int gf_evolve </td>
<td>(</td>
<td class="paramtype">const enum <a class="el" href="gridfire__extern_8h.html#aef130f2ece7c95a5d172559febbbd42d">GF_TYPE</a></td> <td class="paramname"><span class="paramname"><em>type</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>ptr</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void *</td> <td class="paramname"><span class="paramname"><em>Y_in</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const size_t</td> <td class="paramname"><span class="paramname"><em>num_species</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void *</td> <td class="paramname"><span class="paramname"><em>T</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void *</td> <td class="paramname"><span class="paramname"><em>rho</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const double</td> <td class="paramname"><span class="paramname"><em>tMax</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const double</td> <td class="paramname"><span class="paramname"><em>dt0</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>Y_out</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>energy_out</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>dEps_dT</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>dEps_dRho</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>specific_neutrino_energy_loss</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>specific_neutrino_flux</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>mass_lost</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a1a963d1279164f2a870be4e9e1dba1d5" name="a1a963d1279164f2a870be4e9e1dba1d5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1a963d1279164f2a870be4e9e1dba1d5">&#9670;&#160;</a></span>gf_free()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int gf_free </td>
<td>(</td>
<td class="paramtype">const enum <a class="el" href="gridfire__extern_8h.html#aef130f2ece7c95a5d172559febbbd42d">GF_TYPE</a></td> <td class="paramname"><span class="paramname"><em>type</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>ctx</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a851d8c23bdc73852988b870c5f409639" name="a851d8c23bdc73852988b870c5f409639"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a851d8c23bdc73852988b870c5f409639">&#9670;&#160;</a></span>gf_get_last_error_message()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char * gf_get_last_error_message </td>
<td>(</td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>ptr</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a0d42f6060caa8e73b2ef36f591a12034" name="a0d42f6060caa8e73b2ef36f591a12034"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0d42f6060caa8e73b2ef36f591a12034">&#9670;&#160;</a></span>gf_init()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void * gf_init </td>
<td>(</td>
<td class="paramtype">const enum <a class="el" href="gridfire__extern_8h.html#aef130f2ece7c95a5d172559febbbd42d">GF_TYPE</a></td> <td class="paramname"><span class="paramname"><em>type</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="af7e09bf5cf979211260e715faaa3a680" name="af7e09bf5cf979211260e715faaa3a680"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af7e09bf5cf979211260e715faaa3a680">&#9670;&#160;</a></span>gf_register_species()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int gf_register_species </td>
<td>(</td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>ptr</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const int</td> <td class="paramname"><span class="paramname"><em>num_species</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char **</td> <td class="paramname"><span class="paramname"><em>species_names</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a541a743ca349b42f627a357dff5a7d18" name="a541a743ca349b42f627a357dff5a7d18"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a541a743ca349b42f627a357dff5a7d18">&#9670;&#160;</a></span>gf_set_num_zones()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int gf_set_num_zones </td>
<td>(</td>
<td class="paramtype">const enum <a class="el" href="gridfire__extern_8h.html#aef130f2ece7c95a5d172559febbbd42d">GF_TYPE</a></td> <td class="paramname"><span class="paramname"><em>type</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>ptr</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const size_t</td> <td class="paramname"><span class="paramname"><em>num_zones</em></span>&#160;)</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="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_026b903d89613d2d50919c0215a7de0b.html">extern</a></li><li class="navelem"><a class="el" href="dir_f79ba22e4d7153a09a819f6726b2d7e8.html">lib</a></li><li class="navelem"><a class="el" href="gridfire__extern_8cpp.html">gridfire_extern.cpp</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