Files
MeanField_SERiF/docs/latex/calibration_8cpp.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

39 lines
3.6 KiB
TeX

\doxysection{src/lib/serif/solver/preconditioner/backend/mfem/surface/calibration.cpp File Reference}
\hypertarget{calibration_8cpp}{}\label{calibration_8cpp}\index{src/lib/serif/solver/preconditioner/backend/mfem/surface/calibration.cpp@{src/lib/serif/solver/preconditioner/backend/mfem/surface/calibration.cpp}}
{\ttfamily \#include "{}serif/solver/preconditioner/backend/mfem/surface/detail/calibration.\+hpp"{}}\newline
{\ttfamily \#include $<$algorithm$>$}\newline
{\ttfamily \#include $<$cmath$>$}\newline
{\ttfamily \#include $<$cstdint$>$}\newline
{\ttfamily \#include $<$limits$>$}\newline
Include dependency graph for calibration.\+cpp\+:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{calibration_8cpp__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_1backend}{serif\+::solver\+::preconditioner\+::backend}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem}{serif\+::solver\+::preconditioner\+::backend\+::mfem}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem_1_1detail}{serif\+::solver\+::preconditioner\+::backend\+::mfem\+::detail}}
\end{DoxyCompactItemize}
\doxysubsubsection*{Functions}
\begin{DoxyCompactItemize}
\item
std\+::expected$<$ \mbox{\hyperlink{namespaceserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem_a12e3dd6e5e7ac18ab2dba10956af8d59}{Operator\+Handle}}, \mbox{\hyperlink{structserif_1_1solver_1_1preconditioner_1_1_failure}{Failure}} $>$ \mbox{\hyperlink{namespaceserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem_1_1detail_a36074194e5b09d02a990cf63bd42b91f}{serif\+::solver\+::preconditioner\+::backend\+::mfem\+::detail\+::surface\+\_\+target}} (const \mbox{\hyperlink{structserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem_1_1_surface_targets}{Surface\+Targets}} \&targets, \mbox{\hyperlink{namespaceserif_1_1solver_1_1preconditioner_1_1strategies_1_1surface_acd82633fe41ab4bf710e20ee4a007a72}{strategies\+::surface\+::\+Calibration\+Target}} target, int size)
\begin{DoxyCompactList}\small\item\em Require the selected accepted physical action in the native shape coordinate layout. \end{DoxyCompactList}\item
std\+::expected$<$ void, \mbox{\hyperlink{structserif_1_1solver_1_1preconditioner_1_1_failure}{Failure}} $>$ \mbox{\hyperlink{namespaceserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem_1_1detail_a22124f4d33fc43b754f0eaf82aba5039}{serif\+::solver\+::preconditioner\+::backend\+::mfem\+::detail\+::validate\+\_\+surface\+\_\+metric}} (std\+::span$<$ const double $>$ metric)
\begin{DoxyCompactList}\small\item\em Validate a positive native metric before using it as either a mass action or an inverse. \end{DoxyCompactList}\item
std\+::expected$<$ void, \mbox{\hyperlink{structserif_1_1solver_1_1preconditioner_1_1_failure}{Failure}} $>$ \mbox{\hyperlink{namespaceserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem_1_1detail_adc72568604f32e576bd683d4f78dbe8f}{serif\+::solver\+::preconditioner\+::backend\+::mfem\+::detail\+::fill\+\_\+surface\+\_\+probe}} (int sample, \+::mfem\+::\+Vector \&probe, bool include\+\_\+smooth\+\_\+modes)
\begin{DoxyCompactList}\small\item\em Deterministic native-\/coordinate probes, with smooth modes and unit norm for the two-\/term H1 fit. \end{DoxyCompactList}\end{DoxyCompactItemize}