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,42 @@
\doxysection{src/include/serif/backend/mfem/model/computations/scalar\+\_\+row.hpp File Reference}
\hypertarget{computations_2scalar__row_8hpp}{}\label{computations_2scalar__row_8hpp}\index{src/include/serif/backend/mfem/model/computations/scalar\_row.hpp@{src/include/serif/backend/mfem/model/computations/scalar\_row.hpp}}
{\ttfamily \#include "{}serif/backend/mfem/model/scalar\+\_\+row.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/backend/mfem/model/volume\+\_\+actions.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/backend/mfem/model/computations/shape\+\_\+derivatives.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/backend/mfem/operators/volume\+\_\+computations.\+hpp"{}}\newline
Include dependency graph for scalar\+\_\+row.\+hpp\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{computations_2scalar__row_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]{computations_2scalar__row_8hpp__dep__incl}
\end{center}
\end{figure}
\doxysubsubsection*{Classes}
\begin{DoxyCompactItemize}
\item
struct \mbox{\hyperlink{structserif_1_1model_1_1computations_1_1_scalar_residual_row}{serif\+::model\+::computations\+::\+Scalar\+Residual\+Row$<$ Row $>$}}
\begin{DoxyCompactList}\small\item\em One global scalar equation\textquotesingle{}s accepted derivative in complete physical state coordinates. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsubsection*{Namespaces}
\begin{DoxyCompactItemize}
\item
namespace \mbox{\hyperlink{namespaceserif}{serif}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1model}{serif\+::model}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1model_1_1computations}{serif\+::model\+::computations}}
\end{DoxyCompactItemize}
\doxysubsubsection*{Functions}
\begin{DoxyCompactItemize}
\item
{\footnotesize template$<$typename Equation, typename Layout$>$ \newline
requires discretization\+::blocks\+::\+Global\+Scalar\+Term$<$typename Equation\+::\+Test$>$}\\auto \mbox{\hyperlink{namespaceserif_1_1model_1_1computations_a6cc3c063b45f722bf8d0739ce53b47ca}{serif\+::model\+::computations\+::scalar\+\_\+residual\+\_\+row}} (Layout layout)
\begin{DoxyCompactList}\small\item\em Rebuild a scalar functional only when its physical equation or shape derivative changes. \end{DoxyCompactList}\end{DoxyCompactItemize}