tboudreaux/SERiF
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(docs): rebuilt docs

Browse Source
This commit is contained in:
Emily Boudreaux
2025-06-16 12:33:11 -04:00
parent 556b5737be
commit 1a1db48ddd
37 changed files with 987 additions and 589 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/html/index.html
View File

@@ -291,7 +291,7 @@ Logging</h2>
</div><!-- fragment --><h2><a class="anchor" id="usage_eos"></a>
Equation of State (EOS)</h2>
<p>The <code>EosIO</code> class loads EOS tables, and the <code>helmholtz</code> namespace provides functions to use them, for example, the Helmholtz EOS.</p>
<div class="fragment"><div class="line"><span class="preprocessor">#include &quot;<a class="code" href="eos_i_o_8h.html">eosIO.h</a>&quot;</span></div>
<div class="fragment"><div class="line"><span class="preprocessor">#include &quot;<a class="code" href="_e_o_sio_8h.html">eosIO.h</a>&quot;</span></div>
<div class="line"><span class="preprocessor">#include &quot;<a class="code" href="helm_8h.html">helm.h</a>&quot;</span></div>
<div class="line"><span class="preprocessor">#include &lt;iostream&gt;</span></div>
<div class="line"> </div>
@@ -328,7 +328,7 @@ Equation of State (EOS)</h2>
<div class="line"> }</div>
<div class="line"> <span class="keywordflow">return</span> 0;</div>
<div class="line">}</div>
<div class="ttc" id="aeos_i_o_8h_html"><div class="ttname"><a href="eos_i_o_8h.html">eosIO.h</a></div></div>
<div class="ttc" id="a_e_o_sio_8h_html"><div class="ttname"><a href="_e_o_sio_8h.html">EOSio.h</a></div></div>
<div class="ttc" id="ahelm_8h_html"><div class="ttname"><a href="helm_8h.html">helm.h</a></div></div>
</div><!-- fragment --><h2><a class="anchor" id="usage_meshio"></a>
Mesh Handling</h2>
@@ -366,7 +366,7 @@ Key Modules and Components</h1>
<p>4DSSE is organized into several key modules:</p>
<ul>
<li><b>Polytrope Solver (<code><a class="el" href="poly_solver_8h.html">polySolver.h</a></code>, <code><a class="el" href="polytrope_operator_8h.html">polytropeOperator.h</a></code>):</b> Provides tools to solve the Lane-Emden equation for polytropic stellar structures using a mixed finite element method. <code>PolytropeOperator</code> defines the nonlinear system and its Jacobian, while <code>PolySolver</code> orchestrates the solution process. The <code>SchurCompliment</code> and <code>GMRESInverter</code> classes are helper components for the linear algebra involved.</li>
<li><b>Equation of State (EOS) (<code><a class="el" href="helm_8h.html">helm.h</a></code>, <code><a class="el" href="eos_i_o_8h.html">eosIO.h</a></code>):</b> Manages Equation of State data. <code><a class="el" href="helm_8h.html">helm.h</a></code> provides an implementation of the Helmholtz EOS (Timmes &amp; Swesty 2000), including structures for table data (<code>HELMTable</code>), input parameters (<code>EOSInput</code>), and output results (<code>EOS</code>). It also defines functions for reading tables and calculating EOS quantities. <code><a class="el" href="eos_i_o_8h.html">eosIO.h</a></code> provides the <code>EosIO</code> class for loading EOS tables from files, currently supporting the HELM table format.</li>
<li><b>Equation of State (EOS) (<code><a class="el" href="helm_8h.html">helm.h</a></code>, <code><a class="el" href="_e_o_sio_8h.html">eosIO.h</a></code>):</b> Manages Equation of State data. <code><a class="el" href="helm_8h.html">helm.h</a></code> provides an implementation of the Helmholtz EOS (Timmes &amp; Swesty 2000), including structures for table data (<code>HELMTable</code>), input parameters (<code>EOSInput</code>), and output results (<code>EOS</code>). It also defines functions for reading tables and calculating EOS quantities. <code><a class="el" href="_e_o_sio_8h.html">eosIO.h</a></code> provides the <code>EosIO</code> class for loading EOS tables from files, currently supporting the HELM table format.</li>
<li><b>Chemical Composition (<code><a class="el" href="composition_8h.html">composition.h</a></code>, <code>atomicSpecies.h</code>):</b> Manages chemical compositions, allowing representation in mass or number fractions. It interfaces with <code>atomicSpecies.h</code> which provides a database of atomic species properties (based on AME2020).</li>
<li><b>Nuclear Reaction Networks (<code><a class="el" href="network_8h.html">network.h</a></code>, <code><a class="el" href="approx8_8h.html" title="Header file for the Approx8 nuclear reaction network.">approx8.h</a></code>):</b> Defines a base <code>Network</code> class for nuclear reaction network calculations. <code><a class="el" href="approx8_8h.html" title="Header file for the Approx8 nuclear reaction network.">approx8.h</a></code> provides a specific implementation, <code>Approx8Network</code>, for an 8-isotope network (H1, He3, He4, C12, N14, O16, Ne20, Mg24) based on Frank Timmes' "aprox8". It includes functions for individual reaction rates and uses Boost.Numeric.Odeint for solving the ODE system.</li>
<li><b>Physical Constants (<code><a class="el" href="const_8h.html">const.h</a></code>):</b> A singleton class <code>Constants</code> that loads and provides access to a wide range of physical constants with their values, uncertainties, units, and references.</li>