Files
MeanField_SERiF/docs/latex/namespaceserif_1_1utils_1_1checks.tex

59 lines
4.5 KiB
TeX
Raw Normal View History

\doxysection{serif\+::utils\+::checks Namespace Reference}
\hypertarget{namespaceserif_1_1utils_1_1checks}{}\label{namespaceserif_1_1utils_1_1checks}\index{serif::utils::checks@{serif::utils::checks}}
\doxysubsubsection*{Functions}
\begin{DoxyCompactItemize}
\item
bool \mbox{\hyperlink{namespaceserif_1_1utils_1_1checks_a4eb8e1d2bdd4bdae0242814f9018537e}{is\+\_\+finite}} (const mfem\+::\+Vector \&vector)
\begin{DoxyCompactList}\small\item\em Check every MFEM coefficient before publishing a numerical result. \end{DoxyCompactList}\item
bool \mbox{\hyperlink{namespaceserif_1_1utils_1_1checks_a573108a049c9d39dbb13558314c828ff}{is\+\_\+finite}} (const mfem\+::\+Dense\+Matrix \&matrix)
\begin{DoxyCompactList}\small\item\em Check all entries of a small MFEM dense matrix. \end{DoxyCompactList}\item
bool \mbox{\hyperlink{namespaceserif_1_1utils_1_1checks_a3471cc276b4a977cff023828197af29e}{has\+\_\+stable\+\_\+inverse}} (const \+::mfem\+::\+Dense\+Matrix \&matrix)
\begin{DoxyCompactList}\small\item\em Check a one-\/ to three-\/dimensional square Jacobian before asking MFEM to invert it. \end{DoxyCompactList}\item
{\footnotesize template$<$typename Scalar$>$ \newline
requires requires (Scalar x) \{\{std\+::isfinite(x)\} -\/$>$ std\+::convertible\+\_\+to$<$bool$>$; \}}\\bool \mbox{\hyperlink{namespaceserif_1_1utils_1_1checks_abf004f539355f7039efe011d0b1780ef}{is\+\_\+finite}} (const Scalar scalar)
\end{DoxyCompactItemize}
\doxysubsection{Function Documentation}
\Hypertarget{namespaceserif_1_1utils_1_1checks_a3471cc276b4a977cff023828197af29e}\index{serif::utils::checks@{serif::utils::checks}!has\_stable\_inverse@{has\_stable\_inverse}}
\index{has\_stable\_inverse@{has\_stable\_inverse}!serif::utils::checks@{serif::utils::checks}}
\doxysubsubsection{\texorpdfstring{has\_stable\_inverse()}{has\_stable\_inverse()}}
{\footnotesize\ttfamily \label{namespaceserif_1_1utils_1_1checks_a3471cc276b4a977cff023828197af29e}
bool serif\+::utils\+::checks\+::has\+\_\+stable\+\_\+inverse (\begin{DoxyParamCaption}\item[{const \+::mfem\+::\+Dense\+Matrix \&}]{matrix}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [nodiscard]}}
Check a one-\/ to three-\/dimensional square Jacobian before asking MFEM to invert it.
\begin{DoxyNote}{Note}
Use MFEM\textquotesingle{}s scale-\/relative singularity criterion in all build modes, so invalid geometry can be reported as a value instead of triggering its debug assertion. Uniform coordinate scaling is permitted.
\end{DoxyNote}
\Hypertarget{namespaceserif_1_1utils_1_1checks_a573108a049c9d39dbb13558314c828ff}\index{serif::utils::checks@{serif::utils::checks}!is\_finite@{is\_finite}}
\index{is\_finite@{is\_finite}!serif::utils::checks@{serif::utils::checks}}
\doxysubsubsection{\texorpdfstring{is\_finite()}{is\_finite()}\hspace{0.1cm}{\footnotesize\ttfamily [1/3]}}
{\footnotesize\ttfamily \label{namespaceserif_1_1utils_1_1checks_a573108a049c9d39dbb13558314c828ff}
bool serif\+::utils\+::checks\+::is\+\_\+finite (\begin{DoxyParamCaption}\item[{const mfem\+::\+Dense\+Matrix \&}]{matrix}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
Check all entries of a small MFEM dense matrix.
\Hypertarget{namespaceserif_1_1utils_1_1checks_a4eb8e1d2bdd4bdae0242814f9018537e}\index{serif::utils::checks@{serif::utils::checks}!is\_finite@{is\_finite}}
\index{is\_finite@{is\_finite}!serif::utils::checks@{serif::utils::checks}}
\doxysubsubsection{\texorpdfstring{is\_finite()}{is\_finite()}\hspace{0.1cm}{\footnotesize\ttfamily [2/3]}}
{\footnotesize\ttfamily \label{namespaceserif_1_1utils_1_1checks_a4eb8e1d2bdd4bdae0242814f9018537e}
bool serif\+::utils\+::checks\+::is\+\_\+finite (\begin{DoxyParamCaption}\item[{const mfem\+::\+Vector \&}]{vector}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
Check every MFEM coefficient before publishing a numerical result.
\Hypertarget{namespaceserif_1_1utils_1_1checks_abf004f539355f7039efe011d0b1780ef}\index{serif::utils::checks@{serif::utils::checks}!is\_finite@{is\_finite}}
\index{is\_finite@{is\_finite}!serif::utils::checks@{serif::utils::checks}}
\doxysubsubsection{\texorpdfstring{is\_finite()}{is\_finite()}\hspace{0.1cm}{\footnotesize\ttfamily [3/3]}}
{\footnotesize\ttfamily \label{namespaceserif_1_1utils_1_1checks_abf004f539355f7039efe011d0b1780ef}
template$<$typename Scalar$>$ \newline
requires requires (Scalar x) \{\{std\+::isfinite(x)\} -\/$>$ std\+::convertible\+\_\+to$<$bool$>$; \}\\
bool serif\+::utils\+::checks\+::is\+\_\+finite (\begin{DoxyParamCaption}\item[{const Scalar}]{scalar}{}\end{DoxyParamCaption})}