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)
55 lines
5.7 KiB
TeX
55 lines
5.7 KiB
TeX
\doxysection{src/include/serif/solver/preconditioner/backend/mfem/surface/fitted\+\_\+h1.hpp File Reference}
|
|
\hypertarget{backend_2mfem_2surface_2fitted__h1_8hpp}{}\label{backend_2mfem_2surface_2fitted__h1_8hpp}\index{src/include/serif/solver/preconditioner/backend/mfem/surface/fitted\_h1.hpp@{src/include/serif/solver/preconditioner/backend/mfem/surface/fitted\_h1.hpp}}
|
|
{\ttfamily \#include $<$expected$>$}\newline
|
|
{\ttfamily \#include $<$memory$>$}\newline
|
|
{\ttfamily \#include "{}mfem/linalg/sparsemat.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/geometry/deformation/reference\+\_\+surface.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/geometry/deformation/surface\+\_\+embedding.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/solver/preconditioner/backend/mfem/surface/calibrated\+\_\+mass.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/solver/preconditioner/strategies/surface/fitted\+\_\+h1.\+hpp"{}}\newline
|
|
Include dependency graph for fitted\+\_\+h1.\+hpp\+:\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{backend_2mfem_2surface_2fitted__h1_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]{backend_2mfem_2surface_2fitted__h1_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_surface_h1_matrices}{serif\+::solver\+::preconditioner\+::backend\+::mfem\+::\+Surface\+H1\+Matrices}}
|
|
\begin{DoxyCompactList}\small\item\em Reference boundary mass and tangential stiffness in canonical nodal shape coordinates. \end{DoxyCompactList}\item
|
|
struct \mbox{\hyperlink{structserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem_1_1_fitted_surface_operator}{serif\+::solver\+::preconditioner\+::backend\+::mfem\+::\+Fitted\+Surface\+Operator}}
|
|
\begin{DoxyCompactList}\small\item\em A positive matrix for the chosen inverse backend, with a separately retained physical sign. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Namespaces}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespacemfem}{mfem}}
|
|
\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_surface_h1_matrices}{Surface\+H1\+Matrices}}, \mbox{\hyperlink{structserif_1_1solver_1_1preconditioner_1_1_failure}{Failure}} $>$ \mbox{\hyperlink{namespaceserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem_adf596feb1bd78da37cb5cbb63a2b3f3c}{serif\+::solver\+::preconditioner\+::backend\+::mfem\+::try\+\_\+surface\+\_\+h1\+\_\+matrices}} (const \+::mfem\+::\+Finite\+Element\+Space \&scalar\+\_\+space, int surface\+\_\+attribute, const \mbox{\hyperlink{structserif_1_1geometry_1_1deformation_1_1_reference_surface}{geometry\+::deformation\+::\+Reference\+Surface}} \&reference\+\_\+surface, const \mbox{\hyperlink{classserif_1_1geometry_1_1deformation_1_1_surface_embedding}{geometry\+::deformation\+::\+Surface\+Embedding}} \&embedding)
|
|
\begin{DoxyCompactList}\small\item\em Assemble the exact serial boundary M and K, restricted to existing nodal shape coordinates; harmonic coordinates require another strategy. \end{DoxyCompactList}\item
|
|
std\+::expected$<$ \mbox{\hyperlink{structserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem_1_1_fitted_surface_operator}{Fitted\+Surface\+Operator}}, \mbox{\hyperlink{structserif_1_1solver_1_1preconditioner_1_1_failure}{Failure}} $>$ \mbox{\hyperlink{namespaceserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem_a8b2f4b633fd9548da29fbb9484a4a9c1}{serif\+::solver\+::preconditioner\+::backend\+::mfem\+::try\+\_\+fitted\+\_\+surface\+\_\+h1}} (const \mbox{\hyperlink{structserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem_1_1_surface_h1_matrices}{Surface\+H1\+Matrices}} \&matrices, const \mbox{\hyperlink{structserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem_1_1_surface_targets}{Surface\+Targets}} \&targets, \mbox{\hyperlink{structserif_1_1solver_1_1preconditioner_1_1strategies_1_1surface_1_1_fitted_surface_h1}{strategies\+::surface\+::\+Fitted\+Surface\+H1}} options=\{\})
|
|
\begin{DoxyCompactList}\small\item\em Fit sign\texorpdfstring{$\ast$}{*}(alpha\texorpdfstring{$\ast$}{*}\+M+beta\texorpdfstring{$\ast$}{*}K) with alpha positive and beta nonnegative, using three to 64 deterministic probes. \end{DoxyCompactList}\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_a9a38e001ce74796b36faa6417cf3654e}{serif\+::solver\+::preconditioner\+::backend\+::mfem\+::try\+\_\+signed\+\_\+surface\+\_\+inverse}} (\mbox{\hyperlink{structserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem_1_1_inverse}{Inverse}} positive\+\_\+inverse, double sign)
|
|
\begin{DoxyCompactList}\small\item\em Apply the fitted physical sign outside a positive inverse backend, preserving its stationarity contract and zero initial guesses. \end{DoxyCompactList}\end{DoxyCompactItemize}
|