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

64
docs/latex/annotated.tex
View File

@@ -1,48 +1,42 @@
\doxysection{Class List}
Here are the classes, structs, unions and interfaces with brief descriptions\+:\begin{DoxyCompactList}
\item\contentsline{section}{\mbox{\hyperlink{classnn_approx8_1_1_approx8_network}{nn\+Approx8\+::\+Approx8\+Network}} \\*Class for the Approx8 nuclear reaction network }{\pageref{classnn_approx8_1_1_approx8_network}}{}
\item\contentsline{section}{\mbox{\hyperlink{classserif_1_1network_1_1approx8_1_1_approx8_network}{serif\+::network\+::approx8\+::\+Approx8\+Network}} \\*Class for the Approx8 nuclear reaction network }{\pageref{classserif_1_1network_1_1approx8_1_1_approx8_network}}{}
\item\contentsline{section}{\mbox{\hyperlink{classapprox8_test}{approx8\+Test}} }{\pageref{classapprox8_test}}{}
\item\contentsline{section}{\mbox{\hyperlink{classcomposition_1_1_composition}{composition\+::\+Composition}} }{\pageref{classcomposition_1_1_composition}}{}
\item\contentsline{section}{\mbox{\hyperlink{structcomposition_1_1_composition_entry}{composition\+::\+Composition\+Entry}} \\*Represents an entry in the composition with a symbol and mass fraction }{\pageref{structcomposition_1_1_composition_entry}}{}
\item\contentsline{section}{\mbox{\hyperlink{classserif_1_1composition_1_1_composition}{serif\+::composition\+::\+Composition}} }{\pageref{classserif_1_1composition_1_1_composition}}{}
\item\contentsline{section}{\mbox{\hyperlink{structserif_1_1composition_1_1_composition_entry}{serif\+::composition\+::\+Composition\+Entry}} \\*Represents an entry in the composition with a symbol and mass fraction }{\pageref{structserif_1_1composition_1_1_composition_entry}}{}
\item\contentsline{section}{\mbox{\hyperlink{classcomposition_test}{composition\+Test}} \\*Test suite for the composition class }{\pageref{classcomposition_test}}{}
\item\contentsline{section}{\mbox{\hyperlink{class_config}{Config}} \\*Singleton class to manage configuration settings loaded from a YAML file }{\pageref{class_config}}{}
\item\contentsline{section}{\mbox{\hyperlink{classconfig_test}{config\+Test}} \\*Test suite for the \doxylink{class_config}{Config} class }{\pageref{classconfig_test}}{}
\item\contentsline{section}{\mbox{\hyperlink{classconfig_test}{config\+Test}} \\*Test suite for the Config class }{\pageref{classconfig_test}}{}
\item\contentsline{section}{\mbox{\hyperlink{classconfig_test_private_accessor}{config\+Test\+Private\+Accessor}} }{\pageref{classconfig_test_private_accessor}}{}
\item\contentsline{section}{\mbox{\hyperlink{struct_constant}{Constant}} \\*Structure to hold a constant\textquotesingle{}s details }{\pageref{struct_constant}}{}
\item\contentsline{section}{\mbox{\hyperlink{class_constants}{Constants}} \\*Class to manage a collection of constants }{\pageref{class_constants}}{}
\item\contentsline{section}{\mbox{\hyperlink{structserif_1_1constant_1_1_constant}{serif\+::constant\+::\+Constant}} \\*Structure to hold a constant\textquotesingle{}s details }{\pageref{structserif_1_1constant_1_1_constant}}{}
\item\contentsline{section}{\mbox{\hyperlink{classserif_1_1constant_1_1_constants}{serif\+::constant\+::\+Constants}} \\*Class to manage a collection of constants }{\pageref{classserif_1_1constant_1_1_constants}}{}
\item\contentsline{section}{\mbox{\hyperlink{classconst_test}{const\+Test}} \\*Test suite for the const class }{\pageref{classconst_test}}{}
\item\contentsline{section}{\mbox{\hyperlink{class_d_object}{DObject}} \\*A universal data container class }{\pageref{class_d_object}}{}
\item\contentsline{section}{\mbox{\hyperlink{class_d_object_test}{DObject\+Test}} \\*Test suite for the \doxylink{class_d_object}{DObject} class }{\pageref{class_d_object_test}}{}
\item\contentsline{section}{\mbox{\hyperlink{structpolycoeff_1_1d_theta_interp_coeff}{polycoeff\+::d\+Theta\+Interp\+Coeff}} }{\pageref{structpolycoeff_1_1d_theta_interp_coeff}}{}
\item\contentsline{section}{\mbox{\hyperlink{structhelmholtz_1_1_e_o_s}{helmholtz\+::\+EOS}} \\*Structure to hold the output parameters and derivatives of the \doxylink{structhelmholtz_1_1_e_o_s}{EOS} calculation }{\pageref{structhelmholtz_1_1_e_o_s}}{}
\item\contentsline{section}{\mbox{\hyperlink{structhelmholtz_1_1_e_o_s_input}{helmholtz\+::\+EOSInput}} \\*Structure to hold the input parameters for the \doxylink{structhelmholtz_1_1_e_o_s}{EOS} calculation }{\pageref{structhelmholtz_1_1_e_o_s_input}}{}
\item\contentsline{section}{\mbox{\hyperlink{class_eos_i_o}{Eos\+IO}} \\*Handles the input/output operations for EOS tables }{\pageref{class_eos_i_o}}{}
\item\contentsline{section}{\mbox{\hyperlink{structserif_1_1polytrope_1_1polycoeff_1_1d_theta_interp_coeff}{serif\+::polytrope\+::polycoeff\+::d\+Theta\+Interp\+Coeff}} }{\pageref{structserif_1_1polytrope_1_1polycoeff_1_1d_theta_interp_coeff}}{}
\item\contentsline{section}{\mbox{\hyperlink{structserif_1_1eos_1_1helmholtz_1_1_e_o_s}{serif\+::eos\+::helmholtz\+::\+EOS}} \\*Structure to hold the output parameters and derivatives of the \doxylink{structserif_1_1eos_1_1helmholtz_1_1_e_o_s}{EOS} calculation }{\pageref{structserif_1_1eos_1_1helmholtz_1_1_e_o_s}}{}
\item\contentsline{section}{\mbox{\hyperlink{structserif_1_1eos_1_1helmholtz_1_1_e_o_s_input}{serif\+::eos\+::helmholtz\+::\+EOSInput}} \\*Structure to hold the input parameters for the \doxylink{structserif_1_1eos_1_1helmholtz_1_1_e_o_s}{EOS} calculation }{\pageref{structserif_1_1eos_1_1helmholtz_1_1_e_o_s_input}}{}
\item\contentsline{section}{\mbox{\hyperlink{classserif_1_1eos_1_1_eos_i_o}{serif\+::eos\+::\+Eos\+IO}} \\*Handles the input/output operations for EOS tables }{\pageref{classserif_1_1eos_1_1_eos_i_o}}{}
\item\contentsline{section}{\mbox{\hyperlink{classeos_test}{eos\+Test}} \\*Test suite for the const class }{\pageref{classeos_test}}{}
\item\contentsline{section}{\mbox{\hyperlink{structform_bundle}{form\+Bundle}} \\*Structure to hold the various bilinear and nonlinear forms for the polytrope problem }{\pageref{structform_bundle}}{}
\item\contentsline{section}{\mbox{\hyperlink{structcomposition_1_1_global_composition}{composition\+::\+Global\+Composition}} \\*Represents the global composition of a system. This tends to be used after finalize and is primarily for internal use }{\pageref{structcomposition_1_1_global_composition}}{}
\item\contentsline{section}{\mbox{\hyperlink{class_g_m_r_e_s_inverter}{GMRESInverter}} \\*Provides an approximate inverse of the \doxylink{class_schur_compliment}{Schur\+Compliment} operator using GMRES }{\pageref{class_g_m_r_e_s_inverter}}{}
\item\contentsline{section}{\mbox{\hyperlink{structhelmholtz_1_1_h_e_l_m_table}{helmholtz\+::\+HELMTable}} \\*Structure to hold the Helmholtz \doxylink{structhelmholtz_1_1_e_o_s}{EOS} table data }{\pageref{structhelmholtz_1_1_h_e_l_m_table}}{}
\item\contentsline{section}{\mbox{\hyperlink{structnn_approx8_1_1_jacobian}{nn\+Approx8\+::\+Jacobian}} \\*Functor to calculate the \doxylink{structnn_approx8_1_1_jacobian}{Jacobian} matrix for implicit solvers }{\pageref{structnn_approx8_1_1_jacobian}}{}
\item\contentsline{section}{\mbox{\hyperlink{class_lockable_d_object}{Lockable\+DObject}} \\*Wrapper for \doxylink{class_d_object}{DObject} with thread-\/safe access }{\pageref{class_lockable_d_object}}{}
\item\contentsline{section}{\mbox{\hyperlink{class_lockable_d_object_test}{Lockable\+DObject\+Test}} \\*Test suite for the \doxylink{class_lockable_d_object}{Lockable\+DObject} class }{\pageref{class_lockable_d_object_test}}{}
\item\contentsline{section}{\mbox{\hyperlink{class_probe_1_1_log_manager}{Probe\+::\+Log\+Manager}} \\*Class to manage logging operations }{\pageref{class_probe_1_1_log_manager}}{}
\item\contentsline{section}{\mbox{\hyperlink{class_mesh_i_o}{Mesh\+IO}} \\*Class for handling mesh input/output operations }{\pageref{class_mesh_i_o}}{}
\item\contentsline{section}{\mbox{\hyperlink{structserif_1_1polytrope_1_1form_bundle}{serif\+::polytrope\+::form\+Bundle}} \\*Structure to hold the various bilinear and nonlinear forms for the polytrope problem }{\pageref{structserif_1_1polytrope_1_1form_bundle}}{}
\item\contentsline{section}{\mbox{\hyperlink{structserif_1_1composition_1_1_global_composition}{serif\+::composition\+::\+Global\+Composition}} \\*Represents the global composition of a system. This tends to be used after finalize and is primarily for internal use }{\pageref{structserif_1_1composition_1_1_global_composition}}{}
\item\contentsline{section}{\mbox{\hyperlink{classserif_1_1polytrope_1_1_g_m_r_e_s_inverter}{serif\+::polytrope\+::\+GMRESInverter}} \\*Provides an approximate inverse of the \doxylink{classserif_1_1polytrope_1_1_schur_compliment}{Schur\+Compliment} operator using GMRES }{\pageref{classserif_1_1polytrope_1_1_g_m_r_e_s_inverter}}{}
\item\contentsline{section}{\mbox{\hyperlink{structserif_1_1eos_1_1helmholtz_1_1_h_e_l_m_table}{serif\+::eos\+::helmholtz\+::\+HELMTable}} \\*Structure to hold the Helmholtz \doxylink{structserif_1_1eos_1_1helmholtz_1_1_e_o_s}{EOS} table data }{\pageref{structserif_1_1eos_1_1helmholtz_1_1_h_e_l_m_table}}{}
\item\contentsline{section}{\mbox{\hyperlink{structserif_1_1network_1_1approx8_1_1_jacobian}{serif\+::network\+::approx8\+::\+Jacobian}} \\*Functor to calculate the \doxylink{structserif_1_1network_1_1approx8_1_1_jacobian}{Jacobian} matrix for implicit solvers }{\pageref{structserif_1_1network_1_1approx8_1_1_jacobian}}{}
\item\contentsline{section}{\mbox{\hyperlink{classserif_1_1probe_1_1_log_manager}{serif\+::probe\+::\+Log\+Manager}} \\*Class to manage logging operations }{\pageref{classserif_1_1probe_1_1_log_manager}}{}
\item\contentsline{section}{\mbox{\hyperlink{classserif_1_1mesh_1_1_mesh_i_o}{serif\+::mesh\+::\+Mesh\+IO}} \\*Class for handling mesh input/output operations }{\pageref{classserif_1_1mesh_1_1_mesh_i_o}}{}
\item\contentsline{section}{\mbox{\hyperlink{classmesh_i_o_test}{mesh\+IOTest}} }{\pageref{classmesh_i_o_test}}{}
\item\contentsline{section}{\mbox{\hyperlink{class_metadata}{Metadata}} \\*Represents metadata information for data objects in the dobj module }{\pageref{class_metadata}}{}
\item\contentsline{section}{\mbox{\hyperlink{class_metadata_test}{Metadata\+Test}} \\*Test suite for the \doxylink{class_metadata}{Metadata} class }{\pageref{class_metadata_test}}{}
\item\contentsline{section}{\mbox{\hyperlink{structnn_approx8_1_1_net}{nn\+Approx8\+::\+Net}} \\*Contains constants and arrays related to the nuclear network }{\pageref{structnn_approx8_1_1_net}}{}
\item\contentsline{section}{\mbox{\hyperlink{structnuclear_network_1_1_net_in}{nuclear\+Network\+::\+Net\+In}} \\*Input structure for the network evaluation }{\pageref{structnuclear_network_1_1_net_in}}{}
\item\contentsline{section}{\mbox{\hyperlink{structnuclear_network_1_1_net_out}{nuclear\+Network\+::\+Net\+Out}} \\*Output structure for the network evaluation }{\pageref{structnuclear_network_1_1_net_out}}{}
\item\contentsline{section}{\mbox{\hyperlink{classnuclear_network_1_1_network}{nuclear\+Network\+::\+Network}} \\*Class for network evaluation }{\pageref{classnuclear_network_1_1_network}}{}
\item\contentsline{section}{\mbox{\hyperlink{classpoly_m_f_e_m_utils_1_1_nonlinear_power_integrator}{poly\+MFEMUtils\+::\+Nonlinear\+Power\+Integrator}} \\*A class for nonlinear power integrator }{\pageref{classpoly_m_f_e_m_utils_1_1_nonlinear_power_integrator}}{}
\item\contentsline{section}{\mbox{\hyperlink{structnn_approx8_1_1_o_d_e}{nn\+Approx8\+::\+ODE}} \\*Functor to calculate the derivatives for the \doxylink{structnn_approx8_1_1_o_d_e}{ODE} solver }{\pageref{structnn_approx8_1_1_o_d_e}}{}
\item\contentsline{section}{\mbox{\hyperlink{class_poly_solver}{Poly\+Solver}} \\*Solves the Lane-\/\+Emden equation for a polytropic star using a mixed finite element method }{\pageref{class_poly_solver}}{}
\item\contentsline{section}{\mbox{\hyperlink{structserif_1_1network_1_1approx8_1_1_net}{serif\+::network\+::approx8\+::\+Net}} \\*Contains constants and arrays related to the nuclear network }{\pageref{structserif_1_1network_1_1approx8_1_1_net}}{}
\item\contentsline{section}{\mbox{\hyperlink{structserif_1_1network_1_1_net_in}{serif\+::network\+::\+Net\+In}} \\*Input structure for the network evaluation }{\pageref{structserif_1_1network_1_1_net_in}}{}
\item\contentsline{section}{\mbox{\hyperlink{structserif_1_1network_1_1_net_out}{serif\+::network\+::\+Net\+Out}} \\*Output structure for the network evaluation }{\pageref{structserif_1_1network_1_1_net_out}}{}
\item\contentsline{section}{\mbox{\hyperlink{classserif_1_1network_1_1_network}{serif\+::network\+::\+Network}} \\*Class for network evaluation }{\pageref{classserif_1_1network_1_1_network}}{}
\item\contentsline{section}{\mbox{\hyperlink{classserif_1_1polytrope_1_1poly_m_f_e_m_utils_1_1_nonlinear_power_integrator}{serif\+::polytrope\+::poly\+MFEMUtils\+::\+Nonlinear\+Power\+Integrator}} \\*A class for nonlinear power integrator }{\pageref{classserif_1_1polytrope_1_1poly_m_f_e_m_utils_1_1_nonlinear_power_integrator}}{}
\item\contentsline{section}{\mbox{\hyperlink{structserif_1_1network_1_1approx8_1_1_o_d_e}{serif\+::network\+::approx8\+::\+ODE}} \\*Functor to calculate the derivatives for the \doxylink{structserif_1_1network_1_1approx8_1_1_o_d_e}{ODE} solver }{\pageref{structserif_1_1network_1_1approx8_1_1_o_d_e}}{}
\item\contentsline{section}{\mbox{\hyperlink{classserif_1_1polytrope_1_1_poly_solver}{serif\+::polytrope\+::\+Poly\+Solver}} \\*Solves the Lane-\/\+Emden equation for a polytropic star using a mixed finite element method }{\pageref{classserif_1_1polytrope_1_1_poly_solver}}{}
\item\contentsline{section}{\mbox{\hyperlink{classpoly_test}{poly\+Test}} }{\pageref{classpoly_test}}{}
\item\contentsline{section}{\mbox{\hyperlink{class_polytrope_operator}{Polytrope\+Operator}} \\*Represents the coupled nonlinear operator for the polytropic system }{\pageref{class_polytrope_operator}}{}
\item\contentsline{section}{\mbox{\hyperlink{classserif_1_1polytrope_1_1_polytrope_operator}{serif\+::polytrope\+::\+Polytrope\+Operator}} \\*Represents the coupled nonlinear operator for the polytropic system }{\pageref{classserif_1_1polytrope_1_1_polytrope_operator}}{}
\item\contentsline{section}{\mbox{\hyperlink{classprobe_test}{probe\+Test}} }{\pageref{classprobe_test}}{}
\item\contentsline{section}{\mbox{\hyperlink{class_resource_manager}{Resource\+Manager}} \\*Manages resources within the application }{\pageref{class_resource_manager}}{}
\item\contentsline{section}{\mbox{\hyperlink{classserif_1_1resource_1_1_resource_manager}{serif\+::resource\+::\+Resource\+Manager}} }{\pageref{classserif_1_1resource_1_1_resource_manager}}{}
\item\contentsline{section}{\mbox{\hyperlink{classresource_manager_test}{resource\+Manager\+Test}} \\*Test suite for the resource\+Manager class }{\pageref{classresource_manager_test}}{}
\item\contentsline{section}{\mbox{\hyperlink{class_schur_compliment}{Schur\+Compliment}} \\*Represents the Schur complement operator used in the solution process }{\pageref{class_schur_compliment}}{}
\item\contentsline{section}{\mbox{\hyperlink{structsolver_bundle}{solver\+Bundle}} \\*Structure to manage the lifetime of MFEM solver objects }{\pageref{structsolver_bundle}}{}
\item\contentsline{section}{\mbox{\hyperlink{structpolycoeff_1_1x1_interp_coeff}{polycoeff\+::x1\+Interp\+Coeff}} \\*Coefficients for the interpolations of the surface location of a polytrope }{\pageref{structpolycoeff_1_1x1_interp_coeff}}{}
\item\contentsline{section}{\mbox{\hyperlink{classserif_1_1polytrope_1_1_schur_compliment}{serif\+::polytrope\+::\+Schur\+Compliment}} \\*Represents the Schur complement operator used in the solution process }{\pageref{classserif_1_1polytrope_1_1_schur_compliment}}{}
\item\contentsline{section}{\mbox{\hyperlink{structserif_1_1polytrope_1_1solver_bundle}{serif\+::polytrope\+::solver\+Bundle}} \\*Structure to manage the lifetime of MFEM solver objects }{\pageref{structserif_1_1polytrope_1_1solver_bundle}}{}
\item\contentsline{section}{\mbox{\hyperlink{structserif_1_1polytrope_1_1polycoeff_1_1x1_interp_coeff}{serif\+::polytrope\+::polycoeff\+::x1\+Interp\+Coeff}} \\*Coefficients for the interpolations of the surface location of a polytrope }{\pageref{structserif_1_1polytrope_1_1polycoeff_1_1x1_interp_coeff}}{}
\end{DoxyCompactList}

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}}{}

