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,45 @@
\doxysection{src/include/serif/geometry/deformation/backend/mfem/computations.hpp File Reference}
\hypertarget{deformation_2backend_2mfem_2computations_8hpp}{}\label{deformation_2backend_2mfem_2computations_8hpp}\index{src/include/serif/geometry/deformation/backend/mfem/computations.hpp@{src/include/serif/geometry/deformation/backend/mfem/computations.hpp}}
{\ttfamily \#include $<$algorithm$>$}\newline
{\ttfamily \#include $<$utility$>$}\newline
{\ttfamily \#include "{}serif/geometry/deformation/backend/mfem/inputs.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/geometry/deformation/backend/mfem/radial\+\_\+interpolation.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/geometry/deformation/backend/mfem/surface\+\_\+metric.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/geometry/deformation/surface\+\_\+embedding.\+hpp"{}}\newline
Include dependency graph for computations.\+hpp\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{deformation_2backend_2mfem_2computations_8hpp__incl}
\end{center}
\end{figure}
\doxysubsubsection*{Namespaces}
\begin{DoxyCompactItemize}
\item
namespace \mbox{\hyperlink{namespaceserif}{serif}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1geometry}{serif\+::geometry}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1geometry_1_1deformation}{serif\+::geometry\+::deformation}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1geometry_1_1deformation_1_1backend}{serif\+::geometry\+::deformation\+::backend}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1geometry_1_1deformation_1_1backend_1_1mfem}{serif\+::geometry\+::deformation\+::backend\+::mfem}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1geometry_1_1deformation_1_1backend_1_1mfem_1_1detail}{serif\+::geometry\+::deformation\+::backend\+::mfem\+::detail}}
\end{DoxyCompactItemize}
\doxysubsubsection*{Functions}
\begin{DoxyCompactItemize}
\item
{\footnotesize template$<$typename Value$>$ }\\std\+::expected$<$ std\+::shared\+\_\+ptr$<$ const Value $>$, \mbox{\hyperlink{structserif_1_1geometry_1_1deformation_1_1_deformation_failure}{Deformation\+Failure}} $>$ \mbox{\hyperlink{namespaceserif_1_1geometry_1_1deformation_1_1backend_1_1mfem_1_1detail_a05b352de13c1c09e3358f7990397f317}{serif\+::geometry\+::deformation\+::backend\+::mfem\+::detail\+::share\+\_\+reference\+\_\+result}} (std\+::expected$<$ Value, \mbox{\hyperlink{structserif_1_1geometry_1_1deformation_1_1_deformation_failure}{Deformation\+Failure}} $>$ result)
\begin{DoxyCompactList}\small\item\em Share a successfully compiled immutable table without copying it into each consumer. \end{DoxyCompactList}\item
std\+::expected$<$ \mbox{\hyperlink{classserif_1_1geometry_1_1deformation_1_1_radial_interpolation}{Radial\+Interpolation}}, \mbox{\hyperlink{structserif_1_1geometry_1_1deformation_1_1_deformation_failure}{Deformation\+Failure}} $>$ \mbox{\hyperlink{namespaceserif_1_1geometry_1_1deformation_1_1backend_1_1mfem_1_1detail_a6d9608b34a2b5cc2fc9290e472c5da2c}{serif\+::geometry\+::deformation\+::backend\+::mfem\+::detail\+::compile\+\_\+radial\+\_\+reference}} (const \mbox{\hyperlink{structserif_1_1geometry_1_1deformation_1_1backend_1_1mfem_1_1_reference_discretization}{Reference\+Discretization}} \&input, const std\+::vector$<$ int $>$ \&selected)
\begin{DoxyCompactList}\small\item\em Resolve changing mesh labels at preparation time, keeping material masks out of model constructors. \end{DoxyCompactList}\item
auto \mbox{\hyperlink{namespaceserif_1_1geometry_1_1deformation_1_1backend_1_1mfem_ace5c5dfca1387670e54a585069907974}{serif\+::geometry\+::deformation\+::backend\+::mfem\+::make\+\_\+surface\+\_\+metric\+\_\+computation}} ()
\begin{DoxyCompactList}\small\item\em Optionally supply the reference surface mass diagonal in native shape coordinates. \end{DoxyCompactList}\item
{\footnotesize template$<$typename Surface$>$ \newline
requires requires(const Surface\& model, std\+::span$<$const std\+::array$<$double, 3$>$$>$ positions) \{ \{ \mbox{\hyperlink{namespaceserif_1_1geometry_1_1deformation_acb2008299cc4c40f49e8c9c0086e5356}{build\+\_\+surface\+\_\+embedding}}(model, positions) \} -\/$>$ std\+::same\+\_\+as$<$std\+::expected$<$\mbox{\hyperlink{classserif_1_1geometry_1_1deformation_1_1_surface_embedding}{Surface\+Embedding}}, \mbox{\hyperlink{structserif_1_1geometry_1_1deformation_1_1_deformation_failure}{Deformation\+Failure}}$>$$>$; \}}\\auto \mbox{\hyperlink{namespaceserif_1_1geometry_1_1deformation_1_1backend_1_1mfem_ad5adf6fb962f3bd5e82121270d4f5701}{serif\+::geometry\+::deformation\+::backend\+::mfem\+::make\+\_\+deformation\+\_\+computations}} ()
\begin{DoxyCompactList}\small\item\em Compile fixed reference factors and evaluate shape motion with one dependency engine. \end{DoxyCompactList}\item
{\footnotesize template$<$typename Surface$>$ }\\auto \mbox{\hyperlink{namespaceserif_1_1geometry_1_1deformation_1_1backend_1_1mfem_a11cb43141841879bf3dc270b02b22cb8}{serif\+::geometry\+::deformation\+::backend\+::mfem\+::make\+\_\+deformation\+\_\+graph}} ()
\begin{DoxyCompactList}\small\item\em Provide a standalone graph while leaving the same computations available for equation composition. \end{DoxyCompactList}\end{DoxyCompactItemize}