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/latex/annotated.tex
View File

@@ -13,7 +13,7 @@ Here are the classes, structs, unions and interfaces with brief descriptions\+:\
\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{classserif_1_1eos_1_1_e_o_sio}{serif\+::eos\+::\+EOSio}} \\*Handles the input/output operations for EOS tables }{\pageref{classserif_1_1eos_1_1_e_o_sio}}{}
\item\contentsline{section}{\mbox{\hyperlink{classeos_test}{eos\+Test}} \\*Test suite for the const class }{\pageref{classeos_test}}{}
\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}}{}
@@ -33,6 +33,10 @@ Here are the classes, structs, unions and interfaces with brief descriptions\+:\
\item\contentsline{section}{\mbox{\hyperlink{classpoly_test}{poly\+Test}} }{\pageref{classpoly_test}}{}
\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{classserif_1_1pybind_1_1_py_coefficient}{serif\+::pybind\+::\+Py\+Coefficient}} \\*Trampoline class for mfem\+::\+Coefficient }{\pageref{classserif_1_1pybind_1_1_py_coefficient}}{}
\item\contentsline{section}{\mbox{\hyperlink{classserif_1_1pybind_1_1_py_matrix}{serif\+::pybind\+::\+Py\+Matrix}} \\*A trampoline class for mfem\+::\+Matrix }{\pageref{classserif_1_1pybind_1_1_py_matrix}}{}
\item\contentsline{section}{\mbox{\hyperlink{classserif_1_1pybind_1_1_py_operator}{serif\+::pybind\+::\+Py\+Operator}} \\*Trampoline class for mfem\+::\+Operator }{\pageref{classserif_1_1pybind_1_1_py_operator}}{}
\item\contentsline{section}{\mbox{\hyperlink{classserif_1_1pybind_1_1_py_vector_coefficient}{serif\+::pybind\+::\+Py\+Vector\+Coefficient}} \\*Trampoline class for mfem\+::\+Vector\+Coefficient }{\pageref{classserif_1_1pybind_1_1_py_vector_coefficient}}{}
\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}}{}