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)
61 lines
5.2 KiB
TeX
61 lines
5.2 KiB
TeX
\doxysection{src/include/serif/solver/preconditioner/strategies/gravity/factorization.hpp File Reference}
|
|
\hypertarget{strategies_2gravity_2factorization_8hpp}{}\label{strategies_2gravity_2factorization_8hpp}\index{src/include/serif/solver/preconditioner/strategies/gravity/factorization.hpp@{src/include/serif/solver/preconditioner/strategies/gravity/factorization.hpp}}
|
|
{\ttfamily \#include $<$concepts$>$}\newline
|
|
Include dependency graph for factorization.\+hpp\+:\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=206pt]{strategies_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]{strategies_2gravity_2factorization_8hpp__dep__incl}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsubsection*{Classes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1solver_1_1preconditioner_1_1strategies_1_1gravity_1_1_block_diagonal}{serif\+::solver\+::preconditioner\+::strategies\+::gravity\+::\+Block\+Diagonal}}
|
|
\begin{DoxyCompactList}\small\item\em Independently invert mass and the positive potential Schur operator. \end{DoxyCompactList}\item
|
|
struct \mbox{\hyperlink{structserif_1_1solver_1_1preconditioner_1_1strategies_1_1gravity_1_1_lower_triangular}{serif\+::solver\+::preconditioner\+::strategies\+::gravity\+::\+Lower\+Triangular}}
|
|
\begin{DoxyCompactList}\small\item\em Recover gravity gradient before correcting the potential residual. \end{DoxyCompactList}\item
|
|
struct \mbox{\hyperlink{structserif_1_1solver_1_1preconditioner_1_1strategies_1_1gravity_1_1_upper_triangular}{serif\+::solver\+::preconditioner\+::strategies\+::gravity\+::\+Upper\+Triangular}}
|
|
\begin{DoxyCompactList}\small\item\em Recover potential before correcting the gravity-\/gradient residual. \end{DoxyCompactList}\item
|
|
struct \mbox{\hyperlink{structserif_1_1solver_1_1preconditioner_1_1strategies_1_1gravity_1_1_approximate_l_d_u}{serif\+::solver\+::preconditioner\+::strategies\+::gravity\+::\+Approximate\+LDU}}
|
|
\begin{DoxyCompactList}\small\item\em Apply the signed mass/\+Schur factorization once. \end{DoxyCompactList}\item
|
|
struct \mbox{\hyperlink{structserif_1_1solver_1_1preconditioner_1_1strategies_1_1gravity_1_1_consistent_schur_l_d_u}{serif\+::solver\+::preconditioner\+::strategies\+::gravity\+::\+Consistent\+Schur\+LDU}}
|
|
\begin{DoxyCompactList}\small\item\em Refine potential against B R Bᵀ with fixed work; positive relaxation does not guarantee contraction. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
\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_1strategies}{serif\+::solver\+::preconditioner\+::strategies}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1solver_1_1preconditioner_1_1strategies_1_1gravity}{serif\+::solver\+::preconditioner\+::strategies\+::gravity}}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Concepts}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
concept \mbox{\hyperlink{conceptserif_1_1solver_1_1preconditioner_1_1strategies_1_1gravity_1_1_policy}{serif\+::solver\+::preconditioner\+::strategies\+::gravity\+::\+Policy}}
|
|
\begin{DoxyCompactList}\small\item\em Restrict mixed-\/gravity preparation to the supported signed factorizations. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Enumerations}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
enum class \mbox{\hyperlink{namespaceserif_1_1solver_1_1preconditioner_1_1strategies_1_1gravity_ac8751bb2d27560447a3accbc439065b9}{serif\+::solver\+::preconditioner\+::strategies\+::gravity\+::\+Factorization}} \{ \newline
|
|
\mbox{\hyperlink{namespaceserif_1_1solver_1_1preconditioner_1_1strategies_1_1gravity_ac8751bb2d27560447a3accbc439065b9a810ed8e1ac64dff7364597fa4776c717}{serif\+::solver\+::preconditioner\+::strategies\+::gravity\+::block\+\_\+diagonal}}
|
|
, \mbox{\hyperlink{namespaceserif_1_1solver_1_1preconditioner_1_1strategies_1_1gravity_ac8751bb2d27560447a3accbc439065b9aaf9387c48010a1e4a9768596ebdb07b8}{serif\+::solver\+::preconditioner\+::strategies\+::gravity\+::lower\+\_\+triangular}}
|
|
, \mbox{\hyperlink{namespaceserif_1_1solver_1_1preconditioner_1_1strategies_1_1gravity_ac8751bb2d27560447a3accbc439065b9a68ba2cbeae8199c4dd74004e3558a0a2}{serif\+::solver\+::preconditioner\+::strategies\+::gravity\+::upper\+\_\+triangular}}
|
|
, \mbox{\hyperlink{namespaceserif_1_1solver_1_1preconditioner_1_1strategies_1_1gravity_ac8751bb2d27560447a3accbc439065b9adaf3848f8cbb132f0e20a33939b3a61f}{serif\+::solver\+::preconditioner\+::strategies\+::gravity\+::approximate\+\_\+ldu}}
|
|
, \newline
|
|
\mbox{\hyperlink{namespaceserif_1_1solver_1_1preconditioner_1_1strategies_1_1gravity_ac8751bb2d27560447a3accbc439065b9a7278304a39f6d53d9dcbd4761e2551ad}{serif\+::solver\+::preconditioner\+::strategies\+::gravity\+::consistent\+\_\+schur\+\_\+ldu}}
|
|
\}
|
|
\begin{DoxyCompactList}\small\item\em The five signed approximations to the mixed gravity-\/gradient and potential equations. \end{DoxyCompactList}\end{DoxyCompactItemize}
|