171 lines
23 KiB
HTML
171 lines
23 KiB
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>SERiF: Class List</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">SERiF<span id="projectnumber"> 0.0.1a</span>
|
|
</div>
|
|
<div id="projectbrief">3+1D Stellar Structure and Evolution</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('annotated.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 List</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="textblock">Here are the classes, structs, unions and interfaces with brief descriptions:</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>]</div><table class="directory">
|
|
<tr id="row_0_" class="even"><td class="entry"><span style="width:0px;display:inline-block;"> </span><span id="arr_0_" class="arrow" onclick="dynsection.toggleFolder('0_')">▼</span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespacecomposition.html" target="_self">composition</a></td><td class="desc"></td></tr>
|
|
<tr id="row_0_0_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classcomposition_1_1_composition.html" target="_self">Composition</a></td><td class="desc"></td></tr>
|
|
<tr id="row_0_1_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structcomposition_1_1_composition_entry.html" target="_self">CompositionEntry</a></td><td class="desc">Represents an entry in the composition with a symbol and mass fraction </td></tr>
|
|
<tr id="row_0_2_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structcomposition_1_1_global_composition.html" target="_self">GlobalComposition</a></td><td class="desc">Represents the global composition of a system. This tends to be used after finalize and is primarily for internal use </td></tr>
|
|
<tr id="row_1_" class="even"><td class="entry"><span style="width:0px;display:inline-block;"> </span><span id="arr_1_" class="arrow" onclick="dynsection.toggleFolder('1_')">▼</span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespacehelmholtz.html" target="_self">helmholtz</a></td><td class="desc"></td></tr>
|
|
<tr id="row_1_0_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structhelmholtz_1_1_e_o_s.html" target="_self">EOS</a></td><td class="desc">Structure to hold the output parameters and derivatives of the <a class="el" href="structhelmholtz_1_1_e_o_s.html" title="Structure to hold the output parameters and derivatives of the EOS calculation.">EOS</a> calculation </td></tr>
|
|
<tr id="row_1_1_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structhelmholtz_1_1_e_o_s_input.html" target="_self">EOSInput</a></td><td class="desc">Structure to hold the input parameters for the <a class="el" href="structhelmholtz_1_1_e_o_s.html" title="Structure to hold the output parameters and derivatives of the EOS calculation.">EOS</a> calculation </td></tr>
|
|
<tr id="row_1_2_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structhelmholtz_1_1_h_e_l_m_table.html" target="_self">HELMTable</a></td><td class="desc">Structure to hold the Helmholtz <a class="el" href="structhelmholtz_1_1_e_o_s.html" title="Structure to hold the output parameters and derivatives of the EOS calculation.">EOS</a> table data </td></tr>
|
|
<tr id="row_2_" class="even"><td class="entry"><span style="width:0px;display:inline-block;"> </span><span id="arr_2_" class="arrow" onclick="dynsection.toggleFolder('2_')">▼</span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespacenn_approx8.html" target="_self">nnApprox8</a></td><td class="desc"></td></tr>
|
|
<tr id="row_2_0_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classnn_approx8_1_1_approx8_network.html" target="_self">Approx8Network</a></td><td class="desc">Class for the Approx8 nuclear reaction network </td></tr>
|
|
<tr id="row_2_1_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structnn_approx8_1_1_jacobian.html" target="_self">Jacobian</a></td><td class="desc">Functor to calculate the <a class="el" href="structnn_approx8_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_2_2_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structnn_approx8_1_1_net.html" target="_self">Net</a></td><td class="desc">Contains constants and arrays related to the nuclear network </td></tr>
|
|
<tr id="row_2_3_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structnn_approx8_1_1_o_d_e.html" target="_self">ODE</a></td><td class="desc">Functor to calculate the derivatives for the <a class="el" href="structnn_approx8_1_1_o_d_e.html" title="Functor to calculate the derivatives for the ODE solver.">ODE</a> solver </td></tr>
|
|
<tr id="row_3_" class="odd"><td class="entry"><span style="width:0px;display:inline-block;"> </span><span id="arr_3_" class="arrow" onclick="dynsection.toggleFolder('3_')">▼</span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespacenuclear_network.html" target="_self">nuclearNetwork</a></td><td class="desc"></td></tr>
|
|
<tr id="row_3_0_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structnuclear_network_1_1_net_in.html" target="_self">NetIn</a></td><td class="desc">Input structure for the network evaluation </td></tr>
|
|
<tr id="row_3_1_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structnuclear_network_1_1_net_out.html" target="_self">NetOut</a></td><td class="desc">Output structure for the network evaluation </td></tr>
|
|
<tr id="row_3_2_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classnuclear_network_1_1_network.html" target="_self">Network</a></td><td class="desc">Class for network evaluation </td></tr>
|
|
<tr id="row_4_" class="odd"><td class="entry"><span style="width:0px;display:inline-block;"> </span><span id="arr_4_" class="arrow" onclick="dynsection.toggleFolder('4_')">▼</span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespacepolycoeff.html" target="_self">polycoeff</a></td><td class="desc"></td></tr>
|
|
<tr id="row_4_0_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structpolycoeff_1_1d_theta_interp_coeff.html" target="_self">dThetaInterpCoeff</a></td><td class="desc"></td></tr>
|
|
<tr id="row_4_1_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structpolycoeff_1_1x1_interp_coeff.html" target="_self">x1InterpCoeff</a></td><td class="desc">Coefficients for the interpolations of the surface location of a polytrope </td></tr>
|
|
<tr id="row_5_" class="even"><td class="entry"><span style="width:0px;display:inline-block;"> </span><span id="arr_5_" class="arrow" onclick="dynsection.toggleFolder('5_')">▼</span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespacepoly_m_f_e_m_utils.html" target="_self">polyMFEMUtils</a></td><td class="desc">A namespace for utilities for working with MFEM and solving the lane-emden equation </td></tr>
|
|
<tr id="row_5_0_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classpoly_m_f_e_m_utils_1_1_nonlinear_power_integrator.html" target="_self">NonlinearPowerIntegrator</a></td><td class="desc">A class for nonlinear power integrator </td></tr>
|
|
<tr id="row_6_" class="even"><td class="entry"><span style="width:0px;display:inline-block;"> </span><span id="arr_6_" class="arrow" onclick="dynsection.toggleFolder('6_')">▼</span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespace_probe.html" target="_self">Probe</a></td><td class="desc">The <a class="el" href="namespace_probe.html" title="The Probe namespace contains utility functions for debugging and logging.">Probe</a> namespace contains utility functions for debugging and logging </td></tr>
|
|
<tr id="row_6_0_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_probe_1_1_log_manager.html" target="_self">LogManager</a></td><td class="desc">Class to manage logging operations </td></tr>
|
|
<tr id="row_7_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classapprox8_test.html" target="_self">approx8Test</a></td><td class="desc"></td></tr>
|
|
<tr id="row_8_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classcomposition_test.html" target="_self">compositionTest</a></td><td class="desc">Test suite for the composition class </td></tr>
|
|
<tr id="row_9_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_config.html" target="_self">Config</a></td><td class="desc">Singleton class to manage configuration settings loaded from a YAML file </td></tr>
|
|
<tr id="row_10_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classconfig_test.html" target="_self">configTest</a></td><td class="desc">Test suite for the <a class="el" href="class_config.html" title="Singleton class to manage configuration settings loaded from a YAML file.">Config</a> class </td></tr>
|
|
<tr id="row_11_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classconfig_test_private_accessor.html" target="_self">configTestPrivateAccessor</a></td><td class="desc"></td></tr>
|
|
<tr id="row_12_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_constant.html" target="_self">Constant</a></td><td class="desc">Structure to hold a constant's details </td></tr>
|
|
<tr id="row_13_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_constants.html" target="_self">Constants</a></td><td class="desc">Class to manage a collection of constants </td></tr>
|
|
<tr id="row_14_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classconst_test.html" target="_self">constTest</a></td><td class="desc">Test suite for the const class </td></tr>
|
|
<tr id="row_15_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_d_object.html" target="_self">DObject</a></td><td class="desc">A universal data container class </td></tr>
|
|
<tr id="row_16_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_d_object_test.html" target="_self">DObjectTest</a></td><td class="desc">Test suite for the <a class="el" href="class_d_object.html" title="A universal data container class.">DObject</a> class </td></tr>
|
|
<tr id="row_17_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_eos_i_o.html" target="_self">EosIO</a></td><td class="desc">Handles the input/output operations for EOS tables </td></tr>
|
|
<tr id="row_18_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classeos_test.html" target="_self">eosTest</a></td><td class="desc">Test suite for the const class </td></tr>
|
|
<tr id="row_19_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structform_bundle.html" target="_self">formBundle</a></td><td class="desc">Structure to hold the various bilinear and nonlinear forms for the polytrope problem </td></tr>
|
|
<tr id="row_20_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_g_m_r_e_s_inverter.html" target="_self">GMRESInverter</a></td><td class="desc">Provides an approximate inverse of the <a class="el" href="class_schur_compliment.html" title="Represents the Schur complement operator used in the solution process.">SchurCompliment</a> operator using GMRES </td></tr>
|
|
<tr id="row_21_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_lockable_d_object.html" target="_self">LockableDObject</a></td><td class="desc">Wrapper for <a class="el" href="class_d_object.html" title="A universal data container class.">DObject</a> with thread-safe access </td></tr>
|
|
<tr id="row_22_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_lockable_d_object_test.html" target="_self">LockableDObjectTest</a></td><td class="desc">Test suite for the <a class="el" href="class_lockable_d_object.html" title="Wrapper for DObject with thread-safe access.">LockableDObject</a> class </td></tr>
|
|
<tr id="row_23_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_mesh_i_o.html" target="_self">MeshIO</a></td><td class="desc">Class for handling mesh input/output operations </td></tr>
|
|
<tr id="row_24_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classmesh_i_o_test.html" target="_self">meshIOTest</a></td><td class="desc"></td></tr>
|
|
<tr id="row_25_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_metadata.html" target="_self">Metadata</a></td><td class="desc">Represents metadata information for data objects in the dobj module </td></tr>
|
|
<tr id="row_26_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_metadata_test.html" target="_self">MetadataTest</a></td><td class="desc">Test suite for the <a class="el" href="class_metadata.html" title="Represents metadata information for data objects in the dobj module.">Metadata</a> class </td></tr>
|
|
<tr id="row_27_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_poly_solver.html" target="_self">PolySolver</a></td><td class="desc">Solves the Lane-Emden equation for a polytropic star using a mixed finite element method </td></tr>
|
|
<tr id="row_28_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classpoly_test.html" target="_self">polyTest</a></td><td class="desc"></td></tr>
|
|
<tr id="row_29_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_polytrope_operator.html" target="_self">PolytropeOperator</a></td><td class="desc">Represents the coupled nonlinear operator for the polytropic system </td></tr>
|
|
<tr id="row_30_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classprobe_test.html" target="_self">probeTest</a></td><td class="desc"></td></tr>
|
|
<tr id="row_31_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_resource_manager.html" target="_self">ResourceManager</a></td><td class="desc">Manages resources within the application </td></tr>
|
|
<tr id="row_32_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classresource_manager_test.html" target="_self">resourceManagerTest</a></td><td class="desc">Test suite for the resourceManager class </td></tr>
|
|
<tr id="row_33_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_schur_compliment.html" target="_self">SchurCompliment</a></td><td class="desc">Represents the Schur complement operator used in the solution process </td></tr>
|
|
<tr id="row_34_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structsolver_bundle.html" target="_self">solverBundle</a></td><td class="desc">Structure to manage the lifetime of MFEM solver objects </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>
|