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)
41 lines
3.2 KiB
TeX
41 lines
3.2 KiB
TeX
\doxysection{src/include/serif/solver/preconditioner/computations/gravity.hpp File Reference}
|
|
\hypertarget{computations_2gravity_8hpp}{}\label{computations_2gravity_8hpp}\index{src/include/serif/solver/preconditioner/computations/gravity.hpp@{src/include/serif/solver/preconditioner/computations/gravity.hpp}}
|
|
{\ttfamily \#include "{}serif/solver/preconditioner/recipes/gravity.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/solver/preconditioner/computations/inverse.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/solver/preconditioner/backend/mfem/gravity/factorization.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/solver/preconditioner/backend/mfem/gravity/schur.\+hpp"{}}\newline
|
|
Include dependency graph for gravity.\+hpp\+:\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{computations_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]{computations_2gravity_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_1computations}{serif\+::solver\+::preconditioner\+::computations}}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
{\footnotesize template$<$typename Gradient, typename Potential$>$ }\\auto \mbox{\hyperlink{namespaceserif_1_1solver_1_1preconditioner_1_1computations_a14492f57c6477ef93b08e6b58250d551}{serif\+::solver\+::preconditioner\+::computations\+::gravity\+\_\+schur}} ()
|
|
\begin{DoxyCompactList}\small\item\em Build B diag(\+M)\texorpdfstring{$^\wedge$}{\string^}-\/1 B\texorpdfstring{$^\wedge$}{\string^}T while the computational divergence remains independently reusable. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$typename Gradient, typename Potential, typename Strategy$>$ }\\auto \mbox{\hyperlink{namespaceserif_1_1solver_1_1preconditioner_1_1computations_a9f9be7ea5af1702d6000371e304e51fb}{serif\+::solver\+::preconditioner\+::computations\+::gravity\+\_\+potential\+\_\+inverse}} (const Strategy \&strategy)
|
|
\begin{DoxyCompactList}\small\item\em Prepare the positive potential inverse without changing the physical saddle-\/point signs. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$typename Gradient, typename Potential, typename Mass\+Strategy, typename Schur\+Strategy, typename Policy$>$ }\\auto \mbox{\hyperlink{namespaceserif_1_1solver_1_1preconditioner_1_1computations_ab9dc5fddca032d6de2a5fcf08851941c}{serif\+::solver\+::preconditioner\+::computations\+::gravity}} (const \mbox{\hyperlink{structserif_1_1solver_1_1preconditioner_1_1_gravity_preconditioner}{Gravity\+Preconditioner}}$<$ Gradient, Potential, Mass\+Strategy, Schur\+Strategy, Policy $>$ \&choice)
|
|
\begin{DoxyCompactList}\small\item\em Compose the chosen mixed-\/gravity factorization using the same accepted mass and divergence results. \end{DoxyCompactList}\end{DoxyCompactItemize}
|