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)
192 lines
9.0 KiB
Groff
192 lines
9.0 KiB
Groff
.TH "serif::solver::SolveResult< State, System, Model >" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::solver::SolveResult< State, System, Model > \- Own the last accepted physical state, matching frozen system, and descriptive model\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
\fR#include <result\&.hpp>\fP
|
|
.SS "Public Member Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "\fBSolveResult\fP (std::shared_ptr< const Model > \fBmodel\fP={})"
|
|
.br
|
|
.RI "Retain the physical definition before any numerical attempt is made\&. "
|
|
.ti -1c
|
|
.RI "bool \fBconverged\fP () const noexcept"
|
|
.br
|
|
.RI "True only after the complete nonlinear convergence test succeeds\&. "
|
|
.ti -1c
|
|
.RI "bool \fBhas_state\fP () const noexcept"
|
|
.br
|
|
.RI "Distinguish a usable accepted checkpoint from a rejected initial guess\&. "
|
|
.ti -1c
|
|
.RI "const State & \fBstate\fP () const"
|
|
.br
|
|
.RI "Read the last accepted physical coefficients; reject access when none were evaluated\&. "
|
|
.ti -1c
|
|
.RI "const std::shared_ptr< const System > & \fBsystem\fP () const noexcept"
|
|
.br
|
|
.RI "Retain or inspect the exact residual and Jacobian belonging to \fBstate()\fP\&. "
|
|
.ti -1c
|
|
.RI "const Model & \fBmodel\fP () const"
|
|
.br
|
|
.RI "Read the physical definition owned by a stellar result\&. "
|
|
.ti -1c
|
|
.RI "const \fBSolveDiagnostics\fP & \fBdiagnostics\fP () const noexcept"
|
|
.br
|
|
.RI "Inspect work counts and final convergence measurements\&. "
|
|
.ti -1c
|
|
.RI "\fBSolveStatus\fP \fBstatus\fP () const noexcept"
|
|
.br
|
|
.RI "Inspect the numerical reason for termination\&. "
|
|
.ti -1c
|
|
.RI "const std::string & \fBmessage\fP () const noexcept"
|
|
.br
|
|
.RI "Read the diagnostic associated with numerical termination\&. "
|
|
.ti -1c
|
|
.RI "bool \fBhas_checkpoint\fP () const noexcept"
|
|
.br
|
|
.RI "Whether this accepted boundary has supported, complete numerical restart data\&. "
|
|
.ti -1c
|
|
.RI "\fBNewtonCheckpoint\fP< State > \fBcheckpoint\fP () const"
|
|
.br
|
|
.RI "Copy a portable accepted boundary without retaining runtime operators or caches\&. "
|
|
.ti -1c
|
|
.RI "void \fBcheckpoint\fP (\fBNewtonProgress\fP progress)"
|
|
.br
|
|
.RI "Record history only after all accepted-step correction and step-length updates are complete\&. "
|
|
.ti -1c
|
|
.RI "void \fBaccept\fP (State \fBstate\fP, std::shared_ptr< const System > \fBsystem\fP)"
|
|
.br
|
|
.RI "Publish a complete state/system pair only after candidate preparation succeeds\&. "
|
|
.ti -1c
|
|
.RI "void \fBfinish\fP (\fBSolveStatus\fP \fBstatus\fP, std::string \fBmessage\fP, \fBSolveDiagnostics\fP \fBdiagnostics\fP)"
|
|
.br
|
|
.RI "Finalize bounded diagnostics without altering the accepted checkpoint\&. "
|
|
.in -1c
|
|
.SS "Private Attributes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "std::shared_ptr< const Model > \fBm_model\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "std::optional< State > \fBm_state\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "std::shared_ptr< const System > \fBm_system\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "std::optional< \fBNewtonProgress\fP > \fBm_progress\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "\fBSolveStatus\fP \fBm_status\fP {\fBSolveStatus::initial_state_rejected\fP}"
|
|
.br
|
|
.ti -1c
|
|
.RI "std::string \fBm_message\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "\fBSolveDiagnostics\fP \fBm_diagnostics\fP"
|
|
.br
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
|
|
.SS "template<typename State, typename System, typename Model = NoModel>
|
|
.br
|
|
class serif::solver::SolveResult< State, System, Model >"Own the last accepted physical state, matching frozen system, and descriptive model\&.
|
|
|
|
|
|
.PP
|
|
\fBNote\fP
|
|
.RS 4
|
|
A failed initial evaluation has no accepted state\&. A later failure retains the last accepted star, which remains usable after the solver and its dependency cache are destroyed\&.
|
|
.RE
|
|
.PP
|
|
|
|
.SH "Constructor & Destructor Documentation"
|
|
.PP
|
|
.SS "template<typename State, typename System, typename Model = NoModel> \fBserif::solver::SolveResult\fP< State, System, Model >::SolveResult (std::shared_ptr< const Model > model = \fR{}\fP)\fR [inline]\fP, \fR [explicit]\fP"
|
|
|
|
.PP
|
|
Retain the physical definition before any numerical attempt is made\&.
|
|
.SH "Member Function Documentation"
|
|
.PP
|
|
.SS "template<typename State, typename System, typename Model = NoModel> void \fBserif::solver::SolveResult\fP< State, System, Model >::accept (State state, std::shared_ptr< const System > system)\fR [inline]\fP"
|
|
|
|
.PP
|
|
Publish a complete state/system pair only after candidate preparation succeeds\&.
|
|
.SS "template<typename State, typename System, typename Model = NoModel> \fBNewtonCheckpoint\fP< State > \fBserif::solver::SolveResult\fP< State, System, Model >::checkpoint () const\fR [inline]\fP, \fR [nodiscard]\fP"
|
|
|
|
.PP
|
|
Copy a portable accepted boundary without retaining runtime operators or caches\&.
|
|
.SS "template<typename State, typename System, typename Model = NoModel> void \fBserif::solver::SolveResult\fP< State, System, Model >::checkpoint (\fBNewtonProgress\fP progress)\fR [inline]\fP"
|
|
|
|
.PP
|
|
Record history only after all accepted-step correction and step-length updates are complete\&.
|
|
.SS "template<typename State, typename System, typename Model = NoModel> bool \fBserif::solver::SolveResult\fP< State, System, Model >::converged () const\fR [inline]\fP, \fR [nodiscard]\fP, \fR [noexcept]\fP"
|
|
|
|
.PP
|
|
True only after the complete nonlinear convergence test succeeds\&.
|
|
.SS "template<typename State, typename System, typename Model = NoModel> const \fBSolveDiagnostics\fP & \fBserif::solver::SolveResult\fP< State, System, Model >::diagnostics () const\fR [inline]\fP, \fR [nodiscard]\fP, \fR [noexcept]\fP"
|
|
|
|
.PP
|
|
Inspect work counts and final convergence measurements\&.
|
|
.SS "template<typename State, typename System, typename Model = NoModel> void \fBserif::solver::SolveResult\fP< State, System, Model >::finish (\fBSolveStatus\fP status, std::string message, \fBSolveDiagnostics\fP diagnostics)\fR [inline]\fP"
|
|
|
|
.PP
|
|
Finalize bounded diagnostics without altering the accepted checkpoint\&.
|
|
.SS "template<typename State, typename System, typename Model = NoModel> bool \fBserif::solver::SolveResult\fP< State, System, Model >::has_checkpoint () const\fR [inline]\fP, \fR [nodiscard]\fP, \fR [noexcept]\fP"
|
|
|
|
.PP
|
|
Whether this accepted boundary has supported, complete numerical restart data\&.
|
|
.SS "template<typename State, typename System, typename Model = NoModel> bool \fBserif::solver::SolveResult\fP< State, System, Model >::has_state () const\fR [inline]\fP, \fR [nodiscard]\fP, \fR [noexcept]\fP"
|
|
|
|
.PP
|
|
Distinguish a usable accepted checkpoint from a rejected initial guess\&.
|
|
.SS "template<typename State, typename System, typename Model = NoModel> const std::string & \fBserif::solver::SolveResult\fP< State, System, Model >::message () const\fR [inline]\fP, \fR [nodiscard]\fP, \fR [noexcept]\fP"
|
|
|
|
.PP
|
|
Read the diagnostic associated with numerical termination\&.
|
|
.SS "template<typename State, typename System, typename Model = NoModel> const Model & \fBserif::solver::SolveResult\fP< State, System, Model >::model () const\fR [inline]\fP, \fR [nodiscard]\fP"
|
|
|
|
.PP
|
|
Read the physical definition owned by a stellar result\&.
|
|
.SS "template<typename State, typename System, typename Model = NoModel> const State & \fBserif::solver::SolveResult\fP< State, System, Model >::state () const\fR [inline]\fP, \fR [nodiscard]\fP"
|
|
|
|
.PP
|
|
Read the last accepted physical coefficients; reject access when none were evaluated\&.
|
|
.SS "template<typename State, typename System, typename Model = NoModel> \fBSolveStatus\fP \fBserif::solver::SolveResult\fP< State, System, Model >::status () const\fR [inline]\fP, \fR [nodiscard]\fP, \fR [noexcept]\fP"
|
|
|
|
.PP
|
|
Inspect the numerical reason for termination\&.
|
|
.SS "template<typename State, typename System, typename Model = NoModel> const std::shared_ptr< const System > & \fBserif::solver::SolveResult\fP< State, System, Model >::system () const\fR [inline]\fP, \fR [nodiscard]\fP, \fR [noexcept]\fP"
|
|
|
|
.PP
|
|
Retain or inspect the exact residual and Jacobian belonging to \fBstate()\fP\&.
|
|
.SH "Member Data Documentation"
|
|
.PP
|
|
.SS "template<typename State, typename System, typename Model = NoModel> \fBSolveDiagnostics\fP \fBserif::solver::SolveResult\fP< State, System, Model >::m_diagnostics\fR [private]\fP"
|
|
|
|
.SS "template<typename State, typename System, typename Model = NoModel> std::string \fBserif::solver::SolveResult\fP< State, System, Model >::m_message\fR [private]\fP"
|
|
|
|
.SS "template<typename State, typename System, typename Model = NoModel> std::shared_ptr<const Model> \fBserif::solver::SolveResult\fP< State, System, Model >::m_model\fR [private]\fP"
|
|
|
|
.SS "template<typename State, typename System, typename Model = NoModel> std::optional<\fBNewtonProgress\fP> \fBserif::solver::SolveResult\fP< State, System, Model >::m_progress\fR [private]\fP"
|
|
|
|
.SS "template<typename State, typename System, typename Model = NoModel> std::optional<State> \fBserif::solver::SolveResult\fP< State, System, Model >::m_state\fR [private]\fP"
|
|
|
|
.SS "template<typename State, typename System, typename Model = NoModel> \fBSolveStatus\fP \fBserif::solver::SolveResult\fP< State, System, Model >::m_status {\fBSolveStatus::initial_state_rejected\fP}\fR [private]\fP"
|
|
|
|
.SS "template<typename State, typename System, typename Model = NoModel> std::shared_ptr<const System> \fBserif::solver::SolveResult\fP< State, System, Model >::m_system\fR [private]\fP"
|
|
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|