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)
44 lines
3.1 KiB
TeX
44 lines
3.1 KiB
TeX
\doxysection{src/include/serif/solver/preconditioner/recipes/gravity.hpp File Reference}
|
|
\hypertarget{recipes_2gravity_8hpp}{}\label{recipes_2gravity_8hpp}\index{src/include/serif/solver/preconditioner/recipes/gravity.hpp@{src/include/serif/solver/preconditioner/recipes/gravity.hpp}}
|
|
{\ttfamily \#include $<$utility$>$}\newline
|
|
{\ttfamily \#include "{}serif/discretization/blocks/fields.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/solver/preconditioner/recipes/block.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/solver/preconditioner/strategies/inverse/chebyshev.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/solver/preconditioner/strategies/inverse/fixed\+\_\+amg.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/solver/preconditioner/strategies/gravity/factorization.\+hpp"{}}\newline
|
|
Include dependency graph for gravity.\+hpp\+:\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{recipes_2gravity_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=242pt]{recipes_2gravity_8hpp__dep__incl}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsubsection*{Classes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1solver_1_1preconditioner_1_1_gravity_preconditioner}{serif\+::solver\+::preconditioner\+::\+Gravity\+Preconditioner$<$ Gradient, Potential, Mass\+Strategy, Schur\+Strategy, Policy $>$}}
|
|
\begin{DoxyCompactList}\small\item\em Approximate the mixed gravity-\/gradient and potential equations with explicitly selected child inverses. \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}}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
{\footnotesize template$<$typename Gradient = discretization\+::blocks\+::gravity\+::gradient, typename Potential = discretization\+::blocks\+::gravity\+::potential, typename Mass\+Strategy, typename Schur\+Strategy, strategies\+::gravity\+::\+Policy Policy = strategies\+::gravity\+::\+Approximate\+LDU$>$ }\\auto \mbox{\hyperlink{namespaceserif_1_1solver_1_1preconditioner_aa6aba99bc849b81c566f4d823d04495c}{serif\+::solver\+::preconditioner\+::make\+\_\+gravity\+\_\+preconditioner}} (Mass\+Strategy mass, Schur\+Strategy potential, Policy factorization=\{\})
|
|
\begin{DoxyCompactList}\small\item\em Select advanced gravity numerics without encoding a particular equation-\/of-\/state model. \end{DoxyCompactList}\item
|
|
auto \mbox{\hyperlink{namespaceserif_1_1solver_1_1preconditioner_ae186b6d655f5e9b7ca307162c948f228}{serif\+::solver\+::preconditioner\+::make\+\_\+gravity\+\_\+preconditioner}} ()
|
|
\begin{DoxyCompactList}\small\item\em Preserve Mean\+Field\textquotesingle{}s stellar default\+: fifth-\/order mass polynomial, three AMG cycles, and gravity LDU. \end{DoxyCompactList}\end{DoxyCompactItemize}
|