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,30 @@
\doxysection{src/include/serif/geometry/deformation/finite\+\_\+elements.hpp File Reference}
\hypertarget{geometry_2deformation_2finite__elements_8hpp}{}\label{geometry_2deformation_2finite__elements_8hpp}\index{src/include/serif/geometry/deformation/finite\_elements.hpp@{src/include/serif/geometry/deformation/finite\_elements.hpp}}
{\ttfamily \#include "{}serif/backend/mfem/geometry/deformation/computations.\+hpp"{}}\newline
Include dependency graph for finite\+\_\+elements.\+hpp\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{geometry_2deformation_2finite__elements_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}}
\end{DoxyCompactItemize}
\doxysubsubsection*{Functions}
\begin{DoxyCompactItemize}
\item
{\footnotesize template$<$typename Surface, typename Interior, typename Vacuum$>$ }\\auto \mbox{\hyperlink{namespaceserif_1_1geometry_1_1deformation_a10e993d0c69b24df4bb3cd1a5ac12e9f}{serif\+::geometry\+::deformation\+::make\+\_\+deformation\+\_\+inputs}} (const \mbox{\hyperlink{structserif_1_1geometry_1_1deformation_1_1_domain_deformation}{Domain\+Deformation}}$<$ Surface, Interior, Vacuum $>$ \&model, const Reference\+Discretization \&discretization, const std\+::vector$<$ double $>$ \&coefficients)
\begin{DoxyCompactList}\small\item\em Bind physical choices and a borrowed shape vector without evaluating deformation. \end{DoxyCompactList}\item
{\footnotesize template$<$typename Surface$>$ }\\auto \mbox{\hyperlink{namespaceserif_1_1geometry_1_1deformation_a11cb43141841879bf3dc270b02b22cb8}{serif\+::geometry\+::deformation\+::make\+\_\+deformation\+\_\+graph}} ()
\begin{DoxyCompactList}\small\item\em Provide a standalone graph while leaving the same computations available for equation composition. \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_ad5adf6fb962f3bd5e82121270d4f5701}{serif\+::geometry\+::deformation\+::make\+\_\+deformation\+\_\+computations}} ()
\begin{DoxyCompactList}\small\item\em Compile fixed reference factors and evaluate shape motion with one dependency engine. \end{DoxyCompactList}\end{DoxyCompactItemize}