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,47 @@
\doxysection{src/include/serif/solver/preconditioner/recipes/surface.hpp File Reference}
\hypertarget{solver_2preconditioner_2recipes_2surface_8hpp}{}\label{solver_2preconditioner_2recipes_2surface_8hpp}\index{src/include/serif/solver/preconditioner/recipes/surface.hpp@{src/include/serif/solver/preconditioner/recipes/surface.hpp}}
{\ttfamily \#include $<$concepts$>$}\newline
{\ttfamily \#include $<$utility$>$}\newline
{\ttfamily \#include "{}serif/discretization/blocks/fields.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/solver/preconditioner/keys.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/solver/preconditioner/strategies/inverse/fixed\+\_\+amg.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/solver/preconditioner/strategies/surface/reference\+\_\+mass.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/solver/preconditioner/strategies/surface/fitted\+\_\+h1.\+hpp"{}}\newline
Include dependency graph for surface.\+hpp\+:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{solver_2preconditioner_2recipes_2surface_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=242pt]{solver_2preconditioner_2recipes_2surface_8hpp__dep__incl}
\end{center}
\end{figure}
\doxysubsubsection*{Classes}
\begin{DoxyCompactItemize}
\item
struct \mbox{\hyperlink{structserif_1_1solver_1_1preconditioner_1_1_surface_preconditioner}{serif\+::solver\+::preconditioner\+::\+Surface\+Preconditioner$<$ Field, Row, Strategy, Backend $>$}}
\begin{DoxyCompactList}\small\item\em Declare shape physics separately from the positive H1 matrix inverse used when that strategy needs one. \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_1preconditioner}{serif\+::solver\+::preconditioner}}
\end{DoxyCompactItemize}
\doxysubsubsection*{Concepts}
\begin{DoxyCompactItemize}
\item
concept \mbox{\hyperlink{conceptserif_1_1solver_1_1preconditioner_1_1_surface_strategy}{serif\+::solver\+::preconditioner\+::\+Surface\+Strategy}}
\begin{DoxyCompactList}\small\item\em Surface approximations supported by the native mass and nodal H1 factories. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsubsection*{Functions}
\begin{DoxyCompactItemize}
\item
{\footnotesize template$<$typename Field = discretization\+::blocks\+::surface\+\_\+deformation\+::coefficients, typename Row = discretization\+::blocks\+::surface\+\_\+deformation\+::shape\+\_\+equilibrium, Surface\+Strategy Strategy = strategies\+::surface\+::\+Reference\+Surface\+Mass, typename Backend = strategies\+::inverse\+::\+Fixed\+AMG$>$ }\\auto \mbox{\hyperlink{namespaceserif_1_1solver_1_1preconditioner_a8cda33fa5c819ca656e891bd94b3f04b}{serif\+::solver\+::preconditioner\+::make\+\_\+surface\+\_\+preconditioner}} (Strategy surface=\{\}, Backend inverse=\{.cycles=3\})
\begin{DoxyCompactList}\small\item\em Select native reference mass by default; fitted H1 uses three fixed AMG cycles unless another backend is requested. \end{DoxyCompactList}\end{DoxyCompactItemize}