Files
GridFire/docs/html/namespacegridfire.html

539 lines
28 KiB
HTML

<!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 Namespace 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('namespacegridfire.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="#namespaces">Namespaces</a> &#124;
<a href="#nested-classes">Classes</a> &#124;
<a href="#concepts">Concepts</a> &#124;
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle"><div class="title">gridfire Namespace Reference</div></div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="namespaces" name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire_1_1config.html">config</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire_1_1engine.html">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">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire_1_1exceptions.html">exceptions</a></td></tr>
<tr class="memdesc:namespacegridfire_1_1exceptions"><td class="mdescLeft">&#160;</td><td class="mdescRight">Namespace for GridFire exception classes. All custom exceptions defined in GridFire inherit from std::exception and are organized within this namespace for clarity and modularity. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire_1_1io.html">io</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire_1_1omp.html">omp</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire_1_1partition.html">partition</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire_1_1policy.html">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">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire_1_1rates.html">rates</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire_1_1reaclib.html">reaclib</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire_1_1reaction.html">reaction</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire_1_1screening.html">screening</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire_1_1solver.html">solver</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire_1_1trigger.html">trigger</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire_1_1utils.html">utils</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="nested-classes" name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgridfire_1_1_net_in.html">NetIn</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgridfire_1_1_net_out.html">NetOut</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="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="conceptgridfire_1_1_is_arithmetic_or_a_d.html">IsArithmeticOrAD</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Concept for types allowed in engine calculations. <br /></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:a0ee5ace587287cdba8f9755a0ef0b498" id="r_a0ee5ace587287cdba8f9755a0ef0b498"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0ee5ace587287cdba8f9755a0ef0b498">gf_metadata</a> ()</td></tr>
<tr class="separator:a0ee5ace587287cdba8f9755a0ef0b498"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a45c5e5933ef14301b6f7ec2fff6a0966" id="r_a45c5e5933ef14301b6f7ec2fff6a0966"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a45c5e5933ef14301b6f7ec2fff6a0966">gf_version</a> ()</td></tr>
<tr class="separator:a45c5e5933ef14301b6f7ec2fff6a0966"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1de3db5e65a2e834c55f458307cab68e" id="r_a1de3db5e65a2e834c55f458307cab68e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a1de3db5e65a2e834c55f458307cab68e">gf_author</a> ()</td></tr>
<tr class="separator:a1de3db5e65a2e834c55f458307cab68e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a081c76fc9fbac9b5b380c8e4fa0e7be0" id="r_a081c76fc9fbac9b5b380c8e4fa0e7be0"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a081c76fc9fbac9b5b380c8e4fa0e7be0">gf_license</a> ()</td></tr>
<tr class="separator:a081c76fc9fbac9b5b380c8e4fa0e7be0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae6f8e40e5233e5c98c9c4290f518b72d" id="r_ae6f8e40e5233e5c98c9c4290f518b72d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae6f8e40e5233e5c98c9c4290f518b72d">gf_email</a> ()</td></tr>
<tr class="separator:ae6f8e40e5233e5c98c9c4290f518b72d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae5ade7b2d801af88a79382441ec68277" id="r_ae5ade7b2d801af88a79382441ec68277"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae5ade7b2d801af88a79382441ec68277">gf_url</a> ()</td></tr>
<tr class="separator:ae5ade7b2d801af88a79382441ec68277"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afa60407432a1e563b9731ce298cf42bc" id="r_afa60407432a1e563b9731ce298cf42bc"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#afa60407432a1e563b9731ce298cf42bc">gf_description</a> ()</td></tr>
<tr class="separator:afa60407432a1e563b9731ce298cf42bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a454366ce631749963d3c6b387bcbc3e7" id="r_a454366ce631749963d3c6b387bcbc3e7"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a454366ce631749963d3c6b387bcbc3e7">gf_collaboration</a> ()</td></tr>
<tr class="separator:a454366ce631749963d3c6b387bcbc3e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a787f9de5930793c2976d22426ae971b5" id="r_a787f9de5930793c2976d22426ae971b5"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a787f9de5930793c2976d22426ae971b5">gf_credits</a> ()</td></tr>
<tr class="separator:a787f9de5930793c2976d22426ae971b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:a2adfc910bd5466746bd71490d2cbdf1d" id="r_a2adfc910bd5466746bd71490d2cbdf1d"><td class="memItemLeft" align="right" valign="top">list&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a2adfc910bd5466746bd71490d2cbdf1d">__all__</a> = ['type', 'utils', 'engine', 'solver', 'exceptions', 'partition', 'reaction', 'screening', 'io', 'policy', 'config']</td></tr>
<tr class="separator:a2adfc910bd5466746bd71490d2cbdf1d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acb6c9c1b2920f0d1744a8e7198d2cf5b" id="r_acb6c9c1b2920f0d1744a8e7198d2cf5b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#acb6c9c1b2920f0d1744a8e7198d2cf5b">_meta</a> = importlib.metadata.metadata('gridfire')</td></tr>
<tr class="separator:acb6c9c1b2920f0d1744a8e7198d2cf5b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a14116c4fbbb07c2fa95826dc543771a2" id="r_a14116c4fbbb07c2fa95826dc543771a2"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a14116c4fbbb07c2fa95826dc543771a2">__version__</a> = <a class="el" href="#acb6c9c1b2920f0d1744a8e7198d2cf5b">_meta</a>['Version']</td></tr>
<tr class="separator:a14116c4fbbb07c2fa95826dc543771a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3535aedf8a24266670197a715d91229c" id="r_a3535aedf8a24266670197a715d91229c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a3535aedf8a24266670197a715d91229c">__author__</a> = <a class="el" href="#acb6c9c1b2920f0d1744a8e7198d2cf5b">_meta</a>['Author']</td></tr>
<tr class="separator:a3535aedf8a24266670197a715d91229c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a23f04b652e06ef7660bed6ce2f36def8" id="r_a23f04b652e06ef7660bed6ce2f36def8"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a23f04b652e06ef7660bed6ce2f36def8">__license__</a> = <a class="el" href="#acb6c9c1b2920f0d1744a8e7198d2cf5b">_meta</a>['License']</td></tr>
<tr class="separator:a23f04b652e06ef7660bed6ce2f36def8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2aa7da424bb571416c8cfa93147b27ed" id="r_a2aa7da424bb571416c8cfa93147b27ed"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a2aa7da424bb571416c8cfa93147b27ed">__email__</a> = <a class="el" href="#acb6c9c1b2920f0d1744a8e7198d2cf5b">_meta</a>['Author-email']</td></tr>
<tr class="separator:a2aa7da424bb571416c8cfa93147b27ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a75069cd30950ced7af0da9454e4cc921" id="r_a75069cd30950ced7af0da9454e4cc921"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a75069cd30950ced7af0da9454e4cc921">__url__</a> = <a class="el" href="#acb6c9c1b2920f0d1744a8e7198d2cf5b">_meta</a>['Home-page'] or _meta.get('Project-URL', '').split(',')[0].split(' ')[-1].strip()</td></tr>
<tr class="separator:a75069cd30950ced7af0da9454e4cc921"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a62cc4eb0aa62cc209ee4583b8cc0df52" id="r_a62cc4eb0aa62cc209ee4583b8cc0df52"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a62cc4eb0aa62cc209ee4583b8cc0df52">__description__</a> = <a class="el" href="#acb6c9c1b2920f0d1744a8e7198d2cf5b">_meta</a>['Summary']</td></tr>
<tr class="separator:a62cc4eb0aa62cc209ee4583b8cc0df52"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="a1de3db5e65a2e834c55f458307cab68e" name="a1de3db5e65a2e834c55f458307cab68e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1de3db5e65a2e834c55f458307cab68e">&#9670;&#160;</a></span>gf_author()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gridfire.gf_author </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a454366ce631749963d3c6b387bcbc3e7" name="a454366ce631749963d3c6b387bcbc3e7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a454366ce631749963d3c6b387bcbc3e7">&#9670;&#160;</a></span>gf_collaboration()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gridfire.gf_collaboration </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a787f9de5930793c2976d22426ae971b5" name="a787f9de5930793c2976d22426ae971b5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a787f9de5930793c2976d22426ae971b5">&#9670;&#160;</a></span>gf_credits()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gridfire.gf_credits </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="afa60407432a1e563b9731ce298cf42bc" name="afa60407432a1e563b9731ce298cf42bc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afa60407432a1e563b9731ce298cf42bc">&#9670;&#160;</a></span>gf_description()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gridfire.gf_description </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ae6f8e40e5233e5c98c9c4290f518b72d" name="ae6f8e40e5233e5c98c9c4290f518b72d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae6f8e40e5233e5c98c9c4290f518b72d">&#9670;&#160;</a></span>gf_email()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gridfire.gf_email </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a081c76fc9fbac9b5b380c8e4fa0e7be0" name="a081c76fc9fbac9b5b380c8e4fa0e7be0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a081c76fc9fbac9b5b380c8e4fa0e7be0">&#9670;&#160;</a></span>gf_license()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gridfire.gf_license </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a0ee5ace587287cdba8f9755a0ef0b498" name="a0ee5ace587287cdba8f9755a0ef0b498"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0ee5ace587287cdba8f9755a0ef0b498">&#9670;&#160;</a></span>gf_metadata()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gridfire.gf_metadata </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ae5ade7b2d801af88a79382441ec68277" name="ae5ade7b2d801af88a79382441ec68277"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae5ade7b2d801af88a79382441ec68277">&#9670;&#160;</a></span>gf_url()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gridfire.gf_url </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a45c5e5933ef14301b6f7ec2fff6a0966" name="a45c5e5933ef14301b6f7ec2fff6a0966"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a45c5e5933ef14301b6f7ec2fff6a0966">&#9670;&#160;</a></span>gf_version()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gridfire.gf_version </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a id="a2adfc910bd5466746bd71490d2cbdf1d" name="a2adfc910bd5466746bd71490d2cbdf1d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2adfc910bd5466746bd71490d2cbdf1d">&#9670;&#160;</a></span>__all__</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">list gridfire.__all__ = ['type', 'utils', 'engine', 'solver', 'exceptions', 'partition', 'reaction', 'screening', 'io', 'policy', 'config']</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a3535aedf8a24266670197a715d91229c" name="a3535aedf8a24266670197a715d91229c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3535aedf8a24266670197a715d91229c">&#9670;&#160;</a></span>__author__</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">str gridfire.__author__ = <a class="el" href="#acb6c9c1b2920f0d1744a8e7198d2cf5b">_meta</a>['Author']</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a62cc4eb0aa62cc209ee4583b8cc0df52" name="a62cc4eb0aa62cc209ee4583b8cc0df52"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a62cc4eb0aa62cc209ee4583b8cc0df52">&#9670;&#160;</a></span>__description__</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">gridfire.__description__ = <a class="el" href="#acb6c9c1b2920f0d1744a8e7198d2cf5b">_meta</a>['Summary']</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a2aa7da424bb571416c8cfa93147b27ed" name="a2aa7da424bb571416c8cfa93147b27ed"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2aa7da424bb571416c8cfa93147b27ed">&#9670;&#160;</a></span>__email__</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">str gridfire.__email__ = <a class="el" href="#acb6c9c1b2920f0d1744a8e7198d2cf5b">_meta</a>['Author-email']</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a23f04b652e06ef7660bed6ce2f36def8" name="a23f04b652e06ef7660bed6ce2f36def8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a23f04b652e06ef7660bed6ce2f36def8">&#9670;&#160;</a></span>__license__</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">str gridfire.__license__ = <a class="el" href="#acb6c9c1b2920f0d1744a8e7198d2cf5b">_meta</a>['License']</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a75069cd30950ced7af0da9454e4cc921" name="a75069cd30950ced7af0da9454e4cc921"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a75069cd30950ced7af0da9454e4cc921">&#9670;&#160;</a></span>__url__</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">str gridfire.__url__ = <a class="el" href="#acb6c9c1b2920f0d1744a8e7198d2cf5b">_meta</a>['Home-page'] or _meta.get('Project-URL', '').split(',')[0].split(' ')[-1].strip()</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a14116c4fbbb07c2fa95826dc543771a2" name="a14116c4fbbb07c2fa95826dc543771a2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a14116c4fbbb07c2fa95826dc543771a2">&#9670;&#160;</a></span>__version__</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">str gridfire.__version__ = <a class="el" href="#acb6c9c1b2920f0d1744a8e7198d2cf5b">_meta</a>['Version']</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="acb6c9c1b2920f0d1744a8e7198d2cf5b" name="acb6c9c1b2920f0d1744a8e7198d2cf5b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acb6c9c1b2920f0d1744a8e7198d2cf5b">&#9670;&#160;</a></span>_meta</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">gridfire._meta = importlib.metadata.metadata('gridfire')</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel protected">protected</span></span> </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.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>