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

201 lines
16 KiB
HTML
Raw Normal View History

docs(rebuilt-docs): rebuild docs for v0.7.6rc4.0
2026-04-20 12:45:31 -04:00
<!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/scratchpads/engine_defined_scratchpad.h 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">
fix(gf_get_compiler_flags): fixed bug in getting gridfire compiler flags also added command line utilities and rebuilt docs
2026-06-14 08:36:52 -04:00
<div id="projectname">GridFire<span id="projectnumber">&#160;v1.0.2</span>
docs(rebuilt-docs): rebuild docs for v0.7.6rc4.0
2026-04-20 12:45:31 -04:00
</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('engine__defined__scratchpad_8h.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="#nested-classes">Classes</a> &#124;
<a href="#namespaces">Namespaces</a> </div>
<div class="headertitle"><div class="title">engine_defined_scratchpad.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Scratchpad implementation for the DefinedEngineView.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;<a class="el" href="engine_2scratchpads_2types_8h.html">gridfire/engine/scratchpads/types.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="scratchpad__abstract_8h.html">gridfire/engine/scratchpads/scratchpad_abstract.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="reaction_8h.html">gridfire/reaction/reaction.h</a>&quot;</code><br />
<code>#include &quot;fourdst/atomic/atomicSpecies.h&quot;</code><br />
<code>#include &lt;vector&gt;</code><br />
<code>#include &lt;memory&gt;</code><br />
<code>#include &lt;set&gt;</code><br />
fix(gf_get_compiler_flags): fixed bug in getting gridfire compiler flags also added command line utilities and rebuilt docs
2026-06-14 08:36:52 -04:00
<code>#include &lt;optional&gt;</code><br />
docs(rebuilt-docs): rebuild docs for v0.7.6rc4.0
2026-04-20 12:45:31 -04:00
</div><div class="textblock"><div class="dynheader">
Include dependency graph for engine_defined_scratchpad.h:</div>
<div class="dyncontent">
<div class="center"><div class="zoom"><iframe scrolling="no" frameborder="0" src="engine__defined__scratchpad_8h__incl.svg" width="100%" height="483"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div></div>
</div>
</div><div class="textblock"><div class="dynheader">
This graph shows which files directly or indirectly include this file:</div>
<div class="dyncontent">
<div class="center"><div class="zoom"><iframe scrolling="no" frameborder="0" src="engine__defined__scratchpad_8h__dep__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="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_1engine_1_1scratch_1_1_defined_engine_view_scratch_pad.html">gridfire::engine::scratch::DefinedEngineViewScratchPad</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Scratchpad for storing working memory used by defined reaction network engines. <a href="structgridfire_1_1engine_1_1scratch_1_1_defined_engine_view_scratch_pad.html#details">More...</a><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="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.html">gridfire</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">gridfire::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_1engine_1_1scratch.html">gridfire::engine::scratch</a></td></tr>
<tr class="memdesc:namespacegridfire_1_1engine_1_1scratch"><td class="mdescLeft">&#160;</td><td class="mdescRight">Scratchpad memory management for computational engines. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Scratchpad implementation for the DefinedEngineView. </p>
<p>This header defines the DefinedEngineViewScratchPad, a concrete implementation of AbstractScratchPad designed for use with engines that have a statically defined reaction network. It provides storage for the active species, reactions, and index mappings that enable efficient lookups during computations.</p>
<dl class="section user"><dt>Purpose</dt><dd>The DefinedEngineViewScratchPad stores:<ul>
<li>The set of active species in the defined network</li>
<li>The set of active reactions in the defined network</li>
<li>Index mappings for efficient species and reaction lookups</li>
<li>A cached vector representation of active species for performance</li>
</ul>
</dd></dl>
<dl class="section user"><dt>Examples</dt><dd><div class="fragment"><div class="line"><span class="preprocessor">#include &quot;<a class="code" href="engine__defined__scratchpad_8h.html">gridfire/engine/scratchpads/engine_defined_scratchpad.h</a>&quot;</span></div>
<div class="line"> </div>
<div class="line"><span class="comment">// Create a scratchpad for a defined engine</span></div>
<div class="line"><a class="code hl_struct" href="structgridfire_1_1engine_1_1scratch_1_1_defined_engine_view_scratch_pad.html">gridfire::engine::scratch::DefinedEngineViewScratchPad</a> scratch;</div>
<div class="line"> </div>
<div class="line"><span class="comment">// Populate active species</span></div>
<div class="line">scratch.<a class="code hl_variable" href="structgridfire_1_1engine_1_1scratch_1_1_defined_engine_view_scratch_pad.html#a20a1293b8d217a2c78c64c4da2976103">active_species</a>.insert(species1);</div>
<div class="line">scratch.<a class="code hl_variable" href="structgridfire_1_1engine_1_1scratch_1_1_defined_engine_view_scratch_pad.html#a20a1293b8d217a2c78c64c4da2976103">active_species</a>.insert(species2);</div>
<div class="line"> </div>
<div class="line"><span class="comment">// Set up index mappings for efficient lookups</span></div>
<div class="line">scratch.<a class="code hl_variable" href="structgridfire_1_1engine_1_1scratch_1_1_defined_engine_view_scratch_pad.html#a05c0fe3d8e07eabff28b719e7565fccb">species_index_map</a> = {0, 1, 2, 3};</div>
<div class="line">scratch.<a class="code hl_variable" href="structgridfire_1_1engine_1_1scratch_1_1_defined_engine_view_scratch_pad.html#a95b8528f60ca591bb9d8833e68cd6924">reaction_index_map</a> = {0, 1};</div>
<div class="line"> </div>
<div class="line"><span class="keywordflow">if</span> (scratch.<a class="code hl_function" href="structgridfire_1_1engine_1_1scratch_1_1_defined_engine_view_scratch_pad.html#a8820a147ba891c656dea16b3dd2d20da">is_initialized</a>()) {</div>
<div class="line"> <span class="comment">// Use the scratchpad for computations</span></div>
<div class="line"> <span class="keywordflow">for</span> (<span class="keywordtype">size_t</span> idx : scratch.<a class="code hl_variable" href="structgridfire_1_1engine_1_1scratch_1_1_defined_engine_view_scratch_pad.html#a05c0fe3d8e07eabff28b719e7565fccb">species_index_map</a>) {</div>
<div class="line"> <span class="comment">// Process species by index</span></div>
<div class="line"> }</div>
<div class="line">}</div>
<div class="line"> </div>
<div class="line"><span class="comment">// Clone for parallel execution</span></div>
<div class="line"><span class="keyword">auto</span> worker_scratch = scratch.<a class="code hl_function" href="structgridfire_1_1engine_1_1scratch_1_1_defined_engine_view_scratch_pad.html#ae6c007066aee6807530c8611e717024d">clone</a>();</div>
<div class="ttc" id="aengine__defined__scratchpad_8h_html"><div class="ttname"><a href="engine__defined__scratchpad_8h.html">engine_defined_scratchpad.h</a></div><div class="ttdoc">Scratchpad implementation for the DefinedEngineView.</div></div>
fix(gf_get_compiler_flags): fixed bug in getting gridfire compiler flags also added command line utilities and rebuilt docs
2026-06-14 08:36:52 -04:00
<div class="ttc" id="astructgridfire_1_1engine_1_1scratch_1_1_defined_engine_view_scratch_pad_html"><div class="ttname"><a href="structgridfire_1_1engine_1_1scratch_1_1_defined_engine_view_scratch_pad.html">gridfire::engine::scratch::DefinedEngineViewScratchPad</a></div><div class="ttdoc">Scratchpad for storing working memory used by defined reaction network engines.</div><div class="ttdef"><b>Definition</b> engine_defined_scratchpad.h:81</div></div>
<div class="ttc" id="astructgridfire_1_1engine_1_1scratch_1_1_defined_engine_view_scratch_pad_html_a05c0fe3d8e07eabff28b719e7565fccb"><div class="ttname"><a href="structgridfire_1_1engine_1_1scratch_1_1_defined_engine_view_scratch_pad.html#a05c0fe3d8e07eabff28b719e7565fccb">gridfire::engine::scratch::DefinedEngineViewScratchPad::species_index_map</a></div><div class="ttdeci">std::vector&lt; size_t &gt; species_index_map</div><div class="ttdoc">Mapping from local indices to global species indices.</div><div class="ttdef"><b>Definition</b> engine_defined_scratchpad.h:95</div></div>
<div class="ttc" id="astructgridfire_1_1engine_1_1scratch_1_1_defined_engine_view_scratch_pad_html_a20a1293b8d217a2c78c64c4da2976103"><div class="ttname"><a href="structgridfire_1_1engine_1_1scratch_1_1_defined_engine_view_scratch_pad.html#a20a1293b8d217a2c78c64c4da2976103">gridfire::engine::scratch::DefinedEngineViewScratchPad::active_species</a></div><div class="ttdeci">std::set&lt; fourdst::atomic::Species &gt; active_species</div><div class="ttdoc">Set of species active in the defined network.</div><div class="ttdef"><b>Definition</b> engine_defined_scratchpad.h:89</div></div>
<div class="ttc" id="astructgridfire_1_1engine_1_1scratch_1_1_defined_engine_view_scratch_pad_html_a8820a147ba891c656dea16b3dd2d20da"><div class="ttname"><a href="structgridfire_1_1engine_1_1scratch_1_1_defined_engine_view_scratch_pad.html#a8820a147ba891c656dea16b3dd2d20da">gridfire::engine::scratch::DefinedEngineViewScratchPad::is_initialized</a></div><div class="ttdeci">bool is_initialized() const override</div><div class="ttdoc">Check whether the scratchpad has been initialized.</div><div class="ttdef"><b>Definition</b> engine_defined_scratchpad.h:108</div></div>
<div class="ttc" id="astructgridfire_1_1engine_1_1scratch_1_1_defined_engine_view_scratch_pad_html_a95b8528f60ca591bb9d8833e68cd6924"><div class="ttname"><a href="structgridfire_1_1engine_1_1scratch_1_1_defined_engine_view_scratch_pad.html#a95b8528f60ca591bb9d8833e68cd6924">gridfire::engine::scratch::DefinedEngineViewScratchPad::reaction_index_map</a></div><div class="ttdeci">std::vector&lt; size_t &gt; reaction_index_map</div><div class="ttdoc">Mapping from local indices to global reaction indices.</div><div class="ttdef"><b>Definition</b> engine_defined_scratchpad.h:98</div></div>
<div class="ttc" id="astructgridfire_1_1engine_1_1scratch_1_1_defined_engine_view_scratch_pad_html_ae6c007066aee6807530c8611e717024d"><div class="ttname"><a href="structgridfire_1_1engine_1_1scratch_1_1_defined_engine_view_scratch_pad.html#ae6c007066aee6807530c8611e717024d">gridfire::engine::scratch::DefinedEngineViewScratchPad::clone</a></div><div class="ttdeci">std::unique_ptr&lt; AbstractScratchPad &gt; clone() const override</div><div class="ttdoc">Create a deep copy of this scratchpad.</div><div class="ttdef"><b>Definition</b> engine_defined_scratchpad.h:129</div></div>
docs(rebuilt-docs): rebuild docs for v0.7.6rc4.0
2026-04-20 12:45:31 -04:00
</div><!-- fragment --></dd></dl>
<dl class="section user"><dt>Thread Safety</dt><dd>This class is <b>not thread-safe</b>. Each thread should have its own instance of DefinedEngineViewScratchPad. Use clone() to create independent copies for parallel workers.</dd></dl>
<dl class="section see"><dt>See also</dt><dd>AbstractScratchPad </dd>
<dd>
DefinedEngineView </dd></dl>
</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_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_65a5f8f804465673712f6f1daa9f9ade.html">scratchpads</a></li><li class="navelem"><a class="el" href="engine__defined__scratchpad_8h.html">engine_defined_scratchpad.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 Copy Permalink