docs/html/hierarchy.html

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.13.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>GridFire: Class Hierarchy</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;0.0.1a</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('hierarchy.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="headertitle"><div class="title">Class Hierarchy</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock">This inheritance list is sorted roughly, but not completely, alphabetically:</div><div class="directory">
<div class="levels">[detail level <span onclick="javascript:dynsection.toggleLevel(1);">1</span><span onclick="javascript:dynsection.toggleLevel(2);">2</span><span onclick="javascript:dynsection.toggleLevel(3);">3</span>]</div><table class="directory">
<tr id="row_0_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structgridfire_1_1approx8_1_1_approx8_net.html" target="_self">gridfire::approx8::Approx8Net</a></td><td class="desc">Contains constants and arrays related to the nuclear network </td></tr>
<tr id="row_1_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structgridfire_1_1_graph_engine_1_1constants.html" target="_self">gridfire::GraphEngine::constants</a></td><td class="desc"></td></tr>
<tr id="row_2_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structgridfire_1_1solver_1_1dynamic_q_s_e_species_indices.html" target="_self">gridfire::solver::dynamicQSESpeciesIndices</a></td><td class="desc">Structure to hold indices of dynamic and QSE species </td></tr>
<tr id="row_3_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structgridfire_1_1solver_1_1_q_s_e_network_solver_1_1_eigen_functor.html" target="_self">gridfire::solver::QSENetworkSolver::EigenFunctor&lt; T &gt;</a></td><td class="desc">Functor for calculating the residual and Jacobian for the QSE species using Eigen </td></tr>
<tr id="row_4_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_4_" class="arrow" onclick="dynsection.toggleFolder('4_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classgridfire_1_1_engine.html" target="_self">gridfire::Engine</a></td><td class="desc">Abstract base class for a reaction network engine </td></tr>
<tr id="row_4_0_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_4_0_" class="arrow" onclick="dynsection.toggleFolder('4_0_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classgridfire_1_1_dynamic_engine.html" target="_self">gridfire::DynamicEngine</a></td><td class="desc">Abstract class for engines supporting Jacobian and stoichiometry operations </td></tr>
<tr id="row_4_0_0_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classgridfire_1_1_adaptive_engine_view.html" target="_self">gridfire::AdaptiveEngineView</a></td><td class="desc">An engine view that dynamically adapts the reaction network based on runtime conditions </td></tr>
<tr id="row_4_0_1_" class="odd"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classgridfire_1_1_file_defined_engine_view.html" target="_self">gridfire::FileDefinedEngineView</a></td><td class="desc">An engine view that uses a user-defined reaction network from a file </td></tr>
<tr id="row_4_0_2_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classgridfire_1_1_graph_engine.html" target="_self">gridfire::GraphEngine</a></td><td class="desc">A reaction network engine that uses a graph-based representation </td></tr>
<tr id="row_5_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classgridfire_1_1_engine_view.html" target="_self">gridfire::EngineView&lt; EngineT &gt;</a></td><td class="desc">Abstract base class for a "view" of a reaction network engine </td></tr>
<tr id="row_6_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_6_" class="arrow" onclick="dynsection.toggleFolder('6_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classgridfire_1_1_engine_view.html" target="_self">gridfire::EngineView&lt; DynamicEngine &gt;</a></td><td class="desc"></td></tr>
<tr id="row_6_0_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classgridfire_1_1_adaptive_engine_view.html" target="_self">gridfire::AdaptiveEngineView</a></td><td class="desc">An engine view that dynamically adapts the reaction network based on runtime conditions </td></tr>
<tr id="row_6_1_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classgridfire_1_1_file_defined_engine_view.html" target="_self">gridfire::FileDefinedEngineView</a></td><td class="desc">An engine view that uses a user-defined reaction network from a file </td></tr>
<tr id="row_7_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structstd_1_1hash_3_01gridfire_1_1reaction_1_1_logical_reaction_set_01_4.html" target="_self">std::hash&lt; gridfire::reaction::LogicalReactionSet &gt;</a></td><td class="desc"></td></tr>
<tr id="row_8_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structstd_1_1hash_3_01gridfire_1_1reaction_1_1_reaction_01_4.html" target="_self">std::hash&lt; gridfire::reaction::Reaction &gt;</a></td><td class="desc"></td></tr>
<tr id="row_9_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structstd_1_1hash_3_01gridfire_1_1reaction_1_1_reaction_set_01_4.html" target="_self">std::hash&lt; gridfire::reaction::ReactionSet &gt;</a></td><td class="desc"></td></tr>
<tr id="row_10_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structgridfire_1_1approx8_1_1_jacobian.html" target="_self">gridfire::approx8::Jacobian</a></td><td class="desc">Functor to calculate the <a class="el" href="structgridfire_1_1approx8_1_1_jacobian.html" title="Functor to calculate the Jacobian matrix for implicit solvers.">Jacobian</a> matrix for implicit solvers </td></tr>
<tr id="row_11_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structgridfire_1_1solver_1_1_direct_network_solver_1_1_jacobian_functor.html" target="_self">gridfire::solver::DirectNetworkSolver::JacobianFunctor</a></td><td class="desc">Functor for calculating the Jacobian matrix </td></tr>
<tr id="row_12_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structgridfire_1_1solver_1_1_q_s_e_network_solver_1_1_jacobian_functor.html" target="_self">gridfire::solver::QSENetworkSolver::JacobianFunctor</a></td><td class="desc">Functor for calculating the Jacobian matrix of the ODEs for the dynamic species </td></tr>
<tr id="row_13_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structgridfire_1_1_net_in.html" target="_self">gridfire::NetIn</a></td><td class="desc"></td></tr>
<tr id="row_14_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structgridfire_1_1_net_out.html" target="_self">gridfire::NetOut</a></td><td class="desc"></td></tr>
<tr id="row_15_" class="odd"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_15_" class="arrow" onclick="dynsection.toggleFolder('15_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classgridfire_1_1_network.html" target="_self">gridfire::Network</a></td><td class="desc"></td></tr>
<tr id="row_15_0_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classgridfire_1_1approx8_1_1_approx8_network.html" target="_self">gridfire::approx8::Approx8Network</a></td><td class="desc">Class for the Approx8 nuclear reaction network </td></tr>
<tr id="row_16_" class="odd"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_16_" class="arrow" onclick="dynsection.toggleFolder('16_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classgridfire_1_1io_1_1_network_file_parser.html" target="_self">gridfire::io::NetworkFileParser</a></td><td class="desc">An abstract base class for network file parsers </td></tr>
<tr id="row_16_0_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classgridfire_1_1io_1_1_m_e_s_a_network_file_parser.html" target="_self">gridfire::io::MESANetworkFileParser</a></td><td class="desc">A parser for MESA-format network files </td></tr>
<tr id="row_16_1_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classgridfire_1_1io_1_1_simple_reaction_list_file_parser.html" target="_self">gridfire::io::SimpleReactionListFileParser</a></td><td class="desc">A parser for simple text files containing a list of reactions </td></tr>
<tr id="row_17_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classgridfire_1_1solver_1_1_network_solver_strategy.html" target="_self">gridfire::solver::NetworkSolverStrategy&lt; EngineT &gt;</a></td><td class="desc">Abstract base class for network solver strategies </td></tr>
<tr id="row_18_" class="odd"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_18_" class="arrow" onclick="dynsection.toggleFolder('18_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classgridfire_1_1solver_1_1_network_solver_strategy.html" target="_self">gridfire::solver::NetworkSolverStrategy&lt; DynamicEngine &gt;</a></td><td class="desc"></td></tr>
<tr id="row_18_0_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classgridfire_1_1solver_1_1_direct_network_solver.html" target="_self">gridfire::solver::DirectNetworkSolver</a></td><td class="desc">A network solver that directly integrates the reaction network ODEs </td></tr>
<tr id="row_18_1_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classgridfire_1_1solver_1_1_q_s_e_network_solver.html" target="_self">gridfire::solver::QSENetworkSolver</a></td><td class="desc">A network solver that uses a Quasi-Steady-State Equilibrium (QSE) approach </td></tr>
<tr id="row_19_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structgridfire_1_1approx8_1_1_o_d_e.html" target="_self">gridfire::approx8::ODE</a></td><td class="desc">Functor to calculate the derivatives for the <a class="el" href="structgridfire_1_1approx8_1_1_o_d_e.html" title="Functor to calculate the derivatives for the ODE solver.">ODE</a> solver </td></tr>
<tr id="row_20_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structgridfire_1_1io_1_1_parsed_network_data.html" target="_self">gridfire::io::ParsedNetworkData</a></td><td class="desc">Holds the data parsed from a network file </td></tr>
<tr id="row_21_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structgridfire_1_1_graph_engine_1_1_precomputed_reaction.html" target="_self">gridfire::GraphEngine::PrecomputedReaction</a></td><td class="desc"></td></tr>
<tr id="row_22_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structgridfire_1_1reaction_1_1_rate_coefficient_set.html" target="_self">gridfire::reaction::RateCoefficientSet</a></td><td class="desc">Holds the seven coefficients for the REACLIB rate equation </td></tr>
<tr id="row_23_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_23_" class="arrow" onclick="dynsection.toggleFolder('23_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classgridfire_1_1reaction_1_1_reaction.html" target="_self">gridfire::reaction::Reaction</a></td><td class="desc">Represents a single nuclear reaction from a specific data source </td></tr>
<tr id="row_23_0_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classgridfire_1_1reaction_1_1_logical_reaction.html" target="_self">gridfire::reaction::LogicalReaction</a></td><td class="desc">Represents a "logical" reaction that aggregates rates from multiple sources </td></tr>
<tr id="row_24_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structgridfire_1_1_adaptive_engine_view_1_1_reaction_flow.html" target="_self">gridfire::AdaptiveEngineView::ReactionFlow</a></td><td class="desc">A struct to hold a reaction and its flow rate </td></tr>
<tr id="row_25_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structgridfire_1_1reaclib_1_1_reaction_record.html" target="_self">gridfire::reaclib::ReactionRecord</a></td><td class="desc"></td></tr>
<tr id="row_26_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structgridfire_1_1solver_1_1_direct_network_solver_1_1_r_h_s_functor.html" target="_self">gridfire::solver::DirectNetworkSolver::RHSFunctor</a></td><td class="desc">Functor for calculating the right-hand side of the ODEs </td></tr>
<tr id="row_27_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structgridfire_1_1solver_1_1_q_s_e_network_solver_1_1_r_h_s_functor.html" target="_self">gridfire::solver::QSENetworkSolver::RHSFunctor</a></td><td class="desc">Functor for calculating the right-hand side of the ODEs for the dynamic species </td></tr>
<tr id="row_28_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_28_" class="arrow" onclick="dynsection.toggleFolder('28_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classgridfire_1_1screening_1_1_screening_model.html" target="_self">gridfire::screening::ScreeningModel</a></td><td class="desc">An abstract base class for plasma screening models </td></tr>
<tr id="row_28_0_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classgridfire_1_1screening_1_1_bare_screening_model.html" target="_self">gridfire::screening::BareScreeningModel</a></td><td class="desc">A screening model that applies no screening effect </td></tr>
<tr id="row_28_1_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classgridfire_1_1screening_1_1_weak_screening_model.html" target="_self">gridfire::screening::WeakScreeningModel</a></td><td class="desc">Implements the weak screening model based on the Debye-Hückel approximation </td></tr>
<tr id="row_29_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structgridfire_1_1_step_derivatives.html" target="_self">gridfire::StepDerivatives&lt; T &gt;</a></td><td class="desc">Structure holding derivatives and energy generation for a network step </td></tr>
<tr id="row_30_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classgridfire_1_1reaction_1_1_templated_reaction_set.html" target="_self">gridfire::reaction::TemplatedReactionSet&lt; ReactionT &gt;</a></td><td class="desc"></td></tr>
</table>
</div><!-- directory -->
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <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>