Files
MeanField_SERiF/docs/latex/scaling_8hpp.tex

51 lines
6.1 KiB
TeX
Raw Permalink Normal View History

\doxysection{src/include/serif/utils/laneemden/scaling.hpp File Reference}
\hypertarget{scaling_8hpp}{}\label{scaling_8hpp}\index{src/include/serif/utils/laneemden/scaling.hpp@{src/include/serif/utils/laneemden/scaling.hpp}}
{\ttfamily \#include $<$expected$>$}\newline
{\ttfamily \#include $<$optional$>$}\newline
{\ttfamily \#include $<$string$>$}\newline
{\ttfamily \#include "{}serif/dimensions/dimensions.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/utils/laneemden/solution.\+hpp"{}}\newline
Include dependency graph for scaling.\+hpp\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{scaling_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]{scaling_8hpp__dep__incl}
\end{center}
\end{figure}
\doxysubsubsection*{Classes}
\begin{DoxyCompactItemize}
\item
struct \mbox{\hyperlink{structserif_1_1utils_1_1laneemden_1_1_physical_scales}{serif\+::utils\+::laneemden\+::\+Physical\+Scales}}
\begin{DoxyCompactList}\small\item\em A physical conversion of one finite-\/radius dimensionless polytrope, in the caller\textquotesingle{}s consistent units. \end{DoxyCompactList}\item
struct \mbox{\hyperlink{structserif_1_1utils_1_1laneemden_1_1_physical_sample}{serif\+::utils\+::laneemden\+::\+Physical\+Sample}}
\begin{DoxyCompactList}\small\item\em Physical scalar fields; gravity is the outward potential derivative, not the inward force component. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsubsection*{Namespaces}
\begin{DoxyCompactItemize}
\item
namespace \mbox{\hyperlink{namespaceserif}{serif}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1utils}{serif\+::utils}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1utils_1_1laneemden}{serif\+::utils\+::laneemden}}
\end{DoxyCompactItemize}
\doxysubsubsection*{Functions}
\begin{DoxyCompactItemize}
\item
std\+::expected$<$ \mbox{\hyperlink{structserif_1_1utils_1_1laneemden_1_1_physical_scales}{Physical\+Scales}}, std\+::string $>$ \mbox{\hyperlink{namespaceserif_1_1utils_1_1laneemden_a4c3ea7fb533fd5a9306e993593eb20fc}{serif\+::utils\+::laneemden\+::scale\+\_\+from\+\_\+mass}} (const \mbox{\hyperlink{structserif_1_1utils_1_1laneemden_1_1_solution}{Solution}} \&solution, \mbox{\hyperlink{classserif_1_1dimensions_1_1_quantity_value}{dimensions\+::\+Quantity\+Value}}$<$ \mbox{\hyperlink{structserif_1_1dimensions_1_1_mass}{dimensions\+::\+Mass}} $>$ mass, \mbox{\hyperlink{classserif_1_1dimensions_1_1_quantity_value}{dimensions\+::\+Quantity\+Value}}$<$ \mbox{\hyperlink{structserif_1_1dimensions_1_1_mass_density}{dimensions\+::\+Mass\+Density}} $>$ central\+\_\+density, \mbox{\hyperlink{classserif_1_1dimensions_1_1_quantity_value}{dimensions\+::\+Quantity\+Value}}$<$ \mbox{\hyperlink{structserif_1_1dimensions_1_1_gravitational_constant}{dimensions\+::\+Gravitational\+Constant}} $>$ gravitational\+\_\+constant)
\begin{DoxyCompactList}\small\item\em Fix a reference star by mass and central density; its implied K is an output, never a change to an EOS. \end{DoxyCompactList}\item
std\+::expected$<$ \mbox{\hyperlink{structserif_1_1utils_1_1laneemden_1_1_physical_scales}{Physical\+Scales}}, std\+::string $>$ \mbox{\hyperlink{namespaceserif_1_1utils_1_1laneemden_ab57cad62436b0fcf5cb9df68347b196b}{serif\+::utils\+::laneemden\+::scale\+\_\+from\+\_\+enthalpy}} (const \mbox{\hyperlink{structserif_1_1utils_1_1laneemden_1_1_solution}{Solution}} \&solution, \mbox{\hyperlink{classserif_1_1dimensions_1_1_quantity_value}{dimensions\+::\+Quantity\+Value}}$<$ \mbox{\hyperlink{structserif_1_1dimensions_1_1_specific_enthalpy}{dimensions\+::\+Specific\+Enthalpy}} $>$ central\+\_\+enthalpy, \mbox{\hyperlink{classserif_1_1dimensions_1_1_quantity_value}{dimensions\+::\+Quantity\+Value}}$<$ \mbox{\hyperlink{structserif_1_1dimensions_1_1_mass_density}{dimensions\+::\+Mass\+Density}} $>$ central\+\_\+density, \mbox{\hyperlink{classserif_1_1dimensions_1_1_quantity_value}{dimensions\+::\+Quantity\+Value}}$<$ \mbox{\hyperlink{structserif_1_1dimensions_1_1_gravitational_constant}{dimensions\+::\+Gravitational\+Constant}} $>$ gravitational\+\_\+constant)
\begin{DoxyCompactList}\small\item\em Fix a physical star by central enthalpy and density, including the incompressible n = 0 limit. \end{DoxyCompactList}\item
std\+::expected$<$ \mbox{\hyperlink{structserif_1_1utils_1_1laneemden_1_1_physical_scales}{Physical\+Scales}}, std\+::string $>$ \mbox{\hyperlink{namespaceserif_1_1utils_1_1laneemden_adf057a3c9420e9b4e92c20c89126d3fd}{serif\+::utils\+::laneemden\+::scale\+\_\+from\+\_\+polytropic\+\_\+constant}} (const \mbox{\hyperlink{structserif_1_1utils_1_1laneemden_1_1_solution}{Solution}} \&solution, double polytropic\+\_\+constant, \mbox{\hyperlink{classserif_1_1dimensions_1_1_quantity_value}{dimensions\+::\+Quantity\+Value}}$<$ \mbox{\hyperlink{structserif_1_1dimensions_1_1_mass_density}{dimensions\+::\+Mass\+Density}} $>$ central\+\_\+density, \mbox{\hyperlink{classserif_1_1dimensions_1_1_quantity_value}{dimensions\+::\+Quantity\+Value}}$<$ \mbox{\hyperlink{structserif_1_1dimensions_1_1_gravitational_constant}{dimensions\+::\+Gravitational\+Constant}} $>$ gravitational\+\_\+constant)
\begin{DoxyCompactList}\small\item\em Fix a polytropic EOS through its K and central density; n must be strictly positive. \end{DoxyCompactList}\item
std\+::expected$<$ \mbox{\hyperlink{structserif_1_1utils_1_1laneemden_1_1_physical_sample}{Physical\+Sample}}, std\+::string $>$ \mbox{\hyperlink{namespaceserif_1_1utils_1_1laneemden_aec2842a8929dc7a2b5dac2adf8a067b6}{serif\+::utils\+::laneemden\+::evaluate\+\_\+physical}} (const \mbox{\hyperlink{structserif_1_1utils_1_1laneemden_1_1_solution}{Solution}} \&solution, const \mbox{\hyperlink{structserif_1_1utils_1_1laneemden_1_1_physical_scales}{Physical\+Scales}} \&scales, \mbox{\hyperlink{classserif_1_1dimensions_1_1_quantity_value}{dimensions\+::\+Quantity\+Value}}$<$ \mbox{\hyperlink{structserif_1_1dimensions_1_1_length}{dimensions\+::\+Length}} $>$ radius)
\begin{DoxyCompactList}\small\item\em Evaluate physical fields, continuing into vacuum beyond the stellar surface. \end{DoxyCompactList}\end{DoxyCompactItemize}