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)
69 lines
5.0 KiB
TeX
69 lines
5.0 KiB
TeX
\doxysection{src/include/serif/solver/continuation/controller.hpp File Reference}
|
|
\hypertarget{controller_8hpp}{}\label{controller_8hpp}\index{src/include/serif/solver/continuation/controller.hpp@{src/include/serif/solver/continuation/controller.hpp}}
|
|
{\ttfamily \#include $<$algorithm$>$}\newline
|
|
{\ttfamily \#include $<$array$>$}\newline
|
|
{\ttfamily \#include $<$cmath$>$}\newline
|
|
{\ttfamily \#include $<$cstdint$>$}\newline
|
|
{\ttfamily \#include $<$limits$>$}\newline
|
|
{\ttfamily \#include $<$optional$>$}\newline
|
|
{\ttfamily \#include "{}serif/utils/error/errors.\+hpp"{}}\newline
|
|
Include dependency graph for controller.\+hpp\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{controller_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]{controller_8hpp__dep__incl}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsubsection*{Classes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1solver_1_1continuation_1_1_coordinate_options}{serif\+::solver\+::continuation\+::\+Coordinate\+Options$<$ Count $>$}}
|
|
\begin{DoxyCompactList}\small\item\em Numerical increments are fractions of each coordinate\textquotesingle{}s complete physical span. \end{DoxyCompactList}\item
|
|
struct \mbox{\hyperlink{structserif_1_1solver_1_1continuation_1_1_coordinate_proposal}{serif\+::solver\+::continuation\+::\+Coordinate\+Proposal$<$ Count $>$}}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1solver_1_1continuation_1_1_coordinate_counters}{serif\+::solver\+::continuation\+::\+Coordinate\+Counters}}
|
|
\item
|
|
class \mbox{\hyperlink{classserif_1_1solver_1_1continuation_1_1_coordinate_controller}{serif\+::solver\+::continuation\+::\+Coordinate\+Controller$<$ Count $>$}}
|
|
\begin{DoxyCompactList}\small\item\em Own only the continuation path; a caller promotes physical states after successful correction. \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_1continuation}{serif\+::solver\+::continuation}}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Enumerations}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
enum class \mbox{\hyperlink{namespaceserif_1_1solver_1_1continuation_a66bc61a6db9aafdd80e8be6ef7e50c7d}{serif\+::solver\+::continuation\+::\+Coordinate\+Order}} \{ \mbox{\hyperlink{namespaceserif_1_1solver_1_1continuation_a66bc61a6db9aafdd80e8be6ef7e50c7da2bd9c0ed00116be1258e0cc66617d7c8}{serif\+::solver\+::continuation\+::automatic}}
|
|
, \mbox{\hyperlink{namespaceserif_1_1solver_1_1continuation_a66bc61a6db9aafdd80e8be6ef7e50c7dae4e5ef276d7ffb582d6c44f837a1e11e}{serif\+::solver\+::continuation\+::preferred}}
|
|
, \mbox{\hyperlink{namespaceserif_1_1solver_1_1continuation_a66bc61a6db9aafdd80e8be6ef7e50c7da2133fd717402a7966ee88d06f9e0b792}{serif\+::solver\+::continuation\+::strict}}
|
|
\}
|
|
\item
|
|
enum class \mbox{\hyperlink{namespaceserif_1_1solver_1_1continuation_a888b97a307db6acbca740638be478375}{serif\+::solver\+::continuation\+::\+Attempt\+Outcome}} \{ \mbox{\hyperlink{namespaceserif_1_1solver_1_1continuation_a888b97a307db6acbca740638be478375a260ca9dd8a4577fc00b7bd5810298076}{serif\+::solver\+::continuation\+::success}}
|
|
, \mbox{\hyperlink{namespaceserif_1_1solver_1_1continuation_a888b97a307db6acbca740638be478375a9d2045acefec47e0dff109bd1309581d}{serif\+::solver\+::continuation\+::recoverable\+\_\+rejection}}
|
|
, \mbox{\hyperlink{namespaceserif_1_1solver_1_1continuation_a888b97a307db6acbca740638be478375a3fa51915e3330498d7b812b8738dd3f4}{serif\+::solver\+::continuation\+::fatal\+\_\+failure}}
|
|
\}
|
|
\item
|
|
enum class \mbox{\hyperlink{namespaceserif_1_1solver_1_1continuation_ac833c779d67dfdac0917f38d98020224}{serif\+::solver\+::continuation\+::\+Controller\+Status}} \{ \newline
|
|
\mbox{\hyperlink{namespaceserif_1_1solver_1_1continuation_ac833c779d67dfdac0917f38d98020224ab2fdab230a2c39f3595a947861863cb7}{serif\+::solver\+::continuation\+::ready}}
|
|
, \mbox{\hyperlink{namespaceserif_1_1solver_1_1continuation_ac833c779d67dfdac0917f38d98020224a7c6c2e5d48ab37a007cbf70d3ea25fa4}{serif\+::solver\+::continuation\+::pending}}
|
|
, \mbox{\hyperlink{namespaceserif_1_1solver_1_1continuation_ac833c779d67dfdac0917f38d98020224ad9a22d7a8178d5b42a8750123cbfe5b1}{serif\+::solver\+::continuation\+::complete}}
|
|
, \mbox{\hyperlink{namespaceserif_1_1solver_1_1continuation_ac833c779d67dfdac0917f38d98020224acc37d00e5e12d2c8308851308b845222}{serif\+::solver\+::continuation\+::attempt\+\_\+limit}}
|
|
, \newline
|
|
\mbox{\hyperlink{namespaceserif_1_1solver_1_1continuation_ac833c779d67dfdac0917f38d98020224a43c09831647cc3d85b480f8815f0eef7}{serif\+::solver\+::continuation\+::no\+\_\+progress}}
|
|
, \mbox{\hyperlink{namespaceserif_1_1solver_1_1continuation_ac833c779d67dfdac0917f38d98020224a3fa51915e3330498d7b812b8738dd3f4}{serif\+::solver\+::continuation\+::fatal\+\_\+failure}}
|
|
\}
|
|
\end{DoxyCompactItemize}
|