265 lines
23 KiB
HTML
265 lines
23 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: src/include/gridfire/engine/scratchpads/scratchpads.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">
|
|
<div id="projectname">GridFire<span id="projectnumber"> 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&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('scratchpads_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="#namespaces">Namespaces</a> </div>
|
|
<div class="headertitle"><div class="title">scratchpads.h File Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Unified header for the scratchpad memory management system.
|
|
<a href="#details">More...</a></p>
|
|
<div class="textblock"><code>#include "<a class="el" href="scratchpad__abstract_8h.html">gridfire/engine/scratchpads/scratchpad_abstract.h</a>"</code><br />
|
|
<code>#include "<a class="el" href="engine__graph__scratchpad_8h.html">gridfire/engine/scratchpads/engine_graph_scratchpad.h</a>"</code><br />
|
|
<code>#include "<a class="el" href="engine__adaptive__scratchpad_8h.html">gridfire/engine/scratchpads/engine_adaptive_scratchpad.h</a>"</code><br />
|
|
<code>#include "<a class="el" href="engine__multiscale__scratchpad_8h.html">gridfire/engine/scratchpads/engine_multiscale_scratchpad.h</a>"</code><br />
|
|
<code>#include "<a class="el" href="engine__defined__scratchpad_8h.html">gridfire/engine/scratchpads/engine_defined_scratchpad.h</a>"</code><br />
|
|
<code>#include "<a class="el" href="engine_2scratchpads_2types_8h.html">gridfire/engine/scratchpads/types.h</a>"</code><br />
|
|
<code>#include "<a class="el" href="blob_8h.html">gridfire/engine/scratchpads/blob.h</a>"</code><br />
|
|
<code>#include "<a class="el" href="engine_2scratchpads_2utils_8h.html">gridfire/engine/scratchpads/utils.h</a>"</code><br />
|
|
<code>#include "<a class="el" href="engine_2scratchpads_2formatters_8h.html">gridfire/engine/scratchpads/formatters.h</a>"</code><br />
|
|
</div><div class="textblock"><div class="dynheader">
|
|
Include dependency graph for scratchpads.h:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><div class="zoom"><iframe scrolling="no" frameborder="0" src="scratchpads_8h__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><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="scratchpads_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="namespaces" name="namespaces"></a>
|
|
Namespaces</h2></td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace  </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"> </td><td class="mdescRight">Scratchpad memory management for computational engines. <br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Unified header for the scratchpad memory management system. </p>
|
|
<p>This is the main include file for the scratchpad subsystem. It provides a single include point for all scratchpad-related functionality, including the abstract base class, concrete implementations, type definitions, the StateBlob container, utility functions, and formatters for debugging.</p>
|
|
<dl class="section user"><dt>What are Scratchpads?</dt><dd>Scratchpads are temporary working memory containers used by computational engines during ODE integration and reaction network calculations. They serve several critical purposes:</dd></dl>
|
|
<ul>
|
|
<li><b>Performance</b>: Pre-allocate memory once and reuse across iterations, avoiding repeated heap allocations during time-critical computations.</li>
|
|
<li><b>Caching</b>: Store intermediate results (Jacobians, derivatives, etc.) that can be reused across solver steps.</li>
|
|
<li><b>Thread Safety</b>: Provide thread-local storage for parallel execution, where each thread operates on its own independent scratchpad instance.</li>
|
|
<li><b>State Management</b>: Encapsulate engine-specific working state separate from the engine's persistent configuration.</li>
|
|
</ul>
|
|
<dl class="section user"><dt>Architecture Overview</dt><dd>The scratchpad system consists of:</dd></dl>
|
|
<ul>
|
|
<li><b>AbstractScratchPad</b>: Base interface defining <code>is_initialized()</code> and <code>clone()</code></li>
|
|
<li><b>Concrete Scratchpads</b>: Engine-specific implementations<ul>
|
|
<li><code>GraphEngineScratchPad</code>: CppAD ADFun and Jacobian caches</li>
|
|
<li><code>AdaptiveEngineViewScratchPad</code>: Active species/reactions for adaptive networks</li>
|
|
<li><code>DefinedEngineViewScratchPad</code>: Species/reactions for static networks</li>
|
|
<li><code>MultiscalePartitioningEngineViewScratchPad</code>: QSE groups and SUNDIALS context</li>
|
|
</ul>
|
|
</li>
|
|
<li><b>StateBlob</b>: Container managing multiple scratchpads with type-safe access</li>
|
|
<li><b>Utilities</b>: Helper functions for exception-based retrieval</li>
|
|
<li><b>Formatters</b>: std::format specializations for debugging output</li>
|
|
</ul>
|
|
<dl class="section user"><dt>Why Use Scratchpads?</dt><dd>During numerical integration of stiff reaction networks, engines must:<ol type="1">
|
|
<li>Evaluate right-hand side functions (species derivatives)</li>
|
|
<li>Compute sparse Jacobian matrices</li>
|
|
<li>Solve linear systems within Newton iterations</li>
|
|
</ol>
|
|
</dd></dl>
|
|
<p>These operations require substantial temporary memory. Without scratchpads, each evaluation would allocate and deallocate working buffers, causing:</p><ul>
|
|
<li>Memory fragmentation</li>
|
|
<li>Cache thrashing</li>
|
|
<li>Unnecessary allocation overhead</li>
|
|
</ul>
|
|
<p>Scratchpads solve this by providing persistent, reusable working memory that lives for the duration of an integration step (or longer).</p>
|
|
<dl class="section user"><dt>Thread Safety Model</dt><dd>The scratchpad system is designed for thread-local usage:</dd></dl>
|
|
<ul>
|
|
<li>Scratchpads are <b>not thread-safe</b> by design</li>
|
|
<li>Each thread must have its own scratchpad instances</li>
|
|
<li>Use <code>StateBlob::clone_structure()</code> to create independent copies for workers</li>
|
|
<li>The original scratchpad/blob remains usable by the main thread</li>
|
|
</ul>
|
|
<dl class="section user"><dt>Examples</dt><dd><div class="fragment"><div class="line"><span class="preprocessor">#include "<a class="code" href="scratchpads_8h.html">gridfire/engine/scratchpads/scratchpads.h</a>"</span></div>
|
|
<div class="line"> </div>
|
|
<div class="line"><span class="keyword">using namespace </span><a class="code hl_namespace" href="namespacegridfire_1_1engine_1_1scratch.html">gridfire::engine::scratch</a>;</div>
|
|
<div class="line"> </div>
|
|
<div class="line"><span class="comment">// === Basic Usage ===</span></div>
|
|
<div class="line"><span class="comment">// Create a StateBlob and enroll scratchpads</span></div>
|
|
<div class="line"><a class="code hl_class" href="classgridfire_1_1engine_1_1scratch_1_1_state_blob.html">StateBlob</a> blob;</div>
|
|
<div class="line">blob.<a class="code hl_function" href="classgridfire_1_1engine_1_1scratch_1_1_state_blob.html#aa06d7bb89e67c4b6fd584d8f32a251bf">enroll</a><<a class="code hl_struct" href="structgridfire_1_1engine_1_1scratch_1_1_graph_engine_scratch_pad.html">GraphEngineScratchPad</a>>();</div>
|
|
<div class="line">blob.<a class="code hl_function" href="classgridfire_1_1engine_1_1scratch_1_1_state_blob.html#aa06d7bb89e67c4b6fd584d8f32a251bf">enroll</a><<a class="code hl_struct" href="structgridfire_1_1engine_1_1scratch_1_1_adaptive_engine_view_scratch_pad.html">AdaptiveEngineViewScratchPad</a>>();</div>
|
|
<div class="line"> </div>
|
|
<div class="line"><span class="comment">// Initialize scratchpads</span></div>
|
|
<div class="line"><span class="keyword">auto</span>* graph_scratch = <a class="code hl_function" href="namespacegridfire_1_1engine_1_1scratch.html#ab8f89f710094bfc93b84e26c818249b9">get_state<GraphEngineScratchPad></a>(blob);</div>
|
|
<div class="line">graph_scratch-><a class="code hl_function" href="structgridfire_1_1engine_1_1scratch_1_1_adaptive_engine_view_scratch_pad.html#a8fc25bac8529777504a206fc9fa2a5d6">initialize</a>(<a class="code hl_namespace" href="namespacegridfire_1_1engine.html">engine</a>);</div>
|
|
<div class="line"> </div>
|
|
<div class="line"><span class="comment">// Use initialized scratchpad</span></div>
|
|
<div class="line"><span class="keyword">auto</span>* <a class="code hl_namespace" href="namespacegridfire_1_1engine_1_1scratch.html">scratch</a> = <a class="code hl_function" href="namespacegridfire_1_1engine_1_1scratch.html#ab8f89f710094bfc93b84e26c818249b9">get_state<GraphEngineScratchPad, true></a>(blob); <span class="comment">// Throws if not initialized</span></div>
|
|
<div class="line"><span class="keyword">auto</span>& adfun = <a class="code hl_namespace" href="namespacegridfire_1_1engine_1_1scratch.html">scratch</a>->rhsADFun.value();</div>
|
|
<div class="line"> </div>
|
|
<div class="line"><span class="comment">// === Parallel Execution ===</span></div>
|
|
<div class="line"><span class="comment">// Clone for worker threads</span></div>
|
|
<div class="line">std::vector<std::unique_ptr<StateBlob>> worker_blobs;</div>
|
|
<div class="line"><span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i < num_threads; ++i) {</div>
|
|
<div class="line"> worker_blobs.push_back(blob.<a class="code hl_function" href="classgridfire_1_1engine_1_1scratch_1_1_state_blob.html#aa45357f0c368d7403306452c5ea56af0">clone_structure</a>());</div>
|
|
<div class="line">}</div>
|
|
<div class="line"> </div>
|
|
<div class="line"><span class="comment">// Each worker uses its own blob</span></div>
|
|
<div class="line"><span class="preprocessor">#pragma omp parallel for</span></div>
|
|
<div class="line"><span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i < work_items; ++i) {</div>
|
|
<div class="line"> <span class="keywordtype">int</span> tid = omp_get_thread_num();</div>
|
|
<div class="line"> <a class="code hl_class" href="classgridfire_1_1engine_1_1scratch_1_1_state_blob.html">StateBlob</a>& my_blob = *worker_blobs[tid];</div>
|
|
<div class="line"> <span class="keyword">auto</span>* my_scratch = <a class="code hl_function" href="namespacegridfire_1_1engine_1_1scratch.html#ab8f89f710094bfc93b84e26c818249b9">get_state<GraphEngineScratchPad></a>(my_blob);</div>
|
|
<div class="line"> <span class="comment">// Thread-safe: each thread has its own scratchpad</span></div>
|
|
<div class="line"> compute_with_scratchpad(*my_scratch);</div>
|
|
<div class="line">}</div>
|
|
<div class="line"> </div>
|
|
<div class="line"><span class="comment">// === Debugging ===</span></div>
|
|
<div class="line"><span class="comment">// Use formatters for logging</span></div>
|
|
<div class="line">std::cout << std::format(<span class="stringliteral">"Blob state: {}\n"</span>, blob);</div>
|
|
<div class="line"><span class="comment">// Output: StateBlob(Enrolled: GraphEngineScratchPad(...), AdaptiveEngineViewScratchPad(...))</span></div>
|
|
<div class="line"> </div>
|
|
<div class="line"><span class="comment">// Check status</span></div>
|
|
<div class="line"><span class="keyword">auto</span> status = blob.<a class="code hl_function" href="classgridfire_1_1engine_1_1scratch_1_1_state_blob.html#a1633fec8fc3592bdf954ee1603f5e2a8">get_status</a><<a class="code hl_struct" href="structgridfire_1_1engine_1_1scratch_1_1_graph_engine_scratch_pad.html">GraphEngineScratchPad</a>>();</div>
|
|
<div class="line"><span class="keywordflow">if</span> (status == <a class="code hl_enumvalue" href="classgridfire_1_1engine_1_1scratch_1_1_state_blob.html#a8c998621c476665e812be930664286e6ad6d348ab4faddf5de5ec5aa302695ab5">StateBlob::ScratchPadStatus::ENROLLED_NOT_INITIALIZED</a>) {</div>
|
|
<div class="line"> <span class="comment">// Need to initialize before use</span></div>
|
|
<div class="line">}</div>
|
|
<div class="ttc" id="aclassgridfire_1_1engine_1_1scratch_1_1_state_blob_html"><div class="ttname"><a href="classgridfire_1_1engine_1_1scratch_1_1_state_blob.html">gridfire::engine::scratch::StateBlob</a></div><div class="ttdoc">Container for managing a collection of typed scratchpad instances.</div><div class="ttdef"><b>Definition</b> blob.h:114</div></div>
|
|
<div class="ttc" id="aclassgridfire_1_1engine_1_1scratch_1_1_state_blob_html_a1633fec8fc3592bdf954ee1603f5e2a8"><div class="ttname"><a href="classgridfire_1_1engine_1_1scratch_1_1_state_blob.html#a1633fec8fc3592bdf954ee1603f5e2a8">gridfire::engine::scratch::StateBlob::get_status</a></div><div class="ttdeci">ScratchPadStatus get_status() const</div><div class="ttdoc">Get the status of a specific scratchpad type.</div><div class="ttdef"><b>Definition</b> blob.h:445</div></div>
|
|
<div class="ttc" id="aclassgridfire_1_1engine_1_1scratch_1_1_state_blob_html_a8c998621c476665e812be930664286e6ad6d348ab4faddf5de5ec5aa302695ab5"><div class="ttname"><a href="classgridfire_1_1engine_1_1scratch_1_1_state_blob.html#a8c998621c476665e812be930664286e6ad6d348ab4faddf5de5ec5aa302695ab5">gridfire::engine::scratch::StateBlob::ScratchPadStatus::ENROLLED_NOT_INITIALIZED</a></div><div class="ttdeci">@ ENROLLED_NOT_INITIALIZED</div><div class="ttdoc">Scratchpad enrolled but not yet initialized.</div><div class="ttdef"><b>Definition</b> blob.h:164</div></div>
|
|
<div class="ttc" id="aclassgridfire_1_1engine_1_1scratch_1_1_state_blob_html_aa06d7bb89e67c4b6fd584d8f32a251bf"><div class="ttname"><a href="classgridfire_1_1engine_1_1scratch_1_1_state_blob.html#aa06d7bb89e67c4b6fd584d8f32a251bf">gridfire::engine::scratch::StateBlob::enroll</a></div><div class="ttdeci">void enroll()</div><div class="ttdoc">Enroll a new scratchpad type into the blob.</div><div class="ttdef"><b>Definition</b> blob.h:196</div></div>
|
|
<div class="ttc" id="aclassgridfire_1_1engine_1_1scratch_1_1_state_blob_html_aa45357f0c368d7403306452c5ea56af0"><div class="ttname"><a href="classgridfire_1_1engine_1_1scratch_1_1_state_blob.html#aa45357f0c368d7403306452c5ea56af0">gridfire::engine::scratch::StateBlob::clone_structure</a></div><div class="ttdeci">std::unique_ptr< StateBlob > clone_structure() const</div><div class="ttdoc">Create a deep copy of this blob with all enrolled scratchpads.</div><div class="ttdef"><b>Definition</b> blob.h:361</div></div>
|
|
<div class="ttc" id="anamespacegridfire_1_1engine_1_1scratch_html"><div class="ttname"><a href="namespacegridfire_1_1engine_1_1scratch.html">gridfire::engine::scratch</a></div><div class="ttdoc">Scratchpad memory management for computational engines.</div><div class="ttdef"><b>Definition</b> blob.h:69</div></div>
|
|
<div class="ttc" id="anamespacegridfire_1_1engine_1_1scratch_html_ab8f89f710094bfc93b84e26c818249b9"><div class="ttname"><a href="namespacegridfire_1_1engine_1_1scratch.html#ab8f89f710094bfc93b84e26c818249b9">gridfire::engine::scratch::get_state</a></div><div class="ttdeci">CTX * get_state(StateBlob &ctx)</div><div class="ttdoc">Retrieve a scratchpad from a StateBlob, throwing on error.</div><div class="ttdef"><b>Definition</b> utils.h:84</div></div>
|
|
<div class="ttc" id="anamespacegridfire_1_1engine_html"><div class="ttname"><a href="namespacegridfire_1_1engine.html">gridfire::engine</a></div><div class="ttdef"><b>Definition</b> dynamic_engine_diagnostics.h:39</div></div>
|
|
<div class="ttc" id="ascratchpads_8h_html"><div class="ttname"><a href="scratchpads_8h.html">scratchpads.h</a></div><div class="ttdoc">Unified header for the scratchpad memory management system.</div></div>
|
|
<div class="ttc" id="astructgridfire_1_1engine_1_1scratch_1_1_adaptive_engine_view_scratch_pad_html"><div class="ttname"><a href="structgridfire_1_1engine_1_1scratch_1_1_adaptive_engine_view_scratch_pad.html">gridfire::engine::scratch::AdaptiveEngineViewScratchPad</a></div><div class="ttdoc">Scratchpad for storing working memory used by AdaptiveEngineView computations.</div><div class="ttdef"><b>Definition</b> engine_adaptive_scratchpad.h:66</div></div>
|
|
<div class="ttc" id="astructgridfire_1_1engine_1_1scratch_1_1_adaptive_engine_view_scratch_pad_html_a8fc25bac8529777504a206fc9fa2a5d6"><div class="ttname"><a href="structgridfire_1_1engine_1_1scratch_1_1_adaptive_engine_view_scratch_pad.html#a8fc25bac8529777504a206fc9fa2a5d6">gridfire::engine::scratch::AdaptiveEngineViewScratchPad::initialize</a></div><div class="ttdeci">void initialize(const AdaptiveEngineView &engine)</div><div class="ttdoc">Initialize the scratchpad from an AdaptiveEngineView.</div><div class="ttdef"><b>Definition</b> engine_adaptive_scratchpad.h:102</div></div>
|
|
<div class="ttc" id="astructgridfire_1_1engine_1_1scratch_1_1_graph_engine_scratch_pad_html"><div class="ttname"><a href="structgridfire_1_1engine_1_1scratch_1_1_graph_engine_scratch_pad.html">gridfire::engine::scratch::GraphEngineScratchPad</a></div><div class="ttdoc">Scratchpad for storing CppAD automatic differentiation state for GraphEngine.</div><div class="ttdef"><b>Definition</b> engine_graph_scratchpad.h:83</div></div>
|
|
</div><!-- fragment --></dd></dl>
|
|
<dl class="section user"><dt>Included Headers</dt><dd>This header includes:<ul>
|
|
<li><a class="el" href="scratchpad__abstract_8h.html" title="Abstract base class for scratchpad memory used during engine computations.">scratchpad_abstract.h</a> - AbstractScratchPad base class</li>
|
|
<li><a class="el" href="engine__graph__scratchpad_8h.html" title="Scratchpad implementation for the GraphEngine using CppAD automatic differentiation.">engine_graph_scratchpad.h</a> - GraphEngineScratchPad</li>
|
|
<li><a class="el" href="engine__adaptive__scratchpad_8h.html" title="Scratchpad implementation for the AdaptiveEngineView.">engine_adaptive_scratchpad.h</a> - AdaptiveEngineViewScratchPad</li>
|
|
<li><a class="el" href="engine__multiscale__scratchpad_8h.html" title="Scratchpad implementation for the MultiscalePartitioningEngineView.">engine_multiscale_scratchpad.h</a> - MultiscalePartitioningEngineViewScratchPad</li>
|
|
<li><a class="el" href="engine__defined__scratchpad_8h.html" title="Scratchpad implementation for the DefinedEngineView.">engine_defined_scratchpad.h</a> - DefinedEngineViewScratchPad</li>
|
|
<li>types.h - ScratchPadType enumeration</li>
|
|
<li><a class="el" href="blob_8h.html" title="Container class for managing multiple scratchpad instances.">blob.h</a> - StateBlob container</li>
|
|
<li>utils.h - get_state() helper functions</li>
|
|
<li>formatters.h - std::format specializations</li>
|
|
</ul>
|
|
</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd>AbstractScratchPad </dd>
|
|
<dd>
|
|
StateBlob </dd>
|
|
<dd>
|
|
ScratchPadType </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="scratchpads_8h.html">scratchpads.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>
|