58 lines
2.0 KiB
Groff
58 lines
2.0 KiB
Groff
|
|
.TH "src/include/serif/solver/nonlinear/newton.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
||
|
|
.ad l
|
||
|
|
.nh
|
||
|
|
.SH NAME
|
||
|
|
src/include/serif/solver/nonlinear/newton.hpp
|
||
|
|
.SH SYNOPSIS
|
||
|
|
.br
|
||
|
|
.PP
|
||
|
|
\fR#include 'serif/solver/nonlinear/observers\&.hpp'\fP
|
||
|
|
.br
|
||
|
|
\fR#include 'serif/solver/nonlinear/steps\&.hpp'\fP
|
||
|
|
.br
|
||
|
|
|
||
|
|
.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 "Concepts"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "concept \fBserif::solver::detail::NewtonStrategyFor\fP"
|
||
|
|
.br
|
||
|
|
.RI "A custom method must supply the exact correction contract; malformed overrides never select a fallback\&. "
|
||
|
|
.in -1c
|
||
|
|
.SS "Functions"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "template<typename Problem, typename State, typename Options, typename Observer> auto \fBserif::solver::detail::run_newton\fP (Problem &problem, State initial_state, Options options, Observer observer, std::optional< \fBNewtonProgress\fP > restart)"
|
||
|
|
.br
|
||
|
|
.RI "Find equilibrium while retaining the last fully qualified physical state\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "template<typename Problem, typename State, typename Options = SolverOptions<>, typename Observer = NoObserver>
|
||
|
|
.br
|
||
|
|
requires detail::NewtonStrategyFor<Problem, State, Options>auto \fBserif::solver::solve_newton\fP (Problem &problem, State initial_state, Options options={}, Observer observer={})"
|
||
|
|
.br
|
||
|
|
.RI "Solve a custom numerical problem using its native \fBVector\fP, evaluate, prepare and solve_linear operations\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "template<typename Problem, typename State, typename Options = SolverOptions<>, typename Observer = NoObserver>
|
||
|
|
.br
|
||
|
|
requires detail::NewtonStrategyFor<Problem, State, Options>auto \fBserif::solver::resume_newton\fP (Problem &problem, \fBNewtonCheckpoint\fP< State > checkpoint, Options options={}, Observer observer={})"
|
||
|
|
.br
|
||
|
|
.RI "Resume the original convergence reference, correction reuse, and cumulative work budget\&. "
|
||
|
|
.in -1c
|
||
|
|
.SH "Author"
|
||
|
|
.PP
|
||
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|