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

26
docs/latex/files.tex
View File

@@ -6,9 +6,9 @@ Here is a list of all files with brief descriptions\+:\begin{DoxyCompactList}
\item\contentsline{section}{src/config/public/\mbox{\hyperlink{config_8h}{config.\+h}} }{\pageref{config_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{_e_o_sio_8cpp}{EOSio.\+cpp}} }{\pageref{_e_o_sio_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}}{}
\item\contentsline{section}{src/eos/public/\mbox{\hyperlink{_e_o_sio_8h}{EOSio.\+h}} }{\pageref{_e_o_sio_8h}}{}
\item\contentsline{section}{src/eos/public/\mbox{\hyperlink{helm_8h}{helm.\+h}} }{\pageref{helm_8h}}{}
\item\contentsline{section}{src/mesh\+IO/private/\mbox{\hyperlink{mesh_i_o_8cpp}{mesh\+IO.\+cpp}} }{\pageref{mesh_i_o_8cpp}}{}
\item\contentsline{section}{src/mesh\+IO/public/\mbox{\hyperlink{mesh_i_o_8h}{mesh\+IO.\+h}} }{\pageref{mesh_i_o_8h}}{}
@@ -30,6 +30,26 @@ Here is a list of all files with brief descriptions\+:\begin{DoxyCompactList}
\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/python/\mbox{\hyperlink{bindings_8cpp}{bindings.\+cpp}} }{\pageref{bindings_8cpp}}{}
\item\contentsline{section}{src/python/composition/\mbox{\hyperlink{composition_2bindings_8cpp}{bindings.\+cpp}} }{\pageref{composition_2bindings_8cpp}}{}
\item\contentsline{section}{src/python/composition/\mbox{\hyperlink{composition_2bindings_8h}{bindings.\+h}} }{\pageref{composition_2bindings_8h}}{}
\item\contentsline{section}{src/python/config/\mbox{\hyperlink{config_2bindings_8cpp}{bindings.\+cpp}} }{\pageref{config_2bindings_8cpp}}{}
\item\contentsline{section}{src/python/config/\mbox{\hyperlink{config_2bindings_8h}{bindings.\+h}} }{\pageref{config_2bindings_8h}}{}
\item\contentsline{section}{src/python/const/\mbox{\hyperlink{const_2bindings_8cpp}{bindings.\+cpp}} }{\pageref{const_2bindings_8cpp}}{}
\item\contentsline{section}{src/python/const/\mbox{\hyperlink{const_2bindings_8h}{bindings.\+h}} }{\pageref{const_2bindings_8h}}{}
\item\contentsline{section}{src/python/eos/\mbox{\hyperlink{eos_2bindings_8cpp}{bindings.\+cpp}} }{\pageref{eos_2bindings_8cpp}}{}
\item\contentsline{section}{src/python/eos/\mbox{\hyperlink{eos_2bindings_8h}{bindings.\+h}} }{\pageref{eos_2bindings_8h}}{}
\item\contentsline{section}{src/python/mfem/\mbox{\hyperlink{mfem_2bindings_8cpp}{bindings.\+cpp}} }{\pageref{mfem_2bindings_8cpp}}{}
\item\contentsline{section}{src/python/mfem/\mbox{\hyperlink{mfem_2bindings_8h}{bindings.\+h}} \\*Declares functions to register MFEM core library components with pybind11 }{\pageref{mfem_2bindings_8h}}{}
\item\contentsline{section}{src/python/mfem/\+Trampoline/\+Py\+MFEMTrampolines/\+Coefficient/\mbox{\hyperlink{_py_coefficient_8cpp}{Py\+Coefficient.\+cpp}} }{\pageref{_py_coefficient_8cpp}}{}
\item\contentsline{section}{src/python/mfem/\+Trampoline/\+Py\+MFEMTrampolines/\+Coefficient/\mbox{\hyperlink{_py_coefficient_8h}{Py\+Coefficient.\+h}} \\*Defines pybind11 trampoline classes for mfem\+::\+Coefficient and mfem\+::\+Vector\+Coefficient }{\pageref{_py_coefficient_8h}}{}
\item\contentsline{section}{src/python/mfem/\+Trampoline/\+Py\+MFEMTrampolines/\+Operator/\mbox{\hyperlink{_py_operator_8cpp}{Py\+Operator.\+cpp}} }{\pageref{_py_operator_8cpp}}{}
\item\contentsline{section}{src/python/mfem/\+Trampoline/\+Py\+MFEMTrampolines/\+Operator/\mbox{\hyperlink{_py_operator_8h}{Py\+Operator.\+h}} \\*Defines a pybind11 trampoline class for mfem\+::\+Operator }{\pageref{_py_operator_8h}}{}
\item\contentsline{section}{src/python/mfem/\+Trampoline/\+Py\+MFEMTrampolines/\+Operator/\+Matrix/\mbox{\hyperlink{_py_matrix_8cpp}{Py\+Matrix.\+cpp}} }{\pageref{_py_matrix_8cpp}}{}
\item\contentsline{section}{src/python/mfem/\+Trampoline/\+Py\+MFEMTrampolines/\+Operator/\+Matrix/\mbox{\hyperlink{_py_matrix_8h}{Py\+Matrix.\+h}} \\*Defines a pybind11 trampoline class for mfem\+::\+Matrix }{\pageref{_py_matrix_8h}}{}
\item\contentsline{section}{src/python/polytrope/\mbox{\hyperlink{polytrope_2bindings_8cpp}{bindings.\+cpp}} }{\pageref{polytrope_2bindings_8cpp}}{}
\item\contentsline{section}{src/python/polytrope/\mbox{\hyperlink{polytrope_2bindings_8h}{bindings.\+h}} \\*Declares the function to register polytrope module C++ components with pybind11 }{\pageref{polytrope_2bindings_8h}}{}
\item\contentsline{section}{src/python/serif/\mbox{\hyperlink{____init_____8py}{\+\_\+\+\_\+init\+\_\+\+\_\+.\+py}} }{\pageref{____init_____8py}}{}
\item\contentsline{section}{src/resource/private/\mbox{\hyperlink{resource_manager_8cpp}{resource\+Manager.\+cpp}} }{\pageref{resource_manager_8cpp}}{}
\item\contentsline{section}{src/resource/private/\mbox{\hyperlink{resource_manager_types_8cpp}{resource\+Manager\+Types.\+cpp}} }{\pageref{resource_manager_types_8cpp}}{}
\item\contentsline{section}{src/resource/public/\mbox{\hyperlink{resource_manager_8h}{resource\+Manager.\+h}} }{\pageref{resource_manager_8h}}{}
@@ -44,5 +64,7 @@ Here is a list of all files with brief descriptions\+:\begin{DoxyCompactList}
\item\contentsline{section}{tests/network/\mbox{\hyperlink{approx8_test_8cpp}{approx8\+Test.\+cpp}} }{\pageref{approx8_test_8cpp}}{}
\item\contentsline{section}{tests/poly/\mbox{\hyperlink{poly_test_8cpp}{poly\+Test.\+cpp}} }{\pageref{poly_test_8cpp}}{}
\item\contentsline{section}{tests/probe/\mbox{\hyperlink{probe_test_8cpp}{probe\+Test.\+cpp}} }{\pageref{probe_test_8cpp}}{}
\item\contentsline{section}{tests/python/polytrope/\mbox{\hyperlink{load_mesh_8py}{load\+Mesh.\+py}} }{\pageref{load_mesh_8py}}{}
\item\contentsline{section}{tests/python/polytrope/\mbox{\hyperlink{run_polytrope_8py}{run\+Polytrope.\+py}} }{\pageref{run_polytrope_8py}}{}
\item\contentsline{section}{tests/resource/\mbox{\hyperlink{resource_manager_test_8cpp}{resource\+Manager\+Test.\+cpp}} }{\pageref{resource_manager_test_8cpp}}{}
\end{DoxyCompactList}

