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)
44 lines
2.6 KiB
TeX
44 lines
2.6 KiB
TeX
\doxysection{src/include/serif/solver/preconditioner/recipes/bordered.hpp File Reference}
|
|
\hypertarget{bordered_8hpp}{}\label{bordered_8hpp}\index{src/include/serif/solver/preconditioner/recipes/bordered.hpp@{src/include/serif/solver/preconditioner/recipes/bordered.hpp}}
|
|
{\ttfamily \#include $<$utility$>$}\newline
|
|
{\ttfamily \#include "{}serif/solver/preconditioner/recipes/coupled.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/solver/preconditioner/strategies/inverse/dense.\+hpp"{}}\newline
|
|
Include dependency graph for bordered.\+hpp\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{bordered_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]{bordered_8hpp__dep__incl}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsubsection*{Classes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1solver_1_1preconditioner_1_1_constraint_coordinates}{serif\+::solver\+::preconditioner\+::\+Constraint\+Coordinates$<$ Rows\+T, Values\+T $>$}}
|
|
\begin{DoxyCompactList}\small\item\em Select arbitrary constraint rows and unknowns, including coupled generated scalars. \end{DoxyCompactList}\item
|
|
struct \mbox{\hyperlink{structserif_1_1solver_1_1preconditioner_1_1_bordered_preconditioner}{serif\+::solver\+::preconditioner\+::\+Bordered\+Preconditioner$<$ Fields, Constraints $>$}}
|
|
\begin{DoxyCompactList}\small\item\em Correct a physical field inverse through its dense constraint Schur system. \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 Constraints, typename Fields$>$ \newline
|
|
requires Disjoint\+Subsystems$<$Fields, Constraints$>$}\\auto \mbox{\hyperlink{namespaceserif_1_1solver_1_1preconditioner_a1443fd07473ce97765003d6730b32204}{serif\+::solver\+::preconditioner\+::with\+\_\+constraints}} (Fields fields, \mbox{\hyperlink{structserif_1_1solver_1_1preconditioner_1_1strategies_1_1inverse_1_1_dense_direct}{strategies\+::inverse\+::\+Dense\+Direct}} inverse=\{\})
|
|
\begin{DoxyCompactList}\small\item\em Attach constraints without a registry of built-\/in mass, rotation, or central-\/density providers. \end{DoxyCompactList}\end{DoxyCompactItemize}
|