2025-07-24 11:10:45 -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: PyDynamicNetworkSolverStrategy Class 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-27 15:06:27 -05:00
< div id = "projectname" > GridFire< span id = "projectnumber" >   v0.7.0_rc2< / span >
2025-07-24 11:10:45 -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('class_py_dynamic_network_solver_strategy.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 = "#pri-methods" > Private Member Functions< / a > |
< a href = "class_py_dynamic_network_solver_strategy-members.html" > List of all members< / a > < / div >
< div class = "headertitle" > < div class = "title" > PyDynamicNetworkSolverStrategy Class Reference< span class = "mlabels" > < span class = "mlabel final" > final< / span > < / span > < / div > < / div >
< / div > <!-- header -->
< div class = "contents" >
2025-07-31 10:54:31 -04:00
< p > < code > #include < py_solver.h> < / code > < / p >
2025-07-24 11:10:45 -04:00
< div class = "dynheader" >
Inheritance diagram for PyDynamicNetworkSolverStrategy:< / div >
< div class = "dyncontent" >
2025-11-06 09:16:40 -05:00
< div class = "center" > < iframe scrolling = "no" frameborder = "0" src = "class_py_dynamic_network_solver_strategy__inherit__graph.svg" width = "235" height = "126" > < p > < b > This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.< / b > < / p > < / iframe > < / div >
< center > < span class = "legend" > [< a target = "top" href = "graph_legend.html" > legend< / a > ]< / span > < / center > < / div >
< div class = "dynheader" >
Collaboration diagram for PyDynamicNetworkSolverStrategy:< / div >
< div class = "dyncontent" >
< div class = "center" > < iframe scrolling = "no" frameborder = "0" src = "class_py_dynamic_network_solver_strategy__coll__graph.svg" width = "235" height = "126" > < p > < b > This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.< / b > < / p > < / iframe > < / div >
< center > < span class = "legend" > [< a target = "top" href = "graph_legend.html" > legend< / a > ]< / span > < / center > < / div >
2025-07-24 11:10:45 -04:00
< table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a id = "pri-methods" name = "pri-methods" > < / a >
Private Member Functions< / h2 > < / td > < / tr >
2025-11-25 14:31:59 -05:00
< tr class = "memitem:a5adc2c51958c6114b4c46264e4d68917" id = "r_a5adc2c51958c6114b4c46264e4d68917" > < td class = "memItemLeft" align = "right" valign = "top" >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "#a5adc2c51958c6114b4c46264e4d68917" > PyDynamicNetworkSolverStrategy< / a > (< a class = "el" href = "classgridfire_1_1engine_1_1_dynamic_engine.html" > gridfire::engine::DynamicEngine< / a > & engine)< / td > < / tr >
< tr class = "separator:a5adc2c51958c6114b4c46264e4d68917" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2025-07-24 11:10:45 -04:00
< tr class = "memitem:a2095abb83ed6229ebb27b4883cec51c4" id = "r_a2095abb83ed6229ebb27b4883cec51c4" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "el" href = "structgridfire_1_1_net_out.html" > gridfire::NetOut< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "#a2095abb83ed6229ebb27b4883cec51c4" > evaluate< / a > (const < a class = "el" href = "structgridfire_1_1_net_in.html" > gridfire::NetIn< / a > & netIn) override< / td > < / tr >
< tr class = "memdesc:a2095abb83ed6229ebb27b4883cec51c4" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Evaluates the network for a given timestep. < br / > < / td > < / tr >
< tr class = "separator:a2095abb83ed6229ebb27b4883cec51c4" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2025-07-31 15:04:57 -04:00
< tr class = "memitem:a112a7babc03858a69d6994a7155370d3" id = "r_a112a7babc03858a69d6994a7155370d3" > < td class = "memItemLeft" align = "right" valign = "top" > void  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "#a112a7babc03858a69d6994a7155370d3" > set_callback< / a > (const std::any & callback) override< / td > < / tr >
< tr class = "memdesc:a112a7babc03858a69d6994a7155370d3" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > set the callback function to be called at the end of each timestep. < br / > < / td > < / tr >
< tr class = "separator:a112a7babc03858a69d6994a7155370d3" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a147a0a543268427a5930143902217ac3" id = "r_a147a0a543268427a5930143902217ac3" > < td class = "memItemLeft" align = "right" valign = "top" > std::vector< std::tuple< std::string, std::string > >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "#a147a0a543268427a5930143902217ac3" > describe_callback_context< / a > () const override< / td > < / tr >
< tr class = "memdesc:a147a0a543268427a5930143902217ac3" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Describe the context that will be passed to the callback function. < br / > < / td > < / tr >
< tr class = "separator:a147a0a543268427a5930143902217ac3" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2025-07-24 11:10:45 -04:00
< / table > < table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a id = "inherited" name = "inherited" > < / a >
Additional Inherited Members< / h2 > < / td > < / tr >
2025-11-24 09:08:28 -05:00
< tr class = "inherit_header pub_methods_classgridfire_1_1solver_1_1_network_solver_strategy" > < td colspan = "2" onclick = "javascript:dynsection.toggleInherit('pub_methods_classgridfire_1_1solver_1_1_network_solver_strategy')" > < img src = "closed.png" alt = "-" / >   Public Member Functions inherited from < a class = "el" href = "classgridfire_1_1solver_1_1_network_solver_strategy.html" > gridfire::solver::NetworkSolverStrategy< engine::DynamicEngine > < / a > < / td > < / tr >
< tr class = "memitem:a01cbbec0eb5c3a60f50da38cdaf66505 inherit pub_methods_classgridfire_1_1solver_1_1_network_solver_strategy" id = "r_a01cbbec0eb5c3a60f50da38cdaf66505" > < td class = "memItemLeft" align = "right" valign = "top" >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classgridfire_1_1solver_1_1_network_solver_strategy.html#a01cbbec0eb5c3a60f50da38cdaf66505" > NetworkSolverStrategy< / a > (< a class = "el" href = "classgridfire_1_1engine_1_1_dynamic_engine.html" > engine::DynamicEngine< / a > & engine)< / td > < / tr >
2025-07-24 11:10:45 -04:00
< tr class = "memdesc:a01cbbec0eb5c3a60f50da38cdaf66505 inherit pub_methods_classgridfire_1_1solver_1_1_network_solver_strategy" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Constructor for the < a class = "el" href = "classgridfire_1_1solver_1_1_network_solver_strategy.html" title = "Abstract base class for network solver strategies." > NetworkSolverStrategy< / a > . < br / > < / td > < / tr >
< tr class = "separator:a01cbbec0eb5c3a60f50da38cdaf66505 inherit pub_methods_classgridfire_1_1solver_1_1_network_solver_strategy" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a1693dc93f63599c89587d729aca8e318 inherit pub_methods_classgridfire_1_1solver_1_1_network_solver_strategy" id = "r_a1693dc93f63599c89587d729aca8e318" > < td class = "memItemLeft" align = "right" valign = "top" > virtual  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classgridfire_1_1solver_1_1_network_solver_strategy.html#a1693dc93f63599c89587d729aca8e318" > ~NetworkSolverStrategy< / a > ()=default< / td > < / tr >
< tr class = "memdesc:a1693dc93f63599c89587d729aca8e318 inherit pub_methods_classgridfire_1_1solver_1_1_network_solver_strategy" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Virtual destructor. < br / > < / td > < / tr >
< tr class = "separator:a1693dc93f63599c89587d729aca8e318 inherit pub_methods_classgridfire_1_1solver_1_1_network_solver_strategy" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2025-11-24 09:08:28 -05:00
< tr class = "memitem:a01cbbec0eb5c3a60f50da38cdaf66505 inherit pub_methods_classgridfire_1_1solver_1_1_network_solver_strategy" id = "r_a01cbbec0eb5c3a60f50da38cdaf66505" > < td class = "memItemLeft" align = "right" valign = "top" >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classgridfire_1_1solver_1_1_network_solver_strategy.html#a01cbbec0eb5c3a60f50da38cdaf66505" > NetworkSolverStrategy< / a > (< a class = "el" href = "classgridfire_1_1engine_1_1_dynamic_engine.html" > engine::DynamicEngine< / a > & engine)< / td > < / tr >
2025-07-24 11:10:45 -04:00
< tr class = "memdesc:a01cbbec0eb5c3a60f50da38cdaf66505 inherit pub_methods_classgridfire_1_1solver_1_1_network_solver_strategy" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Constructor for the < a class = "el" href = "classgridfire_1_1solver_1_1_network_solver_strategy.html" title = "Abstract base class for network solver strategies." > NetworkSolverStrategy< / a > . < br / > < / td > < / tr >
< tr class = "separator:a01cbbec0eb5c3a60f50da38cdaf66505 inherit pub_methods_classgridfire_1_1solver_1_1_network_solver_strategy" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a1693dc93f63599c89587d729aca8e318 inherit pub_methods_classgridfire_1_1solver_1_1_network_solver_strategy" id = "r_a1693dc93f63599c89587d729aca8e318" > < td class = "memItemLeft" align = "right" valign = "top" > virtual  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classgridfire_1_1solver_1_1_network_solver_strategy.html#a1693dc93f63599c89587d729aca8e318" > ~NetworkSolverStrategy< / a > ()=default< / td > < / tr >
< tr class = "memdesc:a1693dc93f63599c89587d729aca8e318 inherit pub_methods_classgridfire_1_1solver_1_1_network_solver_strategy" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Virtual destructor. < br / > < / td > < / tr >
< tr class = "separator:a1693dc93f63599c89587d729aca8e318 inherit pub_methods_classgridfire_1_1solver_1_1_network_solver_strategy" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2025-11-24 09:08:28 -05:00
< tr class = "inherit_header pro_attribs_classgridfire_1_1solver_1_1_network_solver_strategy" > < td colspan = "2" onclick = "javascript:dynsection.toggleInherit('pro_attribs_classgridfire_1_1solver_1_1_network_solver_strategy')" > < img src = "closed.png" alt = "-" / >   Protected Attributes inherited from < a class = "el" href = "classgridfire_1_1solver_1_1_network_solver_strategy.html" > gridfire::solver::NetworkSolverStrategy< engine::DynamicEngine > < / a > < / td > < / tr >
< tr class = "memitem:a724924d94eaf82b67d9988a55c3261e8 inherit pro_attribs_classgridfire_1_1solver_1_1_network_solver_strategy" id = "r_a724924d94eaf82b67d9988a55c3261e8" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "el" href = "classgridfire_1_1engine_1_1_dynamic_engine.html" > engine::DynamicEngine< / a > &   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classgridfire_1_1solver_1_1_network_solver_strategy.html#a724924d94eaf82b67d9988a55c3261e8" > m_engine< / a > < / td > < / tr >
2025-07-24 11:10:45 -04:00
< tr class = "memdesc:a724924d94eaf82b67d9988a55c3261e8 inherit pro_attribs_classgridfire_1_1solver_1_1_network_solver_strategy" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > The engine used by this solver strategy. < br / > < / td > < / tr >
< tr class = "separator:a724924d94eaf82b67d9988a55c3261e8 inherit pro_attribs_classgridfire_1_1solver_1_1_network_solver_strategy" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2025-11-24 09:08:28 -05:00
< tr class = "memitem:a724924d94eaf82b67d9988a55c3261e8 inherit pro_attribs_classgridfire_1_1solver_1_1_network_solver_strategy" id = "r_a724924d94eaf82b67d9988a55c3261e8" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "el" href = "classgridfire_1_1engine_1_1_dynamic_engine.html" > engine::DynamicEngine< / a > &   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classgridfire_1_1solver_1_1_network_solver_strategy.html#a724924d94eaf82b67d9988a55c3261e8" > m_engine< / a > < / td > < / tr >
2025-07-24 11:10:45 -04:00
< tr class = "memdesc:a724924d94eaf82b67d9988a55c3261e8 inherit pro_attribs_classgridfire_1_1solver_1_1_network_solver_strategy" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > The engine used by this solver strategy. < br / > < / td > < / tr >
< tr class = "separator:a724924d94eaf82b67d9988a55c3261e8 inherit pro_attribs_classgridfire_1_1solver_1_1_network_solver_strategy" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< / table >
2025-07-31 10:54:31 -04:00
< h2 class = "groupheader" > Constructor & Destructor Documentation< / h2 >
2025-11-25 14:31:59 -05:00
< a id = "a5adc2c51958c6114b4c46264e4d68917" name = "a5adc2c51958c6114b4c46264e4d68917" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a5adc2c51958c6114b4c46264e4d68917" > ◆   < / a > < / span > PyDynamicNetworkSolverStrategy()< / h2 >
2025-07-24 11:10:45 -04:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
< td class = "memname" > PyDynamicNetworkSolverStrategy::PyDynamicNetworkSolverStrategy < / td >
< td > (< / td >
2025-11-25 14:31:59 -05:00
< td class = "paramtype" > < a class = "el" href = "classgridfire_1_1engine_1_1_dynamic_engine.html" > gridfire::engine::DynamicEngine< / a > & < / td > < td class = "paramname" > < span class = "paramname" > < em > engine< / em > < / span > < / td > < td > )< / td >
2025-07-24 11:10:45 -04:00
< td > < / td >
< / tr >
< / table >
< / td >
< td class = "mlabels-right" >
< span class = "mlabels" > < span class = "mlabel inline" > inline< / span > < span class = "mlabel explicit" > explicit< / span > < span class = "mlabel private" > private< / span > < / span > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< / div >
< / div >
< h2 class = "groupheader" > Member Function Documentation< / h2 >
2025-07-31 15:04:57 -04:00
< a id = "a147a0a543268427a5930143902217ac3" name = "a147a0a543268427a5930143902217ac3" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a147a0a543268427a5930143902217ac3" > ◆   < / a > < / span > describe_callback_context()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
< td class = "memname" > std::vector< std::tuple< std::string, std::string > > PyDynamicNetworkSolverStrategy::describe_callback_context < / 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" >
2025-10-08 11:17:09 -04:00
< span class = "mlabels" > < span class = "mlabel nodiscard" > nodiscard< / span > < span class = "mlabel override" > override< / span > < span class = "mlabel private" > private< / span > < span class = "mlabel virtual" > virtual< / span > < / span > < / td >
2025-07-31 15:04:57 -04:00
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Describe the context that will be passed to the callback function. < / p >
< dl class = "section return" > < dt > Returns< / dt > < dd > A vector of tuples, each containing a string for the parameter's name and a string for its type.< / dd > < / dl >
< p > This method should be overridden by derived classes to provide a description of the context that will be passed to the callback function. The intent of this method is that an end user can investigate the context that will be passed to the callback function, and use this information to craft their own callback function. < / p >
2025-11-24 09:08:28 -05:00
< p > Implements < a class = "el" href = "classgridfire_1_1solver_1_1_network_solver_strategy.html#ae09169769774f17df8701c42a64ed656" > gridfire::solver::NetworkSolverStrategy< engine::DynamicEngine > < / a > .< / p >
2025-07-31 15:04:57 -04:00
< / div >
< / div >
2025-07-24 11:10:45 -04:00
< a id = "a2095abb83ed6229ebb27b4883cec51c4" name = "a2095abb83ed6229ebb27b4883cec51c4" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a2095abb83ed6229ebb27b4883cec51c4" > ◆   < / a > < / span > evaluate()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
< td class = "memname" > < a class = "el" href = "structgridfire_1_1_net_out.html" > gridfire::NetOut< / a > PyDynamicNetworkSolverStrategy::evaluate < / td >
< td > (< / td >
< td class = "paramtype" > const < a class = "el" href = "structgridfire_1_1_net_in.html" > gridfire::NetIn< / a > & < / td > < td class = "paramname" > < span class = "paramname" > < em > netIn< / em > < / span > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
< / td >
< td class = "mlabels-right" >
< span class = "mlabels" > < span class = "mlabel override" > override< / span > < span class = "mlabel private" > private< / span > < span class = "mlabel virtual" > virtual< / span > < / span > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Evaluates the network for a given timestep. < / p >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramname" > netIn< / td > < td > The input conditions for the network. < / td > < / tr >
< / table >
< / dd >
< / dl >
< dl class = "section return" > < dt > Returns< / dt > < dd > The output conditions after the timestep. < / dd > < / dl >
2025-11-24 09:08:28 -05:00
< p > Implements < a class = "el" href = "classgridfire_1_1solver_1_1_network_solver_strategy.html#ace539b0482db171845ff1bd38d76b70f" > gridfire::solver::NetworkSolverStrategy< engine::DynamicEngine > < / a > .< / p >
2025-07-24 11:10:45 -04:00
2025-07-31 15:04:57 -04:00
< / div >
< / div >
< a id = "a112a7babc03858a69d6994a7155370d3" name = "a112a7babc03858a69d6994a7155370d3" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a112a7babc03858a69d6994a7155370d3" > ◆   < / a > < / span > set_callback()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
< td class = "memname" > void PyDynamicNetworkSolverStrategy::set_callback < / td >
< td > (< / td >
< td class = "paramtype" > const std::any & < / td > < td class = "paramname" > < span class = "paramname" > < em > callback< / em > < / span > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
< / td >
< td class = "mlabels-right" >
< span class = "mlabels" > < span class = "mlabel override" > override< / span > < span class = "mlabel private" > private< / span > < span class = "mlabel virtual" > virtual< / span > < / span > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > set the callback function to be called at the end of each timestep. < / p >
< p > This function allows the user to set a callback function that will be called at the end of each timestep. The callback function will receive a < a class = "el" href = "namespacegridfire_1_1solver.html" > gridfire::solver< / a > ::< SOMESOLVER> ::TimestepContext object. Note that depending on the solver, this context may contain different information. Further, the exact signature of the callback function is left up to each solver. Every solver should provide a type or type alias TimestepCallback that defines the signature of the callback function so that the user can easily get that type information.< / p >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramname" > callback< / td > < td > The callback function to be called at the end of each timestep. < / td > < / tr >
< / table >
< / dd >
< / dl >
2025-11-24 09:08:28 -05:00
< p > Implements < a class = "el" href = "classgridfire_1_1solver_1_1_network_solver_strategy.html#a4d97ee85933d5e5f90d4194bb021a1dc" > gridfire::solver::NetworkSolverStrategy< engine::DynamicEngine > < / a > .< / p >
2025-07-31 15:04:57 -04:00
2025-07-24 11:10:45 -04:00
< / div >
< / div >
< hr / > The documentation for this class was generated from the following files:< ul >
2025-07-31 10:54:31 -04:00
< li > src/python/solver/trampoline/< a class = "el" href = "py__solver_8h.html" > py_solver.h< / a > < / li >
< li > src/python/solver/trampoline/< a class = "el" href = "py__solver_8cpp.html" > py_solver.cpp< / a > < / li >
2025-07-24 11:10:45 -04:00
< / 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 = "class_py_dynamic_network_solver_strategy.html" > PyDynamicNetworkSolverStrategy< / 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 >
