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)
46 lines
3.5 KiB
TeX
46 lines
3.5 KiB
TeX
\doxysection{src/include/serif/backend/mfem/solver/linear/solve.hpp File Reference}
|
|
\hypertarget{solve_8hpp}{}\label{solve_8hpp}\index{src/include/serif/backend/mfem/solver/linear/solve.hpp@{src/include/serif/backend/mfem/solver/linear/solve.hpp}}
|
|
{\ttfamily \#include $<$concepts$>$}\newline
|
|
{\ttfamily \#include $<$type\+\_\+traits$>$}\newline
|
|
{\ttfamily \#include "{}mfem/linalg/operator.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}mfem/linalg/vector.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/solver/linear/linear.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/solver/preconditioner/contract.\+hpp"{}}\newline
|
|
Include dependency graph for solve.\+hpp\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{solve_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]{solve_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_1linear}{serif\+::solver\+::linear}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1solver_1_1linear_1_1backend}{serif\+::solver\+::linear\+::backend}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1solver_1_1linear_1_1backend_1_1mfem}{serif\+::solver\+::linear\+::backend\+::mfem}}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
\mbox{\hyperlink{structserif_1_1solver_1_1linear_1_1_report}{Report}} \mbox{\hyperlink{namespaceserif_1_1solver_1_1linear_1_1backend_1_1mfem_a048c6be0b47ff070d1ce8165ed857051}{serif\+::solver\+::linear\+::backend\+::mfem\+::solve}} (\mbox{\hyperlink{structserif_1_1solver_1_1linear_1_1_f_g_m_r_e_s}{FGMRES}} options, const \+::mfem\+::\+Operator \&operation, \+::mfem\+::\+Solver \&preconditioner, \mbox{\hyperlink{namespaceserif_1_1solver_1_1preconditioner_aa7f59af2cd4988b0904ebc5b7b575a53}{preconditioner\+::\+Application\+Contract}} contract, const \+::mfem\+::\+Vector \&right\+\_\+hand\+\_\+side, \+::mfem\+::\+Vector \&correction, \mbox{\hyperlink{structserif_1_1solver_1_1linear_1_1_control}{Control}} control=\{\})
|
|
\begin{DoxyCompactList}\small\item\em Solve a serial linear system and independently verify the resulting correction. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$typename Backend$>$ \newline
|
|
requires (!std\+::same\+\_\+as$<$std\+::remove\+\_\+cvref\+\_\+t$<$Backend$>$, \mbox{\hyperlink{structserif_1_1solver_1_1linear_1_1_f_g_m_r_e_s}{FGMRES}}$>$)}\\\mbox{\hyperlink{structserif_1_1solver_1_1linear_1_1_report}{Report}} \mbox{\hyperlink{namespaceserif_1_1solver_1_1linear_1_1backend_1_1mfem_a8d7711d1f87dc3d213f1aa556c69efdd}{serif\+::solver\+::linear\+::backend\+::mfem\+::solve}} (const Backend \&backend, const \+::mfem\+::\+Operator \&operation, \+::mfem\+::\+Solver \&inverse, \mbox{\hyperlink{namespaceserif_1_1solver_1_1preconditioner_aa7f59af2cd4988b0904ebc5b7b575a53}{preconditioner\+::\+Application\+Contract}} contract, const \+::mfem\+::\+Vector \&rhs, \+::mfem\+::\+Vector \&correction, \mbox{\hyperlink{structserif_1_1solver_1_1linear_1_1_control}{Control}} control)
|
|
\begin{DoxyCompactList}\small\item\em Custom linear solvers implement the same checked-\/result contract as the built-\/in solver. \end{DoxyCompactList}\end{DoxyCompactItemize}
|