docs(docs): asdded and cleaned up docs
This commit is contained in:
162
docs/html/engine__priming_8h_source.html
Normal file
162
docs/html/engine__priming_8h_source.html
Normal file
@@ -0,0 +1,162 @@
|
||||
<!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/include/gridfire/engine/views/engine_priming.h Source File</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('engine__priming_8h_source.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="headertitle"><div class="title">engine_priming.h</div></div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
<a href="engine__priming_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#pragma once</span></div>
|
||||
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span> </div>
|
||||
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="preprocessor">#include "<a class="code" href="engine__abstract_8h.html">gridfire/engine/engine_abstract.h</a>"</span></div>
|
||||
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include "<a class="code" href="engine__defined_8h.html">gridfire/engine/views/engine_defined.h</a>"</span></div>
|
||||
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span> </div>
|
||||
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#include "<a class="code" href="network_8h.html">gridfire/network.h</a>"</span></div>
|
||||
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span> </div>
|
||||
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include "fourdst/logging/logging.h"</span></div>
|
||||
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include "fourdst/composition/atomicSpecies.h"</span></div>
|
||||
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#include "fourdst/composition/composition.h"</span></div>
|
||||
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> </div>
|
||||
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="preprocessor">#include "quill/Logger.h"</span></div>
|
||||
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> </div>
|
||||
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="preprocessor">#include <vector></span></div>
|
||||
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="preprocessor">#include <string></span></div>
|
||||
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> </div>
|
||||
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespacegridfire.html">gridfire</a> {</div>
|
||||
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span></div>
|
||||
<div class="foldopen" id="foldopen00030" data-start="{" data-end="};">
|
||||
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"><a class="line" href="classgridfire_1_1_network_priming_engine_view.html"> 30</a></span> <span class="keyword">class </span><a class="code hl_function" href="classgridfire_1_1_network_priming_engine_view.html#ad13ec8d4974421c72cffd88558d71177">NetworkPrimingEngineView</a> final : <span class="keyword">public</span> <a class="code hl_function" href="classgridfire_1_1_defined_engine_view.html#a9b319b4a1bd5a08381ebb183daf72c92">DefinedEngineView</a> {</div>
|
||||
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">public</span>:</div>
|
||||
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> <a class="code hl_function" href="classgridfire_1_1_network_priming_engine_view.html#ad13ec8d4974421c72cffd88558d71177">NetworkPrimingEngineView</a>(<span class="keyword">const</span> std::string& primingSymbol, <a class="code hl_class" href="classgridfire_1_1_dynamic_engine.html">DynamicEngine</a>& baseEngine);</div>
|
||||
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> <a class="code hl_function" href="classgridfire_1_1_network_priming_engine_view.html#ad13ec8d4974421c72cffd88558d71177">NetworkPrimingEngineView</a>(<span class="keyword">const</span> fourdst::atomic::Species& primingSpecies, <a class="code hl_class" href="classgridfire_1_1_dynamic_engine.html">DynamicEngine</a>& baseEngine);</div>
|
||||
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> </div>
|
||||
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> </div>
|
||||
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> <span class="keyword">private</span>:</div>
|
||||
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"><a class="line" href="classgridfire_1_1_network_priming_engine_view.html#a1eed366e916c4e9b7847ae52836f3c7d"> 56</a></span> quill::Logger* <a class="code hl_variable" href="classgridfire_1_1_network_priming_engine_view.html#a1eed366e916c4e9b7847ae52836f3c7d">m_logger</a> = fourdst::logging::LogManager::getInstance().getLogger(<span class="stringliteral">"log"</span>);</div>
|
||||
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"><a class="line" href="classgridfire_1_1_network_priming_engine_view.html#aeb8f25d97e2459037cc999b974823cf5"> 57</a></span> fourdst::atomic::Species <a class="code hl_variable" href="classgridfire_1_1_network_priming_engine_view.html#aeb8f25d97e2459037cc999b974823cf5">m_primingSpecies</a>; </div>
|
||||
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> <span class="keyword">private</span>:</div>
|
||||
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> std::vector<std::string> <a class="code hl_function" href="classgridfire_1_1_network_priming_engine_view.html#a91f60d8a6bd92dc5d5f6fcda8e89408f">constructPrimingReactionSet</a>(</div>
|
||||
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> <span class="keyword">const</span> fourdst::atomic::Species& primingSpecies,</div>
|
||||
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> <span class="keyword">const</span> <a class="code hl_class" href="classgridfire_1_1_dynamic_engine.html">DynamicEngine</a>& baseEngine</div>
|
||||
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> ) <span class="keyword">const</span>;</div>
|
||||
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> };</div>
|
||||
</div>
|
||||
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> </div>
|
||||
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span>}</div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_defined_engine_view_html_a9b319b4a1bd5a08381ebb183daf72c92"><div class="ttname"><a href="classgridfire_1_1_defined_engine_view.html#a9b319b4a1bd5a08381ebb183daf72c92">gridfire::DefinedEngineView::DefinedEngineView</a></div><div class="ttdeci">DefinedEngineView(const std::vector< std::string > &peNames, DynamicEngine &baseEngine)</div><div class="ttdef"><b>Definition</b> <a href="engine__defined_8cpp_source.html#l00017">engine_defined.cpp:17</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_dynamic_engine_html"><div class="ttname"><a href="classgridfire_1_1_dynamic_engine.html">gridfire::DynamicEngine</a></div><div class="ttdoc">Abstract class for engines supporting Jacobian and stoichiometry operations.</div><div class="ttdef"><b>Definition</b> <a href="engine__abstract_8h_source.html#l00130">engine_abstract.h:130</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_network_priming_engine_view_html_a1eed366e916c4e9b7847ae52836f3c7d"><div class="ttname"><a href="classgridfire_1_1_network_priming_engine_view.html#a1eed366e916c4e9b7847ae52836f3c7d">gridfire::NetworkPrimingEngineView::m_logger</a></div><div class="ttdeci">quill::Logger * m_logger</div><div class="ttdef"><b>Definition</b> <a href="#l00056">engine_priming.h:56</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_network_priming_engine_view_html_a91f60d8a6bd92dc5d5f6fcda8e89408f"><div class="ttname"><a href="classgridfire_1_1_network_priming_engine_view.html#a91f60d8a6bd92dc5d5f6fcda8e89408f">gridfire::NetworkPrimingEngineView::constructPrimingReactionSet</a></div><div class="ttdeci">std::vector< std::string > constructPrimingReactionSet(const fourdst::atomic::Species &primingSpecies, const DynamicEngine &baseEngine) const</div><div class="ttdoc">Constructs the set of reaction names that involve the priming species.</div><div class="ttdef"><b>Definition</b> <a href="engine__priming_8cpp_source.html#l00051">engine_priming.cpp:51</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_network_priming_engine_view_html_ad13ec8d4974421c72cffd88558d71177"><div class="ttname"><a href="classgridfire_1_1_network_priming_engine_view.html#ad13ec8d4974421c72cffd88558d71177">gridfire::NetworkPrimingEngineView::NetworkPrimingEngineView</a></div><div class="ttdeci">NetworkPrimingEngineView(const std::string &primingSymbol, DynamicEngine &baseEngine)</div><div class="ttdoc">Constructs the view by looking up the priming species by symbol.</div><div class="ttdef"><b>Definition</b> <a href="engine__priming_8cpp_source.html#l00023">engine_priming.cpp:23</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_network_priming_engine_view_html_aeb8f25d97e2459037cc999b974823cf5"><div class="ttname"><a href="classgridfire_1_1_network_priming_engine_view.html#aeb8f25d97e2459037cc999b974823cf5">gridfire::NetworkPrimingEngineView::m_primingSpecies</a></div><div class="ttdeci">fourdst::atomic::Species m_primingSpecies</div><div class="ttdoc">The priming species, if specified.</div><div class="ttdef"><b>Definition</b> <a href="#l00057">engine_priming.h:57</a></div></div>
|
||||
<div class="ttc" id="aengine__abstract_8h_html"><div class="ttname"><a href="engine__abstract_8h.html">engine_abstract.h</a></div><div class="ttdoc">Abstract interfaces for reaction network engines in GridFire.</div></div>
|
||||
<div class="ttc" id="aengine__defined_8h_html"><div class="ttname"><a href="engine__defined_8h.html">engine_defined.h</a></div></div>
|
||||
<div class="ttc" id="anamespacegridfire_html"><div class="ttname"><a href="namespacegridfire.html">gridfire</a></div><div class="ttdef"><b>Definition</b> <a href="engine__abstract_8h_source.html#l00031">engine_abstract.h:31</a></div></div>
|
||||
<div class="ttc" id="anetwork_8h_html"><div class="ttname"><a href="network_8h.html">network.h</a></div></div>
|
||||
</div><!-- fragment --></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_b0856f6b0d80ccb263b2f415c91f9e17.html">include</a></li><li class="navelem"><a class="el" href="dir_3626e0c0e3c5d7812d6b277dfa4ec364.html">gridfire</a></li><li class="navelem"><a class="el" href="dir_aff155d61c3b73b9ab7dcdc908c4d49e.html">engine</a></li><li class="navelem"><a class="el" href="dir_d5492b42d970deba31f48df1b35a6c47.html">views</a></li><li class="navelem"><a class="el" href="engine__priming_8h.html">engine_priming.h</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
Block a user