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

docs(docs): rebuilt

Browse Source
This commit is contained in:
Emily Boudreaux
2025-06-11 14:50:33 -04:00
parent dae51a1303
commit 8dec139a00
43 changed files with 1622 additions and 1962 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
docs/latex/files.tex
View File

@@ -4,14 +4,8 @@ Here is a list of all files with brief descriptions\+:\begin{DoxyCompactList}
\item\contentsline{section}{src/composition/public/\mbox{\hyperlink{composition_8h}{composition.\+h}} }{\pageref{composition_8h}}{}
\item\contentsline{section}{src/config/private/\mbox{\hyperlink{config_8cpp}{config.\+cpp}} }{\pageref{config_8cpp}}{}
\item\contentsline{section}{src/config/public/\mbox{\hyperlink{config_8h}{config.\+h}} }{\pageref{config_8h}}{}
\item\contentsline{section}{src/const/private/\mbox{\hyperlink{const_8cpp}{const.\+cpp}} }{\pageref{const_8cpp}}{}
\item\contentsline{section}{src/const/public/\mbox{\hyperlink{const_8h}{const.\+h}} }{\pageref{const_8h}}{}
\item\contentsline{section}{src/dobj/private/\mbox{\hyperlink{_d_object_8cpp}{DObject.\+cpp}} \\*Implementation of the \doxylink{class_d_object}{DObject} class }{\pageref{_d_object_8cpp}}{}
\item\contentsline{section}{src/dobj/private/\mbox{\hyperlink{_lockable_d_object_8cpp}{Lockable\+DObject.\+cpp}} }{\pageref{_lockable_d_object_8cpp}}{}
\item\contentsline{section}{src/dobj/private/\mbox{\hyperlink{_metadata_8cpp}{Metadata.\+cpp}} \\*Implementation of the \doxylink{class_metadata}{Metadata} class used in the dobj module }{\pageref{_metadata_8cpp}}{}
\item\contentsline{section}{src/dobj/public/\mbox{\hyperlink{_d_object_8h}{DObject.\+h}} \\*Defines the \doxylink{class_d_object}{DObject} class, a universal data container for the project }{\pageref{_d_object_8h}}{}
\item\contentsline{section}{src/dobj/public/\mbox{\hyperlink{_lockable_d_object_8h}{Lockable\+DObject.\+h}} \\*A lightweight wrapper for \doxylink{class_d_object}{DObject} that adds locking capabilities }{\pageref{_lockable_d_object_8h}}{}
\item\contentsline{section}{src/dobj/public/\mbox{\hyperlink{_metadata_8h}{Metadata.\+h}} \\*Public interface for the \doxylink{class_metadata}{Metadata} class used in the dobj module }{\pageref{_metadata_8h}}{}
\item\contentsline{section}{src/constants/private/\mbox{\hyperlink{const_8cpp}{const.\+cpp}} }{\pageref{const_8cpp}}{}
\item\contentsline{section}{src/constants/public/\mbox{\hyperlink{const_8h}{const.\+h}} }{\pageref{const_8h}}{}
\item\contentsline{section}{src/eos/private/\mbox{\hyperlink{eos_i_o_8cpp}{eos\+IO.\+cpp}} }{\pageref{eos_i_o_8cpp}}{}
\item\contentsline{section}{src/eos/private/\mbox{\hyperlink{helm_8cpp}{helm.\+cpp}} }{\pageref{helm_8cpp}}{}
\item\contentsline{section}{src/eos/public/\mbox{\hyperlink{eos_i_o_8h}{eos\+IO.\+h}} }{\pageref{eos_i_o_8h}}{}
@@ -24,17 +18,16 @@ Here is a list of all files with brief descriptions\+:\begin{DoxyCompactList}
\item\contentsline{section}{src/network/private/\mbox{\hyperlink{network_8cpp}{network.\+cpp}} }{\pageref{network_8cpp}}{}
\item\contentsline{section}{src/network/public/\mbox{\hyperlink{approx8_8h}{approx8.\+h}} \\*Header file for the Approx8 nuclear reaction network }{\pageref{approx8_8h}}{}
\item\contentsline{section}{src/network/public/\mbox{\hyperlink{network_8h}{network.\+h}} }{\pageref{network_8h}}{}
\item\contentsline{section}{src/opac/public/\mbox{\hyperlink{opac_8h}{opac.\+h}} }{\pageref{opac_8h}}{}
\item\contentsline{section}{src/poly/coeff/private/\mbox{\hyperlink{poly_coeff_8cpp}{poly\+Coeff.\+cpp}} }{\pageref{poly_coeff_8cpp}}{}
\item\contentsline{section}{src/poly/coeff/public/\mbox{\hyperlink{poly_coeff_8h}{poly\+Coeff.\+h}} }{\pageref{poly_coeff_8h}}{}
\item\contentsline{section}{src/poly/solver/private/\mbox{\hyperlink{poly_solver_8cpp}{poly\+Solver.\+cpp}} }{\pageref{poly_solver_8cpp}}{}
\item\contentsline{section}{src/poly/solver/public/\mbox{\hyperlink{poly_solver_8h}{poly\+Solver.\+h}} }{\pageref{poly_solver_8h}}{}
\item\contentsline{section}{src/poly/utils/private/\mbox{\hyperlink{integrators_8cpp}{integrators.\+cpp}} }{\pageref{integrators_8cpp}}{}
\item\contentsline{section}{src/poly/utils/private/\mbox{\hyperlink{polytrope_operator_8cpp}{polytrope\+Operator.\+cpp}} }{\pageref{polytrope_operator_8cpp}}{}
\item\contentsline{section}{src/poly/utils/private/\mbox{\hyperlink{utilities_8cpp}{utilities.\+cpp}} }{\pageref{utilities_8cpp}}{}
\item\contentsline{section}{src/poly/utils/public/\mbox{\hyperlink{integrators_8h}{integrators.\+h}} \\*A collection of utilities for working with MFEM and solving the lane-\/emden equation }{\pageref{integrators_8h}}{}
\item\contentsline{section}{src/poly/utils/public/\mbox{\hyperlink{polytrope_operator_8h}{polytrope\+Operator.\+h}} }{\pageref{polytrope_operator_8h}}{}
\item\contentsline{section}{src/poly/utils/public/\mbox{\hyperlink{utilities_8h}{utilities.\+h}} }{\pageref{utilities_8h}}{}
\item\contentsline{section}{src/polytrope/coeff/private/\mbox{\hyperlink{poly_coeff_8cpp}{poly\+Coeff.\+cpp}} }{\pageref{poly_coeff_8cpp}}{}
\item\contentsline{section}{src/polytrope/coeff/public/\mbox{\hyperlink{poly_coeff_8h}{poly\+Coeff.\+h}} }{\pageref{poly_coeff_8h}}{}
\item\contentsline{section}{src/polytrope/solver/private/\mbox{\hyperlink{poly_solver_8cpp}{poly\+Solver.\+cpp}} }{\pageref{poly_solver_8cpp}}{}
\item\contentsline{section}{src/polytrope/solver/public/\mbox{\hyperlink{poly_solver_8h}{poly\+Solver.\+h}} }{\pageref{poly_solver_8h}}{}
\item\contentsline{section}{src/polytrope/utils/private/\mbox{\hyperlink{integrators_8cpp}{integrators.\+cpp}} }{\pageref{integrators_8cpp}}{}
\item\contentsline{section}{src/polytrope/utils/private/\mbox{\hyperlink{polytrope_operator_8cpp}{polytrope\+Operator.\+cpp}} }{\pageref{polytrope_operator_8cpp}}{}
\item\contentsline{section}{src/polytrope/utils/private/\mbox{\hyperlink{utilities_8cpp}{utilities.\+cpp}} }{\pageref{utilities_8cpp}}{}
\item\contentsline{section}{src/polytrope/utils/public/\mbox{\hyperlink{integrators_8h}{integrators.\+h}} \\*A collection of utilities for working with MFEM and solving the lane-\/emden equation }{\pageref{integrators_8h}}{}
\item\contentsline{section}{src/polytrope/utils/public/\mbox{\hyperlink{polytrope_operator_8h}{polytrope\+Operator.\+h}} }{\pageref{polytrope_operator_8h}}{}
\item\contentsline{section}{src/polytrope/utils/public/\mbox{\hyperlink{utilities_8h}{utilities.\+h}} }{\pageref{utilities_8h}}{}
\item\contentsline{section}{src/probe/private/\mbox{\hyperlink{probe_8cpp}{probe.\+cpp}} }{\pageref{probe_8cpp}}{}
\item\contentsline{section}{src/probe/public/\mbox{\hyperlink{probe_8h}{probe.\+h}} }{\pageref{probe_8h}}{}
\item\contentsline{section}{src/resource/private/\mbox{\hyperlink{resource_manager_8cpp}{resource\+Manager.\+cpp}} }{\pageref{resource_manager_8cpp}}{}
@@ -44,12 +37,8 @@ Here is a list of all files with brief descriptions\+:\begin{DoxyCompactList}
\item\contentsline{section}{src/types/public/\mbox{\hyperlink{4_d_s_t_a_r_types_8h}{4\+DSTARTypes.\+h}} }{\pageref{4_d_s_t_a_r_types_8h}}{}
\item\contentsline{section}{tests/composition/\mbox{\hyperlink{composition_test_8cpp}{composition\+Test.\+cpp}} }{\pageref{composition_test_8cpp}}{}
\item\contentsline{section}{tests/composition\+\_\+sandbox/\mbox{\hyperlink{comp_8cpp}{comp.\+cpp}} }{\pageref{comp_8cpp}}{}
\item\contentsline{section}{tests/config/\mbox{\hyperlink{config_test_8cpp}{config\+Test.\+cpp}} \\*Unit tests for the \doxylink{class_config}{Config} class }{\pageref{config_test_8cpp}}{}
\item\contentsline{section}{tests/config/\mbox{\hyperlink{config_test_8cpp}{config\+Test.\+cpp}} \\*Unit tests for the Config class }{\pageref{config_test_8cpp}}{}
\item\contentsline{section}{tests/const/\mbox{\hyperlink{const_test_8cpp}{const\+Test.\+cpp}} \\*Unit tests for the const class }{\pageref{const_test_8cpp}}{}
\item\contentsline{section}{tests/dobj/\mbox{\hyperlink{_d_object_test_8cpp}{DObject\+Test.\+cpp}} \\*Unit tests for the \doxylink{class_d_object}{DObject} class }{\pageref{_d_object_test_8cpp}}{}
\item\contentsline{section}{tests/dobj/\mbox{\hyperlink{_lockable_d_object_test_8cpp}{Lockable\+DObject\+Test.\+cpp}} \\*Unit tests for the \doxylink{class_lockable_d_object}{Lockable\+DObject} class }{\pageref{_lockable_d_object_test_8cpp}}{}
\item\contentsline{section}{tests/dobj/\mbox{\hyperlink{_metadata_test_8cpp}{Metadata\+Test.\+cpp}} \\*Unit tests and integration tests for the \doxylink{class_metadata}{Metadata} class }{\pageref{_metadata_test_8cpp}}{}
\item\contentsline{section}{tests/dobj\+\_\+sandbox/\mbox{\hyperlink{test_d_object_8cpp}{test\+DObject.\+cpp}} }{\pageref{test_d_object_8cpp}}{}
\item\contentsline{section}{tests/eos/\mbox{\hyperlink{eos_test_8cpp}{eos\+Test.\+cpp}} }{\pageref{eos_test_8cpp}}{}
\item\contentsline{section}{tests/mesh\+IO/\mbox{\hyperlink{mesh_i_o_test_8cpp}{mesh\+IOTest.\+cpp}} }{\pageref{mesh_i_o_test_8cpp}}{}
\item\contentsline{section}{tests/network/\mbox{\hyperlink{approx8_test_8cpp}{approx8\+Test.\+cpp}} }{\pageref{approx8_test_8cpp}}{}