Files
MeanField_SERiF/docs/latex/strategies_2surface_2calibrated__mass_8hpp.tex
Emily Boudreaux 6b57738330 docs(docs): built docs
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)
2026-11-09 14:09:44 -05:00

56 lines
5.1 KiB
TeX

\doxysection{src/include/serif/solver/preconditioner/strategies/surface/calibrated\+\_\+mass.hpp File Reference}
\hypertarget{strategies_2surface_2calibrated__mass_8hpp}{}\label{strategies_2surface_2calibrated__mass_8hpp}\index{src/include/serif/solver/preconditioner/strategies/surface/calibrated\_mass.hpp@{src/include/serif/solver/preconditioner/strategies/surface/calibrated\_mass.hpp}}
{\ttfamily \#include $<$expected$>$}\newline
{\ttfamily \#include "{}serif/solver/preconditioner/failure.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/solver/preconditioner/strategies/inverse/diagonal\+\_\+regularization.\+hpp"{}}\newline
Include dependency graph for calibrated\+\_\+mass.\+hpp\+:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{strategies_2surface_2calibrated__mass_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]{strategies_2surface_2calibrated__mass_8hpp__dep__incl}
\end{center}
\end{figure}
\doxysubsubsection*{Classes}
\begin{DoxyCompactItemize}
\item
struct \mbox{\hyperlink{structserif_1_1solver_1_1preconditioner_1_1strategies_1_1surface_1_1_calibrated_surface_mass}{serif\+::solver\+::preconditioner\+::strategies\+::surface\+::\+Calibrated\+Surface\+Mass}}
\begin{DoxyCompactList}\small\item\em Calibrate a signed multiple of the native reference mass diagonal with bounded deterministic probes. \end{DoxyCompactList}\item
struct \mbox{\hyperlink{structserif_1_1solver_1_1preconditioner_1_1strategies_1_1surface_1_1_surface_mass_fit}{serif\+::solver\+::preconditioner\+::strategies\+::surface\+::\+Surface\+Mass\+Fit}}
\begin{DoxyCompactList}\small\item\em Retain the scalar least-\/squares evidence and the signed surrogate and inverse multipliers. \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_1strategies}{serif\+::solver\+::preconditioner\+::strategies}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1solver_1_1preconditioner_1_1strategies_1_1surface}{serif\+::solver\+::preconditioner\+::strategies\+::surface}}
\end{DoxyCompactItemize}
\doxysubsubsection*{Enumerations}
\begin{DoxyCompactItemize}
\item
enum class \mbox{\hyperlink{namespaceserif_1_1solver_1_1preconditioner_1_1strategies_1_1surface_acd82633fe41ab4bf710e20ee4a007a72}{serif\+::solver\+::preconditioner\+::strategies\+::surface\+::\+Calibration\+Target}} \{ \mbox{\hyperlink{namespaceserif_1_1solver_1_1preconditioner_1_1strategies_1_1surface_acd82633fe41ab4bf710e20ee4a007a72acab8fced5b7ce6e9d500e3a4a9acee24}{serif\+::solver\+::preconditioner\+::strategies\+::surface\+::surface\+\_\+jacobian}}
, \mbox{\hyperlink{namespaceserif_1_1solver_1_1preconditioner_1_1strategies_1_1surface_acd82633fe41ab4bf710e20ee4a007a72a1611bfbe231b3b22b787356dd5be35b6}{serif\+::solver\+::preconditioner\+::strategies\+::surface\+::material\+\_\+schur}}
\}
\begin{DoxyCompactList}\small\item\em Choose the physical shape response, with or without approximate material relaxation. \end{DoxyCompactList}\item
enum class \mbox{\hyperlink{namespaceserif_1_1solver_1_1preconditioner_1_1strategies_1_1surface_a5a1ecfdc4d0dd17d3e40c197ff2b73c6}{serif\+::solver\+::preconditioner\+::strategies\+::surface\+::\+Calibration\+Objective}} \{ \mbox{\hyperlink{namespaceserif_1_1solver_1_1preconditioner_1_1strategies_1_1surface_a5a1ecfdc4d0dd17d3e40c197ff2b73c6a55b711669591e3cb8e7075982eefd616}{serif\+::solver\+::preconditioner\+::strategies\+::surface\+::operator\+\_\+action}}
, \mbox{\hyperlink{namespaceserif_1_1solver_1_1preconditioner_1_1strategies_1_1surface_a5a1ecfdc4d0dd17d3e40c197ff2b73c6af0b88e4644862f60d9d038cb06160142}{serif\+::solver\+::preconditioner\+::strategies\+::surface\+::right\+\_\+preconditioned\+\_\+action}}
\}
\begin{DoxyCompactList}\small\item\em Fit the shape operator itself, or its action after applying the reference mass inverse. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsubsection*{Functions}
\begin{DoxyCompactItemize}
\item
std\+::expected$<$ \mbox{\hyperlink{structserif_1_1solver_1_1preconditioner_1_1strategies_1_1surface_1_1_surface_mass_fit}{Surface\+Mass\+Fit}}, \mbox{\hyperlink{structserif_1_1solver_1_1preconditioner_1_1_failure}{Failure}} $>$ \mbox{\hyperlink{namespaceserif_1_1solver_1_1preconditioner_1_1strategies_1_1surface_aab4d374bcad901242fb8aba2dc170a6e}{serif\+::solver\+::preconditioner\+::strategies\+::surface\+::try\+\_\+fit\+\_\+surface\+\_\+mass}} (double numerator, double denominator, \mbox{\hyperlink{namespaceserif_1_1solver_1_1preconditioner_1_1strategies_1_1surface_a5a1ecfdc4d0dd17d3e40c197ff2b73c6}{Calibration\+Objective}} objective)
\begin{DoxyCompactList}\small\item\em Solve either scalar calibration objective without discarding the physical sign. \end{DoxyCompactList}\end{DoxyCompactItemize}