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)
58 lines
1.8 KiB
Groff
58 lines
1.8 KiB
Groff
.TH "serif::utils::checks" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::utils::checks
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.SS "Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "bool \fBis_finite\fP (const mfem::Vector &vector)"
|
|
.br
|
|
.RI "Check every MFEM coefficient before publishing a numerical result\&. "
|
|
.ti -1c
|
|
.RI "bool \fBis_finite\fP (const mfem::DenseMatrix &matrix)"
|
|
.br
|
|
.RI "Check all entries of a small MFEM dense matrix\&. "
|
|
.ti -1c
|
|
.RI "bool \fBhas_stable_inverse\fP (const ::mfem::DenseMatrix &matrix)"
|
|
.br
|
|
.RI "Check a one- to three-dimensional square Jacobian before asking MFEM to invert it\&. "
|
|
.ti -1c
|
|
.RI "template<typename Scalar>
|
|
.br
|
|
requires requires (Scalar x) {{std::isfinite(x)} \-> std::convertible_to<bool>; }bool \fBis_finite\fP (const Scalar scalar)"
|
|
.br
|
|
.in -1c
|
|
.SH "Function Documentation"
|
|
.PP
|
|
.SS "bool serif::utils::checks::has_stable_inverse (const ::mfem::DenseMatrix & matrix)\fR [inline]\fP, \fR [nodiscard]\fP"
|
|
|
|
.PP
|
|
Check a one- to three-dimensional square Jacobian before asking MFEM to invert it\&.
|
|
.PP
|
|
\fBNote\fP
|
|
.RS 4
|
|
Use MFEM'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\&.
|
|
.RE
|
|
.PP
|
|
|
|
.SS "bool serif::utils::checks::is_finite (const mfem::DenseMatrix & matrix)\fR [inline]\fP"
|
|
|
|
.PP
|
|
Check all entries of a small MFEM dense matrix\&.
|
|
.SS "bool serif::utils::checks::is_finite (const mfem::Vector & vector)\fR [inline]\fP"
|
|
|
|
.PP
|
|
Check every MFEM coefficient before publishing a numerical result\&.
|
|
.SS "template<typename Scalar>
|
|
.br
|
|
requires requires (Scalar x) {{std::isfinite(x)} \-> std::convertible_to<bool>; }bool serif::utils::checks::is_finite (const Scalar scalar)"
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|