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)
50 lines
5.4 KiB
TeX
50 lines
5.4 KiB
TeX
\doxysection{src/include/serif/solver/continuation/equilibrium.hpp File Reference}
|
|
\hypertarget{solver_2continuation_2equilibrium_8hpp}{}\label{solver_2continuation_2equilibrium_8hpp}\index{src/include/serif/solver/continuation/equilibrium.hpp@{src/include/serif/solver/continuation/equilibrium.hpp}}
|
|
{\ttfamily \#include "{}serif/solver/continuation/driver.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/backend/mfem/solver/continuation/detail/physical\+\_\+transfer.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/solver/equilibrium.\+hpp"{}}\newline
|
|
Include dependency graph for equilibrium.\+hpp\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{solver_2continuation_2equilibrium_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=220pt]{solver_2continuation_2equilibrium_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_1continuation}{serif\+::solver\+::continuation}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1solver_1_1continuation_1_1detail}{serif\+::solver\+::continuation\+::detail}}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
\mbox{\hyperlink{structserif_1_1solver_1_1_solver_options}{Solver\+Options}} \mbox{\hyperlink{namespaceserif_1_1solver_1_1continuation_a284b5f1f64852170370630726f9fd9e6}{serif\+::solver\+::continuation\+::default\+\_\+solver\+\_\+options}} ()
|
|
\begin{DoxyCompactList}\small\item\em Continuation uses one absolute qualification threshold across all family members. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$typename \mbox{\hyperlink{classserif_1_1solver_1_1continuation_1_1_family}{Family}}, typename Factory, typename \mbox{\hyperlink{structserif_1_1solver_1_1_solver_options}{Solver\+Options}}, typename Solve$>$ }\\auto \mbox{\hyperlink{namespaceserif_1_1solver_1_1continuation_1_1detail_aac9bffafddbf641d91baf36f0807430c}{serif\+::solver\+::continuation\+::detail\+::corrector}} (const \mbox{\hyperlink{classserif_1_1solver_1_1continuation_1_1_family}{Family}} \&family, Factory \&configure, \mbox{\hyperlink{structserif_1_1solver_1_1_solver_options}{Solver\+Options}} options, Solve solve)
|
|
\begin{DoxyCompactList}\small\item\em Adapt one fresh configured discretization per stage to the same public equilibrium solve. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$typename Family, typename Factory, typename State, typename Options = Solver\+Options$<$$>$$>$ \newline
|
|
requires std\+::copy\+\_\+constructible$<$Options$>$}\\auto \mbox{\hyperlink{namespaceserif_1_1solver_a795ce8d9efdc979d67d91cb56839fd1e}{serif\+::solver\+::continue\+\_\+equilibrium}} (const Family \&family, Factory configure, const State \&initial\+\_\+state, \mbox{\hyperlink{structserif_1_1solver_1_1continuation_1_1_options}{continuation\+::\+Options}}$<$ Family $>$ continuation\+\_\+options, Options solver\+\_\+options=\mbox{\hyperlink{namespaceserif_1_1solver_1_1continuation_a284b5f1f64852170370630726f9fd9e6}{continuation\+::default\+\_\+solver\+\_\+options}}())
|
|
\begin{DoxyCompactList}\small\item\em Continue moving-\/star equilibria through an explicitly declared physical family. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$typename Family, typename Factory, typename State$>$ }\\auto \mbox{\hyperlink{namespaceserif_1_1solver_aae73f87737f0d06a65fdf60a267717d7}{serif\+::solver\+::continue\+\_\+equilibrium}} (const Family \&family, Factory configure, const State \&initial\+\_\+state)
|
|
\begin{DoxyCompactList}\small\item\em Start with the family\textquotesingle{}s physics-\/owned default coordinates and bounded fallback route. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$typename Family, typename Factory, typename State, typename Options = Solver\+Options$<$$>$$>$ \newline
|
|
requires std\+::copy\+\_\+constructible$<$Options$>$}\\auto \mbox{\hyperlink{namespaceserif_1_1solver_abb8b187f7bbc1ffbe64842176278d16f}{serif\+::solver\+::continue\+\_\+equilibrium}} (const Family \&family, Factory configure, const State \&initial\+\_\+state, const \mbox{\hyperlink{namespaceserif_ab7690da8665e9d9bd2fa8e8534cd6e57}{Vector}} \&displacement, \mbox{\hyperlink{structserif_1_1solver_1_1continuation_1_1_options}{continuation\+::\+Options}}$<$ Family $>$ continuation\+\_\+options, Options solver\+\_\+options=\mbox{\hyperlink{namespaceserif_1_1solver_1_1continuation_a284b5f1f64852170370630726f9fd9e6}{continuation\+::default\+\_\+solver\+\_\+options}}())
|
|
\begin{DoxyCompactList}\small\item\em Continue a fixed-\/geometry model while preserving its prescribed displacement. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$typename Family, typename Factory, typename State$>$ }\\auto \mbox{\hyperlink{namespaceserif_1_1solver_ada5a2ebd458d64ac776bede196e81002}{serif\+::solver\+::continue\+\_\+equilibrium}} (const Family \&family, Factory configure, const State \&initial\+\_\+state, const \mbox{\hyperlink{namespaceserif_ab7690da8665e9d9bd2fa8e8534cd6e57}{Vector}} \&displacement)
|
|
\begin{DoxyCompactList}\small\item\em Use the same default route and absolute qualification tolerance for fixed geometry. \end{DoxyCompactList}\end{DoxyCompactItemize}
|