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,40 @@
\doxysection{src/include/serif/operators/backend/mfem/nodal\+\_\+evaluation.hpp File Reference}
\hypertarget{nodal__evaluation_8hpp}{}\label{nodal__evaluation_8hpp}\index{src/include/serif/operators/backend/mfem/nodal\_evaluation.hpp@{src/include/serif/operators/backend/mfem/nodal\_evaluation.hpp}}
{\ttfamily \#include $<$cmath$>$}\newline
{\ttfamily \#include $<$expected$>$}\newline
{\ttfamily \#include "{}serif/operators/backend/mfem/nodal\+\_\+data.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/operators/backend/mfem/rejection.\+hpp"{}}\newline
Include dependency graph for nodal\+\_\+evaluation.\+hpp\+:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{nodal__evaluation_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]{nodal__evaluation_8hpp__dep__incl}
\end{center}
\end{figure}
\doxysubsubsection*{Namespaces}
\begin{DoxyCompactItemize}
\item
namespace \mbox{\hyperlink{namespaceserif}{serif}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1operators}{serif\+::operators}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1operators_1_1backend}{serif\+::operators\+::backend}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1operators_1_1backend_1_1mfem}{serif\+::operators\+::backend\+::mfem}}
\end{DoxyCompactItemize}
\doxysubsubsection*{Functions}
\begin{DoxyCompactItemize}
\item
{\footnotesize template$<$Nodal\+Value\+Equation EquationT$>$ }\\\mbox{\hyperlink{structserif_1_1equations_1_1_equation_point}{equations\+::\+Equation\+Point}}$<$ typename Equation\+T\+::\+Operands $>$ \mbox{\hyperlink{namespaceserif_1_1operators_1_1backend_1_1mfem_a1ab7cb26bb2acf36fc8da96d9f7a9c14}{serif\+::operators\+::backend\+::mfem\+::make\+\_\+nodal\+\_\+equation\+\_\+point}} (const \mbox{\hyperlink{namespaceserif_1_1operators_1_1backend_1_1mfem_a317d4e0bea2ef8780ac3747cfe62bf72}{\+::mfem\+::\+Vector}} \&\mbox{\hyperlink{namespaceserif_1_1operators_1_1backend_1_1mfem_adf1d7a29193c8b8a6cd17745686a04d8}{values}}, const int first)
\begin{DoxyCompactList}\small\item\em Convert one scalar node or one complete vector point into the equation\textquotesingle{}s declared input. \end{DoxyCompactList}\item
{\footnotesize template$<$Nodal\+Value\+Equation EquationT, discretization\+::domain\+::schema\+::\+Is\+Schema SchemaT$>$ }\\std\+::expected$<$ void, \mbox{\hyperlink{structserif_1_1operators_1_1backend_1_1mfem_1_1_preparation_rejection}{Preparation\+Rejection}} $>$ \mbox{\hyperlink{namespaceserif_1_1operators_1_1backend_1_1mfem_a38b41b80e1f209522f4f91a664f4b80e}{serif\+::operators\+::backend\+::mfem\+::store\+\_\+nodal\+\_\+linearization}} (const \mbox{\hyperlink{structserif_1_1equations_1_1_point_linearization}{equations\+::\+Point\+Linearization}}$<$ typename Equation\+T\+::\+Operands, \mbox{\hyperlink{namespaceserif_1_1discretization_1_1forms_ab58e222c3ef402eeceadd03fd04180bf}{discretization\+::forms\+::\+Operand\+Value}}$<$ \mbox{\hyperlink{namespaceserif_1_1equations_ab3b0f61ca51136b0ddf4d868ebdfd8df}{equations\+::\+Test\+Operand\+Of}}$<$ EquationT $>$ $>$ $>$ \&physics, const int first, \mbox{\hyperlink{structserif_1_1operators_1_1backend_1_1mfem_1_1_nodal_data}{Nodal\+Data}}$<$ EquationT, SchemaT $>$ \&data)
\begin{DoxyCompactList}\small\item\em Accept only finite, position-\/independent linearizations before exposing their row data. \end{DoxyCompactList}\item
{\footnotesize template$<$Nodal\+Value\+Equation EquationT, discretization\+::domain\+::schema\+::\+Is\+Schema SchemaT$>$ }\\std\+::expected$<$ \mbox{\hyperlink{structserif_1_1operators_1_1backend_1_1mfem_1_1_nodal_data}{Nodal\+Data}}$<$ EquationT, SchemaT $>$, \mbox{\hyperlink{structserif_1_1operators_1_1backend_1_1mfem_1_1_preparation_rejection}{Preparation\+Rejection}} $>$ \mbox{\hyperlink{namespaceserif_1_1operators_1_1backend_1_1mfem_a1027b92bb8c706c864519a7145f07144}{serif\+::operators\+::backend\+::mfem\+::evaluate\+\_\+nodal\+\_\+values}} (const EquationT \&equation, const \mbox{\hyperlink{structserif_1_1operators_1_1backend_1_1mfem_1_1_nodal_discretization}{Nodal\+Discretization}}$<$ EquationT, SchemaT $>$ \&discretization, const \mbox{\hyperlink{namespaceserif_1_1operators_1_1backend_1_1mfem_a317d4e0bea2ef8780ac3747cfe62bf72}{\+::mfem\+::\+Vector}} \&\mbox{\hyperlink{namespaceserif_1_1operators_1_1backend_1_1mfem_adf1d7a29193c8b8a6cd17745686a04d8}{values}})
\begin{DoxyCompactList}\small\item\em Evaluate the equation once per selected point, keeping residuals and derivatives in one cached result. \end{DoxyCompactList}\end{DoxyCompactItemize}