Files
MeanField_SERiF/docs/man/man3/serif_solver_Newton.3

67 lines
1.8 KiB
Groff
Raw Normal View History

.TH "serif::solver::Newton" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::solver::Newton \- Accuracy and work limits for finding one equilibrium star\&.
.SH SYNOPSIS
.br
.PP
.PP
\fR#include <options\&.hpp>\fP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "void \fBvalidate\fP () const"
.br
.RI "Check tolerances and budgets before evaluating any candidate\&. "
.ti -1c
.RI "double \fBconvergence_threshold\fP (double initial_norm) const"
.br
.RI "Freeze the convergence threshold from this solve's initial residual\&. "
.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 {50}"
.br
.ti -1c
.RI "\fBlinear::Control\fP \fBlinear_solve\fP {\&.\fBrelative_tolerance\fP = 0\&.03, \&.\fBmaximum_iterations\fP = 200}"
.br
.in -1c
.SH "Detailed Description"
.PP
Accuracy and work limits for finding one equilibrium star\&.
.SH "Member Function Documentation"
.PP
.SS "double serif::solver::Newton::convergence_threshold (double initial_norm) const\fR [nodiscard]\fP"
.PP
Freeze the convergence threshold from this solve's initial residual\&.
.SS "void serif::solver::Newton::validate () const"
.PP
Check tolerances and budgets before evaluating any candidate\&.
.SH "Member Data Documentation"
.PP
.SS "double serif::solver::Newton::absolute_tolerance {0\&.0}"
.SS "\fBlinear::Control\fP serif::solver::Newton::linear_solve {\&.\fBrelative_tolerance\fP = 0\&.03, \&.\fBmaximum_iterations\fP = 200}"
.SS "int serif::solver::Newton::maximum_iterations {50}"
.SS "double serif::solver::Newton::relative_tolerance {1\&.0e\-8}"
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.