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,55 @@
\doxysection{src/include/serif/backend/mfem/solver/seed/state.hpp File Reference}
\hypertarget{backend_2mfem_2solver_2seed_2state_8hpp}{}\label{backend_2mfem_2solver_2seed_2state_8hpp}\index{src/include/serif/backend/mfem/solver/seed/state.hpp@{src/include/serif/backend/mfem/solver/seed/state.hpp}}
{\ttfamily \#include $<$algorithm$>$}\newline
{\ttfamily \#include $<$cmath$>$}\newline
{\ttfamily \#include $<$expected$>$}\newline
{\ttfamily \#include $<$format$>$}\newline
{\ttfamily \#include $<$span$>$}\newline
{\ttfamily \#include $<$string$>$}\newline
{\ttfamily \#include $<$vector$>$}\newline
{\ttfamily \#include "{}serif/backend/mfem/discretization/dof\+\_\+selection.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/backend/mfem/model/binding.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/model/state.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/backend/mfem/solver/seed/fitted.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/backend/mfem/mapping/evaluator.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/backend/mfem/projection/radial.\+hpp"{}}\newline
Include dependency graph for state.\+hpp\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{backend_2mfem_2solver_2seed_2state_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=221pt]{backend_2mfem_2solver_2seed_2state_8hpp__dep__incl}
\end{center}
\end{figure}
\doxysubsubsection*{Classes}
\begin{DoxyCompactItemize}
\item
struct \mbox{\hyperlink{structserif_1_1solver_1_1seed_1_1backend_1_1mfem_1_1_projection_options}{serif\+::solver\+::seed\+::backend\+::mfem\+::\+Projection\+Options}}
\begin{DoxyCompactList}\small\item\em Allow for the reference mesh\textquotesingle{}s finite-\/order approximation to a spherical seed surface. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsubsection*{Namespaces}
\begin{DoxyCompactItemize}
\item
namespace \mbox{\hyperlink{namespaceserif}{serif}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1solver}{serif\+::solver}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1solver_1_1seed}{serif\+::solver\+::seed}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1solver_1_1seed_1_1backend}{serif\+::solver\+::seed\+::backend}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1solver_1_1seed_1_1backend_1_1mfem}{serif\+::solver\+::seed\+::backend\+::mfem}}
\end{DoxyCompactItemize}
\doxysubsubsection*{Functions}
\begin{DoxyCompactItemize}
\item
{\footnotesize template$<$model\+::\+Stellar\+Model\+Type Model, typename Discretization, typename Profile$>$ \newline
requires (std\+::same\+\_\+as$<$Profile, \mbox{\hyperlink{structserif_1_1solver_1_1seed_1_1_radial_seed}{Radial\+Seed}}$>$ \texorpdfstring{$\vert$}{|}\texorpdfstring{$\vert$}{|} std\+::same\+\_\+as$<$Profile, \mbox{\hyperlink{structserif_1_1solver_1_1seed_1_1_fitted_radial_seed}{Fitted\+Radial\+Seed}}$>$) \&\& requires(const Model\& model, const Discretization\& discretization) \{ requires (!std\+::same\+\_\+as$<$typename std\+::remove\+\_\+cvref\+\_\+t$<$decltype(\mbox{\hyperlink{namespaceserif_1_1model_aa55d6cc09e69d07412896dedcb71c5a5}{model\+::resolve\+\_\+equilibrium\+\_\+equations}}(model))$>$\+::\+Shape\+Force, \mbox{\hyperlink{structserif_1_1model_1_1_no_shape_force}{model\+::\+No\+Shape\+Force}}$>$); discretization.\+deformation.\+model.\+surface; discretization.\+deformation.\+reference; \}}\\auto \mbox{\hyperlink{namespaceserif_1_1solver_1_1seed_1_1backend_1_1mfem_ace50a90a69f7c31c7af73939977821b6}{serif\+::solver\+::seed\+::backend\+::mfem\+::make\+\_\+polytropic\+\_\+state}} (const Model \&model, const Discretization \&discretization, const Profile \&seed, const \mbox{\hyperlink{structserif_1_1solver_1_1seed_1_1backend_1_1mfem_1_1_projection_options}{Projection\+Options}} options=\{\})
\begin{DoxyCompactList}\small\item\em Project a spherical guess into a moving model\textquotesingle{}s named physical coordinates on its undeformed reference mesh. \end{DoxyCompactList}\end{DoxyCompactItemize}