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)
81 lines
2.2 KiB
Groff
81 lines
2.2 KiB
Groff
.TH "src/include/serif/solver/nonlinear/options.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
src/include/serif/solver/nonlinear/options.hpp
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
\fR#include <cmath>\fP
|
|
.br
|
|
\fR#include <span>\fP
|
|
.br
|
|
\fR#include <optional>\fP
|
|
.br
|
|
\fR#include <string>\fP
|
|
.br
|
|
\fR#include <tuple>\fP
|
|
.br
|
|
\fR#include <utility>\fP
|
|
.br
|
|
\fR#include 'serif/solver/linear/linear\&.hpp'\fP
|
|
.br
|
|
|
|
.SS "Classes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "struct \fBserif::solver::Newton\fP"
|
|
.br
|
|
.RI "Accuracy and work limits for finding one equilibrium star\&. "
|
|
.ti -1c
|
|
.RI "struct \fBserif::solver::Backtracking\fP"
|
|
.br
|
|
.RI "Shorten a \fBNewton\fP step until the complete residual merit decreases sufficiently\&. "
|
|
.ti -1c
|
|
.RI "struct \fBserif::solver::MetricEvaluation\fP"
|
|
.br
|
|
.RI "Separate the convergence norm from the line-search merit for custom metrics\&. "
|
|
.ti -1c
|
|
.RI "struct \fBserif::solver::NormalizedResidualMetric\fP"
|
|
.br
|
|
.RI "Use the Euclidean norm of SERiF's normalized residual and half its square\&. "
|
|
.ti -1c
|
|
.RI "struct \fBserif::solver::DirectionAssessment\fP"
|
|
.br
|
|
.RI "A modified direction must report whether it is usable and any measured merit slope\&. "
|
|
.ti -1c
|
|
.RI "struct \fBserif::solver::TrialAssessment\fP"
|
|
.br
|
|
.RI "A numerical policy explicitly accepts its work or explains why this candidate must be rejected\&. "
|
|
.ti -1c
|
|
.RI "struct \fBserif::solver::StandardNewton\fP"
|
|
.br
|
|
.RI "Ordinary \fBNewton\fP supplies every strategy phase; custom policies may replace individual phases explicitly\&. "
|
|
.ti -1c
|
|
.RI "struct \fBserif::solver::SolverOptions< Metric, Strategies, LinearSolver >\fP"
|
|
.br
|
|
.RI "Select numerical policies while keeping equilibrium physics in the model\&. "
|
|
.in -1c
|
|
.SS "Namespaces"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "namespace \fBserif\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::solver\fP"
|
|
.br
|
|
.in -1c
|
|
.SS "Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "double \fBserif::solver::next_backtracking_step\fP (double rejected_step, double accepted_determinant, double rejected_determinant, bool inverted, const \fBBacktracking\fP &options) noexcept"
|
|
.br
|
|
.RI "Skip only existing backtracking rungs when an inverted trial gives a finite boundary estimate\&. "
|
|
.in -1c
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|