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)
49 lines
6.8 KiB
TeX
49 lines
6.8 KiB
TeX
\doxysection{src/include/serif/solver/equilibrium.hpp File Reference}
|
|
\hypertarget{solver_2equilibrium_8hpp}{}\label{solver_2equilibrium_8hpp}\index{src/include/serif/solver/equilibrium.hpp@{src/include/serif/solver/equilibrium.hpp}}
|
|
{\ttfamily \#include "{}serif/backend/mfem/solver/equilibrium.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/solver/nonlinear/newton.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/model/finite\+\_\+elements.\+hpp"{}}\newline
|
|
Include dependency graph for equilibrium.\+hpp\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{solver_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=256pt]{solver_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}}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Typedefs}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
using \mbox{\hyperlink{namespaceserif_1_1solver_aaee71b0914bfa77aeb37e494eab911bb}{serif\+::solver\+::\+Volume\+Options}} = \mbox{\hyperlink{structserif_1_1operators_1_1backend_1_1mfem_1_1_volume_options}{operators\+::backend\+::mfem\+::\+Volume\+Options}}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
{\footnotesize template$<$typename Configuration, typename Layout, typename Options = Solver\+Options$<$$>$, typename Observer = No\+Observer, utils\+::dependencies\+::\+Is\+Dependency\+Context Inputs = utils\+::dependencies\+::\+Dependency\+Context$<$$>$, typename Observer\+Factory = utils\+::dependencies\+::\+No\+Graph\+Observers$>$ \newline
|
|
requires utils\+::dependencies\+::\+Contains\+Key$<$\mbox{\hyperlink{structserif_1_1discretization_1_1blocks_1_1surface__deformation_1_1coefficients}{discretization\+::blocks\+::surface\+\_\+deformation\+::coefficients}}, typename Layout\+::\+Values$>$}\\auto \mbox{\hyperlink{namespaceserif_1_1solver_a2e9de7691387f8b6f7ee258e6516da7d}{serif\+::solver\+::solve\+\_\+equilibrium}} (Configuration configuration, \mbox{\hyperlink{structserif_1_1model_1_1_stellar_state}{model\+::\+Stellar\+State}}$<$ Layout $>$ initial\+\_\+state, Options options=\{\}, Observer observer=\{\}, \mbox{\hyperlink{namespaceserif_1_1solver_aaee71b0914bfa77aeb37e494eab911bb}{Volume\+Options}} volume\+\_\+options=\{\}, Inputs prescribed=Inputs\{\}, Observer\+Factory observer\+\_\+factory=\{\})
|
|
\begin{DoxyCompactList}\small\item\em Solve a moving star from an owning physical initial state. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$typename Configuration, typename Layout, typename Options = Solver\+Options$<$$>$, typename Observer = No\+Observer, utils\+::dependencies\+::\+Is\+Dependency\+Context Inputs = utils\+::dependencies\+::\+Dependency\+Context$<$$>$, typename Observer\+Factory = utils\+::dependencies\+::\+No\+Graph\+Observers$>$ \newline
|
|
requires (!utils\+::dependencies\+::\+Contains\+Key$<$\mbox{\hyperlink{structserif_1_1discretization_1_1blocks_1_1surface__deformation_1_1coefficients}{discretization\+::blocks\+::surface\+\_\+deformation\+::coefficients}}, typename Layout\+::\+Values$>$)}\\auto \mbox{\hyperlink{namespaceserif_1_1solver_aabb49f9d871887898b5f5001ff33b4bf}{serif\+::solver\+::solve\+\_\+equilibrium}} (Configuration configuration, \mbox{\hyperlink{structserif_1_1model_1_1_stellar_state}{model\+::\+Stellar\+State}}$<$ Layout $>$ initial\+\_\+state, const \mbox{\hyperlink{namespaceserif_ab7690da8665e9d9bd2fa8e8534cd6e57}{Vector}} \&displacement, Options options=\{\}, Observer observer=\{\}, \mbox{\hyperlink{namespaceserif_1_1solver_aaee71b0914bfa77aeb37e494eab911bb}{Volume\+Options}} volume\+\_\+options=\{\}, Inputs prescribed=Inputs\{\}, Observer\+Factory observer\+\_\+factory=\{\})
|
|
\begin{DoxyCompactList}\small\item\em Solve a fixed-\/geometry model with prescribed displacement outside its unknown vector. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$typename Configuration, typename Layout, typename Options = Solver\+Options$<$$>$, typename Observer = No\+Observer, utils\+::dependencies\+::\+Is\+Dependency\+Context Inputs = utils\+::dependencies\+::\+Dependency\+Context$<$$>$, typename Observer\+Factory = utils\+::dependencies\+::\+No\+Graph\+Observers$>$ \newline
|
|
requires utils\+::dependencies\+::\+Contains\+Key$<$\mbox{\hyperlink{structserif_1_1discretization_1_1blocks_1_1surface__deformation_1_1coefficients}{discretization\+::blocks\+::surface\+\_\+deformation\+::coefficients}}, typename Layout\+::\+Values$>$}\\auto \mbox{\hyperlink{namespaceserif_1_1solver_a2698b5ef612716179bbd0f1498cc4cec}{serif\+::solver\+::resume\+\_\+equilibrium}} (Configuration configuration, \mbox{\hyperlink{structserif_1_1solver_1_1_newton_checkpoint}{Newton\+Checkpoint}}$<$ \mbox{\hyperlink{structserif_1_1model_1_1_stellar_state}{model\+::\+Stellar\+State}}$<$ Layout $>$ $>$ checkpoint, Options options=\{\}, Observer observer=\{\}, \mbox{\hyperlink{namespaceserif_1_1solver_aaee71b0914bfa77aeb37e494eab911bb}{Volume\+Options}} volume\+\_\+options=\{\}, Inputs prescribed=Inputs\{\}, Observer\+Factory observer\+\_\+factory=\{\})
|
|
\begin{DoxyCompactList}\small\item\em Continue a moving-\/star checkpoint using reconstructed physical and numerical configuration. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$typename Configuration, typename Layout, typename Options = Solver\+Options$<$$>$, typename Observer = No\+Observer, utils\+::dependencies\+::\+Is\+Dependency\+Context Inputs = utils\+::dependencies\+::\+Dependency\+Context$<$$>$, typename Observer\+Factory = utils\+::dependencies\+::\+No\+Graph\+Observers$>$ \newline
|
|
requires (!utils\+::dependencies\+::\+Contains\+Key$<$\mbox{\hyperlink{structserif_1_1discretization_1_1blocks_1_1surface__deformation_1_1coefficients}{discretization\+::blocks\+::surface\+\_\+deformation\+::coefficients}}, typename Layout\+::\+Values$>$)}\\auto \mbox{\hyperlink{namespaceserif_1_1solver_ad1fa5c83c70e1b37311b7cf0ed4b88bd}{serif\+::solver\+::resume\+\_\+equilibrium}} (Configuration configuration, \mbox{\hyperlink{structserif_1_1solver_1_1_newton_checkpoint}{Newton\+Checkpoint}}$<$ \mbox{\hyperlink{structserif_1_1model_1_1_stellar_state}{model\+::\+Stellar\+State}}$<$ Layout $>$ $>$ checkpoint, const \mbox{\hyperlink{namespaceserif_ab7690da8665e9d9bd2fa8e8534cd6e57}{Vector}} \&displacement, Options options=\{\}, Observer observer=\{\}, \mbox{\hyperlink{namespaceserif_1_1solver_aaee71b0914bfa77aeb37e494eab911bb}{Volume\+Options}} volume\+\_\+options=\{\}, Inputs prescribed=Inputs\{\}, Observer\+Factory observer\+\_\+factory=\{\})
|
|
\begin{DoxyCompactList}\small\item\em Continue a fixed-\/geometry checkpoint with its separately restored prescribed displacement. \end{DoxyCompactList}\end{DoxyCompactItemize}
|