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,65 @@
\doxysection{src/include/serif/backend/mfem/serialize/discretization.hpp File Reference}
\hypertarget{serialize_2discretization_8hpp}{}\label{serialize_2discretization_8hpp}\index{src/include/serif/backend/mfem/serialize/discretization.hpp@{src/include/serif/backend/mfem/serialize/discretization.hpp}}
{\ttfamily \#include $<$optional$>$}\newline
{\ttfamily \#include $<$tuple$>$}\newline
{\ttfamily \#include $<$type\+\_\+traits$>$}\newline
{\ttfamily \#include "{}serif/backend/mfem/model/discretization.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/backend/mfem/serialize/resources.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/utils/serialize/model.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/utils/serialize/physics.\+hpp"{}}\newline
Include dependency graph for discretization.\+hpp\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{serialize_2discretization_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=242pt]{serialize_2discretization_8hpp__dep__incl}
\end{center}
\end{figure}
\doxysubsubsection*{Classes}
\begin{DoxyCompactItemize}
\item
struct \mbox{\hyperlink{structserif_1_1utils_1_1serialize_1_1_serializer_3_01model_1_1backend_1_1mfem_1_1_stellar_discree159e3517b28c4c8168613dfca6fe92a}{serif\+::utils\+::serialize\+::\+Serializer$<$ model\+::backend\+::mfem\+::\+Stellar\+Discretization$<$ Owner, Bindings, Deformation $>$ $>$}}
\begin{DoxyCompactList}\small\item\em Integrate native discretizations into packs while keeping application-\/owner reconstruction explicit. \end{DoxyCompactList}\item
struct \mbox{\hyperlink{structserif_1_1backend_1_1mfem_1_1serialize_1_1detail_1_1_owned_bindings}{serif\+::backend\+::mfem\+::serialize\+::detail\+::\+Owned\+Bindings$<$ Context, Keys $>$}}
\end{DoxyCompactItemize}
\doxysubsubsection*{Namespaces}
\begin{DoxyCompactItemize}
\item
namespace \mbox{\hyperlink{namespaceserif}{serif}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1backend}{serif\+::backend}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1backend_1_1mfem}{serif\+::backend\+::mfem}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1backend_1_1mfem_1_1serialize}{serif\+::backend\+::mfem\+::serialize}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1backend_1_1mfem_1_1serialize_1_1detail}{serif\+::backend\+::mfem\+::serialize\+::detail}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1utils}{serif\+::utils}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1utils_1_1serialize}{serif\+::utils\+::serialize}}
\end{DoxyCompactItemize}
\doxysubsubsection*{Typedefs}
\begin{DoxyCompactItemize}
\item
{\footnotesize template$<$typename Original$>$ }\\using \mbox{\hyperlink{namespaceserif_1_1backend_1_1mfem_1_1serialize_a9d43442b5e0a974017bed34f96cc7408}{serif\+::backend\+::mfem\+::serialize\+::\+Restored\+Discretization}}
\begin{DoxyCompactList}\small\item\em Retain all compile-\/time physical choices while replacing an opaque user owner with archive-\/owned resources. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsubsection*{Functions}
\begin{DoxyCompactItemize}
\item
{\footnotesize template$<$typename Schema$>$ }\\\mbox{\hyperlink{structserif_1_1utils_1_1serialize_1_1_node}{utils\+::serialize\+::\+Node}} \mbox{\hyperlink{namespaceserif_1_1backend_1_1mfem_1_1serialize_1_1detail_a2076df57734a7180f12b2ee0b1ae8c24}{serif\+::backend\+::mfem\+::serialize\+::detail\+::domain\+\_\+schema}} ()
\begin{DoxyCompactList}\small\item\em Record semantic domain and boundary labels, independent of live mesh addresses. \end{DoxyCompactList}\item
{\footnotesize template$<$typename Key, typename Context, typename Keys$>$ }\\\mbox{\hyperlink{namespaceserif_1_1utils_1_1serialize_ace9e0af29889a767ef1c95a09a4b7265}{utils\+::serialize\+::\+Result}}$<$ void $>$ \mbox{\hyperlink{namespaceserif_1_1backend_1_1mfem_1_1serialize_1_1detail_a8a67df4d7a1c2f3ff37aa260e581fd82}{serif\+::backend\+::mfem\+::serialize\+::detail\+::restore\+\_\+binding}} (const \mbox{\hyperlink{structserif_1_1utils_1_1serialize_1_1_node}{utils\+::serialize\+::\+Node}} \&node, \mbox{\hyperlink{structserif_1_1discretization_1_1backend_1_1mfem_1_1_owned_bindings}{Owned\+Bindings}}$<$ Context, Keys $>$ \&owner)
\begin{DoxyCompactList}\small\item\em Restore one typed term only after checking its scientific identity and reduced numbering. \end{DoxyCompactList}\item
{\footnotesize template$<$typename Owner, typename Bindings, typename Deformation$>$ }\\\mbox{\hyperlink{structserif_1_1utils_1_1serialize_1_1_node}{utils\+::serialize\+::\+Node}} \mbox{\hyperlink{namespaceserif_1_1backend_1_1mfem_1_1serialize_ac945d40fa03bee3256270f52b462b532}{serif\+::backend\+::mfem\+::serialize\+::save\+\_\+discretization}} (const \mbox{\hyperlink{structserif_1_1model_1_1backend_1_1mfem_1_1_stellar_discretization}{model\+::backend\+::mfem\+::\+Stellar\+Discretization}}$<$ Owner, Bindings, Deformation $>$ \&value, \mbox{\hyperlink{structserif_1_1backend_1_1mfem_1_1serialize_1_1_save_options}{Save\+Options}} options=\{\})
\begin{DoxyCompactList}\small\item\em Save physical FE interpretation and numerical geometry, excluding caches and the application\textquotesingle{}s opaque owner. \end{DoxyCompactList}\item
{\footnotesize template$<$typename Original$>$ }\\\mbox{\hyperlink{namespaceserif_1_1utils_1_1serialize_ace9e0af29889a767ef1c95a09a4b7265}{utils\+::serialize\+::\+Result}}$<$ \mbox{\hyperlink{namespaceserif_1_1backend_1_1mfem_1_1serialize_a9d43442b5e0a974017bed34f96cc7408}{Restored\+Discretization}}$<$ Original $>$ $>$ \mbox{\hyperlink{namespaceserif_1_1backend_1_1mfem_1_1serialize_a1d92723ea4d0dd5f2f509aa1483e537b}{serif\+::backend\+::mfem\+::serialize\+::restore\+\_\+discretization}} (const \mbox{\hyperlink{structserif_1_1utils_1_1serialize_1_1_node}{utils\+::serialize\+::\+Node}} \&node, const \mbox{\hyperlink{namespaceserif_1_1backend_1_1mfem_1_1serialize_aa5436f8736dad67e9123ae76e9f229e3}{Mesh\+Resolver}} \&resolver=\{\})
\begin{DoxyCompactList}\small\item\em Recreate a typed discretization with its own meshes, spaces and mapping inputs. \end{DoxyCompactList}\end{DoxyCompactItemize}