Files
MeanField_SERiF/docs/latex/backend_2mfem_2gravity_2factorization_8hpp.tex
Emily Boudreaux 6b57738330 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)
2026-11-09 14:09:44 -05:00

43 lines
4.1 KiB
TeX

\doxysection{src/include/serif/solver/preconditioner/backend/mfem/gravity/factorization.hpp File Reference}
\hypertarget{backend_2mfem_2gravity_2factorization_8hpp}{}\label{backend_2mfem_2gravity_2factorization_8hpp}\index{src/include/serif/solver/preconditioner/backend/mfem/gravity/factorization.hpp@{src/include/serif/solver/preconditioner/backend/mfem/gravity/factorization.hpp}}
{\ttfamily \#include $<$expected$>$}\newline
{\ttfamily \#include $<$utility$>$}\newline
{\ttfamily \#include "{}serif/solver/preconditioner/backend/mfem/inverse.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/solver/preconditioner/strategies/gravity/factorization.\+hpp"{}}\newline
Include dependency graph for factorization.\+hpp\+:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{backend_2mfem_2gravity_2factorization_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]{backend_2mfem_2gravity_2factorization_8hpp__dep__incl}
\end{center}
\end{figure}
\doxysubsubsection*{Namespaces}
\begin{DoxyCompactItemize}
\item
namespace \mbox{\hyperlink{namespaceserif}{serif}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1solver}{serif\+::solver}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1solver_1_1preconditioner}{serif\+::solver\+::preconditioner}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1solver_1_1preconditioner_1_1backend}{serif\+::solver\+::preconditioner\+::backend}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem}{serif\+::solver\+::preconditioner\+::backend\+::mfem}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem_1_1detail}{serif\+::solver\+::preconditioner\+::backend\+::mfem\+::detail}}
\end{DoxyCompactItemize}
\doxysubsubsection*{Functions}
\begin{DoxyCompactItemize}
\item
std\+::expected$<$ \mbox{\hyperlink{structserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem_1_1_inverse}{Inverse}}, \mbox{\hyperlink{structserif_1_1solver_1_1preconditioner_1_1_failure}{Failure}} $>$ \mbox{\hyperlink{namespaceserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem_1_1detail_aa4b8e90442528ed214bb2fc299dda426}{serif\+::solver\+::preconditioner\+::backend\+::mfem\+::detail\+::prepare\+\_\+gravity}} (\mbox{\hyperlink{structserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem_1_1_inverse}{Inverse}} mass, \mbox{\hyperlink{structserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem_1_1_inverse}{Inverse}} positive\+\_\+schur, \mbox{\hyperlink{namespaceserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem_a12e3dd6e5e7ac18ab2dba10956af8d59}{Operator\+Handle}} divergence, \mbox{\hyperlink{namespaceserif_1_1solver_1_1preconditioner_1_1strategies_1_1gravity_ac8751bb2d27560447a3accbc439065b9}{strategies\+::gravity\+::\+Factorization}} method, int correction\+\_\+sweeps, double relaxation)
\begin{DoxyCompactList}\small\item\em Validate and own the children of one signed mixed-\/gravity inverse. \end{DoxyCompactList}\item
{\footnotesize template$<$strategies\+::gravity\+::\+Policy Policy$>$ }\\std\+::expected$<$ \mbox{\hyperlink{structserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem_1_1_inverse}{Inverse}}, \mbox{\hyperlink{structserif_1_1solver_1_1preconditioner_1_1_failure}{Failure}} $>$ \mbox{\hyperlink{namespaceserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem_ae9c4d4743db072040e6bb6a4d6a91f66}{serif\+::solver\+::preconditioner\+::backend\+::mfem\+::try\+\_\+gravity\+\_\+inverse}} (\mbox{\hyperlink{structserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem_1_1_inverse}{Inverse}} mass, \mbox{\hyperlink{structserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem_1_1_inverse}{Inverse}} positive\+\_\+schur, \mbox{\hyperlink{namespaceserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem_a12e3dd6e5e7ac18ab2dba10956af8d59}{Operator\+Handle}} divergence, const Policy \&policy)
\begin{DoxyCompactList}\small\item\em Compose frozen child inverses for \mbox{[}M Bᵀ; B 0\mbox{]}; variable children require a flexible outer solver. \end{DoxyCompactList}\end{DoxyCompactItemize}