96 lines
7.9 KiB
TeX
96 lines
7.9 KiB
TeX
|
|
\doxysection{src/include/serif/solver/nonlinear/result.hpp File Reference}
|
||
|
|
\hypertarget{solver_2nonlinear_2result_8hpp}{}\label{solver_2nonlinear_2result_8hpp}\index{src/include/serif/solver/nonlinear/result.hpp@{src/include/serif/solver/nonlinear/result.hpp}}
|
||
|
|
{\ttfamily \#include $<$algorithm$>$}\newline
|
||
|
|
{\ttfamily \#include $<$cmath$>$}\newline
|
||
|
|
{\ttfamily \#include $<$memory$>$}\newline
|
||
|
|
{\ttfamily \#include $<$optional$>$}\newline
|
||
|
|
{\ttfamily \#include $<$string$>$}\newline
|
||
|
|
{\ttfamily \#include $<$utility$>$}\newline
|
||
|
|
{\ttfamily \#include $<$vector$>$}\newline
|
||
|
|
{\ttfamily \#include "{}serif/geometry/deformation/geometry\+\_\+step.\+hpp"{}}\newline
|
||
|
|
{\ttfamily \#include "{}serif/solver/nonlinear/options.\+hpp"{}}\newline
|
||
|
|
{\ttfamily \#include "{}serif/solver/linear/linear.\+hpp"{}}\newline
|
||
|
|
{\ttfamily \#include "{}serif/utils/error/errors.\+hpp"{}}\newline
|
||
|
|
Include dependency graph for result.\+hpp\+:
|
||
|
|
\nopagebreak
|
||
|
|
\begin{figure}[H]
|
||
|
|
\begin{center}
|
||
|
|
\leavevmode
|
||
|
|
\includegraphics[width=350pt]{solver_2nonlinear_2result_8hpp__incl}
|
||
|
|
\end{center}
|
||
|
|
\end{figure}
|
||
|
|
This graph shows which files directly or indirectly include this file\+:
|
||
|
|
\nopagebreak
|
||
|
|
\begin{figure}[H]
|
||
|
|
\begin{center}
|
||
|
|
\leavevmode
|
||
|
|
\includegraphics[width=350pt]{solver_2nonlinear_2result_8hpp__dep__incl}
|
||
|
|
\end{center}
|
||
|
|
\end{figure}
|
||
|
|
\doxysubsubsection*{Classes}
|
||
|
|
\begin{DoxyCompactItemize}
|
||
|
|
\item
|
||
|
|
struct \mbox{\hyperlink{structserif_1_1solver_1_1_solve_diagnostics}{serif\+::solver\+::\+Solve\+Diagnostics}}
|
||
|
|
\begin{DoxyCompactList}\small\item\em Bounded work totals; accepted physical snapshots are stored separately from diagnostics. \end{DoxyCompactList}\item
|
||
|
|
struct \mbox{\hyperlink{structserif_1_1solver_1_1_newton_progress}{serif\+::solver\+::\+Newton\+Progress}}
|
||
|
|
\begin{DoxyCompactList}\small\item\em Numerical continuation data at one accepted \doxylink{structserif_1_1solver_1_1_newton}{Newton} boundary. \end{DoxyCompactList}\item
|
||
|
|
struct \mbox{\hyperlink{structserif_1_1solver_1_1_newton_checkpoint}{serif\+::solver\+::\+Newton\+Checkpoint$<$ State $>$}}
|
||
|
|
\begin{DoxyCompactList}\small\item\em Own the accepted physical star and the small amount of \doxylink{structserif_1_1solver_1_1_newton}{Newton} history needed to continue it. \end{DoxyCompactList}\item
|
||
|
|
struct \mbox{\hyperlink{structserif_1_1solver_1_1_solve_event}{serif\+::solver\+::\+Solve\+Event}}
|
||
|
|
\begin{DoxyCompactList}\small\item\em Small event record suitable for logging without retaining every iterate. \end{DoxyCompactList}\item
|
||
|
|
struct \mbox{\hyperlink{structserif_1_1solver_1_1_no_observer}{serif\+::solver\+::\+No\+Observer}}
|
||
|
|
\begin{DoxyCompactList}\small\item\em Disable observation without introducing runtime callback allocation. \end{DoxyCompactList}\item
|
||
|
|
struct \mbox{\hyperlink{structserif_1_1solver_1_1_no_model}{serif\+::solver\+::\+No\+Model}}
|
||
|
|
\begin{DoxyCompactList}\small\item\em Marker for algebraic tests and custom problems without a stellar description. \end{DoxyCompactList}\item
|
||
|
|
class \mbox{\hyperlink{classserif_1_1solver_1_1_solve_result}{serif\+::solver\+::\+Solve\+Result$<$ State, System, Model $>$}}
|
||
|
|
\begin{DoxyCompactList}\small\item\em Own the last accepted physical state, matching frozen system, and descriptive model. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||
|
|
\doxysubsubsection*{Namespaces}
|
||
|
|
\begin{DoxyCompactItemize}
|
||
|
|
\item
|
||
|
|
namespace \mbox{\hyperlink{namespaceserif}{serif}}
|
||
|
|
\item
|
||
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1solver}{serif\+::solver}}
|
||
|
|
\item
|
||
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1solver_1_1detail}{serif\+::solver\+::detail}}
|
||
|
|
\end{DoxyCompactItemize}
|
||
|
|
\doxysubsubsection*{Enumerations}
|
||
|
|
\begin{DoxyCompactItemize}
|
||
|
|
\item
|
||
|
|
enum class \mbox{\hyperlink{namespaceserif_1_1solver_a0c5b4c0a272429c1c5807ebb757aad64}{serif\+::solver\+::\+Solve\+Status}} \{ \newline
|
||
|
|
\mbox{\hyperlink{namespaceserif_1_1solver_a0c5b4c0a272429c1c5807ebb757aad64a7de33615d7fbc1cb7bc608d12f1993d2}{serif\+::solver\+::converged}}
|
||
|
|
, \mbox{\hyperlink{namespaceserif_1_1solver_a0c5b4c0a272429c1c5807ebb757aad64a00284e15e20ba8bd246e70c06567efbd}{serif\+::solver\+::initial\+\_\+state\+\_\+rejected}}
|
||
|
|
, \mbox{\hyperlink{namespaceserif_1_1solver_a0c5b4c0a272429c1c5807ebb757aad64ae5352def1775383427334d4671099caf}{serif\+::solver\+::invalid\+\_\+metric}}
|
||
|
|
, \mbox{\hyperlink{namespaceserif_1_1solver_a0c5b4c0a272429c1c5807ebb757aad64ae9f49c7af9b0c06e5e2481ec84cdf9aa}{serif\+::solver\+::preparation\+\_\+failure}}
|
||
|
|
, \newline
|
||
|
|
\mbox{\hyperlink{namespaceserif_1_1solver_a0c5b4c0a272429c1c5807ebb757aad64a4913a35a7eab87ca909c1d360ab82adb}{serif\+::solver\+::linear\+\_\+solve\+\_\+failure}}
|
||
|
|
, \mbox{\hyperlink{namespaceserif_1_1solver_a0c5b4c0a272429c1c5807ebb757aad64a8286355a7892894a1c3cc40354da9999}{serif\+::solver\+::globalization\+\_\+failure}}
|
||
|
|
, \mbox{\hyperlink{namespaceserif_1_1solver_a0c5b4c0a272429c1c5807ebb757aad64af9cc715fb6ecde5fea080ac57ad0dfaf}{serif\+::solver\+::maximum\+\_\+iterations}}
|
||
|
|
, \mbox{\hyperlink{namespaceserif_1_1solver_a0c5b4c0a272429c1c5807ebb757aad64af0a0bfe6bc7d2c58d2989034f83183e0}{serif\+::solver\+::stopped}}
|
||
|
|
\}
|
||
|
|
\begin{DoxyCompactList}\small\item\em Numerical termination; invalid configuration and user callback errors remain exceptions. \end{DoxyCompactList}\item
|
||
|
|
enum class \mbox{\hyperlink{namespaceserif_1_1solver_a6fa8bbc306fbf990b16ade9fb7771464}{serif\+::solver\+::\+Event\+Kind}} \{ \newline
|
||
|
|
\mbox{\hyperlink{namespaceserif_1_1solver_a6fa8bbc306fbf990b16ade9fb7771464acc51b81974287ab79cef9e94fe778cc9}{serif\+::solver\+::initial}}
|
||
|
|
, \mbox{\hyperlink{namespaceserif_1_1solver_a6fa8bbc306fbf990b16ade9fb7771464a57054ff3283d5f50b905c8d1a492c8a3}{serif\+::solver\+::before\+\_\+iteration}}
|
||
|
|
, \mbox{\hyperlink{namespaceserif_1_1solver_a6fa8bbc306fbf990b16ade9fb7771464a8746f4ec6db7fdda6018d314e8c3ae02}{serif\+::solver\+::trial\+\_\+rejected}}
|
||
|
|
, \mbox{\hyperlink{namespaceserif_1_1solver_a6fa8bbc306fbf990b16ade9fb7771464a6e563563af598fa7575b0944e785a7d5}{serif\+::solver\+::before\+\_\+accept}}
|
||
|
|
, \newline
|
||
|
|
\mbox{\hyperlink{namespaceserif_1_1solver_a6fa8bbc306fbf990b16ade9fb7771464a3e4d891a5df3d6d0d7dd9432a1bc6470}{serif\+::solver\+::accepted}}
|
||
|
|
, \mbox{\hyperlink{namespaceserif_1_1solver_a6fa8bbc306fbf990b16ade9fb7771464aa5d7ceb2c59b8cee46c2953fec9abc19}{serif\+::solver\+::finished}}
|
||
|
|
, \mbox{\hyperlink{namespaceserif_1_1solver_a6fa8bbc306fbf990b16ade9fb7771464a121ad2eb76415d284215a4c9deddf79c}{serif\+::solver\+::resumed}}
|
||
|
|
\}
|
||
|
|
\begin{DoxyCompactList}\small\item\em Events expose immutable accepted/trial snapshots; callbacks never decide acceptance. \end{DoxyCompactList}\item
|
||
|
|
enum class \mbox{\hyperlink{namespaceserif_1_1solver_af4b1a8caa8d8f54f51fc013688c7b21c}{serif\+::solver\+::\+Solve\+Control}} \{ \mbox{\hyperlink{namespaceserif_1_1solver_af4b1a8caa8d8f54f51fc013688c7b21ca1c2afff196eca9b02ad6a8dcc4aee0e0}{serif\+::solver\+::continue\+\_\+solve}}
|
||
|
|
, \mbox{\hyperlink{namespaceserif_1_1solver_af4b1a8caa8d8f54f51fc013688c7b21caef399b2d446bb37b7c32ad2cc1b6045b}{serif\+::solver\+::stop}}
|
||
|
|
\}
|
||
|
|
\begin{DoxyCompactList}\small\item\em A stop request is remembered until the next initial, resumed or accepted Newton boundary. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||
|
|
\doxysubsubsection*{Functions}
|
||
|
|
\begin{DoxyCompactItemize}
|
||
|
|
\item
|
||
|
|
std\+::optional$<$ std\+::string $>$ \mbox{\hyperlink{namespaceserif_1_1solver_aba8609bba7520feb62263d06def641e5}{serif\+::solver\+::validate\+\_\+newton\+\_\+progress}} (const \mbox{\hyperlink{structserif_1_1solver_1_1_newton_progress}{Newton\+Progress}} \&progress, const std\+::size\+\_\+t state\+\_\+size)
|
||
|
|
\begin{DoxyCompactList}\small\item\em Reject incomplete or inconsistent imported history before preparing any runtime operators. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||
|
|
\doxysubsubsection*{Variables}
|
||
|
|
\begin{DoxyCompactItemize}
|
||
|
|
\item
|
||
|
|
{\footnotesize template$<$typename Options$>$ }\\constexpr bool \mbox{\hyperlink{namespaceserif_1_1solver_1_1detail_aca34a8e5074029c302fd5d3fc9d35244}{serif\+::solver\+::detail\+::checkpointable\+\_\+options}}
|
||
|
|
\begin{DoxyCompactList}\small\item\em Only built-\/in stateless numerical policies currently have a complete restart contract. \end{DoxyCompactList}\end{DoxyCompactItemize}
|