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)
57 lines
5.0 KiB
TeX
57 lines
5.0 KiB
TeX
\doxysection{src/include/serif/solver/continuation/options.hpp File Reference}
|
|
\hypertarget{solver_2continuation_2options_8hpp}{}\label{solver_2continuation_2options_8hpp}\index{src/include/serif/solver/continuation/options.hpp@{src/include/serif/solver/continuation/options.hpp}}
|
|
{\ttfamily \#include "{}serif/solver/continuation/family.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/solver/continuation/controller.\+hpp"{}}\newline
|
|
Include dependency graph for options.\+hpp\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{solver_2continuation_2options_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_2continuation_2options_8hpp__dep__incl}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsubsection*{Classes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1solver_1_1continuation_1_1_options}{serif\+::solver\+::continuation\+::\+Options$<$ Family $>$}}
|
|
\begin{DoxyCompactList}\small\item\em Bound continuation work and storage independently of \doxylink{structserif_1_1solver_1_1_newton}{Newton}\textquotesingle{}s per-\/correction controls. \end{DoxyCompactList}\item
|
|
struct \mbox{\hyperlink{structserif_1_1solver_1_1continuation_1_1_starting_at}{serif\+::solver\+::continuation\+::\+Starting\+At$<$ Parameter $>$}}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1solver_1_1continuation_1_1_ordering}{serif\+::solver\+::continuation\+::\+Ordering$<$ Strict, Parameters $>$}}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1solver_1_1continuation_1_1_numerical_controls}{serif\+::solver\+::continuation\+::\+Numerical\+Controls$<$ Count $>$}}
|
|
\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*{Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
{\footnotesize template$<$Physical\+Parameter Parameter$>$ }\\auto \mbox{\hyperlink{namespaceserif_1_1solver_1_1continuation_aa7ddba37396ae133a3a2e1744888d4dd}{serif\+::solver\+::continuation\+::starting\+\_\+at}} (Parameter, typename Parameter\+::\+Value value)
|
|
\begin{DoxyCompactList}\small\item\em Select a physical starting value with the parameter\textquotesingle{}s required units. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$Physical\+Parameter... Parameters$>$ \newline
|
|
requires (sizeof...(Parameters) $>$ 0) \&\& utils\+::dependencies\+::\+Is\+Key\+List$<$\mbox{\hyperlink{namespaceserif_1_1solver_1_1continuation_af4abf5dbb21b2d1032b766c80c2138d4}{Parameter\+List}}$<$Parameters...$>$$>$}\\auto \mbox{\hyperlink{namespaceserif_1_1solver_1_1continuation_aacad124179f8468affa401c5a7a80e84}{serif\+::solver\+::continuation\+::prefer}} (Parameters...)
|
|
\begin{DoxyCompactList}\small\item\em Try these physical coordinates first, allowing blocked coordinates to yield. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$Physical\+Parameter... Parameters$>$ \newline
|
|
requires (sizeof...(Parameters) $>$ 0) \&\& utils\+::dependencies\+::\+Is\+Key\+List$<$\mbox{\hyperlink{namespaceserif_1_1solver_1_1continuation_af4abf5dbb21b2d1032b766c80c2138d4}{Parameter\+List}}$<$Parameters...$>$$>$}\\auto \mbox{\hyperlink{namespaceserif_1_1solver_1_1continuation_af7d8b9dda17198536ec18b187be872cc}{serif\+::solver\+::continuation\+::stages}} (Parameters...)
|
|
\begin{DoxyCompactList}\small\item\em Complete each physical stage before attempting the next. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$std\+::size\+\_\+t Count$>$ }\\auto \mbox{\hyperlink{namespaceserif_1_1solver_1_1continuation_a90ad5d8671d73087cd74d1462313a12f}{serif\+::solver\+::continuation\+::numerics}} (\mbox{\hyperlink{structserif_1_1solver_1_1continuation_1_1_coordinate_options}{Coordinate\+Options}}$<$ Count $>$ options)
|
|
\begin{DoxyCompactList}\small\item\em Expose advanced numerical coordinate stepping without mixing it into physical prescriptions. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$typename \mbox{\hyperlink{classserif_1_1solver_1_1continuation_1_1_family}{Family}}, typename... Settings$>$ \newline
|
|
requires (requires(const Settings\& setting, \mbox{\hyperlink{structserif_1_1solver_1_1continuation_1_1_options}{Options}}$<$\mbox{\hyperlink{classserif_1_1solver_1_1continuation_1_1_family}{Family}}$>$\& options) \{ setting.\+apply(options); \} \&\& ...)}\\auto \mbox{\hyperlink{namespaceserif_1_1solver_1_1continuation_aae7169c3931073093e861283e0d514f1}{serif\+::solver\+::continuation\+::make\+\_\+options}} (const \mbox{\hyperlink{classserif_1_1solver_1_1continuation_1_1_family}{Family}} \&family, const Settings \&... settings)
|
|
\begin{DoxyCompactList}\small\item\em Resolve physical settings from family defaults before any corrector runs. \end{DoxyCompactList}\end{DoxyCompactItemize}
|