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}