docs(docs): built docs

Note for now much of the docs is LLM written. This was done to save time and focus on code development. The docs have been LOOSLEY reviewed. However, the code itself has been either fully written by hand or fully reviewed. Therefore, the docs should at the moment be seen as a loose resource rather than authoratiative (and this is on top of the general ability for docs to drift)
This commit is contained in:
2026-11-09 14:09:44 -05:00
parent d9c4919477
commit 6b57738330
32596 changed files with 4155414 additions and 0 deletions

View File

@@ -0,0 +1,64 @@
\doxysection{src/include/serif/operators/backend/mfem/dependencies.hpp File Reference}
\hypertarget{operators_2backend_2mfem_2dependencies_8hpp}{}\label{operators_2backend_2mfem_2dependencies_8hpp}\index{src/include/serif/operators/backend/mfem/dependencies.hpp@{src/include/serif/operators/backend/mfem/dependencies.hpp}}
{\ttfamily \#include $<$array$>$}\newline
{\ttfamily \#include $<$cstddef$>$}\newline
{\ttfamily \#include $<$utility$>$}\newline
{\ttfamily \#include "{}mfem/fem/gridfunc.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/operators/backend/mfem/state.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/discretization/backend/mfem/coefficient\+\_\+tracking.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/utils/dependencies/dependencies.\+hpp"{}}\newline
Include dependency graph for dependencies.\+hpp\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{operators_2backend_2mfem_2dependencies_8hpp__incl}
\end{center}
\end{figure}
This graph shows which files directly or indirectly include this file\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{operators_2backend_2mfem_2dependencies_8hpp__dep__incl}
\end{center}
\end{figure}
\doxysubsubsection*{Classes}
\begin{DoxyCompactItemize}
\item
struct \mbox{\hyperlink{structserif_1_1operators_1_1backend_1_1mfem_1_1_metadata_tracking}{serif\+::operators\+::backend\+::mfem\+::\+Metadata\+Tracking}}
\begin{DoxyCompactList}\small\item\em Metadata is a value; moving its temporary wrapper does not change the mesh or bindings it describes. \end{DoxyCompactList}\item
struct \mbox{\hyperlink{structserif_1_1operators_1_1backend_1_1mfem_1_1_reference_basis}{serif\+::operators\+::backend\+::mfem\+::\+Reference\+Basis}}
\item
struct \mbox{\hyperlink{structserif_1_1operators_1_1backend_1_1mfem_1_1_displacement_coefficients}{serif\+::operators\+::backend\+::mfem\+::\+Displacement\+Coefficients}}
\item
struct \mbox{\hyperlink{structserif_1_1operators_1_1backend_1_1mfem_1_1_compactification_coefficients}{serif\+::operators\+::backend\+::mfem\+::\+Compactification\+Coefficients}}
\item
struct \mbox{\hyperlink{structserif_1_1operators_1_1backend_1_1mfem_1_1_volume_result}{serif\+::operators\+::backend\+::mfem\+::\+Volume\+Result}}
\item
struct \mbox{\hyperlink{structserif_1_1operators_1_1backend_1_1mfem_1_1_nodal_result}{serif\+::operators\+::backend\+::mfem\+::\+Nodal\+Result}}
\item
struct \mbox{\hyperlink{structserif_1_1operators_1_1backend_1_1mfem_1_1_mapping_coefficients}{serif\+::operators\+::backend\+::mfem\+::\+Mapping\+Coefficients}}
\item
struct \mbox{\hyperlink{structserif_1_1operators_1_1backend_1_1mfem_1_1_basis_bindings}{serif\+::operators\+::backend\+::mfem\+::\+Basis\+Bindings$<$ Column\+Count $>$}}
\item
struct \mbox{\hyperlink{structserif_1_1operators_1_1backend_1_1mfem_1_1_volume_dependencies_3_01utils_1_1types_1_1_type_58204beda4e4f11469d9e428a370f941}{serif\+::operators\+::backend\+::mfem\+::\+Volume\+Dependencies$<$ utils\+::types\+::\+Type\+List$<$ Columns... $>$ $>$}}
\item
struct \mbox{\hyperlink{structserif_1_1operators_1_1backend_1_1mfem_1_1_coefficient_tracking}{serif\+::operators\+::backend\+::mfem\+::\+Coefficient\+Tracking}}
\begin{DoxyCompactList}\small\item\em MFEM coefficient views identify a binding, independently of the caller\textquotesingle{}s vector allocation. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsubsection*{Namespaces}
\begin{DoxyCompactItemize}
\item
namespace \mbox{\hyperlink{namespaceserif}{serif}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1operators}{serif\+::operators}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1operators_1_1backend}{serif\+::operators\+::backend}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1operators_1_1backend_1_1mfem}{serif\+::operators\+::backend\+::mfem}}
\end{DoxyCompactItemize}
\doxysubsubsection*{Functions}
\begin{DoxyCompactItemize}
\item
{\footnotesize template$<$typename UpdateT$>$ }\\bool \mbox{\hyperlink{namespaceserif_1_1operators_1_1backend_1_1mfem_a3cc16f7db1fd6c29e3fd3fae05c7555e}{serif\+::operators\+::backend\+::mfem\+::geometry\+\_\+changed}} (const UpdateT \&update)
\begin{DoxyCompactList}\small\item\em Geometry depends on the reference discretization and both mapping coefficient vectors. \end{DoxyCompactList}\end{DoxyCompactItemize}