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)
43 lines
2.9 KiB
TeX
43 lines
2.9 KiB
TeX
\doxysection{src/include/serif/backend/mfem/solver/preconditioner/computations/coupling.hpp File Reference}
|
|
\hypertarget{computations_2coupling_8hpp}{}\label{computations_2coupling_8hpp}\index{src/include/serif/backend/mfem/solver/preconditioner/computations/coupling.hpp@{src/include/serif/backend/mfem/solver/preconditioner/computations/coupling.hpp}}
|
|
{\ttfamily \#include "{}serif/backend/mfem/operators/linearized\+\_\+block.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/solver/preconditioner/recipes/coupled.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/solver/preconditioner/recipes/bordered.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/backend/mfem/solver/preconditioner/coupling.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/backend/mfem/solver/preconditioner/border.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/utils/dependencies/computation.\+hpp"{}}\newline
|
|
Include dependency graph for coupling.\+hpp\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{computations_2coupling_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[height=550pt]{computations_2coupling_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 First, typename Second, typename Policy$>$ }\\auto \mbox{\hyperlink{namespaceserif_1_1solver_1_1preconditioner_1_1computations_a2bdc826b6c7ccfe49e6b6316122d54e6}{serif\+::solver\+::preconditioner\+::computations\+::coupling}} (const \mbox{\hyperlink{structserif_1_1solver_1_1preconditioner_1_1_coupled_preconditioner}{Coupled\+Preconditioner}}$<$ First, Second, Policy $>$ \&)
|
|
\begin{DoxyCompactList}\small\item\em Couple child results through the authoritative physical cross blocks. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$typename Fields, typename Constraints$>$ }\\auto \mbox{\hyperlink{namespaceserif_1_1solver_1_1preconditioner_1_1computations_adc3abbb22230697135559b869b080182}{serif\+::solver\+::preconditioner\+::computations\+::border}} (const \mbox{\hyperlink{structserif_1_1solver_1_1preconditioner_1_1_bordered_preconditioner}{Bordered\+Preconditioner}}$<$ Fields, Constraints $>$ \&choice)
|
|
\begin{DoxyCompactList}\small\item\em Rebuild the constraint Schur system whenever either its physical couplings or its child inverse change. \end{DoxyCompactList}\end{DoxyCompactItemize}
|