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)
47 lines
2.8 KiB
TeX
47 lines
2.8 KiB
TeX
\doxysection{src/include/serif/operators/backend/mfem/preparation.hpp File Reference}
|
|
\hypertarget{operators_2backend_2mfem_2preparation_8hpp}{}\label{operators_2backend_2mfem_2preparation_8hpp}\index{src/include/serif/operators/backend/mfem/preparation.hpp@{src/include/serif/operators/backend/mfem/preparation.hpp}}
|
|
{\ttfamily \#include $<$cstddef$>$}\newline
|
|
{\ttfamily \#include $<$expected$>$}\newline
|
|
{\ttfamily \#include "{}serif/utils/dependencies/preparation.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/operators/backend/mfem/rejection.\+hpp"{}}\newline
|
|
Include dependency graph for preparation.\+hpp\+:\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{operators_2backend_2mfem_2preparation_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]{operators_2backend_2mfem_2preparation_8hpp__dep__incl}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsubsection*{Classes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1operators_1_1backend_1_1mfem_1_1_numerical_work}{serif\+::operators\+::backend\+::mfem\+::\+Numerical\+Work}}
|
|
\begin{DoxyCompactList}\small\item\em Numerical work derived from the dependency engine\textquotesingle{}s most recent report. \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*{Typedefs}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
using \mbox{\hyperlink{namespaceserif_1_1operators_1_1backend_1_1mfem_a6a2411f45caf7bd82d0e3ce2fb7833fa}{serif\+::operators\+::backend\+::mfem\+::\+Preparation\+Mode}} = \mbox{\hyperlink{namespaceserif_1_1utils_1_1dependencies_a84cfff3388a09373636c15a3817a0782}{utils\+::dependencies\+::\+Preparation\+Mode}}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
{\footnotesize template$<$typename CacheT, typename PrepareT$>$ }\\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_acb285cd38d6c0c93b661c1bc54e9ece2}{serif\+::operators\+::backend\+::mfem\+::try\+\_\+prepare\+\_\+validated}} (CacheT \&cache, PrepareT \&\&prepare)
|
|
\begin{DoxyCompactList}\small\item\em A failed validation or calculation must make the previous accepted result inaccessible. \end{DoxyCompactList}\end{DoxyCompactItemize}
|