110
docs/latex/refman.tex
View File

@@ -244,63 +244,65 @@
\chapter{File Index}
\input{files}
\chapter{Namespace Documentation}
\input{namespacecomposition}
\input{namespacehelmholtz}
\input{namespacelane_emden}
\input{namespacenn_approx8}
\input{namespacenuclear_network}
\input{namespacepolycoeff}
\input{namespacepoly_m_f_e_m_utils}
\input{namespace_probe}
\input{namespaceserif}
\input{namespaceserif_1_1composition}
\input{namespaceserif_1_1config}
\input{namespaceserif_1_1constant}
\input{namespaceserif_1_1eos}
\input{namespaceserif_1_1eos_1_1helmholtz}
\input{namespaceserif_1_1mesh}
\input{namespaceserif_1_1network}
\input{namespaceserif_1_1network_1_1approx8}
\input{namespaceserif_1_1polytrope}
\input{namespaceserif_1_1polytrope_1_1lane_emden}
\input{namespaceserif_1_1polytrope_1_1polycoeff}
\input{namespaceserif_1_1polytrope_1_1poly_m_f_e_m_utils}
\input{namespaceserif_1_1probe}
\input{namespaceserif_1_1resource}
\input{namespaceserif_1_1resource_1_1types}
\input{namespaceserif_1_1types}
\input{namespaceserif_1_1utilities}
\input{namespace_s_s_e}
\chapter{Class Documentation}
\input{classnn_approx8_1_1_approx8_network}
\input{classserif_1_1network_1_1approx8_1_1_approx8_network}
\input{classapprox8_test}
\input{classcomposition_1_1_composition}
\input{structcomposition_1_1_composition_entry}
\input{classserif_1_1composition_1_1_composition}
\input{structserif_1_1composition_1_1_composition_entry}
\input{classcomposition_test}
\input{class_config}
\input{classconfig_test}
\input{classconfig_test_private_accessor}
\input{struct_constant}
\input{class_constants}
\input{structserif_1_1constant_1_1_constant}
\input{classserif_1_1constant_1_1_constants}
\input{classconst_test}
\input{class_d_object}
\input{class_d_object_test}
\input{structpolycoeff_1_1d_theta_interp_coeff}
\input{structhelmholtz_1_1_e_o_s}
\input{structhelmholtz_1_1_e_o_s_input}
\input{class_eos_i_o}
\input{structserif_1_1polytrope_1_1polycoeff_1_1d_theta_interp_coeff}
\input{structserif_1_1eos_1_1helmholtz_1_1_e_o_s}
\input{structserif_1_1eos_1_1helmholtz_1_1_e_o_s_input}
\input{classserif_1_1eos_1_1_eos_i_o}
\input{classeos_test}
\input{structform_bundle}
\input{structcomposition_1_1_global_composition}
\input{class_g_m_r_e_s_inverter}
\input{structhelmholtz_1_1_h_e_l_m_table}
\input{structnn_approx8_1_1_jacobian}
\input{class_lockable_d_object}
\input{class_lockable_d_object_test}
\input{class_probe_1_1_log_manager}
\input{class_mesh_i_o}
\input{structserif_1_1polytrope_1_1form_bundle}
\input{structserif_1_1composition_1_1_global_composition}
\input{classserif_1_1polytrope_1_1_g_m_r_e_s_inverter}
\input{structserif_1_1eos_1_1helmholtz_1_1_h_e_l_m_table}
\input{structserif_1_1network_1_1approx8_1_1_jacobian}
\input{classserif_1_1probe_1_1_log_manager}
\input{classserif_1_1mesh_1_1_mesh_i_o}
\input{classmesh_i_o_test}
\input{class_metadata}
\input{class_metadata_test}
\input{structnn_approx8_1_1_net}
\input{structnuclear_network_1_1_net_in}
\input{structnuclear_network_1_1_net_out}
\input{classnuclear_network_1_1_network}
\input{classpoly_m_f_e_m_utils_1_1_nonlinear_power_integrator}
\input{structnn_approx8_1_1_o_d_e}
\input{class_poly_solver}
\input{structserif_1_1network_1_1approx8_1_1_net}
\input{structserif_1_1network_1_1_net_in}
\input{structserif_1_1network_1_1_net_out}
\input{classserif_1_1network_1_1_network}
\input{classserif_1_1polytrope_1_1poly_m_f_e_m_utils_1_1_nonlinear_power_integrator}
\input{structserif_1_1network_1_1approx8_1_1_o_d_e}
\input{classserif_1_1polytrope_1_1_poly_solver}
\input{classpoly_test}
\input{class_polytrope_operator}
\input{classserif_1_1polytrope_1_1_polytrope_operator}
\input{classprobe_test}
\input{class_resource_manager}
\input{classserif_1_1resource_1_1_resource_manager}
\input{classresource_manager_test}
\input{class_schur_compliment}
\input{structsolver_bundle}
\input{structpolycoeff_1_1x1_interp_coeff}
\input{classserif_1_1polytrope_1_1_schur_compliment}
\input{structserif_1_1polytrope_1_1solver_bundle}
\input{structserif_1_1polytrope_1_1polycoeff_1_1x1_interp_coeff}
\chapter{File Documentation}
\input{mainpage_8md}
\input{composition_8cpp}
@@ -315,18 +317,6 @@
\input{const_8cpp_source}
\input{const_8h}
\input{const_8h_source}
\input{_d_object_8cpp}
\input{_d_object_8cpp_source}
\input{_lockable_d_object_8cpp}
\input{_lockable_d_object_8cpp_source}
\input{_metadata_8cpp}
\input{_metadata_8cpp_source}
\input{_d_object_8h}
\input{_d_object_8h_source}
\input{_lockable_d_object_8h}
\input{_lockable_d_object_8h_source}
\input{_metadata_8h}
\input{_metadata_8h_source}
\input{eos_i_o_8cpp}
\input{eos_i_o_8cpp_source}
\input{helm_8cpp}
@@ -351,8 +341,6 @@
\input{approx8_8h_source}
\input{network_8h}
\input{network_8h_source}
\input{opac_8h}
\input{opac_8h_source}
\input{poly_coeff_8cpp}
\input{poly_coeff_8cpp_source}
\input{poly_coeff_8h}
@@ -395,14 +383,6 @@
\input{config_test_8cpp_source}
\input{const_test_8cpp}
\input{const_test_8cpp_source}
\input{_d_object_test_8cpp}
\input{_d_object_test_8cpp_source}
\input{_lockable_d_object_test_8cpp}
\input{_lockable_d_object_test_8cpp_source}
\input{_metadata_test_8cpp}
\input{_metadata_test_8cpp_source}
\input{test_d_object_8cpp}
\input{test_d_object_8cpp_source}
\input{eos_test_8cpp}
\input{eos_test_8cpp_source}
\input{mesh_i_o_test_8cpp}
@@ -419,7 +399,7 @@
\input{_2_users_2tboudreaux_2_programming_2_s_e_ri_f_2src_2composition_2public_2composition_8h-example}
\input{_constructing-example}
\input{_2_users_2tboudreaux_2_programming_2_s_e_ri_f_2src_2network_2public_2approx8_8h-example}
\input{_2_users_2tboudreaux_2_programming_2_s_e_ri_f_2src_2poly_2solver_2public_2poly_solver_8h-example}
\input{_2_users_2tboudreaux_2_programming_2_s_e_ri_f_2src_2polytrope_2solver_2public_2poly_solver_8h-example}
%--- End generated contents ---
% Index
\backmatter