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)
47 lines
2.6 KiB
TeX
47 lines
2.6 KiB
TeX
\doxysection{src/include/serif/solver/preconditioner/recipes/coupled.hpp File Reference}
|
|
\hypertarget{coupled_8hpp}{}\label{coupled_8hpp}\index{src/include/serif/solver/preconditioner/recipes/coupled.hpp@{src/include/serif/solver/preconditioner/recipes/coupled.hpp}}
|
|
{\ttfamily \#include $<$utility$>$}\newline
|
|
{\ttfamily \#include "{}serif/solver/preconditioner/keys.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/solver/preconditioner/strategies/coupling/policies.\+hpp"{}}\newline
|
|
Include dependency graph for coupled.\+hpp\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{coupled_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]{coupled_8hpp__dep__incl}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsubsection*{Classes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1solver_1_1preconditioner_1_1_coupled_preconditioner}{serif\+::solver\+::preconditioner\+::\+Coupled\+Preconditioner$<$ First, Second, Policy $>$}}
|
|
\begin{DoxyCompactList}\small\item\em Compose physical subsystem descriptions without creating an additional preparation owner. \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*{Concepts}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
concept \mbox{\hyperlink{conceptserif_1_1solver_1_1preconditioner_1_1_disjoint_subsystems}{serif\+::solver\+::preconditioner\+::\+Disjoint\+Subsystems}}
|
|
\begin{DoxyCompactList}\small\item\em Require disjoint ownership on both sides rather than silently deduplicating physical coordinates. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
{\footnotesize template$<$typename First, typename Second, typename Policy$>$ \newline
|
|
requires Disjoint\+Subsystems$<$First, Second$>$}\\auto \mbox{\hyperlink{namespaceserif_1_1solver_1_1preconditioner_a4083a10bc61fd512d53a3c1523ae2f95}{serif\+::solver\+::preconditioner\+::couple}} (First first, Second second, Policy coupling)
|
|
\begin{DoxyCompactList}\small\item\em Choose the physical subsystem ordering explicitly; the same algebra serves material/surface and material/gravity. \end{DoxyCompactList}\end{DoxyCompactItemize}
|