docs(docs): rebuilt docs
This commit is contained in:
@@ -29,7 +29,7 @@
|
||||
<tbody>
|
||||
<tr id="projectrow">
|
||||
<td id="projectalign">
|
||||
<div id="projectname">GridFire<span id="projectnumber"> 0.6.0</span>
|
||||
<div id="projectname">GridFire<span id="projectnumber"> v0.7.0-alpha</span>
|
||||
</div>
|
||||
<div id="projectbrief">General Purpose Nuclear Network</div>
|
||||
</td>
|
||||
@@ -135,6 +135,9 @@ Public Member Functions</h2></td></tr>
|
||||
<tr class="memitem:a048899795704f68668960454d118a6fc" id="r_a048899795704f68668960454d118a6fc"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a048899795704f68668960454d118a6fc">update</a> (const TriggerContextStruct &ctx)=0</td></tr>
|
||||
<tr class="memdesc:a048899795704f68668960454d118a6fc"><td class="mdescLeft"> </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"> </td></tr>
|
||||
<tr class="memitem:a4b7ffa4d8d31e2118a8e86172be51041" id="r_a4b7ffa4d8d31e2118a8e86172be51041"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a4b7ffa4d8d31e2118a8e86172be51041">step</a> (const TriggerContextStruct &ctx)=0</td></tr>
|
||||
<tr class="memdesc:a4b7ffa4d8d31e2118a8e86172be51041"><td class="mdescLeft"> </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"> </td></tr>
|
||||
<tr class="memitem:af652af761675736419b961b6946c728d" id="r_af652af761675736419b961b6946c728d"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="#af652af761675736419b961b6946c728d">reset</a> ()=0</td></tr>
|
||||
<tr class="memdesc:af652af761675736419b961b6946c728d"><td class="mdescLeft"> </td><td class="mdescRight">Reset internal state and diagnostics counters. <br /></td></tr>
|
||||
<tr class="separator:af652af761675736419b961b6946c728d"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
@@ -237,7 +240,7 @@ template<typename TriggerContextStruct> </div>
|
||||
</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< TriggerContextStruct ></a>, <a class="el" href="classgridfire_1_1trigger_1_1_every_nth_trigger.html#a69fbb099f8d13d39602f58fa8aa8e7f2">gridfire::trigger::EveryNthTrigger< TriggerContextStruct ></a>, <a class="el" href="classgridfire_1_1trigger_1_1_not_trigger.html#ae453a72df20fdd416443ef7867f86b92">gridfire::trigger::NotTrigger< TriggerContextStruct ></a>, <a class="el" href="classgridfire_1_1trigger_1_1_or_trigger.html#ac8be54d91e77ed16ae3cca2417d82e0a">gridfire::trigger::OrTrigger< TriggerContextStruct ></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>
|
||||
<p>Implemented in <a class="el" href="classgridfire_1_1trigger_1_1_and_trigger.html#aaefdfa86856f9f7839b6a7fdffa4a579">gridfire::trigger::AndTrigger< TriggerContextStruct ></a>, <a class="el" href="classgridfire_1_1trigger_1_1_every_nth_trigger.html#a69fbb099f8d13d39602f58fa8aa8e7f2">gridfire::trigger::EveryNthTrigger< TriggerContextStruct ></a>, <a class="el" href="classgridfire_1_1trigger_1_1_not_trigger.html#ae453a72df20fdd416443ef7867f86b92">gridfire::trigger::NotTrigger< TriggerContextStruct ></a>, <a class="el" href="classgridfire_1_1trigger_1_1_or_trigger.html#ac8be54d91e77ed16ae3cca2417d82e0a">gridfire::trigger::OrTrigger< TriggerContextStruct ></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>
|
||||
@@ -268,7 +271,7 @@ template<typename TriggerContextStruct> </div>
|
||||
|
||||
<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< TriggerContextStruct ></a>, <a class="el" href="classgridfire_1_1trigger_1_1_every_nth_trigger.html#aab88715f3c94437ca7f3fcb1698c69de">gridfire::trigger::EveryNthTrigger< TriggerContextStruct ></a>, <a class="el" href="classgridfire_1_1trigger_1_1_not_trigger.html#ad8166350329db3e1f50954afbb311a35">gridfire::trigger::NotTrigger< TriggerContextStruct ></a>, <a class="el" href="classgridfire_1_1trigger_1_1_or_trigger.html#accb56630df2f57400467d315c61dede6">gridfire::trigger::OrTrigger< TriggerContextStruct ></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>
|
||||
<p>Implemented in <a class="el" href="classgridfire_1_1trigger_1_1_and_trigger.html#a2dcd635c6bdbcfe517adca6e2bd5c408">gridfire::trigger::AndTrigger< TriggerContextStruct ></a>, <a class="el" href="classgridfire_1_1trigger_1_1_every_nth_trigger.html#aab88715f3c94437ca7f3fcb1698c69de">gridfire::trigger::EveryNthTrigger< TriggerContextStruct ></a>, <a class="el" href="classgridfire_1_1trigger_1_1_not_trigger.html#ad8166350329db3e1f50954afbb311a35">gridfire::trigger::NotTrigger< TriggerContextStruct ></a>, <a class="el" href="classgridfire_1_1trigger_1_1_or_trigger.html#accb56630df2f57400467d315c61dede6">gridfire::trigger::OrTrigger< TriggerContextStruct ></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>
|
||||
@@ -299,7 +302,7 @@ template<typename TriggerContextStruct> </div>
|
||||
|
||||
<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< TriggerContextStruct ></a>, <a class="el" href="classgridfire_1_1trigger_1_1_every_nth_trigger.html#a4a834d24286f9204995bf78fb69f35dc">gridfire::trigger::EveryNthTrigger< TriggerContextStruct ></a>, <a class="el" href="classgridfire_1_1trigger_1_1_not_trigger.html#acc3bd2938f7746997fb1d255681d8b20">gridfire::trigger::NotTrigger< TriggerContextStruct ></a>, <a class="el" href="classgridfire_1_1trigger_1_1_or_trigger.html#a062af4f567dc48c088f1fcfb64cc79ec">gridfire::trigger::OrTrigger< TriggerContextStruct ></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>
|
||||
<p>Implemented in <a class="el" href="classgridfire_1_1trigger_1_1_and_trigger.html#ab78539e5cd88194ab9e98434793eae3f">gridfire::trigger::AndTrigger< TriggerContextStruct ></a>, <a class="el" href="classgridfire_1_1trigger_1_1_every_nth_trigger.html#a4a834d24286f9204995bf78fb69f35dc">gridfire::trigger::EveryNthTrigger< TriggerContextStruct ></a>, <a class="el" href="classgridfire_1_1trigger_1_1_not_trigger.html#acc3bd2938f7746997fb1d255681d8b20">gridfire::trigger::NotTrigger< TriggerContextStruct ></a>, <a class="el" href="classgridfire_1_1trigger_1_1_or_trigger.html#a062af4f567dc48c088f1fcfb64cc79ec">gridfire::trigger::OrTrigger< TriggerContextStruct ></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>
|
||||
@@ -330,7 +333,7 @@ template<typename TriggerContextStruct> </div>
|
||||
|
||||
<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< TriggerContextStruct ></a>, <a class="el" href="classgridfire_1_1trigger_1_1_every_nth_trigger.html#ae7776f4a526db3245e64a74a3b0172d3">gridfire::trigger::EveryNthTrigger< TriggerContextStruct ></a>, <a class="el" href="classgridfire_1_1trigger_1_1_not_trigger.html#a2f9b0d6a6ac54f6371c5a208c06826ea">gridfire::trigger::NotTrigger< TriggerContextStruct ></a>, <a class="el" href="classgridfire_1_1trigger_1_1_or_trigger.html#a0b3a7f45604dbb27e832d9559dd20997">gridfire::trigger::OrTrigger< TriggerContextStruct ></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>
|
||||
<p>Implemented in <a class="el" href="classgridfire_1_1trigger_1_1_and_trigger.html#addfd61f8cb234881f535fb8f4d618d74">gridfire::trigger::AndTrigger< TriggerContextStruct ></a>, <a class="el" href="classgridfire_1_1trigger_1_1_every_nth_trigger.html#ae7776f4a526db3245e64a74a3b0172d3">gridfire::trigger::EveryNthTrigger< TriggerContextStruct ></a>, <a class="el" href="classgridfire_1_1trigger_1_1_not_trigger.html#a2f9b0d6a6ac54f6371c5a208c06826ea">gridfire::trigger::NotTrigger< TriggerContextStruct ></a>, <a class="el" href="classgridfire_1_1trigger_1_1_or_trigger.html#a0b3a7f45604dbb27e832d9559dd20997">gridfire::trigger::OrTrigger< TriggerContextStruct ></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>
|
||||
@@ -361,7 +364,7 @@ template<typename TriggerContextStruct> </div>
|
||||
|
||||
<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< TriggerContextStruct ></a>, <a class="el" href="classgridfire_1_1trigger_1_1_every_nth_trigger.html#a7e5568c9d7799b7f80ad0d3efe2cd143">gridfire::trigger::EveryNthTrigger< TriggerContextStruct ></a>, <a class="el" href="classgridfire_1_1trigger_1_1_not_trigger.html#ae2d27d72af9e1fbf711a58e4583b43a3">gridfire::trigger::NotTrigger< TriggerContextStruct ></a>, <a class="el" href="classgridfire_1_1trigger_1_1_or_trigger.html#afc7d3eae8306ee383d76997ac3803327">gridfire::trigger::OrTrigger< TriggerContextStruct ></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>
|
||||
<p>Implemented in <a class="el" href="classgridfire_1_1trigger_1_1_and_trigger.html#afffb4281569963183d7db3ed1568eb3a">gridfire::trigger::AndTrigger< TriggerContextStruct ></a>, <a class="el" href="classgridfire_1_1trigger_1_1_every_nth_trigger.html#a7e5568c9d7799b7f80ad0d3efe2cd143">gridfire::trigger::EveryNthTrigger< TriggerContextStruct ></a>, <a class="el" href="classgridfire_1_1trigger_1_1_not_trigger.html#ae2d27d72af9e1fbf711a58e4583b43a3">gridfire::trigger::NotTrigger< TriggerContextStruct ></a>, <a class="el" href="classgridfire_1_1trigger_1_1_or_trigger.html#afc7d3eae8306ee383d76997ac3803327">gridfire::trigger::OrTrigger< TriggerContextStruct ></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>
|
||||
@@ -392,7 +395,44 @@ template<typename TriggerContextStruct> </div>
|
||||
|
||||
<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< TriggerContextStruct ></a>, <a class="el" href="classgridfire_1_1trigger_1_1_every_nth_trigger.html#abf218d255bde157540b51cd6a54f6eb1">gridfire::trigger::EveryNthTrigger< TriggerContextStruct ></a>, <a class="el" href="classgridfire_1_1trigger_1_1_not_trigger.html#afe337517b77e5433d92ded3a64565141">gridfire::trigger::NotTrigger< TriggerContextStruct ></a>, <a class="el" href="classgridfire_1_1trigger_1_1_or_trigger.html#ab42043e55c81bac5d3f981bc139579de">gridfire::trigger::OrTrigger< TriggerContextStruct ></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>
|
||||
<p>Implemented in <a class="el" href="classgridfire_1_1trigger_1_1_and_trigger.html#a2436d8643911ade907e03fb29531ceaa">gridfire::trigger::AndTrigger< TriggerContextStruct ></a>, <a class="el" href="classgridfire_1_1trigger_1_1_every_nth_trigger.html#abf218d255bde157540b51cd6a54f6eb1">gridfire::trigger::EveryNthTrigger< TriggerContextStruct ></a>, <a class="el" href="classgridfire_1_1trigger_1_1_not_trigger.html#afe337517b77e5433d92ded3a64565141">gridfire::trigger::NotTrigger< TriggerContextStruct ></a>, <a class="el" href="classgridfire_1_1trigger_1_1_or_trigger.html#ab42043e55c81bac5d3f981bc139579de">gridfire::trigger::OrTrigger< TriggerContextStruct ></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">◆ </a></span>step()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<div class="memtemplate">
|
||||
template<typename TriggerContextStruct> </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>< TriggerContextStruct >::step </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">const TriggerContextStruct &</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< TriggerContextStruct ></a>, <a class="el" href="classgridfire_1_1trigger_1_1_every_nth_trigger.html#a26d0aca39087a1f69e96e0701ca83f81">gridfire::trigger::EveryNthTrigger< TriggerContextStruct ></a>, <a class="el" href="classgridfire_1_1trigger_1_1_not_trigger.html#a5096cb7e70ea357f28e1b9fc8301c793">gridfire::trigger::NotTrigger< TriggerContextStruct ></a>, <a class="el" href="classgridfire_1_1trigger_1_1_or_trigger.html#a95a801aafb5aaa9a22566ebf722a1150">gridfire::trigger::OrTrigger< TriggerContextStruct ></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>
|
||||
@@ -429,7 +469,7 @@ template<typename TriggerContextStruct> </div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<p>Implemented in <a class="el" href="classgridfire_1_1trigger_1_1_and_trigger.html#a62f7dbbcf0554caa68e3d778580b3c1d">gridfire::trigger::AndTrigger< TriggerContextStruct ></a>, <a class="el" href="classgridfire_1_1trigger_1_1_every_nth_trigger.html#a0dd783afab7ef6005f0241f9de7b31f6">gridfire::trigger::EveryNthTrigger< TriggerContextStruct ></a>, <a class="el" href="classgridfire_1_1trigger_1_1_not_trigger.html#a846432abf33c7602af0fbb5475c0ad32">gridfire::trigger::NotTrigger< TriggerContextStruct ></a>, <a class="el" href="classgridfire_1_1trigger_1_1_or_trigger.html#a775dac97d109c5fcd5c0287ca98f308c">gridfire::trigger::OrTrigger< TriggerContextStruct ></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>
|
||||
<p>Implemented in <a class="el" href="classgridfire_1_1trigger_1_1_and_trigger.html#a62f7dbbcf0554caa68e3d778580b3c1d">gridfire::trigger::AndTrigger< TriggerContextStruct ></a>, <a class="el" href="classgridfire_1_1trigger_1_1_every_nth_trigger.html#a0dd783afab7ef6005f0241f9de7b31f6">gridfire::trigger::EveryNthTrigger< TriggerContextStruct ></a>, <a class="el" href="classgridfire_1_1trigger_1_1_not_trigger.html#a846432abf33c7602af0fbb5475c0ad32">gridfire::trigger::NotTrigger< TriggerContextStruct ></a>, <a class="el" href="classgridfire_1_1trigger_1_1_or_trigger.html#a775dac97d109c5fcd5c0287ca98f308c">gridfire::trigger::OrTrigger< TriggerContextStruct ></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>
|
||||
@@ -467,7 +507,7 @@ template<typename TriggerContextStruct> </div>
|
||||
</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< TriggerContextStruct ></a>, <a class="el" href="classgridfire_1_1trigger_1_1_every_nth_trigger.html#a3bf0d69122f801deca4b62db47262d9b">gridfire::trigger::EveryNthTrigger< TriggerContextStruct ></a>, <a class="el" href="classgridfire_1_1trigger_1_1_not_trigger.html#abfb3eb7befba646ce9f11f36a63750ae">gridfire::trigger::NotTrigger< TriggerContextStruct ></a>, <a class="el" href="classgridfire_1_1trigger_1_1_or_trigger.html#a7bca0da16353f4b04a2f40fb29c07922">gridfire::trigger::OrTrigger< TriggerContextStruct ></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>
|
||||
<p>Implemented in <a class="el" href="classgridfire_1_1trigger_1_1_and_trigger.html#a01033721e8f5d90483d65c904399cf96">gridfire::trigger::AndTrigger< TriggerContextStruct ></a>, <a class="el" href="classgridfire_1_1trigger_1_1_every_nth_trigger.html#a3bf0d69122f801deca4b62db47262d9b">gridfire::trigger::EveryNthTrigger< TriggerContextStruct ></a>, <a class="el" href="classgridfire_1_1trigger_1_1_not_trigger.html#abfb3eb7befba646ce9f11f36a63750ae">gridfire::trigger::NotTrigger< TriggerContextStruct ></a>, <a class="el" href="classgridfire_1_1trigger_1_1_or_trigger.html#a7bca0da16353f4b04a2f40fb29c07922">gridfire::trigger::OrTrigger< TriggerContextStruct ></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>
|
||||
|
||||
Reference in New Issue
Block a user