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)
38 lines
3.2 KiB
TeX
38 lines
3.2 KiB
TeX
\doxysection{src/include/serif/solver/seed/state.hpp File Reference}
|
|
\hypertarget{solver_2seed_2state_8hpp}{}\label{solver_2seed_2state_8hpp}\index{src/include/serif/solver/seed/state.hpp@{src/include/serif/solver/seed/state.hpp}}
|
|
{\ttfamily \#include "{}serif/backend/mfem/solver/seed/state.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/backend/mfem/solver/seed/fitted.\+hpp"{}}\newline
|
|
Include dependency graph for state.\+hpp\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{solver_2seed_2state_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=194pt]{solver_2seed_2state_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_1seed}{serif\+::solver\+::seed}}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
{\footnotesize template$<$model\+::\+Stellar\+Model\+Type Model, typename Discretization, typename Profile$>$ \newline
|
|
requires (std\+::same\+\_\+as$<$Profile, \mbox{\hyperlink{structserif_1_1solver_1_1seed_1_1_radial_seed}{Radial\+Seed}}$>$ \texorpdfstring{$\vert$}{|}\texorpdfstring{$\vert$}{|} std\+::same\+\_\+as$<$Profile, \mbox{\hyperlink{structserif_1_1solver_1_1seed_1_1_fitted_radial_seed}{Fitted\+Radial\+Seed}}$>$) \&\& requires(const Model\& model, const Discretization\& discretization) \{ requires (!std\+::same\+\_\+as$<$typename std\+::remove\+\_\+cvref\+\_\+t$<$decltype(\mbox{\hyperlink{namespaceserif_1_1model_aa55d6cc09e69d07412896dedcb71c5a5}{model\+::resolve\+\_\+equilibrium\+\_\+equations}}(model))$>$\+::\+Shape\+Force, \mbox{\hyperlink{structserif_1_1model_1_1_no_shape_force}{model\+::\+No\+Shape\+Force}}$>$); discretization.\+deformation.\+model.\+surface; discretization.\+deformation.\+reference; \}}\\auto \mbox{\hyperlink{namespaceserif_1_1solver_1_1seed_ace50a90a69f7c31c7af73939977821b6}{serif\+::solver\+::seed\+::make\+\_\+polytropic\+\_\+state}} (const Model \&model, const Discretization \&discretization, const Profile \&seed, const Projection\+Options options=\{\})
|
|
\begin{DoxyCompactList}\small\item\em Project a spherical guess into a moving model\textquotesingle{}s named physical coordinates on its undeformed reference mesh. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$typename Discretization$>$ }\\std\+::expected$<$ \mbox{\hyperlink{structserif_1_1solver_1_1seed_1_1_fitted_radial_seed}{Fitted\+Radial\+Seed}}, std\+::string $>$ \mbox{\hyperlink{namespaceserif_1_1solver_1_1seed_a440ac630a394e31f451886dbfc61e46e}{serif\+::solver\+::seed\+::fit\+\_\+radial\+\_\+seed}} (const Discretization \&discretization, const \mbox{\hyperlink{structserif_1_1solver_1_1seed_1_1_radial_seed}{Radial\+Seed}} \&seed, double spherical\+\_\+relative\+\_\+tolerance=5.\+0e-\/4)
|
|
\begin{DoxyCompactList}\small\item\em Fit only an initial radial guess to the selected spherical reference surface. \end{DoxyCompactList}\end{DoxyCompactItemize}
|