486 lines
32 KiB
HTML
486 lines
32 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::approx8::Approx8Network Class 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"> 0.0.1a</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&dn=expat.txt MIT */
|
||
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
||
|
|
/* @license-end */
|
||
|
|
</script>
|
||
|
|
<script type="text/javascript">
|
||
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&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&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&dn=expat.txt MIT */
|
||
|
|
$(function(){initNavTree('classgridfire_1_1approx8_1_1_approx8_network.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> |
|
||
|
|
<a href="#pri-static-methods">Static Private Member Functions</a> |
|
||
|
|
<a href="#pri-attribs">Private Attributes</a> |
|
||
|
|
<a href="classgridfire_1_1approx8_1_1_approx8_network-members.html">List of all members</a> </div>
|
||
|
|
<div class="headertitle"><div class="title">gridfire::approx8::Approx8Network Class Reference<span class="mlabels"><span class="mlabel final">final</span></span></div></div>
|
||
|
|
</div><!--header-->
|
||
|
|
<div class="contents">
|
||
|
|
|
||
|
|
<p>Class for the Approx8 nuclear reaction network.
|
||
|
|
<a href="#details">More...</a></p>
|
||
|
|
|
||
|
|
<p><code>#include <<a class="el" href="engine__approx8_8h_source.html">engine_approx8.h</a>></code></p>
|
||
|
|
<div class="dynheader">
|
||
|
|
Inheritance diagram for gridfire::approx8::Approx8Network:</div>
|
||
|
|
<div class="dyncontent">
|
||
|
|
<div class="center">
|
||
|
|
<img src="classgridfire_1_1approx8_1_1_approx8_network.png" usemap="#gridfire::approx8::Approx8Network_map" alt=""/>
|
||
|
|
<map id="gridfire::approx8::Approx8Network_map" name="gridfire::approx8::Approx8Network_map">
|
||
|
|
<area href="classgridfire_1_1_network.html" alt="gridfire::Network" shape="rect" coords="0,0,205,24"/>
|
||
|
|
</map>
|
||
|
|
</div></div>
|
||
|
|
<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:a65066078081c544be4e56e25eb407c8b" id="r_a65066078081c544be4e56e25eb407c8b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a65066078081c544be4e56e25eb407c8b">Approx8Network</a> ()</td></tr>
|
||
|
|
<tr class="separator:a65066078081c544be4e56e25eb407c8b"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a888734a3cdde4259e921e2efece411ee" id="r_a888734a3cdde4259e921e2efece411ee"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structgridfire_1_1_net_out.html">NetOut</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a888734a3cdde4259e921e2efece411ee">evaluate</a> (const <a class="el" href="structgridfire_1_1_net_in.html">NetIn</a> &netIn) override</td></tr>
|
||
|
|
<tr class="memdesc:a888734a3cdde4259e921e2efece411ee"><td class="mdescLeft"> </td><td class="mdescRight">Evaluates the nuclear network. <br /></td></tr>
|
||
|
|
<tr class="separator:a888734a3cdde4259e921e2efece411ee"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:aefed972081514c29cdaaa1efd857ad8d" id="r_aefed972081514c29cdaaa1efd857ad8d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#aefed972081514c29cdaaa1efd857ad8d">setStiff</a> (bool stiff) override</td></tr>
|
||
|
|
<tr class="memdesc:aefed972081514c29cdaaa1efd857ad8d"><td class="mdescLeft"> </td><td class="mdescRight">Sets whether the solver should use a stiff method. <br /></td></tr>
|
||
|
|
<tr class="separator:aefed972081514c29cdaaa1efd857ad8d"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a5b17b2831389829533385900ce19a37a" id="r_a5b17b2831389829533385900ce19a37a"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#a5b17b2831389829533385900ce19a37a">isStiff</a> () const override</td></tr>
|
||
|
|
<tr class="memdesc:a5b17b2831389829533385900ce19a37a"><td class="mdescLeft"> </td><td class="mdescRight">Checks if the solver is using a stiff method. <br /></td></tr>
|
||
|
|
<tr class="separator:a5b17b2831389829533385900ce19a37a"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="inherit_header pub_methods_classgridfire_1_1_network"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_classgridfire_1_1_network')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classgridfire_1_1_network.html">gridfire::Network</a></td></tr>
|
||
|
|
<tr class="memitem:a20b631f2404bfdec2333f680a62abf55 inherit pub_methods_classgridfire_1_1_network" id="r_a20b631f2404bfdec2333f680a62abf55"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1_network.html#a20b631f2404bfdec2333f680a62abf55">Network</a> (const <a class="el" href="namespacegridfire.html#a3f3d6b3f9742b70e62049ccefbb60f37">NetworkFormat</a> format=<a class="el" href="namespacegridfire.html#a3f3d6b3f9742b70e62049ccefbb60f37a1fc7adf719c40457abfdb8334675faea">NetworkFormat::APPROX8</a>)</td></tr>
|
||
|
|
<tr class="separator:a20b631f2404bfdec2333f680a62abf55 inherit pub_methods_classgridfire_1_1_network"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ab8d83289b62dda9b4e02f25311f85b79 inherit pub_methods_classgridfire_1_1_network" id="r_ab8d83289b62dda9b4e02f25311f85b79"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1_network.html#ab8d83289b62dda9b4e02f25311f85b79">~Network</a> ()=default</td></tr>
|
||
|
|
<tr class="separator:ab8d83289b62dda9b4e02f25311f85b79 inherit pub_methods_classgridfire_1_1_network"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a315a123499719178286b29e2aca69118 inherit pub_methods_classgridfire_1_1_network" id="r_a315a123499719178286b29e2aca69118"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacegridfire.html#a3f3d6b3f9742b70e62049ccefbb60f37">NetworkFormat</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1_network.html#a315a123499719178286b29e2aca69118">getFormat</a> () const</td></tr>
|
||
|
|
<tr class="separator:a315a123499719178286b29e2aca69118 inherit pub_methods_classgridfire_1_1_network"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a787c601f6e4bd06600bf946efbcc98d4 inherit pub_methods_classgridfire_1_1_network" id="r_a787c601f6e4bd06600bf946efbcc98d4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacegridfire.html#a3f3d6b3f9742b70e62049ccefbb60f37">NetworkFormat</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1_network.html#a787c601f6e4bd06600bf946efbcc98d4">setFormat</a> (const <a class="el" href="namespacegridfire.html#a3f3d6b3f9742b70e62049ccefbb60f37">NetworkFormat</a> format)</td></tr>
|
||
|
|
<tr class="separator:a787c601f6e4bd06600bf946efbcc98d4 inherit pub_methods_classgridfire_1_1_network"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
</table><table class="memberdecls">
|
||
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-static-methods" name="pri-static-methods"></a>
|
||
|
|
Static Private Member Functions</h2></td></tr>
|
||
|
|
<tr class="memitem:a56426da6f1af7eb8a6d1cc70bc8e742a" id="r_a56426da6f1af7eb8a6d1cc70bc8e742a"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="namespacegridfire_1_1approx8.html#aa04f907d4ef6a1b6b2a9a28d4bb53882">vector_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a56426da6f1af7eb8a6d1cc70bc8e742a">convert_netIn</a> (const <a class="el" href="structgridfire_1_1_net_in.html">NetIn</a> &netIn)</td></tr>
|
||
|
|
<tr class="memdesc:a56426da6f1af7eb8a6d1cc70bc8e742a"><td class="mdescLeft"> </td><td class="mdescRight">Converts the input parameters to the internal state vector. <br /></td></tr>
|
||
|
|
<tr class="separator:a56426da6f1af7eb8a6d1cc70bc8e742a"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
</table><table class="memberdecls">
|
||
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-attribs" name="pri-attribs"></a>
|
||
|
|
Private Attributes</h2></td></tr>
|
||
|
|
<tr class="memitem:abf9f13ff532917ddac4a7d987698836d" id="r_abf9f13ff532917ddac4a7d987698836d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacegridfire_1_1approx8.html#aa04f907d4ef6a1b6b2a9a28d4bb53882">vector_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#abf9f13ff532917ddac4a7d987698836d">m_y</a></td></tr>
|
||
|
|
<tr class="separator:abf9f13ff532917ddac4a7d987698836d"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a6fadf388f07c160f1887a3cb72eaa869" id="r_a6fadf388f07c160f1887a3cb72eaa869"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="#a6fadf388f07c160f1887a3cb72eaa869">m_tMax</a> = 0</td></tr>
|
||
|
|
<tr class="separator:a6fadf388f07c160f1887a3cb72eaa869"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a6ed8022834e9541b3e547dd867648b0f" id="r_a6ed8022834e9541b3e547dd867648b0f"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="#a6ed8022834e9541b3e547dd867648b0f">m_dt0</a> = 0</td></tr>
|
||
|
|
<tr class="separator:a6ed8022834e9541b3e547dd867648b0f"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a697cb49bebc8d0659eb791500c451c67" id="r_a697cb49bebc8d0659eb791500c451c67"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#a697cb49bebc8d0659eb791500c451c67">m_stiff</a> = false</td></tr>
|
||
|
|
<tr class="separator:a697cb49bebc8d0659eb791500c451c67"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
</table><table class="memberdecls">
|
||
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a>
|
||
|
|
Additional Inherited Members</h2></td></tr>
|
||
|
|
<tr class="inherit_header pro_attribs_classgridfire_1_1_network"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pro_attribs_classgridfire_1_1_network')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="classgridfire_1_1_network.html">gridfire::Network</a></td></tr>
|
||
|
|
<tr class="memitem:a9f8802012728ef5fea0e8cd465044e09 inherit pro_attribs_classgridfire_1_1_network" id="r_a9f8802012728ef5fea0e8cd465044e09"><td class="memItemLeft" align="right" valign="top">fourdst::config::Config & </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1_network.html#a9f8802012728ef5fea0e8cd465044e09">m_config</a></td></tr>
|
||
|
|
<tr class="memdesc:a9f8802012728ef5fea0e8cd465044e09 inherit pro_attribs_classgridfire_1_1_network"><td class="mdescLeft"> </td><td class="mdescRight">Configuration instance. <br /></td></tr>
|
||
|
|
<tr class="separator:a9f8802012728ef5fea0e8cd465044e09 inherit pro_attribs_classgridfire_1_1_network"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a0bb7c7be9a3c3212ef6dcbf26dcacb16 inherit pro_attribs_classgridfire_1_1_network" id="r_a0bb7c7be9a3c3212ef6dcbf26dcacb16"><td class="memItemLeft" align="right" valign="top">fourdst::logging::LogManager & </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1_network.html#a0bb7c7be9a3c3212ef6dcbf26dcacb16">m_logManager</a></td></tr>
|
||
|
|
<tr class="memdesc:a0bb7c7be9a3c3212ef6dcbf26dcacb16 inherit pro_attribs_classgridfire_1_1_network"><td class="mdescLeft"> </td><td class="mdescRight">Log manager instance. <br /></td></tr>
|
||
|
|
<tr class="separator:a0bb7c7be9a3c3212ef6dcbf26dcacb16 inherit pro_attribs_classgridfire_1_1_network"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a960d309defc570f92d296ce4b93920e5 inherit pro_attribs_classgridfire_1_1_network" id="r_a960d309defc570f92d296ce4b93920e5"><td class="memItemLeft" align="right" valign="top">quill::Logger * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1_network.html#a960d309defc570f92d296ce4b93920e5">m_logger</a></td></tr>
|
||
|
|
<tr class="memdesc:a960d309defc570f92d296ce4b93920e5 inherit pro_attribs_classgridfire_1_1_network"><td class="mdescLeft"> </td><td class="mdescRight">Logger instance. <br /></td></tr>
|
||
|
|
<tr class="separator:a960d309defc570f92d296ce4b93920e5 inherit pro_attribs_classgridfire_1_1_network"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a37218e18f1bdbda7be94aa230f47dd18 inherit pro_attribs_classgridfire_1_1_network" id="r_a37218e18f1bdbda7be94aa230f47dd18"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacegridfire.html#a3f3d6b3f9742b70e62049ccefbb60f37">NetworkFormat</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1_network.html#a37218e18f1bdbda7be94aa230f47dd18">m_format</a></td></tr>
|
||
|
|
<tr class="memdesc:a37218e18f1bdbda7be94aa230f47dd18 inherit pro_attribs_classgridfire_1_1_network"><td class="mdescLeft"> </td><td class="mdescRight">Format of the network. <br /></td></tr>
|
||
|
|
<tr class="separator:a37218e18f1bdbda7be94aa230f47dd18 inherit pro_attribs_classgridfire_1_1_network"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:adf7002883160101c9f9d1b376b265410 inherit pro_attribs_classgridfire_1_1_network" id="r_adf7002883160101c9f9d1b376b265410"><td class="memItemLeft" align="right" valign="top">fourdst::constant::Constants & </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1_network.html#adf7002883160101c9f9d1b376b265410">m_constants</a></td></tr>
|
||
|
|
<tr class="separator:adf7002883160101c9f9d1b376b265410 inherit pro_attribs_classgridfire_1_1_network"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:aefe364ae5af783e19e7b93bfd475566e inherit pro_attribs_classgridfire_1_1_network" id="r_aefe364ae5af783e19e7b93bfd475566e"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1_network.html#aefe364ae5af783e19e7b93bfd475566e">m_stiff</a> = false</td></tr>
|
||
|
|
<tr class="memdesc:aefe364ae5af783e19e7b93bfd475566e inherit pro_attribs_classgridfire_1_1_network"><td class="mdescLeft"> </td><td class="mdescRight">Flag indicating if the network is stiff. <br /></td></tr>
|
||
|
|
<tr class="separator:aefe364ae5af783e19e7b93bfd475566e inherit pro_attribs_classgridfire_1_1_network"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
</table>
|
||
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||
|
|
<div class="textblock"><p>Class for the Approx8 nuclear reaction network. </p>
|
||
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="_2_users_2tboudreaux_2_programming_24_d_s_t_a_r_2_grid_fire_2src_2network_2include_2gridfire_2engine_2engine_approx8_8h-example.html#_a3">/Users/tboudreaux/Programming/4DSTAR/GridFire/src/network/include/gridfire/engine/engine_approx8.h</a>.</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="engine__approx8_8h_source.html#l00294">294</a> of file <a class="el" href="engine__approx8_8h_source.html">engine_approx8.h</a>.</p>
|
||
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
||
|
|
<a id="a65066078081c544be4e56e25eb407c8b" name="a65066078081c544be4e56e25eb407c8b"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a65066078081c544be4e56e25eb407c8b">◆ </a></span>Approx8Network()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">gridfire::approx8::Approx8Network::Approx8Network </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="_2_users_2tboudreaux_2_programming_24_d_s_t_a_r_2_grid_fire_2src_2network_2include_2gridfire_2engine_2engine_approx8_8h-example.html#a40">/Users/tboudreaux/Programming/4DSTAR/GridFire/src/network/include/gridfire/engine/engine_approx8.h</a>.</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="engine__approx8_8cpp_source.html#l00443">443</a> of file <a class="el" href="engine__approx8_8cpp_source.html">engine_approx8.cpp</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
||
|
|
<a id="a56426da6f1af7eb8a6d1cc70bc8e742a" name="a56426da6f1af7eb8a6d1cc70bc8e742a"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a56426da6f1af7eb8a6d1cc70bc8e742a">◆ </a></span>convert_netIn()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname"><a class="el" href="namespacegridfire_1_1approx8.html#aa04f907d4ef6a1b6b2a9a28d4bb53882">vector_type</a> gridfire::approx8::Approx8Network::convert_netIn </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">const <a class="el" href="structgridfire_1_1_net_in.html">NetIn</a> &</td> <td class="paramname"><span class="paramname"><em>netIn</em></span></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel static">static</span><span class="mlabel private">private</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Converts the input parameters to the internal state vector. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">netIn</td><td>Input parameters for the network. </td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>Internal state vector. </dd></dl>
|
||
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="_2_users_2tboudreaux_2_programming_24_d_s_t_a_r_2_grid_fire_2src_2network_2include_2gridfire_2engine_2engine_approx8_8h-example.html#a48">/Users/tboudreaux/Programming/4DSTAR/GridFire/src/network/include/gridfire/engine/engine_approx8.h</a>.</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="engine__approx8_8cpp_source.html#l00509">509</a> of file <a class="el" href="engine__approx8_8cpp_source.html">engine_approx8.cpp</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a888734a3cdde4259e921e2efece411ee" name="a888734a3cdde4259e921e2efece411ee"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a888734a3cdde4259e921e2efece411ee">◆ </a></span>evaluate()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname"><a class="el" href="structgridfire_1_1_net_out.html">NetOut</a> gridfire::approx8::Approx8Network::evaluate </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">const <a class="el" href="structgridfire_1_1_net_in.html">NetIn</a> &</td> <td class="paramname"><span class="paramname"><em>netIn</em></span></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel override">override</span><span class="mlabel virtual">virtual</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Evaluates the nuclear network. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">netIn</td><td>Input parameters for the network. </td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>Output results from the network. </dd></dl>
|
||
|
|
|
||
|
|
<p>Implements <a class="el" href="classgridfire_1_1_network.html#afc8d5172dd0e2295248b42dcb52b655c">gridfire::Network</a>.</p>
|
||
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="_2_users_2tboudreaux_2_programming_24_d_s_t_a_r_2_grid_fire_2src_2network_2include_2gridfire_2engine_2engine_approx8_8h-example.html#a41">/Users/tboudreaux/Programming/4DSTAR/GridFire/src/network/include/gridfire/engine/engine_approx8.h</a>.</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="engine__approx8_8cpp_source.html#l00445">445</a> of file <a class="el" href="engine__approx8_8cpp_source.html">engine_approx8.cpp</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a5b17b2831389829533385900ce19a37a" name="a5b17b2831389829533385900ce19a37a"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5b17b2831389829533385900ce19a37a">◆ </a></span>isStiff()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">bool gridfire::approx8::Approx8Network::isStiff </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
||
|
|
<td> const</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel override">override</span><span class="mlabel virtual">virtual</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Checks if the solver is using a stiff method. </p>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>Boolean indicating if a stiff method is being used. </dd></dl>
|
||
|
|
|
||
|
|
<p>Reimplemented from <a class="el" href="classgridfire_1_1_network.html#ae93ad65deba79def4b77d420e7affa0b">gridfire::Network</a>.</p>
|
||
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="_2_users_2tboudreaux_2_programming_24_d_s_t_a_r_2_grid_fire_2src_2network_2include_2gridfire_2engine_2engine_approx8_8h-example.html#a43">/Users/tboudreaux/Programming/4DSTAR/GridFire/src/network/include/gridfire/engine/engine_approx8.h</a>.</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="engine__approx8_8h_source.html#l00315">315</a> of file <a class="el" href="engine__approx8_8h_source.html">engine_approx8.h</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="aefed972081514c29cdaaa1efd857ad8d" name="aefed972081514c29cdaaa1efd857ad8d"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aefed972081514c29cdaaa1efd857ad8d">◆ </a></span>setStiff()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">void gridfire::approx8::Approx8Network::setStiff </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">bool</td> <td class="paramname"><span class="paramname"><em>stiff</em></span></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel override">override</span><span class="mlabel virtual">virtual</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Sets whether the solver should use a stiff method. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">stiff</td><td>Boolean indicating if a stiff method should be used. </td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<p>Reimplemented from <a class="el" href="classgridfire_1_1_network.html#a84de2d691af06c4b62cfab5022b1e8fe">gridfire::Network</a>.</p>
|
||
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="_2_users_2tboudreaux_2_programming_24_d_s_t_a_r_2_grid_fire_2src_2network_2include_2gridfire_2engine_2engine_approx8_8h-example.html#a42">/Users/tboudreaux/Programming/4DSTAR/GridFire/src/network/include/gridfire/engine/engine_approx8.h</a>.</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="engine__approx8_8cpp_source.html#l00505">505</a> of file <a class="el" href="engine__approx8_8cpp_source.html">engine_approx8.cpp</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<h2 class="groupheader">Member Data Documentation</h2>
|
||
|
|
<a id="a6ed8022834e9541b3e547dd867648b0f" name="a6ed8022834e9541b3e547dd867648b0f"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6ed8022834e9541b3e547dd867648b0f">◆ </a></span>m_dt0</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">double gridfire::approx8::Approx8Network::m_dt0 = 0</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">
|
||
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="_2_users_2tboudreaux_2_programming_24_d_s_t_a_r_2_grid_fire_2src_2network_2include_2gridfire_2engine_2engine_approx8_8h-example.html#a47">/Users/tboudreaux/Programming/4DSTAR/GridFire/src/network/include/gridfire/engine/engine_approx8.h</a>.</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="engine__approx8_8h_source.html#l00319">319</a> of file <a class="el" href="engine__approx8_8h_source.html">engine_approx8.h</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a697cb49bebc8d0659eb791500c451c67" name="a697cb49bebc8d0659eb791500c451c67"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a697cb49bebc8d0659eb791500c451c67">◆ </a></span>m_stiff</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">bool gridfire::approx8::Approx8Network::m_stiff = false</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">
|
||
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="_2_users_2tboudreaux_2_programming_24_d_s_t_a_r_2_grid_fire_2src_2network_2include_2gridfire_2engine_2engine_approx8_8h-example.html#a44">/Users/tboudreaux/Programming/4DSTAR/GridFire/src/network/include/gridfire/engine/engine_approx8.h</a>.</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="engine__approx8_8h_source.html#l00320">320</a> of file <a class="el" href="engine__approx8_8h_source.html">engine_approx8.h</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a6fadf388f07c160f1887a3cb72eaa869" name="a6fadf388f07c160f1887a3cb72eaa869"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6fadf388f07c160f1887a3cb72eaa869">◆ </a></span>m_tMax</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">double gridfire::approx8::Approx8Network::m_tMax = 0</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">
|
||
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="_2_users_2tboudreaux_2_programming_24_d_s_t_a_r_2_grid_fire_2src_2network_2include_2gridfire_2engine_2engine_approx8_8h-example.html#a46">/Users/tboudreaux/Programming/4DSTAR/GridFire/src/network/include/gridfire/engine/engine_approx8.h</a>.</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="engine__approx8_8h_source.html#l00318">318</a> of file <a class="el" href="engine__approx8_8h_source.html">engine_approx8.h</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="abf9f13ff532917ddac4a7d987698836d" name="abf9f13ff532917ddac4a7d987698836d"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abf9f13ff532917ddac4a7d987698836d">◆ </a></span>m_y</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname"><a class="el" href="namespacegridfire_1_1approx8.html#aa04f907d4ef6a1b6b2a9a28d4bb53882">vector_type</a> gridfire::approx8::Approx8Network::m_y</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">
|
||
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="_2_users_2tboudreaux_2_programming_24_d_s_t_a_r_2_grid_fire_2src_2network_2include_2gridfire_2engine_2engine_approx8_8h-example.html#a45">/Users/tboudreaux/Programming/4DSTAR/GridFire/src/network/include/gridfire/engine/engine_approx8.h</a>.</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="engine__approx8_8h_source.html#l00317">317</a> of file <a class="el" href="engine__approx8_8h_source.html">engine_approx8.h</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
||
|
|
<li>src/network/include/gridfire/engine/<a class="el" href="engine__approx8_8h_source.html">engine_approx8.h</a></li>
|
||
|
|
<li>src/network/lib/engine/<a class="el" href="engine__approx8_8cpp_source.html">engine_approx8.cpp</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.html">gridfire</a></li><li class="navelem"><a class="el" href="namespacegridfire_1_1approx8.html">approx8</a></li><li class="navelem"><a class="el" href="classgridfire_1_1approx8_1_1_approx8_network.html">Approx8Network</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>
|