83 lines
3.2 KiB
Groff
83 lines
3.2 KiB
Groff
|
.TH "src/include/serif/solver/continuation/driver.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
||
|
|
.ad l
|
||
|
|
.nh
|
||
|
|
.SH NAME
|
||
|
|
src/include/serif/solver/continuation/driver.hpp
|
||
|
|
.SH SYNOPSIS
|
||
|
|
.br
|
||
|
|
.PP
|
||
|
|
\fR#include <memory>\fP
|
||
|
|
.br
|
||
|
|
\fR#include <vector>\fP
|
||
|
|
.br
|
||
|
|
\fR#include 'serif/solver/continuation/options\&.hpp'\fP
|
||
|
|
.br
|
||
|
|
|
||
|
|
.SS "Classes"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "struct \fBserif::solver::continuation::CorrectionControls\fP"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "struct \fBserif::solver::continuation::StageRecord< Count >\fP"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "struct \fBserif::solver::continuation::Result< Report, Count >\fP"
|
||
|
|
.br
|
||
|
|
.RI "Retain the last converged physical state separately from the requested endpoint and failed candidates\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "struct \fBserif::solver::continuation::StartingStar< Model, State >\fP"
|
||
|
|
.br
|
||
|
|
.RI "A supplied physical anchor still requires fresh qualification at the continuation tolerance\&. "
|
||
|
|
.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::continuation\fP"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "namespace \fBserif::solver::continuation::detail\fP"
|
||
|
|
.br
|
||
|
|
.in -1c
|
||
|
|
.SS "Enumerations"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "enum class \fBserif::solver::continuation::Status\fP { \fBserif::solver::continuation::target_reached\fP, \fBserif::solver::continuation::starting_star_failed\fP, \fBserif::solver::continuation::attempt_limit\fP, \fBserif::solver::continuation::work_limit\fP, \fBserif::solver::continuation::no_progress\fP, \fBserif::solver::continuation::invalid_model\fP }"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "enum class \fBserif::solver::continuation::StageDisposition\fP { \fBserif::solver::continuation::converged\fP, \fBserif::solver::continuation::not_converged\fP, \fBserif::solver::continuation::invalid_model\fP }"
|
||
|
|
.br
|
||
|
|
.in -1c
|
||
|
|
.SS "Functions"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "template<typename \fBFamily\fP> std::vector< typename Family::Coordinates > \fBserif::solver::continuation::detail::starting_candidates\fP (const \fBFamily\fP &family, const \fBOptions\fP< \fBFamily\fP > &options)"
|
||
|
|
.br
|
||
|
|
.RI "Try bounded simpler starting models, unless the user explicitly fixed the starting coordinates\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "template<typename Report, std::size_t Count> void \fBserif::solver::continuation::detail::record\fP (\fBResult\fP< Report, Count > &result, \fBStageRecord\fP< Count > stage, std::size_t maximum)"
|
||
|
|
.br
|
||
|
|
.RI "Bound diagnostic storage while retaining total work and the newest stage\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "template<typename \fBFamily\fP, typename State, typename Corrector> auto \fBserif::solver::continuation::run\fP (const \fBFamily\fP &family, const State &initial_state, Corrector &&correct, \fBOptions\fP< \fBFamily\fP > options, double absolute_tolerance)"
|
||
|
|
.br
|
||
|
|
.RI "Follow a physical family using owning correction results and physical state transfer\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "template<typename \fBFamily\fP, typename Model, typename State, typename Corrector> auto \fBserif::solver::continuation::run\fP (const \fBFamily\fP &family, const \fBStartingStar\fP< Model, State > &\fBinitial\fP, Corrector &&correct, \fBOptions\fP< \fBFamily\fP > options, double absolute_tolerance)"
|
||
|
|
.br
|
||
|
|
.RI "Qualify a supplied star afresh after checking every physical family input\&. "
|
||
|
|
.in -1c
|
||
|
|
.SH "Author"
|
||
|
|
.PP
|
||
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|