2025-10-08 11:17:09 -04:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
< html xmlns = "http://www.w3.org/1999/xhtml" lang = "en-US" >
< head >
< meta http-equiv = "Content-Type" content = "text/xhtml;charset=UTF-8" / >
< meta http-equiv = "X-UA-Compatible" content = "IE=11" / >
< meta name = "generator" content = "Doxygen 1.13.2" / >
< meta name = "viewport" content = "width=device-width, initial-scale=1" / >
< title > GridFire: src/include/gridfire/solver/strategies/triggers/engine_partitioning_trigger.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" >
2025-11-04 14:04:26 -05:00
< div id = "projectname" > GridFire< span id = "projectnumber" >   v0.7.0-alpha< / span >
2025-10-08 11:17:09 -04:00
< / div >
< div id = "projectbrief" > General Purpose Nuclear Network< / div >
< / td >
< / tr >
< / tbody >
< / table >
< / div >
<!-- end header part -->
<!-- Generated by Doxygen 1.13.2 -->
< script type = "text/javascript" >
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699& dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
< / script >
< script type = "text/javascript" >
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699& dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
< / script >
< script type = "text/javascript" src = "menudata.js" > < / script >
< script type = "text/javascript" src = "menu.js" > < / script >
< script type = "text/javascript" >
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699& dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search',true);
$(function() { init_search(); });
});
/* @license-end */
< / script >
< div id = "main-nav" > < / div >
< / div > <!-- top -->
< div id = "side-nav" class = "ui-resizable side-nav-resizable" >
< div id = "nav-tree" >
< div id = "nav-tree-contents" >
< div id = "nav-sync" class = "sync" > < / div >
< / div >
< / div >
< div id = "splitbar" style = "-moz-user-select:none;"
class="ui-resizable-handle">
< / div >
< / div >
< script type = "text/javascript" >
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699& dn=expat.txt MIT */
$(function(){initNavTree('engine__partitioning__trigger_8h.html',''); initResizable(true); });
/* @license-end */
< / script >
< div id = "doc-content" >
<!-- window showing the filter options -->
< div id = "MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
< / div >
<!-- iframe showing the search results (closed by default) -->
< div id = "MSearchResultsWindow" >
< div id = "MSearchResults" >
< div class = "SRPage" >
< div id = "SRIndex" >
< div id = "SRResults" > < / div >
< div class = "SRStatus" id = "Loading" > Loading...< / div >
< div class = "SRStatus" id = "Searching" > Searching...< / div >
< div class = "SRStatus" id = "NoMatches" > No Matches< / div >
< / div >
< / div >
< / div >
< / div >
< div class = "header" >
< div class = "summary" >
< a href = "#nested-classes" > Classes< / a > |
< a href = "#namespaces" > Namespaces< / a > |
< a href = "#func-members" > Functions< / a > < / div >
< div class = "headertitle" > < div class = "title" > engine_partitioning_trigger.h File Reference< / div > < / div >
< / div > <!-- header -->
< div class = "contents" >
< p > CVODE-specific triggers that decide when to (re)partition the reaction network engine.
< a href = "#details" > More...< / a > < / p >
< div class = "textblock" > < code > #include " < a class = "el" href = "trigger__abstract_8h.html" > gridfire/trigger/trigger_abstract.h< / a > " < / code > < br / >
< code > #include " < a class = "el" href = "trigger__result_8h.html" > gridfire/trigger/trigger_result.h< / a > " < / code > < br / >
< code > #include " < a class = "el" href = "_c_v_o_d_e__solver__strategy_8h.html" > gridfire/solver/strategies/CVODE_solver_strategy.h< / a > " < / code > < br / >
< code > #include " fourdst/logging/logging.h" < / code > < br / >
< code > #include < string> < / code > < br / >
< code > #include < deque> < / code > < br / >
< code > #include < memory> < / code > < br / >
< / div > < table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a id = "nested-classes" name = "nested-classes" > < / a >
Classes< / h2 > < / td > < / tr >
< tr class = "memitem:" > < td class = "memItemLeft" align = "right" valign = "top" > class   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classgridfire_1_1trigger_1_1solver_1_1_c_v_o_d_e_1_1_simulation_time_trigger.html" > gridfire::trigger::solver::CVODE::SimulationTimeTrigger< / a > < / td > < / tr >
< tr class = "memdesc:" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Triggers when the current simulation time advances by at least a fixed interval. < a href = "classgridfire_1_1trigger_1_1solver_1_1_c_v_o_d_e_1_1_simulation_time_trigger.html#details" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:" > < td class = "memItemLeft" align = "right" valign = "top" > class   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classgridfire_1_1trigger_1_1solver_1_1_c_v_o_d_e_1_1_off_diagonal_trigger.html" > gridfire::trigger::solver::CVODE::OffDiagonalTrigger< / a > < / td > < / tr >
< tr class = "memdesc:" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Triggers when any off-diagonal Jacobian entry magnitude exceeds a threshold. < a href = "classgridfire_1_1trigger_1_1solver_1_1_c_v_o_d_e_1_1_off_diagonal_trigger.html#details" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:" > < td class = "memItemLeft" align = "right" valign = "top" > class   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classgridfire_1_1trigger_1_1solver_1_1_c_v_o_d_e_1_1_timestep_collapse_trigger.html" > gridfire::trigger::solver::CVODE::TimestepCollapseTrigger< / a > < / td > < / tr >
< tr class = "memdesc:" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Triggers when the timestep deviates from its recent average beyond a threshold. < a href = "classgridfire_1_1trigger_1_1solver_1_1_c_v_o_d_e_1_1_timestep_collapse_trigger.html#details" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2025-11-04 14:04:26 -05:00
< tr class = "memitem:" > < td class = "memItemLeft" align = "right" valign = "top" > class   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classgridfire_1_1trigger_1_1solver_1_1_c_v_o_d_e_1_1_convergence_failure_trigger.html" > gridfire::trigger::solver::CVODE::ConvergenceFailureTrigger< / a > < / td > < / tr >
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2025-10-08 11:17:09 -04:00
< / table > < table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a id = "namespaces" name = "namespaces" > < / a >
Namespaces< / h2 > < / td > < / tr >
< tr class = "memitem:" > < td class = "memItemLeft" align = "right" valign = "top" > namespace   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "namespacegridfire.html" > gridfire< / a > < / td > < / tr >
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / 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_1trigger.html" > gridfire::trigger< / a > < / td > < / tr >
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / 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_1trigger_1_1solver.html" > gridfire::trigger::solver< / a > < / td > < / tr >
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / 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_1trigger_1_1solver_1_1_c_v_o_d_e.html" > gridfire::trigger::solver::CVODE< / a > < / td > < / tr >
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< / table > < table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a id = "func-members" name = "func-members" > < / a >
Functions< / h2 > < / td > < / tr >
< tr class = "memitem:a26555ea09be620dabc5f9644be8f9908" id = "r_a26555ea09be620dabc5f9644be8f9908" > < td class = "memItemLeft" align = "right" valign = "top" > std::unique_ptr< < a class = "el" href = "classgridfire_1_1trigger_1_1_trigger.html" > Trigger< / a > < < a class = "el" href = "structgridfire_1_1solver_1_1_c_v_o_d_e_solver_strategy_1_1_timestep_context.html" > gridfire::solver::CVODESolverStrategy::TimestepContext< / a > > >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "namespacegridfire_1_1trigger_1_1solver_1_1_c_v_o_d_e.html#a26555ea09be620dabc5f9644be8f9908" > gridfire::trigger::solver::CVODE::makeEnginePartitioningTrigger< / a > (const double simulationTimeInterval, const double offDiagonalThreshold, const double timestepGrowthThreshold, const bool timestepGrowthRelative, const size_t timestepGrowthWindowSize)< / td > < / tr >
< tr class = "memdesc:a26555ea09be620dabc5f9644be8f9908" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Compose a trigger suitable for deciding engine re-partitioning during < a class = "el" href = "namespacegridfire_1_1trigger_1_1solver_1_1_c_v_o_d_e.html" > CVODE< / a > solves. < br / > < / td > < / tr >
< tr class = "separator:a26555ea09be620dabc5f9644be8f9908" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< / table >
< a name = "details" id = "details" > < / a > < h2 class = "groupheader" > Detailed Description< / h2 >
< div class = "textblock" > < p > CVODE-specific triggers that decide when to (re)partition the reaction network engine. < / p >
< p > This header provides three concrete Trigger< CVODESolverStrategy::TimestepContext> implementations:< / p > < ul >
< li > SimulationTimeTrigger: fires when the simulated time advances by a fixed interval.< / li >
< li > OffDiagonalTrigger: fires when any off-diagonal Jacobian entry exceeds a threshold.< / li >
< li > TimestepCollapseTrigger: fires when the timestep changes sharply relative to a moving average.< / li >
< / ul >
< p > It also provides a convenience factory (makeEnginePartitioningTrigger) composing these triggers with logical combinators defined 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 > .< / p >
< p > See the implementation for details: < a class = "el" href = "engine__partitioning__trigger_8cpp.html" > src/lib/solver/strategies/triggers/engine_partitioning_trigger.cpp< / a > < / p >
< dl class = "section user" > < dt > Related headers:< / dt > < dd > < ul >
< li > < a class = "el" href = "trigger__abstract_8h.html" > trigger_abstract.h< / a > : base Trigger interface and lifecycle semantics< / li >
< li > < 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/OR/NOT/EveryNth composition utilities < / li >
< / ul >
< / 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_e2a8863ee8e7cd9122c04bdba1c35a3b.html" > solver< / a > < / li > < li class = "navelem" > < a class = "el" href = "dir_230a420a279f78b45ea47b2d650bf1a7.html" > strategies< / a > < / li > < li class = "navelem" > < a class = "el" href = "dir_3c6e26120bd25666a475751afc8a34bc.html" > triggers< / a > < / li > < li class = "navelem" > < a class = "el" href = "engine__partitioning__trigger_8h.html" > engine_partitioning_trigger.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 >
