tboudreaux/GridFire
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
1500f863b6be1d2a2f2c696e3fac74fb34d04744
GridFire/docs/html/classgridfire_1_1trigger_1_1_trigger.html
Emily Boudreaux d7237e7367 docs(docs): rebuilt
2025-11-06 09:16:40 -05:00

520 lines
40 KiB
HTML
Raw Blame History

<!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::trigger::Trigger&lt; TriggerContextStruct &gt; Class Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome-sidebar-only.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">GridFire<span id="projectnumber">&#160;v0.7.0-alpha</span>
</div>
<div id="projectbrief">General Purpose Nuclear Network</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.13.2 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search',true);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('classgridfire_1_1trigger_1_1_trigger.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> &#124;
<a href="classgridfire_1_1trigger_1_1_trigger-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">gridfire::trigger::Trigger&lt; TriggerContextStruct &gt; Class Template Reference<span class="mlabels"><span class="mlabel abstract">abstract</span></span></div></div>
</div><!--header-->
<div class="contents">
<p>Generic trigger interface for signaling events/conditions during integration.
<a href="#details">More...</a></p>
<p><code>#include &lt;trigger_abstract.h&gt;</code></p>
<div class="dynheader">
Inheritance diagram for gridfire::trigger::Trigger&lt; TriggerContextStruct &gt;:</div>
<div class="dyncontent">
<div class="center"><div class="zoom"><iframe scrolling="no" frameborder="0" src="classgridfire_1_1trigger_1_1_trigger__inherit__graph.svg" width="100%" height="518"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div></div>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></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:a2c077ccbaf4de9f7068e50144391edda" id="r_a2c077ccbaf4de9f7068e50144391edda"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a2c077ccbaf4de9f7068e50144391edda">~Trigger</a> ()=default</td></tr>
<tr class="memdesc:a2c077ccbaf4de9f7068e50144391edda"><td class="mdescLeft">&#160;</td><td class="mdescRight">Virtual destructor for polymorphic use. <br /></td></tr>
<tr class="separator:a2c077ccbaf4de9f7068e50144391edda"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1579ffb1c841cda4e67990b42d400d88" id="r_a1579ffb1c841cda4e67990b42d400d88"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a1579ffb1c841cda4e67990b42d400d88">check</a> (const TriggerContextStruct &amp;ctx) const =0</td></tr>
<tr class="memdesc:a1579ffb1c841cda4e67990b42d400d88"><td class="mdescLeft">&#160;</td><td class="mdescRight">Evaluate the trigger condition against the provided context. <br /></td></tr>
<tr class="separator:a1579ffb1c841cda4e67990b42d400d88"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a048899795704f68668960454d118a6fc" id="r_a048899795704f68668960454d118a6fc"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a048899795704f68668960454d118a6fc">update</a> (const TriggerContextStruct &amp;ctx)=0</td></tr>
<tr class="memdesc:a048899795704f68668960454d118a6fc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Update any internal state with the given context (e.g., counters, windows). <br /></td></tr>
<tr class="separator:a048899795704f68668960454d118a6fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4b7ffa4d8d31e2118a8e86172be51041" id="r_a4b7ffa4d8d31e2118a8e86172be51041"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4b7ffa4d8d31e2118a8e86172be51041">step</a> (const TriggerContextStruct &amp;ctx)=0</td></tr>
<tr class="memdesc:a4b7ffa4d8d31e2118a8e86172be51041"><td class="mdescLeft">&#160;</td><td class="mdescRight">similar to update but intended to be run on every step not just those where the trigger triggered <br /></td></tr>
<tr class="separator:a4b7ffa4d8d31e2118a8e86172be51041"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af652af761675736419b961b6946c728d" id="r_af652af761675736419b961b6946c728d"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af652af761675736419b961b6946c728d">reset</a> ()=0</td></tr>
<tr class="memdesc:af652af761675736419b961b6946c728d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reset internal state and diagnostics counters. <br /></td></tr>
<tr class="separator:af652af761675736419b961b6946c728d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3e5b017147f22ca0733733cd39e334b7" id="r_a3e5b017147f22ca0733733cd39e334b7"><td class="memItemLeft" align="right" valign="top">virtual std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a3e5b017147f22ca0733733cd39e334b7">name</a> () const =0</td></tr>
<tr class="memdesc:a3e5b017147f22ca0733733cd39e334b7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Short, stable name for this trigger (suitable for logs/UI). <br /></td></tr>
<tr class="separator:a3e5b017147f22ca0733733cd39e334b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a402cdd062e9479abbcca02e3d94e528f" id="r_a402cdd062e9479abbcca02e3d94e528f"><td class="memItemLeft" align="right" valign="top">virtual std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a402cdd062e9479abbcca02e3d94e528f">describe</a> () const =0</td></tr>
<tr class="memdesc:a402cdd062e9479abbcca02e3d94e528f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Human-readable description of this trigger's logic. <br /></td></tr>
<tr class="separator:a402cdd062e9479abbcca02e3d94e528f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9f020d828ca36a601b780566cc3377ea" id="r_a9f020d828ca36a601b780566cc3377ea"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="structgridfire_1_1trigger_1_1_trigger_result.html">TriggerResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a9f020d828ca36a601b780566cc3377ea">why</a> (const TriggerContextStruct &amp;ctx) const =0</td></tr>
<tr class="memdesc:a9f020d828ca36a601b780566cc3377ea"><td class="mdescLeft">&#160;</td><td class="mdescRight">Explain why the last evaluation would be true/false in a structured way. <br /></td></tr>
<tr class="separator:a9f020d828ca36a601b780566cc3377ea"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4ea3abfb76a09c4f55ad05d73a2cf12d" id="r_a4ea3abfb76a09c4f55ad05d73a2cf12d"><td class="memItemLeft" align="right" valign="top">virtual size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4ea3abfb76a09c4f55ad05d73a2cf12d">numTriggers</a> () const =0</td></tr>
<tr class="memdesc:a4ea3abfb76a09c4f55ad05d73a2cf12d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Total number of times this trigger evaluated to true since last reset. <br /></td></tr>
<tr class="separator:a4ea3abfb76a09c4f55ad05d73a2cf12d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a81848e5af844795d879b6d885a2701d7" id="r_a81848e5af844795d879b6d885a2701d7"><td class="memItemLeft" align="right" valign="top">virtual size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a81848e5af844795d879b6d885a2701d7">numMisses</a> () const =0</td></tr>
<tr class="memdesc:a81848e5af844795d879b6d885a2701d7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Total number of times this trigger evaluated to false since last reset. <br /></td></tr>
<tr class="separator:a81848e5af844795d879b6d885a2701d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><div class="compoundTemplParams">template&lt;typename TriggerContextStruct&gt;<br />
class gridfire::trigger::Trigger&lt; TriggerContextStruct &gt;</div><p>Generic trigger interface for signaling events/conditions during integration. </p>
<p>A <a class="el" href="classgridfire_1_1trigger_1_1_trigger.html" title="Generic trigger interface for signaling events/conditions during integration.">Trigger</a> encapsulates a condition evaluated against a user-defined context struct (TriggerContextStruct). The interface supports:</p><ul>
<li><a class="el" href="#a1579ffb1c841cda4e67990b42d400d88" title="Evaluate the trigger condition against the provided context.">check()</a>: evaluate the current condition without mutating external state</li>
<li><a class="el" href="#a048899795704f68668960454d118a6fc" title="Update any internal state with the given context (e.g., counters, windows).">update()</a>: feed the context to update internal state (counters, sliding windows, etc.)</li>
<li><a class="el" href="#af652af761675736419b961b6946c728d" title="Reset internal state and diagnostics counters.">reset()</a>: clear internal state and counters</li>
<li><a class="el" href="#a3e5b017147f22ca0733733cd39e334b7" title="Short, stable name for this trigger (suitable for logs/UI).">name()</a>/describe(): human-readable identification and textual description</li>
<li><a class="el" href="#a9f020d828ca36a601b780566cc3377ea" title="Explain why the last evaluation would be true/false in a structured way.">why()</a>: structured explanation (tree of <a class="el" href="structgridfire_1_1trigger_1_1_trigger_result.html">TriggerResult</a>) of the last evaluation</li>
<li><a class="el" href="#a4ea3abfb76a09c4f55ad05d73a2cf12d" title="Total number of times this trigger evaluated to true since last reset.">numTriggers()</a>/numMisses(): simple counters for diagnostics</li>
</ul>
<p>Logical compositions (AND/OR/NOT/EveryNth) are provided in <a class="el" href="trigger__logical_8h.html" title="Combinators for composing triggers with boolean logic (AND/OR/NOT/EveryNth).">trigger_logical.h</a> and implement this interface for any TriggerContextStruct.</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">TriggerContextStruct</td><td>User-defined context passed to triggers (e.g., timestep info). </td></tr>
</table>
</dd>
</dl>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a2c077ccbaf4de9f7068e50144391edda" name="a2c077ccbaf4de9f7068e50144391edda"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2c077ccbaf4de9f7068e50144391edda">&#9670;&#160;</a></span>~Trigger()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TriggerContextStruct&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classgridfire_1_1trigger_1_1_trigger.html">gridfire::trigger::Trigger</a>&lt; TriggerContextStruct &gt;::~<a class="el" href="classgridfire_1_1trigger_1_1_trigger.html">Trigger</a> </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel virtual">virtual</span><span class="mlabel default">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Virtual destructor for polymorphic use. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a1579ffb1c841cda4e67990b42d400d88" name="a1579ffb1c841cda4e67990b42d400d88"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1579ffb1c841cda4e67990b42d400d88">&#9670;&#160;</a></span>check()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TriggerContextStruct&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool <a class="el" href="classgridfire_1_1trigger_1_1_trigger.html">gridfire::trigger::Trigger</a>&lt; TriggerContextStruct &gt;::check </td>
<td>(</td>
<td class="paramtype">const TriggerContextStruct &amp;</td> <td class="paramname"><span class="paramname"><em>ctx</em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel pure-virtual">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Evaluate the trigger condition against the provided context. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ctx</td><td>Context snapshot (immutable view) used to evaluate the condition. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if the condition is satisfied; false otherwise. </dd></dl>
<p>Implemented in <a class="el" href="classgridfire_1_1trigger_1_1_and_trigger.html#aaefdfa86856f9f7839b6a7fdffa4a579">gridfire::trigger::AndTrigger&lt; TriggerContextStruct &gt;</a>, <a class="el" href="classgridfire_1_1trigger_1_1_every_nth_trigger.html#a69fbb099f8d13d39602f58fa8aa8e7f2">gridfire::trigger::EveryNthTrigger&lt; TriggerContextStruct &gt;</a>, <a class="el" href="classgridfire_1_1trigger_1_1_not_trigger.html#ae453a72df20fdd416443ef7867f86b92">gridfire::trigger::NotTrigger&lt; TriggerContextStruct &gt;</a>, <a class="el" href="classgridfire_1_1trigger_1_1_or_trigger.html#ac8be54d91e77ed16ae3cca2417d82e0a">gridfire::trigger::OrTrigger&lt; TriggerContextStruct &gt;</a>, <a class="el" href="classgridfire_1_1trigger_1_1solver_1_1_c_v_o_d_e_1_1_convergence_failure_trigger.html#ae8765656a45319335c2bb90c3fb3d308">gridfire::trigger::solver::CVODE::ConvergenceFailureTrigger</a>, <a class="el" href="classgridfire_1_1trigger_1_1solver_1_1_c_v_o_d_e_1_1_off_diagonal_trigger.html#a3855b15459217383647ecdf12bc35775">gridfire::trigger::solver::CVODE::OffDiagonalTrigger</a>, <a class="el" href="classgridfire_1_1trigger_1_1solver_1_1_c_v_o_d_e_1_1_simulation_time_trigger.html#a50df7fefee167390522aa258fa6ee960">gridfire::trigger::solver::CVODE::SimulationTimeTrigger</a>, and <a class="el" href="classgridfire_1_1trigger_1_1solver_1_1_c_v_o_d_e_1_1_timestep_collapse_trigger.html#a04598611b0807cad395bdd2fbc41a6c2">gridfire::trigger::solver::CVODE::TimestepCollapseTrigger</a>.</p>
</div>
</div>
<a id="a402cdd062e9479abbcca02e3d94e528f" name="a402cdd062e9479abbcca02e3d94e528f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a402cdd062e9479abbcca02e3d94e528f">&#9670;&#160;</a></span>describe()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TriggerContextStruct&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual std::string <a class="el" href="classgridfire_1_1trigger_1_1_trigger.html">gridfire::trigger::Trigger</a>&lt; TriggerContextStruct &gt;::describe </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 nodiscard">nodiscard</span><span class="mlabel pure-virtual">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Human-readable description of this trigger's logic. </p>
<p>Implemented in <a class="el" href="classgridfire_1_1trigger_1_1_and_trigger.html#a2dcd635c6bdbcfe517adca6e2bd5c408">gridfire::trigger::AndTrigger&lt; TriggerContextStruct &gt;</a>, <a class="el" href="classgridfire_1_1trigger_1_1_every_nth_trigger.html#aab88715f3c94437ca7f3fcb1698c69de">gridfire::trigger::EveryNthTrigger&lt; TriggerContextStruct &gt;</a>, <a class="el" href="classgridfire_1_1trigger_1_1_not_trigger.html#ad8166350329db3e1f50954afbb311a35">gridfire::trigger::NotTrigger&lt; TriggerContextStruct &gt;</a>, <a class="el" href="classgridfire_1_1trigger_1_1_or_trigger.html#accb56630df2f57400467d315c61dede6">gridfire::trigger::OrTrigger&lt; TriggerContextStruct &gt;</a>, <a class="el" href="classgridfire_1_1trigger_1_1solver_1_1_c_v_o_d_e_1_1_convergence_failure_trigger.html#aa2bb19e4a1e24f6fd7f86d0c80ebbec3">gridfire::trigger::solver::CVODE::ConvergenceFailureTrigger</a>, <a class="el" href="classgridfire_1_1trigger_1_1solver_1_1_c_v_o_d_e_1_1_off_diagonal_trigger.html#ad0dd92f9da6c291c3bd57c0983940035">gridfire::trigger::solver::CVODE::OffDiagonalTrigger</a>, <a class="el" href="classgridfire_1_1trigger_1_1solver_1_1_c_v_o_d_e_1_1_simulation_time_trigger.html#a0f412b8f788ab7990e353d62ab7d9a16">gridfire::trigger::solver::CVODE::SimulationTimeTrigger</a>, and <a class="el" href="classgridfire_1_1trigger_1_1solver_1_1_c_v_o_d_e_1_1_timestep_collapse_trigger.html#a8ba5a942bb61347851030d1eb6bbaa74">gridfire::trigger::solver::CVODE::TimestepCollapseTrigger</a>.</p>
</div>
</div>
<a id="a3e5b017147f22ca0733733cd39e334b7" name="a3e5b017147f22ca0733733cd39e334b7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3e5b017147f22ca0733733cd39e334b7">&#9670;&#160;</a></span>name()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TriggerContextStruct&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual std::string <a class="el" href="classgridfire_1_1trigger_1_1_trigger.html">gridfire::trigger::Trigger</a>&lt; TriggerContextStruct &gt;::name </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 nodiscard">nodiscard</span><span class="mlabel pure-virtual">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Short, stable name for this trigger (suitable for logs/UI). </p>
<p>Implemented in <a class="el" href="classgridfire_1_1trigger_1_1_and_trigger.html#ab78539e5cd88194ab9e98434793eae3f">gridfire::trigger::AndTrigger&lt; TriggerContextStruct &gt;</a>, <a class="el" href="classgridfire_1_1trigger_1_1_every_nth_trigger.html#a4a834d24286f9204995bf78fb69f35dc">gridfire::trigger::EveryNthTrigger&lt; TriggerContextStruct &gt;</a>, <a class="el" href="classgridfire_1_1trigger_1_1_not_trigger.html#acc3bd2938f7746997fb1d255681d8b20">gridfire::trigger::NotTrigger&lt; TriggerContextStruct &gt;</a>, <a class="el" href="classgridfire_1_1trigger_1_1_or_trigger.html#a062af4f567dc48c088f1fcfb64cc79ec">gridfire::trigger::OrTrigger&lt; TriggerContextStruct &gt;</a>, <a class="el" href="classgridfire_1_1trigger_1_1solver_1_1_c_v_o_d_e_1_1_convergence_failure_trigger.html#a92a57cea3b58bd7948c3c3fb4f75619b">gridfire::trigger::solver::CVODE::ConvergenceFailureTrigger</a>, <a class="el" href="classgridfire_1_1trigger_1_1solver_1_1_c_v_o_d_e_1_1_off_diagonal_trigger.html#a594893c029f044be3119118808470f7a">gridfire::trigger::solver::CVODE::OffDiagonalTrigger</a>, <a class="el" href="classgridfire_1_1trigger_1_1solver_1_1_c_v_o_d_e_1_1_simulation_time_trigger.html#a87fc9fe6bd8762f148c858452ec30043">gridfire::trigger::solver::CVODE::SimulationTimeTrigger</a>, and <a class="el" href="classgridfire_1_1trigger_1_1solver_1_1_c_v_o_d_e_1_1_timestep_collapse_trigger.html#a290e5643eea08726d2fd44a1cd5617d0">gridfire::trigger::solver::CVODE::TimestepCollapseTrigger</a>.</p>
</div>
</div>
<a id="a81848e5af844795d879b6d885a2701d7" name="a81848e5af844795d879b6d885a2701d7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a81848e5af844795d879b6d885a2701d7">&#9670;&#160;</a></span>numMisses()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TriggerContextStruct&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual size_t <a class="el" href="classgridfire_1_1trigger_1_1_trigger.html">gridfire::trigger::Trigger</a>&lt; TriggerContextStruct &gt;::numMisses </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 nodiscard">nodiscard</span><span class="mlabel pure-virtual">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Total number of times this trigger evaluated to false since last reset. </p>
<p>Implemented in <a class="el" href="classgridfire_1_1trigger_1_1_and_trigger.html#addfd61f8cb234881f535fb8f4d618d74">gridfire::trigger::AndTrigger&lt; TriggerContextStruct &gt;</a>, <a class="el" href="classgridfire_1_1trigger_1_1_every_nth_trigger.html#ae7776f4a526db3245e64a74a3b0172d3">gridfire::trigger::EveryNthTrigger&lt; TriggerContextStruct &gt;</a>, <a class="el" href="classgridfire_1_1trigger_1_1_not_trigger.html#a2f9b0d6a6ac54f6371c5a208c06826ea">gridfire::trigger::NotTrigger&lt; TriggerContextStruct &gt;</a>, <a class="el" href="classgridfire_1_1trigger_1_1_or_trigger.html#a0b3a7f45604dbb27e832d9559dd20997">gridfire::trigger::OrTrigger&lt; TriggerContextStruct &gt;</a>, <a class="el" href="classgridfire_1_1trigger_1_1solver_1_1_c_v_o_d_e_1_1_convergence_failure_trigger.html#aa26bf911c73b7f2ec343d473caf13718">gridfire::trigger::solver::CVODE::ConvergenceFailureTrigger</a>, <a class="el" href="classgridfire_1_1trigger_1_1solver_1_1_c_v_o_d_e_1_1_off_diagonal_trigger.html#a0e1ad148f9f3232992a4b16e440c249a">gridfire::trigger::solver::CVODE::OffDiagonalTrigger</a>, <a class="el" href="classgridfire_1_1trigger_1_1solver_1_1_c_v_o_d_e_1_1_simulation_time_trigger.html#a273eb8a3e80d1235d2b3f252e55c5b50">gridfire::trigger::solver::CVODE::SimulationTimeTrigger</a>, and <a class="el" href="classgridfire_1_1trigger_1_1solver_1_1_c_v_o_d_e_1_1_timestep_collapse_trigger.html#a94bb1de08a5ff55e1874f595f8c8965c">gridfire::trigger::solver::CVODE::TimestepCollapseTrigger</a>.</p>
</div>
</div>
<a id="a4ea3abfb76a09c4f55ad05d73a2cf12d" name="a4ea3abfb76a09c4f55ad05d73a2cf12d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4ea3abfb76a09c4f55ad05d73a2cf12d">&#9670;&#160;</a></span>numTriggers()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TriggerContextStruct&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual size_t <a class="el" href="classgridfire_1_1trigger_1_1_trigger.html">gridfire::trigger::Trigger</a>&lt; TriggerContextStruct &gt;::numTriggers </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 nodiscard">nodiscard</span><span class="mlabel pure-virtual">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Total number of times this trigger evaluated to true since last reset. </p>
<p>Implemented in <a class="el" href="classgridfire_1_1trigger_1_1_and_trigger.html#afffb4281569963183d7db3ed1568eb3a">gridfire::trigger::AndTrigger&lt; TriggerContextStruct &gt;</a>, <a class="el" href="classgridfire_1_1trigger_1_1_every_nth_trigger.html#a7e5568c9d7799b7f80ad0d3efe2cd143">gridfire::trigger::EveryNthTrigger&lt; TriggerContextStruct &gt;</a>, <a class="el" href="classgridfire_1_1trigger_1_1_not_trigger.html#ae2d27d72af9e1fbf711a58e4583b43a3">gridfire::trigger::NotTrigger&lt; TriggerContextStruct &gt;</a>, <a class="el" href="classgridfire_1_1trigger_1_1_or_trigger.html#afc7d3eae8306ee383d76997ac3803327">gridfire::trigger::OrTrigger&lt; TriggerContextStruct &gt;</a>, <a class="el" href="classgridfire_1_1trigger_1_1solver_1_1_c_v_o_d_e_1_1_convergence_failure_trigger.html#aa7cc311316539b2d348422ba907dc64e">gridfire::trigger::solver::CVODE::ConvergenceFailureTrigger</a>, <a class="el" href="classgridfire_1_1trigger_1_1solver_1_1_c_v_o_d_e_1_1_off_diagonal_trigger.html#a32980aaf6d9c7632c024b4b74b1d9e70">gridfire::trigger::solver::CVODE::OffDiagonalTrigger</a>, <a class="el" href="classgridfire_1_1trigger_1_1solver_1_1_c_v_o_d_e_1_1_simulation_time_trigger.html#a34d285584ea96f71b99eefad8c738296">gridfire::trigger::solver::CVODE::SimulationTimeTrigger</a>, and <a class="el" href="classgridfire_1_1trigger_1_1solver_1_1_c_v_o_d_e_1_1_timestep_collapse_trigger.html#ad2a7c2567b100f97a024f65818ecefed">gridfire::trigger::solver::CVODE::TimestepCollapseTrigger</a>.</p>
</div>
</div>
<a id="af652af761675736419b961b6946c728d" name="af652af761675736419b961b6946c728d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af652af761675736419b961b6946c728d">&#9670;&#160;</a></span>reset()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TriggerContextStruct&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void <a class="el" href="classgridfire_1_1trigger_1_1_trigger.html">gridfire::trigger::Trigger</a>&lt; TriggerContextStruct &gt;::reset </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel pure-virtual">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reset internal state and diagnostics counters. </p>
<p>Implemented in <a class="el" href="classgridfire_1_1trigger_1_1_and_trigger.html#a2436d8643911ade907e03fb29531ceaa">gridfire::trigger::AndTrigger&lt; TriggerContextStruct &gt;</a>, <a class="el" href="classgridfire_1_1trigger_1_1_every_nth_trigger.html#abf218d255bde157540b51cd6a54f6eb1">gridfire::trigger::EveryNthTrigger&lt; TriggerContextStruct &gt;</a>, <a class="el" href="classgridfire_1_1trigger_1_1_not_trigger.html#afe337517b77e5433d92ded3a64565141">gridfire::trigger::NotTrigger&lt; TriggerContextStruct &gt;</a>, <a class="el" href="classgridfire_1_1trigger_1_1_or_trigger.html#ab42043e55c81bac5d3f981bc139579de">gridfire::trigger::OrTrigger&lt; TriggerContextStruct &gt;</a>, <a class="el" href="classgridfire_1_1trigger_1_1solver_1_1_c_v_o_d_e_1_1_convergence_failure_trigger.html#a0bcab0247b3db618b76bd6769cf9a2ea">gridfire::trigger::solver::CVODE::ConvergenceFailureTrigger</a>, <a class="el" href="classgridfire_1_1trigger_1_1solver_1_1_c_v_o_d_e_1_1_off_diagonal_trigger.html#a9b782cbf033ed2023da6b2d55dcefc4e">gridfire::trigger::solver::CVODE::OffDiagonalTrigger</a>, <a class="el" href="classgridfire_1_1trigger_1_1solver_1_1_c_v_o_d_e_1_1_simulation_time_trigger.html#af4034fa431e6c88fd05c50cce31b2fa0">gridfire::trigger::solver::CVODE::SimulationTimeTrigger</a>, and <a class="el" href="classgridfire_1_1trigger_1_1solver_1_1_c_v_o_d_e_1_1_timestep_collapse_trigger.html#a0fe6af73b11b820561bd4e5552890d4e">gridfire::trigger::solver::CVODE::TimestepCollapseTrigger</a>.</p>
</div>
</div>
<a id="a4b7ffa4d8d31e2118a8e86172be51041" name="a4b7ffa4d8d31e2118a8e86172be51041"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4b7ffa4d8d31e2118a8e86172be51041">&#9670;&#160;</a></span>step()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TriggerContextStruct&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void <a class="el" href="classgridfire_1_1trigger_1_1_trigger.html">gridfire::trigger::Trigger</a>&lt; TriggerContextStruct &gt;::step </td>
<td>(</td>
<td class="paramtype">const TriggerContextStruct &amp;</td> <td class="paramname"><span class="paramname"><em>ctx</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel pure-virtual">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>similar to update but intended to be run on every step not just those where the trigger triggered </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ctx</td><td>Context snapshot used to update state. </td></tr>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="classgridfire_1_1trigger_1_1_and_trigger.html#a8e743e8ebe71f9ded835177db6fad908">gridfire::trigger::AndTrigger&lt; TriggerContextStruct &gt;</a>, <a class="el" href="classgridfire_1_1trigger_1_1_every_nth_trigger.html#a26d0aca39087a1f69e96e0701ca83f81">gridfire::trigger::EveryNthTrigger&lt; TriggerContextStruct &gt;</a>, <a class="el" href="classgridfire_1_1trigger_1_1_not_trigger.html#a5096cb7e70ea357f28e1b9fc8301c793">gridfire::trigger::NotTrigger&lt; TriggerContextStruct &gt;</a>, <a class="el" href="classgridfire_1_1trigger_1_1_or_trigger.html#a95a801aafb5aaa9a22566ebf722a1150">gridfire::trigger::OrTrigger&lt; TriggerContextStruct &gt;</a>, <a class="el" href="classgridfire_1_1trigger_1_1solver_1_1_c_v_o_d_e_1_1_convergence_failure_trigger.html#aaef2090ed67a7c27967821f75a61e524">gridfire::trigger::solver::CVODE::ConvergenceFailureTrigger</a>, <a class="el" href="classgridfire_1_1trigger_1_1solver_1_1_c_v_o_d_e_1_1_off_diagonal_trigger.html#a8b882c6ba6e267d7051031140bbb7ad6">gridfire::trigger::solver::CVODE::OffDiagonalTrigger</a>, <a class="el" href="classgridfire_1_1trigger_1_1solver_1_1_c_v_o_d_e_1_1_simulation_time_trigger.html#aafc7f40bde2c78f4d100b6f9da771831">gridfire::trigger::solver::CVODE::SimulationTimeTrigger</a>, and <a class="el" href="classgridfire_1_1trigger_1_1solver_1_1_c_v_o_d_e_1_1_timestep_collapse_trigger.html#a9723e389aeba05fdb3d4fd1dcc1ba07d">gridfire::trigger::solver::CVODE::TimestepCollapseTrigger</a>.</p>
</div>
</div>
<a id="a048899795704f68668960454d118a6fc" name="a048899795704f68668960454d118a6fc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a048899795704f68668960454d118a6fc">&#9670;&#160;</a></span>update()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TriggerContextStruct&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void <a class="el" href="classgridfire_1_1trigger_1_1_trigger.html">gridfire::trigger::Trigger</a>&lt; TriggerContextStruct &gt;::update </td>
<td>(</td>
<td class="paramtype">const TriggerContextStruct &amp;</td> <td class="paramname"><span class="paramname"><em>ctx</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel pure-virtual">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Update any internal state with the given context (e.g., counters, windows). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ctx</td><td>Context snapshot used to update state. </td></tr>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="classgridfire_1_1trigger_1_1_and_trigger.html#a62f7dbbcf0554caa68e3d778580b3c1d">gridfire::trigger::AndTrigger&lt; TriggerContextStruct &gt;</a>, <a class="el" href="classgridfire_1_1trigger_1_1_every_nth_trigger.html#a0dd783afab7ef6005f0241f9de7b31f6">gridfire::trigger::EveryNthTrigger&lt; TriggerContextStruct &gt;</a>, <a class="el" href="classgridfire_1_1trigger_1_1_not_trigger.html#a846432abf33c7602af0fbb5475c0ad32">gridfire::trigger::NotTrigger&lt; TriggerContextStruct &gt;</a>, <a class="el" href="classgridfire_1_1trigger_1_1_or_trigger.html#a775dac97d109c5fcd5c0287ca98f308c">gridfire::trigger::OrTrigger&lt; TriggerContextStruct &gt;</a>, <a class="el" href="classgridfire_1_1trigger_1_1solver_1_1_c_v_o_d_e_1_1_convergence_failure_trigger.html#ae47bbdf6edae798f30866c1ac4104cc1">gridfire::trigger::solver::CVODE::ConvergenceFailureTrigger</a>, <a class="el" href="classgridfire_1_1trigger_1_1solver_1_1_c_v_o_d_e_1_1_off_diagonal_trigger.html#a179cb09a91d5c638d7a347137b208767">gridfire::trigger::solver::CVODE::OffDiagonalTrigger</a>, <a class="el" href="classgridfire_1_1trigger_1_1solver_1_1_c_v_o_d_e_1_1_simulation_time_trigger.html#a468bf58f66417493501c59d7a8aabc98">gridfire::trigger::solver::CVODE::SimulationTimeTrigger</a>, and <a class="el" href="classgridfire_1_1trigger_1_1solver_1_1_c_v_o_d_e_1_1_timestep_collapse_trigger.html#af6bff6a484e8729445c26620b489665d">gridfire::trigger::solver::CVODE::TimestepCollapseTrigger</a>.</p>
</div>
</div>
<a id="a9f020d828ca36a601b780566cc3377ea" name="a9f020d828ca36a601b780566cc3377ea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9f020d828ca36a601b780566cc3377ea">&#9670;&#160;</a></span>why()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TriggerContextStruct&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="structgridfire_1_1trigger_1_1_trigger_result.html">TriggerResult</a> <a class="el" href="classgridfire_1_1trigger_1_1_trigger.html">gridfire::trigger::Trigger</a>&lt; TriggerContextStruct &gt;::why </td>
<td>(</td>
<td class="paramtype">const TriggerContextStruct &amp;</td> <td class="paramname"><span class="paramname"><em>ctx</em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel nodiscard">nodiscard</span><span class="mlabel pure-virtual">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Explain why the last evaluation would be true/false in a structured way. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ctx</td><td>Context snapshot for the explanation. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A <a class="el" href="structgridfire_1_1trigger_1_1_trigger_result.html">TriggerResult</a> tree with a boolean value and per-cause details. </dd></dl>
<p>Implemented in <a class="el" href="classgridfire_1_1trigger_1_1_and_trigger.html#a01033721e8f5d90483d65c904399cf96">gridfire::trigger::AndTrigger&lt; TriggerContextStruct &gt;</a>, <a class="el" href="classgridfire_1_1trigger_1_1_every_nth_trigger.html#a3bf0d69122f801deca4b62db47262d9b">gridfire::trigger::EveryNthTrigger&lt; TriggerContextStruct &gt;</a>, <a class="el" href="classgridfire_1_1trigger_1_1_not_trigger.html#abfb3eb7befba646ce9f11f36a63750ae">gridfire::trigger::NotTrigger&lt; TriggerContextStruct &gt;</a>, <a class="el" href="classgridfire_1_1trigger_1_1_or_trigger.html#a7bca0da16353f4b04a2f40fb29c07922">gridfire::trigger::OrTrigger&lt; TriggerContextStruct &gt;</a>, <a class="el" href="classgridfire_1_1trigger_1_1solver_1_1_c_v_o_d_e_1_1_convergence_failure_trigger.html#aedd397b71cd5b1ad26a0b21a34cf5631">gridfire::trigger::solver::CVODE::ConvergenceFailureTrigger</a>, <a class="el" href="classgridfire_1_1trigger_1_1solver_1_1_c_v_o_d_e_1_1_off_diagonal_trigger.html#a3af973e466ba62ebf1e41c608355e327">gridfire::trigger::solver::CVODE::OffDiagonalTrigger</a>, <a class="el" href="classgridfire_1_1trigger_1_1solver_1_1_c_v_o_d_e_1_1_simulation_time_trigger.html#a9dfab0b765d3a4c362cecd860d59f58a">gridfire::trigger::solver::CVODE::SimulationTimeTrigger</a>, and <a class="el" href="classgridfire_1_1trigger_1_1solver_1_1_c_v_o_d_e_1_1_timestep_collapse_trigger.html#a22d8bc7aacbc388108225c26158e918c">gridfire::trigger::solver::CVODE::TimestepCollapseTrigger</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/include/gridfire/trigger/<a class="el" href="trigger__abstract_8h.html">trigger_abstract.h</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_1trigger.html">trigger</a></li><li class="navelem"><a class="el" href="classgridfire_1_1trigger_1_1_trigger.html">Trigger</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 View Git Blame Copy Permalink