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)
118 lines
3.0 KiB
Groff
118 lines
3.0 KiB
Groff
.TH "serif::solver::linear::Report" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::solver::linear::Report \- Bounded diagnostics from one solve, including an independently evaluated true residual\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
\fR#include <linear\&.hpp>\fP
|
|
.SS "Public Member Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "bool \fBconverged\fP () const noexcept"
|
|
.br
|
|
.RI "Whether the final correction satisfied the independently checked residual tolerance\&. "
|
|
.in -1c
|
|
.SS "Public Attributes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "\fBStatus\fP \fBstatus\fP {\fBStatus::backend_failure\fP}"
|
|
.br
|
|
.ti -1c
|
|
.RI "\fBControl\fP \fBcontrol\fP {}"
|
|
.br
|
|
.ti -1c
|
|
.RI "int \fBiterations\fP {0}"
|
|
.br
|
|
.ti -1c
|
|
.RI "int \fBrestarts\fP {0}"
|
|
.br
|
|
.ti -1c
|
|
.RI "double \fBright_hand_side_norm\fP {0\&.0}"
|
|
.br
|
|
.ti -1c
|
|
.RI "double \fBinitial_residual_norm\fP {0\&.0}"
|
|
.br
|
|
.ti -1c
|
|
.RI "double \fBreported_residual_norm\fP {0\&.0}"
|
|
.br
|
|
.ti -1c
|
|
.RI "double \fBtrue_residual_norm\fP {0\&.0}"
|
|
.br
|
|
.ti -1c
|
|
.RI "double \fBrelative_true_residual_norm\fP {0\&.0}"
|
|
.br
|
|
.ti -1c
|
|
.RI "std::uint64_t \fBoperator_applications\fP {0}"
|
|
.br
|
|
.ti -1c
|
|
.RI "std::uint64_t \fBpreconditioner_applications\fP {0}"
|
|
.br
|
|
.ti -1c
|
|
.RI "double \fBsolve_seconds\fP {0\&.0}"
|
|
.br
|
|
.ti -1c
|
|
.RI "double \fBoperator_seconds\fP {0\&.0}"
|
|
.br
|
|
.ti -1c
|
|
.RI "double \fBpreconditioner_seconds\fP {0\&.0}"
|
|
.br
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
Bounded diagnostics from one solve, including an independently evaluated true residual\&.
|
|
|
|
|
|
.PP
|
|
\fBNote\fP
|
|
.RS 4
|
|
Operator counts include warm-start safeguarding and final verification\&. Iterations count completed preconditioner applications; restarts count additional Krylov cycles entered\&.
|
|
.RE
|
|
.PP
|
|
|
|
.SH "Member Function Documentation"
|
|
.PP
|
|
.SS "bool serif::solver::linear::Report::converged () const\fR [inline]\fP, \fR [nodiscard]\fP, \fR [noexcept]\fP"
|
|
|
|
.PP
|
|
Whether the final correction satisfied the independently checked residual tolerance\&.
|
|
.SH "Member Data Documentation"
|
|
.PP
|
|
.SS "\fBControl\fP serif::solver::linear::Report::control {}"
|
|
|
|
.SS "double serif::solver::linear::Report::initial_residual_norm {0\&.0}"
|
|
|
|
.SS "int serif::solver::linear::Report::iterations {0}"
|
|
|
|
.SS "std::uint64_t serif::solver::linear::Report::operator_applications {0}"
|
|
|
|
.SS "double serif::solver::linear::Report::operator_seconds {0\&.0}"
|
|
|
|
.SS "std::uint64_t serif::solver::linear::Report::preconditioner_applications {0}"
|
|
|
|
.SS "double serif::solver::linear::Report::preconditioner_seconds {0\&.0}"
|
|
|
|
.SS "double serif::solver::linear::Report::relative_true_residual_norm {0\&.0}"
|
|
|
|
.SS "double serif::solver::linear::Report::reported_residual_norm {0\&.0}"
|
|
|
|
.SS "int serif::solver::linear::Report::restarts {0}"
|
|
|
|
.SS "double serif::solver::linear::Report::right_hand_side_norm {0\&.0}"
|
|
|
|
.SS "double serif::solver::linear::Report::solve_seconds {0\&.0}"
|
|
|
|
.SS "\fBStatus\fP serif::solver::linear::Report::status {\fBStatus::backend_failure\fP}"
|
|
|
|
.SS "double serif::solver::linear::Report::true_residual_norm {0\&.0}"
|
|
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|