Files
MeanField_SERiF/docs/latex/solver_2normalization_2configuration_8hpp.tex

66 lines
6.5 KiB
TeX
Raw Normal View History

\doxysection{src/include/serif/solver/normalization/configuration.hpp File Reference}
\hypertarget{solver_2normalization_2configuration_8hpp}{}\label{solver_2normalization_2configuration_8hpp}\index{src/include/serif/solver/normalization/configuration.hpp@{src/include/serif/solver/normalization/configuration.hpp}}
{\ttfamily \#include $<$concepts$>$}\newline
{\ttfamily \#include $<$expected$>$}\newline
{\ttfamily \#include $<$string$>$}\newline
{\ttfamily \#include $<$tuple$>$}\newline
{\ttfamily \#include $<$utility$>$}\newline
{\ttfamily \#include "{}serif/dimensions/type\+\_\+alias.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/solver/normalization/scales.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/utils/dependencies/dependency\+\_\+context.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/utils/laneemden/laneemden.\+hpp"{}}\newline
Include dependency graph for configuration.\+hpp\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{solver_2normalization_2configuration_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]{solver_2normalization_2configuration_8hpp__dep__incl}
\end{center}
\end{figure}
\doxysubsubsection*{Classes}
\begin{DoxyCompactItemize}
\item
struct \mbox{\hyperlink{structserif_1_1solver_1_1normalization_1_1_from_model}{serif\+::solver\+::normalization\+::\+From\+Model}}
\begin{DoxyCompactList}\small\item\em Obtain a reference value from the corresponding descriptive model prescription. \end{DoxyCompactList}\item
struct \mbox{\hyperlink{structserif_1_1solver_1_1normalization_1_1_automatic_plan}{serif\+::solver\+::normalization\+::\+Automatic\+Plan}}
\begin{DoxyCompactList}\small\item\em Derive the coordinate rules from the selected fields, equations and boundary formulation. \end{DoxyCompactList}\item
struct \mbox{\hyperlink{structserif_1_1solver_1_1normalization_1_1_dimensionless}{serif\+::solver\+::normalization\+::\+Dimensionless}}
\begin{DoxyCompactList}\small\item\em Remove physical and geometric units from the solver\textquotesingle{}s coordinates and norms. \end{DoxyCompactList}\item
struct \mbox{\hyperlink{structserif_1_1solver_1_1normalization_1_1_lane_emden_approximation}{serif\+::solver\+::normalization\+::\+Lane\+Emden\+Approximation$<$ Mass, Central\+Density $>$}}
\begin{DoxyCompactList}\small\item\em Estimate a reference radius from a Lane–\+Emden shape, mass and central density. \end{DoxyCompactList}\item
struct \mbox{\hyperlink{structserif_1_1solver_1_1normalization_1_1_normalization_options}{serif\+::solver\+::normalization\+::\+Normalization\+Options$<$ Scheme, Coordinates, Plan, Sources, Computations $>$}}
\begin{DoxyCompactList}\small\item\em Declare normalization without evaluating a reference star or allocating coordinate factors. \end{DoxyCompactList}\end{DoxyCompactItemize}
\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_1normalization}{serif\+::solver\+::normalization}}
\end{DoxyCompactItemize}
\doxysubsubsection*{Concepts}
\begin{DoxyCompactItemize}
\item
concept \mbox{\hyperlink{conceptserif_1_1solver_1_1normalization_1_1_reference_scheme}{serif\+::solver\+::normalization\+::\+Reference\+Scheme}}
\begin{DoxyCompactList}\small\item\em A custom stellar reference strategy supplies the same typed scales and ordinary failure value. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsubsection*{Functions}
\begin{DoxyCompactItemize}
\item
{\footnotesize template$<$typename Scheme, typename Coordinates, typename Plan, typename Sources, typename Computations$>$ }\\auto \mbox{\hyperlink{namespaceserif_1_1solver_1_1normalization_a58791243c886657505170066c10584ab}{serif\+::solver\+::normalization\+::make\+\_\+normalization}} (\mbox{\hyperlink{structserif_1_1solver_1_1normalization_1_1_normalization_options}{Normalization\+Options}}$<$ Scheme, Coordinates, Plan, Sources, Computations $>$ options)
\begin{DoxyCompactList}\small\item\em Preserve the deduced numerical choices for later preparation with a model and discretization. \end{DoxyCompactList}\item
auto \mbox{\hyperlink{namespaceserif_1_1solver_1_1normalization_aabc0313890d07ed3a2e0afd47597dcef}{serif\+::solver\+::normalization\+::make\+\_\+normalization}} ()
\begin{DoxyCompactList}\small\item\em Select the usual dimensionless Lane–\+Emden reference; supply its central density before resolving it against a model. \end{DoxyCompactList}\item
std\+::expected$<$ \mbox{\hyperlink{structserif_1_1solver_1_1normalization_1_1_stellar_reference_scales}{Stellar\+Reference\+Scales}}, std\+::string $>$ \mbox{\hyperlink{namespaceserif_1_1solver_1_1normalization_a1a787fb498a34fbc3def51c8bfddde35}{serif\+::solver\+::normalization\+::prepare\+\_\+reference\+\_\+scales}} (const \mbox{\hyperlink{structserif_1_1solver_1_1normalization_1_1_lane_emden_approximation}{Lane\+Emden\+Approximation}}$<$ \mbox{\hyperlink{namespaceserif_1_1dimensions_a66499323cee57a1033e7b203a9198c24}{dimensions\+::\+Mass\+Value}}, \mbox{\hyperlink{namespaceserif_1_1dimensions_af7f8c68a704a7bf475c60dbad5f98d78}{dimensions\+::\+Density\+Value}} $>$ \&scheme, \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 Derive the shared stellar scales after both dimensional reference inputs have been resolved. \end{DoxyCompactList}\item
std\+::expected$<$ \mbox{\hyperlink{structserif_1_1solver_1_1normalization_1_1_stellar_reference_scales}{Stellar\+Reference\+Scales}}, std\+::string $>$ \mbox{\hyperlink{namespaceserif_1_1solver_1_1normalization_ac1e9d275253e074720b819188ef1b8c6}{serif\+::solver\+::normalization\+::prepare\+\_\+reference\+\_\+scales}} (const \mbox{\hyperlink{structserif_1_1solver_1_1normalization_1_1_stellar_reference_scales}{Stellar\+Reference\+Scales}} \&reference, \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 Use explicitly prepared reference scales through the same graph as estimated references. \end{DoxyCompactList}\end{DoxyCompactItemize}