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,63 @@
\doxysection{src/include/serif/backend/mfem/operators/operand\+\_\+evaluation.hpp File Reference}
\hypertarget{operand__evaluation_8hpp}{}\label{operand__evaluation_8hpp}\index{src/include/serif/backend/mfem/operators/operand\_evaluation.hpp@{src/include/serif/backend/mfem/operators/operand\_evaluation.hpp}}
{\ttfamily \#include $<$array$>$}\newline
{\ttfamily \#include $<$concepts$>$}\newline
{\ttfamily \#include $<$type\+\_\+traits$>$}\newline
{\ttfamily \#include $<$stdexcept$>$}\newline
{\ttfamily \#include $<$utility$>$}\newline
{\ttfamily \#include "{}mfem/fem/fe/fe\+\_\+base.\+hpp"{}}\newline
{\ttfamily \#include "{}mfem/fem/eltrans.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/operators/concepts.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/backend/mfem/discretization/basis\+\_\+evaluation.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/backend/mfem/discretization/dof\+\_\+map.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/backend/mfem/mapping/transformations.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/utils/error/errors.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/utils/misc/compensated\+\_\+sum.\+hpp"{}}\newline
Include dependency graph for operand\+\_\+evaluation.\+hpp\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{operand__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]{operand__evaluation_8hpp__dep__incl}
\end{center}
\end{figure}
\doxysubsubsection*{Classes}
\begin{DoxyCompactItemize}
\item
struct \mbox{\hyperlink{structserif_1_1operators_1_1backend_1_1mfem_1_1_operand_evaluator_3_01_operand_t_01_4}{serif\+::operators\+::backend\+::mfem\+::\+Operand\+Evaluator$<$ Operand\+T $>$}}
\begin{DoxyCompactList}\small\item\em Scalar and vector H1 gradients share the existing value/divergence coefficient contractions. \end{DoxyCompactList}\item
struct \mbox{\hyperlink{structserif_1_1operators_1_1backend_1_1mfem_1_1_basis_workspace}{serif\+::operators\+::backend\+::mfem\+::\+Basis\+Workspace}}
\begin{DoxyCompactList}\small\item\em Reusable scratch storage for basis contractions, reducing repeated allocations. \end{DoxyCompactList}\item
class \mbox{\hyperlink{classserif_1_1operators_1_1backend_1_1mfem_1_1_tensor_basis_cache}{serif\+::operators\+::backend\+::mfem\+::\+Tensor\+Basis\+Cache}}
\begin{DoxyCompactList}\small\item\em Share immutable tensor plans within one operator; copied rules are keyed by their contents. \end{DoxyCompactList}\end{DoxyCompactItemize}
\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*{Concepts}
\begin{DoxyCompactItemize}
\item
concept \mbox{\hyperlink{conceptserif_1_1operators_1_1backend_1_1mfem_1_1_evaluable_operand}{serif\+::operators\+::backend\+::mfem\+::\+Evaluable\+Operand}}
\begin{DoxyCompactList}\small\item\em Check the complete interface used by preparation, Jacobian application, and its transpose. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsubsection*{Enumerations}
\begin{DoxyCompactItemize}
\item
enum class \mbox{\hyperlink{namespaceserif_1_1operators_1_1backend_1_1mfem_a24da3fc8af225640b2d32c378ef40cde}{serif\+::operators\+::backend\+::mfem\+::\+Contraction\+Mode}}
\begin{DoxyCompactList}\small\item\em Options enum to control how the tensor contractions are performed. \end{DoxyCompactList}\item
enum class \mbox{\hyperlink{namespaceserif_1_1operators_1_1backend_1_1mfem_af75f98db90618153ea4ca169945733f7}{serif\+::operators\+::backend\+::mfem\+::\+Reference\+Operation}}
\begin{DoxyCompactList}\small\item\em Options enum to control what is actually evaluated at the reference points. \end{DoxyCompactList}\end{DoxyCompactItemize}