Files
MeanField_SERiF/docs/latex/namespaceserif_1_1model_1_1preconditioning.tex

37 lines
2.8 KiB
TeX
Raw Permalink Normal View History

\doxysection{serif\+::model\+::preconditioning Namespace Reference}
\hypertarget{namespaceserif_1_1model_1_1preconditioning}{}\label{namespaceserif_1_1model_1_1preconditioning}\index{serif::model::preconditioning@{serif::model::preconditioning}}
\doxysubsubsection*{Namespaces}
\begin{DoxyCompactItemize}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1model_1_1preconditioning_1_1detail}{detail}}
\end{DoxyCompactItemize}
\doxysubsubsection*{Classes}
\begin{DoxyCompactItemize}
\item
struct \mbox{\hyperlink{structserif_1_1model_1_1preconditioning_1_1_none}{None}}
\begin{DoxyCompactList}\small\item\em Evaluate physical equations without preparing an inverse until a recipe is selected. \end{DoxyCompactList}\item
struct \mbox{\hyperlink{structserif_1_1model_1_1preconditioning_1_1_prepared_system}{Prepared\+System}}
\begin{DoxyCompactList}\small\item\em An owning evaluated system and its matching preconditioner. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsubsection*{Functions}
\begin{DoxyCompactItemize}
\item
{\footnotesize template$<$typename Result\+Key, typename Recipe, typename Layout, typename... Existing$>$ }\\auto \mbox{\hyperlink{namespaceserif_1_1model_1_1preconditioning_a36fd24993a4ac4e599ef61b9dfb6d776}{make\+\_\+computations}} (const Recipe \&recipe, const Layout \&layout, const std\+::tuple$<$ Existing... $>$ \&existing)
\begin{DoxyCompactList}\small\item\em Connect a recipe to the same physical root, layout and reference geometry as model evaluation. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsection{Function Documentation}
\Hypertarget{namespaceserif_1_1model_1_1preconditioning_a36fd24993a4ac4e599ef61b9dfb6d776}\index{serif::model::preconditioning@{serif::model::preconditioning}!make\_computations@{make\_computations}}
\index{make\_computations@{make\_computations}!serif::model::preconditioning@{serif::model::preconditioning}}
\doxysubsubsection{\texorpdfstring{make\_computations()}{make\_computations()}}
{\footnotesize\ttfamily \label{namespaceserif_1_1model_1_1preconditioning_a36fd24993a4ac4e599ef61b9dfb6d776}
template$<$typename Result\+Key, typename Recipe, typename Layout, typename... Existing$>$ \\
auto serif\+::model\+::preconditioning\+::make\+\_\+computations (\begin{DoxyParamCaption}\item[{const Recipe \&}]{recipe}{, }\item[{const Layout \&}]{layout}{, }\item[{const std\+::tuple$<$ Existing... $>$ \&}]{existing}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [nodiscard]}}
Connect a recipe to the same physical root, layout and reference geometry as model evaluation.
\begin{DoxyNote}{Note}
Merely adding these computations does not prepare an inverse. Only requesting \doxylink{structserif_1_1model_1_1preconditioning_1_1_prepared_system}{Prepared\+System} reaches this branch, so line-\/search evaluations can reuse the physical graph without inverse setup.
\end{DoxyNote}