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)
66 lines
2.9 KiB
Groff
66 lines
2.9 KiB
Groff
.TH "src/include/serif/solver/nonlinear/steps.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
src/include/serif/solver/nonlinear/steps.hpp
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
\fR#include <limits>\fP
|
|
.br
|
|
\fR#include 'serif/solver/nonlinear/qualification\&.hpp'\fP
|
|
.br
|
|
|
|
.SS "Classes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "struct \fBserif::solver::detail::InitialEvaluation< System >\fP"
|
|
.br
|
|
.RI "Keep a freshly qualified metric beside the exact system from which it was measured\&. "
|
|
.ti -1c
|
|
.RI "struct \fBserif::solver::detail::QualifiedStep< State, System, Prepared >\fP"
|
|
.br
|
|
.RI "Own a qualified trial; a terminal root deliberately has no prepared inverse\&. "
|
|
.in -1c
|
|
.SS "Namespaces"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "namespace \fBserif\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::solver\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::solver::detail\fP"
|
|
.br
|
|
.in -1c
|
|
.SS "Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "void \fBserif::solver::detail::validate_start\fP (const auto &options, const std::optional< \fBNewtonProgress\fP > &restart, std::size_t size)"
|
|
.br
|
|
.RI "Validate controls and restored history before any physical preparation\&. "
|
|
.ti -1c
|
|
.RI "template<typename Problem> std::expected< \fBInitialEvaluation\fP< typename Problem::System >, \fBNewtonFailure\fP > \fBserif::solver::detail::evaluate_start\fP (Problem &problem, auto &state, auto &options, const std::optional< \fBNewtonProgress\fP > &restart, \fBSolveDiagnostics\fP &diagnostics)"
|
|
.br
|
|
.RI "Qualify the initial state and verify a restart against its original convergence reference\&. "
|
|
.ti -1c
|
|
.RI "std::expected< \fBDirectionAssessment\fP, \fBNewtonFailure\fP > \fBserif::solver::detail::compute_direction\fP (auto &problem, const auto &\fBaccepted\fP, const auto &prepared, auto &options, \fBSolveDiagnostics\fP &diagnostics, auto &rhs, auto &correction, std::span< double > physical_direction)"
|
|
.br
|
|
.RI "Solve and qualify a normalized correction before exposing its physical direction to backtracking\&. "
|
|
.ti -1c
|
|
.RI "template<typename Problem, typename State, typename System, typename Model> auto \fBserif::solver::detail::find_acceptable_step\fP (Problem &problem, const \fBSolveResult\fP< State, System, Model > &\fBaccepted\fP, \fBMetricEvaluation\fP accepted_metric, const auto &correction, std::span< const double > physical_direction, const \fBDirectionAssessment\fP &direction, double step, auto &options, \fBSolveDiagnostics\fP &diagnostics, auto &observation)"
|
|
.br
|
|
.RI "Find a safe, sufficiently decreasing candidate without changing the accepted state\&. "
|
|
.ti -1c
|
|
.RI "void \fBserif::solver::detail::save_progress\fP (auto &result, auto &options, \fBSolveDiagnostics\fP &diagnostics, \fBMetricEvaluation\fP metric, std::span< const double > correction, double next_step)"
|
|
.br
|
|
.RI "Snapshot only fully committed numerical history; reporting has no influence on restart\&. "
|
|
.in -1c
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|