Emily Boudreaux
6b57738330
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)
91 lines
5.2 KiB
TeX
91 lines
5.2 KiB
TeX
\doxysection{serif Namespace Reference}
|
|
\hypertarget{namespaceserif}{}\label{namespaceserif}\index{serif@{serif}}
|
|
\doxysubsubsection*{Namespaces}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1backend}{backend}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1compile__time__checks}{compile\+\_\+time\+\_\+checks}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1dimensions}{dimensions}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1discretization}{discretization}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1eos}{eos}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1equations}{equations}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1geometry}{geometry}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1mapping}{mapping}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1meta}{meta}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1model}{model}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1operators}{operators}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1solver}{solver}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1utils}{utils}}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Typedefs}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
using \mbox{\hyperlink{namespaceserif_ab7690da8665e9d9bd2fa8e8534cd6e57}{Vector}} = \mbox{\hyperlink{namespaceserif_1_1backend_1_1mfem_afdd4d9966e5040b2de0684e018dce66e}{backend\+::mfem\+::\+Vector}}
|
|
\item
|
|
using \mbox{\hyperlink{namespaceserif_a2d701ec924ef77ca55c63361e80bc19d}{Dense\+Matrix}} = \mbox{\hyperlink{namespaceserif_1_1backend_1_1mfem_a074a5dd97af4c4276d0f42e21075a135}{backend\+::mfem\+::\+Dense\+Matrix}}
|
|
\item
|
|
using \mbox{\hyperlink{namespaceserif_a90679f321c52b8a722250593c545d1c0}{Sparse\+Matrix}} = \mbox{\hyperlink{namespaceserif_1_1backend_1_1mfem_a5f09505621d66ad460626d5a868c9e21}{backend\+::mfem\+::\+Sparse\+Matrix}}
|
|
\item
|
|
using \mbox{\hyperlink{namespaceserif_ab1840b03c7cbd4fa5b1dd32f73e53089}{Linear\+Operator}} = \mbox{\hyperlink{namespaceserif_1_1backend_1_1mfem_aa6d65d6620b55f916624192885696d27}{backend\+::mfem\+::\+Linear\+Operator}}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
void \mbox{\hyperlink{namespaceserif_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_a2d701ec924ef77ca55c63361e80bc19d}\index{serif@{serif}!DenseMatrix@{DenseMatrix}}
|
|
\index{DenseMatrix@{DenseMatrix}!serif@{serif}}
|
|
\doxysubsubsection{\texorpdfstring{DenseMatrix}{DenseMatrix}}
|
|
{\footnotesize\ttfamily \label{namespaceserif_a2d701ec924ef77ca55c63361e80bc19d}
|
|
using \mbox{\hyperlink{namespaceserif_a2d701ec924ef77ca55c63361e80bc19d}{serif\+::\+Dense\+Matrix}} = \mbox{\hyperlink{namespaceserif_1_1backend_1_1mfem_a074a5dd97af4c4276d0f42e21075a135}{backend\+::mfem\+::\+Dense\+Matrix}}}
|
|
|
|
\Hypertarget{namespaceserif_ab1840b03c7cbd4fa5b1dd32f73e53089}\index{serif@{serif}!LinearOperator@{LinearOperator}}
|
|
\index{LinearOperator@{LinearOperator}!serif@{serif}}
|
|
\doxysubsubsection{\texorpdfstring{LinearOperator}{LinearOperator}}
|
|
{\footnotesize\ttfamily \label{namespaceserif_ab1840b03c7cbd4fa5b1dd32f73e53089}
|
|
using \mbox{\hyperlink{namespaceserif_ab1840b03c7cbd4fa5b1dd32f73e53089}{serif\+::\+Linear\+Operator}} = \mbox{\hyperlink{namespaceserif_1_1backend_1_1mfem_aa6d65d6620b55f916624192885696d27}{backend\+::mfem\+::\+Linear\+Operator}}}
|
|
|
|
\Hypertarget{namespaceserif_a90679f321c52b8a722250593c545d1c0}\index{serif@{serif}!SparseMatrix@{SparseMatrix}}
|
|
\index{SparseMatrix@{SparseMatrix}!serif@{serif}}
|
|
\doxysubsubsection{\texorpdfstring{SparseMatrix}{SparseMatrix}}
|
|
{\footnotesize\ttfamily \label{namespaceserif_a90679f321c52b8a722250593c545d1c0}
|
|
using \mbox{\hyperlink{namespaceserif_a90679f321c52b8a722250593c545d1c0}{serif\+::\+Sparse\+Matrix}} = \mbox{\hyperlink{namespaceserif_1_1backend_1_1mfem_a5f09505621d66ad460626d5a868c9e21}{backend\+::mfem\+::\+Sparse\+Matrix}}}
|
|
|
|
\Hypertarget{namespaceserif_ab7690da8665e9d9bd2fa8e8534cd6e57}\index{serif@{serif}!Vector@{Vector}}
|
|
\index{Vector@{Vector}!serif@{serif}}
|
|
\doxysubsubsection{\texorpdfstring{Vector}{Vector}}
|
|
{\footnotesize\ttfamily \label{namespaceserif_ab7690da8665e9d9bd2fa8e8534cd6e57}
|
|
using \mbox{\hyperlink{namespaceserif_ab7690da8665e9d9bd2fa8e8534cd6e57}{serif\+::\+Vector}} = \mbox{\hyperlink{namespaceserif_1_1backend_1_1mfem_afdd4d9966e5040b2de0684e018dce66e}{backend\+::mfem\+::\+Vector}}}
|
|
|
|
|
|
|
|
\doxysubsection{Function Documentation}
|
|
\Hypertarget{namespaceserif_a31cb75e36c6ad0a21557f789d67229f1}\index{serif@{serif}!initialize@{initialize}}
|
|
\index{initialize@{initialize}!serif@{serif}}
|
|
\doxysubsubsection{\texorpdfstring{initialize()}{initialize()}}
|
|
{\footnotesize\ttfamily \label{namespaceserif_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}
|