Files
MeanField_SERiF/docs/latex/coupling_8hpp.tex

47 lines
4.0 KiB
TeX
Raw Normal View History

\doxysection{src/include/serif/backend/mfem/solver/preconditioner/coupling.hpp File Reference}
\hypertarget{coupling_8hpp}{}\label{coupling_8hpp}\index{src/include/serif/backend/mfem/solver/preconditioner/coupling.hpp@{src/include/serif/backend/mfem/solver/preconditioner/coupling.hpp}}
{\ttfamily \#include $<$expected$>$}\newline
{\ttfamily \#include "{}serif/backend/mfem/solver/preconditioner/inverse.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/solver/preconditioner/strategies/coupling/order.\+hpp"{}}\newline
Include dependency graph for coupling.\+hpp\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{coupling_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]{coupling_8hpp__dep__incl}
\end{center}
\end{figure}
\doxysubsubsection*{Classes}
\begin{DoxyCompactItemize}
\item
struct \mbox{\hyperlink{structserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem_1_1_two_block_couplings}{serif\+::solver\+::preconditioner\+::backend\+::mfem\+::\+Two\+Block\+Couplings}}
\begin{DoxyCompactList}\small\item\em The two Jacobian actions between independently ordered equation and unknown groups. \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_1backend}{serif\+::solver\+::preconditioner\+::backend}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem}{serif\+::solver\+::preconditioner\+::backend\+::mfem}}
\end{DoxyCompactItemize}
\doxysubsubsection*{Functions}
\begin{DoxyCompactItemize}
\item
std\+::expected$<$ \mbox{\hyperlink{structserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem_1_1_inverse}{Inverse}}, \mbox{\hyperlink{structserif_1_1solver_1_1preconditioner_1_1_failure}{Failure}} $>$ \mbox{\hyperlink{namespaceserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem_a2e24799af31c301cb141c2bfd362669a}{serif\+::solver\+::preconditioner\+::backend\+::mfem\+::try\+\_\+coupled\+\_\+inverse}} (\mbox{\hyperlink{structserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem_1_1_inverse}{Inverse}} first, \mbox{\hyperlink{structserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem_1_1_inverse}{Inverse}} second, \mbox{\hyperlink{structserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem_1_1_two_block_couplings}{Two\+Block\+Couplings}} couplings, \mbox{\hyperlink{namespaceserif_1_1solver_1_1preconditioner_1_1strategies_1_1coupling_a1843f298d4e3fb5770085697b48ffa55}{strategies\+::coupling\+::\+Coupling\+Order}} order)
\begin{DoxyCompactList}\small\item\em Compose two inverses with the requested treatment of their cross couplings. \end{DoxyCompactList}\item
std\+::expected$<$ \mbox{\hyperlink{namespaceserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem_a12e3dd6e5e7ac18ab2dba10956af8d59}{Operator\+Handle}}, \mbox{\hyperlink{structserif_1_1solver_1_1preconditioner_1_1_failure}{Failure}} $>$ \mbox{\hyperlink{namespaceserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem_aca9dd8c44b8ce1e631a6dc45396756c4}{serif\+::solver\+::preconditioner\+::backend\+::mfem\+::try\+\_\+schur\+\_\+operator}} (\mbox{\hyperlink{namespaceserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem_a12e3dd6e5e7ac18ab2dba10956af8d59}{Operator\+Handle}} retained\+\_\+diagonal, \mbox{\hyperlink{structserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem_1_1_inverse}{Inverse}} eliminated, \mbox{\hyperlink{structserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem_1_1_two_block_couplings}{Two\+Block\+Couplings}} couplings)
\begin{DoxyCompactList}\small\item\em Form the retained Jacobian minus its response through a fixed linear eliminated inverse. \end{DoxyCompactList}\end{DoxyCompactItemize}