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,33 @@
\doxysection{src/lib/serif/geometry/deformation/backend/mfem/radial\+\_\+interpolation.cpp File Reference}
\hypertarget{backend_2mfem_2radial__interpolation_8cpp}{}\label{backend_2mfem_2radial__interpolation_8cpp}\index{src/lib/serif/geometry/deformation/backend/mfem/radial\_interpolation.cpp@{src/lib/serif/geometry/deformation/backend/mfem/radial\_interpolation.cpp}}
{\ttfamily \#include $<$algorithm$>$}\newline
{\ttfamily \#include $<$cmath$>$}\newline
{\ttfamily \#include $<$limits$>$}\newline
{\ttfamily \#include "{}mfem/fem/fespace.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/geometry/deformation/backend/mfem/radial\+\_\+interpolation.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/geometry/deformation/backend/mfem/detail/radial\+\_\+locator.\+hpp"{}}\newline
Include dependency graph for radial\+\_\+interpolation.\+cpp\+:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{backend_2mfem_2radial__interpolation_8cpp__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}}
\end{DoxyCompactItemize}
\doxysubsubsection*{Functions}
\begin{DoxyCompactItemize}
\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_aa1c497accb383cfdd9c8437117d3f1c0}{serif\+::geometry\+::deformation\+::backend\+::mfem\+::build\+\_\+radial\+\_\+interpolation}} (const \+::mfem\+::\+Finite\+Element\+Space \&scalar\+\_\+space, const \+::mfem\+::\+Finite\+Element\+Space \&vector\+\_\+space, \+::mfem\+::\+Mesh \&logical\+\_\+mesh, std\+::span$<$ const int $>$ stellar\+\_\+element\+\_\+support, std\+::span$<$ const int $>$ vacuum\+\_\+element\+\_\+support, int surface\+\_\+attribute, int infinity\+\_\+attribute)
\begin{DoxyCompactList}\small\item\em Compile logical-\/ray interpolation on paired physical and logical meshes. Supports are zero/one element masks. The logical radius is the maximum absolute Cartesian coordinate, preserving the STROID reference foliation after physical distortion. Only conforming serial nodal spaces and component-\/block vector ordering are supported. \end{DoxyCompactList}\end{DoxyCompactItemize}