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)
54 lines
1.3 KiB
Groff
54 lines
1.3 KiB
Groff
.TH "serif::solver::NewtonProgress" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::solver::NewtonProgress \- Numerical continuation data at one accepted \fBNewton\fP boundary\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
\fR#include <result\&.hpp>\fP
|
|
.SS "Public Attributes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "\fBMetricEvaluation\fP \fBaccepted_metric\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "std::vector< double > \fBcorrection\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "double \fBnext_step\fP {1\&.0}"
|
|
.br
|
|
.ti -1c
|
|
.RI "\fBSolveDiagnostics\fP \fBdiagnostics\fP"
|
|
.br
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
Numerical continuation data at one accepted \fBNewton\fP boundary\&.
|
|
|
|
|
|
.PP
|
|
\fBNote\fP
|
|
.RS 4
|
|
Correction values are normalized solver coordinates\&. Reuse the same physical problem, normalization, metric and numerical options on restart; the total iteration budget may increase\&. Runtime operators and caches are rebuilt, never stored here\&.
|
|
.RE
|
|
.PP
|
|
|
|
.SH "Member Data Documentation"
|
|
.PP
|
|
.SS "\fBMetricEvaluation\fP serif::solver::NewtonProgress::accepted_metric"
|
|
|
|
.SS "std::vector<double> serif::solver::NewtonProgress::correction"
|
|
|
|
.SS "\fBSolveDiagnostics\fP serif::solver::NewtonProgress::diagnostics"
|
|
|
|
.SS "double serif::solver::NewtonProgress::next_step {1\&.0}"
|
|
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|