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)
40 lines
2.0 KiB
TeX
40 lines
2.0 KiB
TeX
\doxysection{src/include/serif/solver/preconditioner/recipes/block.hpp File Reference}
|
|
\hypertarget{block_8hpp}{}\label{block_8hpp}\index{src/include/serif/solver/preconditioner/recipes/block.hpp@{src/include/serif/solver/preconditioner/recipes/block.hpp}}
|
|
{\ttfamily \#include $<$utility$>$}\newline
|
|
{\ttfamily \#include "{}serif/solver/preconditioner/keys.\+hpp"{}}\newline
|
|
Include dependency graph for block.\+hpp\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{block_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]{block_8hpp__dep__incl}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsubsection*{Classes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1solver_1_1preconditioner_1_1_block_preconditioner}{serif\+::solver\+::preconditioner\+::\+Block\+Preconditioner$<$ Row, Field, Strategy $>$}}
|
|
\begin{DoxyCompactList}\small\item\em Select a physical equation/unknown pair and the numerical approximation to its inverse. \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 Field, typename Row = Field, typename Strategy$>$ }\\auto \mbox{\hyperlink{namespaceserif_1_1solver_1_1preconditioner_afd31d14cec3f663d8ed9c51d6fbc8fc7}{serif\+::solver\+::preconditioner\+::make\+\_\+preconditioner}} (Strategy inverse)
|
|
\begin{DoxyCompactList}\small\item\em Describe an inverse without preparing matrices or binding runtime state. \end{DoxyCompactList}\end{DoxyCompactItemize}
|