62 lines
1.7 KiB
Groff
62 lines
1.7 KiB
Groff
|
.TH "serif::solver::linear::Control" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
||
|
|
.ad l
|
||
|
|
.nh
|
||
|
|
.SH NAME
|
||
|
|
serif::solver::linear::Control \- Accuracy is measured against the current right-hand side, independently of the initial guess\&.
|
||
|
|
|
||
|
|
.SH SYNOPSIS
|
||
|
|
.br
|
||
|
|
.PP
|
||
|
|
.PP
|
||
|
|
\fR#include <linear\&.hpp>\fP
|
||
|
|
.SS "Public Member Functions"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "void \fBvalidate\fP () const"
|
||
|
|
.br
|
||
|
|
.RI "Reject invalid tolerances or iteration budgets before numerical work begins\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "double \fBconvergence_threshold\fP (double right_hand_side_norm) const"
|
||
|
|
.br
|
||
|
|
.RI "Return max(absolute tolerance, relative tolerance times the right-hand-side norm)\&. "
|
||
|
|
.in -1c
|
||
|
|
.SS "Public Attributes"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "double \fBrelative_tolerance\fP {1\&.0e\-8}"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "double \fBabsolute_tolerance\fP {0\&.0}"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "int \fBmaximum_iterations\fP {100}"
|
||
|
|
.br
|
||
|
|
.in -1c
|
||
|
|
.SH "Detailed Description"
|
||
|
|
.PP
|
||
|
|
Accuracy is measured against the current right-hand side, independently of the initial guess\&.
|
||
|
|
.SH "Member Function Documentation"
|
||
|
|
.PP
|
||
|
|
.SS "double serif::solver::linear::Control::convergence_threshold (double right_hand_side_norm) const\fR [nodiscard]\fP"
|
||
|
|
|
||
|
|
.PP
|
||
|
|
Return max(absolute tolerance, relative tolerance times the right-hand-side norm)\&.
|
||
|
|
.SS "void serif::solver::linear::Control::validate () const"
|
||
|
|
|
||
|
|
.PP
|
||
|
|
Reject invalid tolerances or iteration budgets before numerical work begins\&.
|
||
|
|
.SH "Member Data Documentation"
|
||
|
|
.PP
|
||
|
|
.SS "double serif::solver::linear::Control::absolute_tolerance {0\&.0}"
|
||
|
|
|
||
|
|
.SS "int serif::solver::linear::Control::maximum_iterations {100}"
|
||
|
|
|
||
|
|
.SS "double serif::solver::linear::Control::relative_tolerance {1\&.0e\-8}"
|
||
|
|
|
||
|
|
|
||
|
|
.SH "Author"
|
||
|
|
.PP
|
||
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|