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)
33 lines
1003 B
Groff
33 lines
1003 B
Groff
.TH "serif::solver::NormalizedResidualMetric" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::solver::NormalizedResidualMetric \- Use the Euclidean norm of SERiF's normalized residual and half its square\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
\fR#include <options\&.hpp>\fP
|
|
.SS "Public Member Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "\fBMetricEvaluation\fP \fBoperator()\fP (std::span< const double > residual) const"
|
|
.br
|
|
.RI "Evaluate serial solver coordinates without interpreting individual physical fields\&. "
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
Use the Euclidean norm of SERiF's normalized residual and half its square\&.
|
|
.SH "Member Function Documentation"
|
|
.PP
|
|
.SS "\fBMetricEvaluation\fP serif::solver::NormalizedResidualMetric::operator() (std::span< const double > residual) const\fR [nodiscard]\fP"
|
|
|
|
.PP
|
|
Evaluate serial solver coordinates without interpreting individual physical fields\&.
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|