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,59 @@
\doxysection{src/include/serif/model/backend/mfem/deformation.hpp File Reference}
\hypertarget{model_2backend_2mfem_2deformation_8hpp}{}\label{model_2backend_2mfem_2deformation_8hpp}\index{src/include/serif/model/backend/mfem/deformation.hpp@{src/include/serif/model/backend/mfem/deformation.hpp}}
{\ttfamily \#include $<$limits$>$}\newline
{\ttfamily \#include $<$span$>$}\newline
{\ttfamily \#include $<$utility$>$}\newline
{\ttfamily \#include "{}serif/geometry/deformation/linearization.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/model/backend/mfem/actions.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/utils/error/errors.\+hpp"{}}\newline
Include dependency graph for deformation.\+hpp\+:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{model_2backend_2mfem_2deformation_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]{model_2backend_2mfem_2deformation_8hpp__dep__incl}
\end{center}
\end{figure}
\doxysubsubsection*{Classes}
\begin{DoxyCompactItemize}
\item
struct \mbox{\hyperlink{structserif_1_1model_1_1backend_1_1mfem_1_1_shape_derivatives}{serif\+::model\+::backend\+::mfem\+::\+Shape\+Derivatives$<$ Deformation $>$}}
\begin{DoxyCompactList}\small\item\em Share one accepted deformation and its projected derivative across all physical equations. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsubsection*{Namespaces}
\begin{DoxyCompactItemize}
\item
namespace \mbox{\hyperlink{namespaceserif}{serif}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1discretization}{serif\+::discretization}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1discretization_1_1backend}{serif\+::discretization\+::backend}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1discretization_1_1backend_1_1mfem}{serif\+::discretization\+::backend\+::mfem}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1model}{serif\+::model}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1model_1_1backend}{serif\+::model\+::backend}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1model_1_1backend_1_1mfem}{serif\+::model\+::backend\+::mfem}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1model_1_1backend_1_1mfem_1_1detail}{serif\+::model\+::backend\+::mfem\+::detail}}
\end{DoxyCompactItemize}
\doxysubsubsection*{Functions}
\begin{DoxyCompactItemize}
\item
\mbox{\hyperlink{namespaceserif_1_1model_1_1backend_1_1mfem_ab8046c6554d9a442f1ac5c859fa51861}{Linearized\+Block}} \mbox{\hyperlink{namespaceserif_1_1model_1_1backend_1_1mfem_a400e43594db5656b09c8e95e77a53dfa}{serif\+::model\+::backend\+::mfem\+::displacement\+\_\+projection}} (const \mbox{\hyperlink{classserif_1_1discretization_1_1backend_1_1mfem_1_1_dof_map}{discretization\+::backend\+::mfem\+::\+Dof\+Map}} \&binding)
\begin{DoxyCompactList}\small\item\em Map the deformation\textquotesingle{}s component ordering into the supported displacement ordering once. \end{DoxyCompactList}\item
{\footnotesize template$<$geometry\+::deformation\+::\+Deformation\+Map Map$>$ }\\void \mbox{\hyperlink{namespaceserif_1_1model_1_1backend_1_1mfem_1_1detail_a5aff82640871b09440e1b27f1b77b955}{serif\+::model\+::backend\+::mfem\+::detail\+::validate\+\_\+deformation}} (const std\+::shared\+\_\+ptr$<$ const \mbox{\hyperlink{structserif_1_1geometry_1_1deformation_1_1_deformation_linearization}{geometry\+::deformation\+::\+Deformation\+Linearization}}$<$ Map $>$ $>$ \&state)
\begin{DoxyCompactList}\small\item\em Reject null accepted maps and dimensions that MFEM cannot represent. \end{DoxyCompactList}\item
void \mbox{\hyperlink{namespaceserif_1_1model_1_1backend_1_1mfem_1_1detail_a714b7375c3c233ce2965fd162bf1f429}{serif\+::model\+::backend\+::mfem\+::detail\+::require\+\_\+deformation\+\_\+action}} (const \mbox{\hyperlink{namespaceserif_1_1geometry_1_1deformation_a08306ee593c172f4877facc061e98f97}{geometry\+::deformation\+::\+Deformation\+Status}} \&status)
\begin{DoxyCompactList}\small\item\em Preserve the originating deformation diagnostic at the MFEM action boundary. \end{DoxyCompactList}\item
{\footnotesize template$<$geometry\+::deformation\+::\+Deformation\+Map Map$>$ }\\\mbox{\hyperlink{namespaceserif_1_1model_1_1backend_1_1mfem_ab8046c6554d9a442f1ac5c859fa51861}{Linearized\+Block}} \mbox{\hyperlink{namespaceserif_1_1model_1_1backend_1_1mfem_a0f8a06e69568585591d87ff618dfd9c8}{serif\+::model\+::backend\+::mfem\+::deformation\+\_\+tangent}} (std\+::shared\+\_\+ptr$<$ const \mbox{\hyperlink{structserif_1_1geometry_1_1deformation_1_1_deformation_linearization}{geometry\+::deformation\+::\+Deformation\+Linearization}}$<$ Map $>$ $>$ state)
\begin{DoxyCompactList}\small\item\em Retain the accepted shape and expose its displacement tangent E and exact transpose E\texorpdfstring{$^\wedge$}{\string^}T. \end{DoxyCompactList}\item
{\footnotesize template$<$geometry\+::deformation\+::\+Deformation\+Map Map$>$ }\\\mbox{\hyperlink{namespaceserif_1_1model_1_1backend_1_1mfem_ab8046c6554d9a442f1ac5c859fa51861}{Linearized\+Block}} \mbox{\hyperlink{namespaceserif_1_1model_1_1backend_1_1mfem_af7577c37e3afa05529b1073c3f8622fd}{serif\+::model\+::backend\+::mfem\+::deformation\+\_\+curvature}} (std\+::shared\+\_\+ptr$<$ const \mbox{\hyperlink{structserif_1_1geometry_1_1deformation_1_1_deformation_linearization}{geometry\+::deformation\+::\+Deformation\+Linearization}}$<$ Map $>$ $>$ state, std\+::vector$<$ double $>$ force)
\begin{DoxyCompactList}\small\item\em Freeze the force-\/weighted curvature H = d(\+E\texorpdfstring{$^\wedge$}{\string^}\+T force)/dq for the accepted geometry. \end{DoxyCompactList}\end{DoxyCompactItemize}