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,86 @@
\doxysection{serif\+::backend\+::mfem Namespace Reference}
\hypertarget{namespaceserif_1_1backend_1_1mfem}{}\label{namespaceserif_1_1backend_1_1mfem}\index{serif::backend::mfem@{serif::backend::mfem}}
\doxysubsubsection*{Namespaces}
\begin{DoxyCompactItemize}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1backend_1_1mfem_1_1discretization}{discretization}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1backend_1_1mfem_1_1serialize}{serialize}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1backend_1_1mfem_1_1shared}{shared}}
\end{DoxyCompactItemize}
\doxysubsubsection*{Typedefs}
\begin{DoxyCompactItemize}
\item
using \mbox{\hyperlink{namespaceserif_1_1backend_1_1mfem_afdd4d9966e5040b2de0684e018dce66e}{Vector}} = \+::mfem\+::\+Vector
\begin{DoxyCompactList}\small\item\em Native owned finite-\/element coefficients. \end{DoxyCompactList}\item
using \mbox{\hyperlink{namespaceserif_1_1backend_1_1mfem_a074a5dd97af4c4276d0f42e21075a135}{Dense\+Matrix}} = \+::mfem\+::\+Dense\+Matrix
\begin{DoxyCompactList}\small\item\em Dense element matrices and small systems. \end{DoxyCompactList}\item
using \mbox{\hyperlink{namespaceserif_1_1backend_1_1mfem_a5f09505621d66ad460626d5a868c9e21}{Sparse\+Matrix}} = \+::mfem\+::\+Sparse\+Matrix
\begin{DoxyCompactList}\small\item\em Explicitly assembled sparse matrices. \end{DoxyCompactList}\item
using \mbox{\hyperlink{namespaceserif_1_1backend_1_1mfem_aa6d65d6620b55f916624192885696d27}{Linear\+Operator}} = \+::mfem\+::\+Operator
\begin{DoxyCompactList}\small\item\em Assembled or matrix-\/free linear actions. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsubsection*{Functions}
\begin{DoxyCompactItemize}
\item
void \mbox{\hyperlink{namespaceserif_1_1backend_1_1mfem_a31cb75e36c6ad0a21557f789d67229f1}{initialize}} ()
\begin{DoxyCompactList}\small\item\em Initialize the selected numerical runtime once, before application work begins. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsection{Typedef Documentation}
\Hypertarget{namespaceserif_1_1backend_1_1mfem_a074a5dd97af4c4276d0f42e21075a135}\index{serif::backend::mfem@{serif::backend::mfem}!DenseMatrix@{DenseMatrix}}
\index{DenseMatrix@{DenseMatrix}!serif::backend::mfem@{serif::backend::mfem}}
\doxysubsubsection{\texorpdfstring{DenseMatrix}{DenseMatrix}}
{\footnotesize\ttfamily \label{namespaceserif_1_1backend_1_1mfem_a074a5dd97af4c4276d0f42e21075a135}
using \mbox{\hyperlink{namespaceserif_1_1backend_1_1mfem_a074a5dd97af4c4276d0f42e21075a135}{serif\+::backend\+::mfem\+::\+Dense\+Matrix}} = \+::mfem\+::\+Dense\+Matrix}
Dense element matrices and small systems.
\Hypertarget{namespaceserif_1_1backend_1_1mfem_aa6d65d6620b55f916624192885696d27}\index{serif::backend::mfem@{serif::backend::mfem}!LinearOperator@{LinearOperator}}
\index{LinearOperator@{LinearOperator}!serif::backend::mfem@{serif::backend::mfem}}
\doxysubsubsection{\texorpdfstring{LinearOperator}{LinearOperator}}
{\footnotesize\ttfamily \label{namespaceserif_1_1backend_1_1mfem_aa6d65d6620b55f916624192885696d27}
using \mbox{\hyperlink{namespaceserif_1_1backend_1_1mfem_aa6d65d6620b55f916624192885696d27}{serif\+::backend\+::mfem\+::\+Linear\+Operator}} = \+::mfem\+::\+Operator}
Assembled or matrix-\/free linear actions.
\Hypertarget{namespaceserif_1_1backend_1_1mfem_a5f09505621d66ad460626d5a868c9e21}\index{serif::backend::mfem@{serif::backend::mfem}!SparseMatrix@{SparseMatrix}}
\index{SparseMatrix@{SparseMatrix}!serif::backend::mfem@{serif::backend::mfem}}
\doxysubsubsection{\texorpdfstring{SparseMatrix}{SparseMatrix}}
{\footnotesize\ttfamily \label{namespaceserif_1_1backend_1_1mfem_a5f09505621d66ad460626d5a868c9e21}
using \mbox{\hyperlink{namespaceserif_1_1backend_1_1mfem_a5f09505621d66ad460626d5a868c9e21}{serif\+::backend\+::mfem\+::\+Sparse\+Matrix}} = \+::mfem\+::\+Sparse\+Matrix}
Explicitly assembled sparse matrices.
\Hypertarget{namespaceserif_1_1backend_1_1mfem_afdd4d9966e5040b2de0684e018dce66e}\index{serif::backend::mfem@{serif::backend::mfem}!Vector@{Vector}}
\index{Vector@{Vector}!serif::backend::mfem@{serif::backend::mfem}}
\doxysubsubsection{\texorpdfstring{Vector}{Vector}}
{\footnotesize\ttfamily \label{namespaceserif_1_1backend_1_1mfem_afdd4d9966e5040b2de0684e018dce66e}
using \mbox{\hyperlink{namespaceserif_1_1backend_1_1mfem_afdd4d9966e5040b2de0684e018dce66e}{serif\+::backend\+::mfem\+::\+Vector}} = \+::mfem\+::\+Vector}
Native owned finite-\/element coefficients.
\doxysubsection{Function Documentation}
\Hypertarget{namespaceserif_1_1backend_1_1mfem_a31cb75e36c6ad0a21557f789d67229f1}\index{serif::backend::mfem@{serif::backend::mfem}!initialize@{initialize}}
\index{initialize@{initialize}!serif::backend::mfem@{serif::backend::mfem}}
\doxysubsubsection{\texorpdfstring{initialize()}{initialize()}}
{\footnotesize\ttfamily \label{namespaceserif_1_1backend_1_1mfem_a31cb75e36c6ad0a21557f789d67229f1}
void serif\+::backend\+::mfem\+::initialize (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})}
Initialize the selected numerical runtime once, before application work begins.
\begin{DoxyNote}{Note}
Call on the main thread. An existing MPI session remains externally owned; a session started here is finalized by MFEM at process exit. Serial builds need no initialization.
\end{DoxyNote}