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)
42 lines
2.7 KiB
TeX
42 lines
2.7 KiB
TeX
\doxysection{src/include/serif/geometry/deformation/models.hpp File Reference}
|
|
\hypertarget{models_8hpp}{}\label{models_8hpp}\index{src/include/serif/geometry/deformation/models.hpp@{src/include/serif/geometry/deformation/models.hpp}}
|
|
{\ttfamily \#include $<$array$>$}\newline
|
|
{\ttfamily \#include $<$optional$>$}\newline
|
|
Include dependency graph for models.\+hpp\+:\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=209pt]{models_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]{models_8hpp__dep__incl}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsubsection*{Classes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1geometry_1_1deformation_1_1_nodal_radial_surface}{serif\+::geometry\+::deformation\+::\+Nodal\+Radial\+Surface}}
|
|
\begin{DoxyCompactList}\small\item\em Give each surface node an independent radial displacement, measured in physical length. \end{DoxyCompactList}\item
|
|
struct \mbox{\hyperlink{structserif_1_1geometry_1_1deformation_1_1_spherical_harmonic_surface}{serif\+::geometry\+::deformation\+::\+Spherical\+Harmonic\+Surface}}
|
|
\begin{DoxyCompactList}\small\item\em Represent radial displacement lengths with normalized real spherical harmonics on the reference surface. \end{DoxyCompactList}\item
|
|
struct \mbox{\hyperlink{structserif_1_1geometry_1_1deformation_1_1_power_law_radial_extension}{serif\+::geometry\+::deformation\+::\+Power\+Law\+Radial\+Extension}}
|
|
\begin{DoxyCompactList}\small\item\em Extend surface motion toward a fixed stellar center using a power of logical reference radius. \end{DoxyCompactList}\item
|
|
struct \mbox{\hyperlink{structserif_1_1geometry_1_1deformation_1_1_fixed_infinity_radial_extension}{serif\+::geometry\+::deformation\+::\+Fixed\+Infinity\+Radial\+Extension}}
|
|
\begin{DoxyCompactList}\small\item\em Reduce surface motion linearly to zero at reference infinity in logical reference radius. \end{DoxyCompactList}\item
|
|
struct \mbox{\hyperlink{structserif_1_1geometry_1_1deformation_1_1_domain_deformation}{serif\+::geometry\+::deformation\+::\+Domain\+Deformation$<$ Surface\+T, Interior\+T, Vacuum\+T $>$}}
|
|
\begin{DoxyCompactList}\small\item\em State how the stellar surface moves and how that motion extends into the two surrounding regions. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Namespaces}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif}{serif}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1geometry}{serif\+::geometry}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1geometry_1_1deformation}{serif\+::geometry\+::deformation}}
|
|
\end{DoxyCompactItemize}
|