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)
46 lines
3.4 KiB
TeX
46 lines
3.4 KiB
TeX
\doxysection{src/include/serif/solver/nonlinear/newton.hpp File Reference}
|
|
\hypertarget{newton_8hpp}{}\label{newton_8hpp}\index{src/include/serif/solver/nonlinear/newton.hpp@{src/include/serif/solver/nonlinear/newton.hpp}}
|
|
{\ttfamily \#include "{}serif/solver/nonlinear/observers.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/solver/nonlinear/steps.\+hpp"{}}\newline
|
|
Include dependency graph for newton.\+hpp\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{newton_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]{newton_8hpp__dep__incl}
|
|
\end{center}
|
|
\end{figure}
|
|
\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*{Concepts}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
concept \mbox{\hyperlink{conceptserif_1_1solver_1_1detail_1_1_newton_strategy_for}{serif\+::solver\+::detail\+::\+Newton\+Strategy\+For}}
|
|
\begin{DoxyCompactList}\small\item\em A custom method must supply the exact correction contract; malformed overrides never select a fallback. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
{\footnotesize template$<$typename Problem, typename State, typename Options, typename Observer$>$ }\\auto \mbox{\hyperlink{namespaceserif_1_1solver_1_1detail_ad84838af2c61fd8a7ff1143ed6e30e07}{serif\+::solver\+::detail\+::run\+\_\+newton}} (Problem \&problem, State initial\+\_\+state, Options options, Observer observer, std\+::optional$<$ \mbox{\hyperlink{structserif_1_1solver_1_1_newton_progress}{Newton\+Progress}} $>$ restart)
|
|
\begin{DoxyCompactList}\small\item\em Find equilibrium while retaining the last fully qualified physical state. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$typename Problem, typename State, typename Options = Solver\+Options$<$$>$, typename Observer = No\+Observer$>$ \newline
|
|
requires detail\+::\+Newton\+Strategy\+For$<$Problem, State, Options$>$}\\auto \mbox{\hyperlink{namespaceserif_1_1solver_a50d481ced4213cc6414d163eff898df9}{serif\+::solver\+::solve\+\_\+newton}} (Problem \&problem, State initial\+\_\+state, Options options=\{\}, Observer observer=\{\})
|
|
\begin{DoxyCompactList}\small\item\em Solve a custom numerical problem using its native \doxylink{namespaceserif_ab7690da8665e9d9bd2fa8e8534cd6e57}{Vector}, evaluate, prepare and solve\+\_\+linear operations. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$typename Problem, typename State, typename Options = Solver\+Options$<$$>$, typename Observer = No\+Observer$>$ \newline
|
|
requires detail\+::\+Newton\+Strategy\+For$<$Problem, State, Options$>$}\\auto \mbox{\hyperlink{namespaceserif_1_1solver_aa3cdbadff61a171e313e316fdf26909d}{serif\+::solver\+::resume\+\_\+newton}} (Problem \&problem, \mbox{\hyperlink{structserif_1_1solver_1_1_newton_checkpoint}{Newton\+Checkpoint}}$<$ State $>$ checkpoint, Options options=\{\}, Observer observer=\{\})
|
|
\begin{DoxyCompactList}\small\item\em Resume the original convergence reference, correction reuse, and cumulative work budget. \end{DoxyCompactList}\end{DoxyCompactItemize}
|