61
docs/latex/refman.tex
View File

@@ -244,7 +244,9 @@
\chapter{File Index}
\input{files}
\chapter{Namespace Documentation}
\input{namespaceload_mesh}
\input{namespacepoly_m_f_e_m_utils}
\input{namespacerun_polytrope}
\input{namespaceserif}
\input{namespaceserif_1_1composition}
\input{namespaceserif_1_1config}
@@ -259,6 +261,7 @@
\input{namespaceserif_1_1polytrope_1_1polycoeff}
\input{namespaceserif_1_1polytrope_1_1poly_m_f_e_m_utils}
\input{namespaceserif_1_1probe}
\input{namespaceserif_1_1pybind}
\input{namespaceserif_1_1resource}
\input{namespaceserif_1_1resource_1_1types}
\input{namespaceserif_1_1types}
@@ -277,7 +280,7 @@
\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{classserif_1_1eos_1_1_e_o_sio}
\input{classeos_test}
\input{structserif_1_1polytrope_1_1form_bundle}
\input{structserif_1_1composition_1_1_global_composition}
@@ -297,6 +300,10 @@
\input{classpoly_test}
\input{classserif_1_1polytrope_1_1_polytrope_operator}
\input{classprobe_test}
\input{classserif_1_1pybind_1_1_py_coefficient}
\input{classserif_1_1pybind_1_1_py_matrix}
\input{classserif_1_1pybind_1_1_py_operator}
\input{classserif_1_1pybind_1_1_py_vector_coefficient}
\input{class_resource_manager}
\input{classserif_1_1resource_1_1_resource_manager}
\input{classresource_manager_test}
@@ -317,12 +324,12 @@
\input{const_8cpp_source}
\input{const_8h}
\input{const_8h_source}
\input{eos_i_o_8cpp}
\input{eos_i_o_8cpp_source}
\input{_e_o_sio_8cpp}
\input{_e_o_sio_8cpp_source}
\input{helm_8cpp}
\input{helm_8cpp_source}
\input{eos_i_o_8h}
\input{eos_i_o_8h_source}
\input{_e_o_sio_8h}
\input{_e_o_sio_8h_source}
\input{helm_8h}
\input{helm_8h_source}
\input{mesh_i_o_8cpp}
@@ -365,6 +372,46 @@
\input{probe_8cpp_source}
\input{probe_8h}
\input{probe_8h_source}
\input{bindings_8cpp}
\input{bindings_8cpp_source}
\input{composition_2bindings_8cpp}
\input{composition_2bindings_8cpp_source}
\input{config_2bindings_8cpp}
\input{config_2bindings_8cpp_source}
\input{const_2bindings_8cpp}
\input{const_2bindings_8cpp_source}
\input{eos_2bindings_8cpp}
\input{eos_2bindings_8cpp_source}
\input{mfem_2bindings_8cpp}
\input{mfem_2bindings_8cpp_source}
\input{polytrope_2bindings_8cpp}
\input{polytrope_2bindings_8cpp_source}
\input{composition_2bindings_8h}
\input{composition_2bindings_8h_source}
\input{config_2bindings_8h}
\input{config_2bindings_8h_source}
\input{const_2bindings_8h}
\input{const_2bindings_8h_source}
\input{eos_2bindings_8h}
\input{eos_2bindings_8h_source}
\input{mfem_2bindings_8h}
\input{mfem_2bindings_8h_source}
\input{polytrope_2bindings_8h}
\input{polytrope_2bindings_8h_source}
\input{_py_coefficient_8cpp}
\input{_py_coefficient_8cpp_source}
\input{_py_coefficient_8h}
\input{_py_coefficient_8h_source}
\input{_py_matrix_8cpp}
\input{_py_matrix_8cpp_source}
\input{_py_matrix_8h}
\input{_py_matrix_8h_source}
\input{_py_operator_8cpp}
\input{_py_operator_8cpp_source}
\input{_py_operator_8h}
\input{_py_operator_8h_source}
\input{____init_____8py}
\input{____init_____8py_source}
\input{resource_manager_8cpp}
\input{resource_manager_8cpp_source}
\input{resource_manager_types_8cpp}
@@ -393,6 +440,10 @@
\input{poly_test_8cpp_source}
\input{probe_test_8cpp}
\input{probe_test_8cpp_source}
\input{load_mesh_8py}
\input{load_mesh_8py_source}
\input{run_polytrope_8py}
\input{run_polytrope_8py_source}
\input{resource_manager_test_8cpp}
\input{resource_manager_test_8cpp_source}
\chapter{Examples}