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,56 @@
\doxysection{src/include/serif/backend/mfem/model/system.hpp File Reference}
\hypertarget{system_8hpp}{}\label{system_8hpp}\index{src/include/serif/backend/mfem/model/system.hpp@{src/include/serif/backend/mfem/model/system.hpp}}
{\ttfamily \#include $<$memory$>$}\newline
{\ttfamily \#include $<$optional$>$}\newline
{\ttfamily \#include $<$span$>$}\newline
{\ttfamily \#include $<$vector$>$}\newline
{\ttfamily \#include "{}serif/backend/mfem/operators/actions.\+hpp"{}}\newline
Include dependency graph for system.\+hpp\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{system_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]{system_8hpp__dep__incl}
\end{center}
\end{figure}
\doxysubsubsection*{Classes}
\begin{DoxyCompactItemize}
\item
struct \mbox{\hyperlink{structserif_1_1model_1_1backend_1_1mfem_1_1_coordinate_range}{serif\+::model\+::backend\+::mfem\+::\+Coordinate\+Range}}
\begin{DoxyCompactList}\small\item\em One contiguous range of equation or state coordinates in an evaluated system. \end{DoxyCompactList}\item
struct \mbox{\hyperlink{structserif_1_1model_1_1backend_1_1mfem_1_1_residual_contribution}{serif\+::model\+::backend\+::mfem\+::\+Residual\+Contribution}}
\begin{DoxyCompactList}\small\item\em One evaluated equation contribution in the independently ordered residual coordinates. \end{DoxyCompactList}\item
struct \mbox{\hyperlink{structserif_1_1model_1_1backend_1_1mfem_1_1_jacobian_contribution}{serif\+::model\+::backend\+::mfem\+::\+Jacobian\+Contribution}}
\begin{DoxyCompactList}\small\item\em One frozen physical Jacobian coupling; overlapping contributions add. \end{DoxyCompactList}\item
struct \mbox{\hyperlink{structserif_1_1model_1_1backend_1_1mfem_1_1_column_contribution}{serif\+::model\+::backend\+::mfem\+::\+Column\+Contribution}}
\begin{DoxyCompactList}\small\item\em A coupling from state coordinates into an ordered selection of replacement rows. \end{DoxyCompactList}\item
struct \mbox{\hyperlink{structserif_1_1model_1_1backend_1_1mfem_1_1_row_replacement}{serif\+::model\+::backend\+::mfem\+::\+Row\+Replacement}}
\begin{DoxyCompactList}\small\item\em Replace complete equations after all ordinary and generated contributions have been added. \end{DoxyCompactList}\item
class \mbox{\hyperlink{classserif_1_1model_1_1backend_1_1mfem_1_1_physical_system}{serif\+::model\+::backend\+::mfem\+::\+Physical\+System}}
\begin{DoxyCompactList}\small\item\em Own one evaluated residual and Jacobian, retaining the discretization owner used by every child action. \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_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
std\+::shared\+\_\+ptr$<$ const \mbox{\hyperlink{classserif_1_1model_1_1backend_1_1mfem_1_1_physical_system}{Physical\+System}} $>$ \mbox{\hyperlink{namespaceserif_1_1model_1_1backend_1_1mfem_a9214085d7bc66bde2f943402552fabc9}{serif\+::model\+::backend\+::mfem\+::make\+\_\+physical\+\_\+system}} (int residual\+\_\+size, int state\+\_\+size, std\+::vector$<$ \mbox{\hyperlink{structserif_1_1model_1_1backend_1_1mfem_1_1_residual_contribution}{Residual\+Contribution}} $>$ residuals, std\+::vector$<$ \mbox{\hyperlink{structserif_1_1model_1_1backend_1_1mfem_1_1_jacobian_contribution}{Jacobian\+Contribution}} $>$ jacobian, std\+::vector$<$ \mbox{\hyperlink{structserif_1_1model_1_1backend_1_1mfem_1_1_row_replacement}{Row\+Replacement}} $>$ replacements=\{\}, std\+::shared\+\_\+ptr$<$ const void $>$ owner=\{\}, std\+::optional$<$ std\+::vector$<$ \mbox{\hyperlink{structserif_1_1model_1_1backend_1_1mfem_1_1_jacobian_contribution}{Jacobian\+Contribution}} $>$ $>$ complete\+\_\+actions=\{\})
\begin{DoxyCompactList}\small\item\em Publish an immutable evaluated system that remains independent of later graph preparation. \end{DoxyCompactList}\end{DoxyCompactItemize}