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)
52 lines
5.2 KiB
TeX
52 lines
5.2 KiB
TeX
\doxysection{src/compile\+\_\+time\+\_\+checks/serif/model/barotropic\+\_\+density.cpp File Reference}
|
|
\hypertarget{barotropic__density_8cpp}{}\label{barotropic__density_8cpp}\index{src/compile\_time\_checks/serif/model/barotropic\_density.cpp@{src/compile\_time\_checks/serif/model/barotropic\_density.cpp}}
|
|
{\ttfamily \#include "{}serif/equations/angular\+\_\+momentum.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/equations/barotropic\+\_\+density.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/equations/mass\+\_\+normalization.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/equations/primal\+\_\+gravity.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/equations/surface\+\_\+potential.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/eos/models/polytropic.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/model/eos\+\_\+reference.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/model/execution\+\_\+validation.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/model/normalization/plan.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/solver/normalization/computations.\+hpp"{}}\newline
|
|
Include dependency graph for barotropic\+\_\+density.\+cpp\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{barotropic__density_8cpp__incl}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsubsection*{Classes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1compile__time__checks_1_1barotropic__density_1_1_mechanical_barotrope}{serif\+::compile\+\_\+time\+\_\+checks\+::barotropic\+\_\+density\+::\+Mechanical\+Barotrope}}
|
|
\begin{DoxyCompactList}\small\item\em Declare only the mechanical EOS capabilities; no enthalpy, polytropic parameters, or curvature is available. \end{DoxyCompactList}\item
|
|
struct \mbox{\hyperlink{structserif_1_1compile__time__checks_1_1barotropic__density_1_1_bound_description}{serif\+::compile\+\_\+time\+\_\+checks\+::barotropic\+\_\+density\+::\+Bound\+Description}}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Namespaces}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif}{serif}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1compile__time__checks}{serif\+::compile\+\_\+time\+\_\+checks}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1compile__time__checks_1_1barotropic__density}{serif\+::compile\+\_\+time\+\_\+checks\+::barotropic\+\_\+density}}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Typedefs}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
using \mbox{\hyperlink{namespaceserif_1_1compile__time__checks_1_1barotropic__density_a52dc2c7ec7e47a59821109263353c5af}{serif\+::compile\+\_\+time\+\_\+checks\+::barotropic\+\_\+density\+::\+Balance}} = \mbox{\hyperlink{classserif_1_1equations_1_1_barotropic_density_balance}{equations\+::\+Barotropic\+Density\+Balance}}$<$\mbox{\hyperlink{structserif_1_1compile__time__checks_1_1barotropic__density_1_1_mechanical_barotrope}{Mechanical\+Barotrope}}$>$
|
|
\item
|
|
using \mbox{\hyperlink{namespaceserif_1_1compile__time__checks_1_1barotropic__density_a45e090eb240b7c8b5bf3e792244b4a70}{serif\+::compile\+\_\+time\+\_\+checks\+::barotropic\+\_\+density\+::\+Borrowed\+Balance}} = \mbox{\hyperlink{classserif_1_1equations_1_1_barotropic_density_balance}{equations\+::\+Barotropic\+Density\+Balance}}$<$\mbox{\hyperlink{classserif_1_1model_1_1_eos_reference}{model\+::\+Eos\+Reference}}$<$\mbox{\hyperlink{structserif_1_1compile__time__checks_1_1barotropic__density_1_1_mechanical_barotrope}{Mechanical\+Barotrope}}$>$$>$
|
|
\item
|
|
using \mbox{\hyperlink{namespaceserif_1_1compile__time__checks_1_1barotropic__density_a5eb5ceeee35e59451ab2f22a787951d1}{serif\+::compile\+\_\+time\+\_\+checks\+::barotropic\+\_\+density\+::\+Registry}}
|
|
\item
|
|
using \mbox{\hyperlink{namespaceserif_1_1compile__time__checks_1_1barotropic__density_abcf0ecc3c6e160f9a9929b4bae23401e}{serif\+::compile\+\_\+time\+\_\+checks\+::barotropic\+\_\+density\+::\+Description}} = \mbox{\hyperlink{structserif_1_1model_1_1_equilibrium_equations}{model\+::\+Equilibrium\+Equations}}$<$\mbox{\hyperlink{namespaceserif_1_1compile__time__checks_1_1barotropic__density_a5eb5ceeee35e59451ab2f22a787951d1}{Registry}}, \mbox{\hyperlink{classserif_1_1equations_1_1_surface_potential_balance}{equations\+::\+Surface\+Potential\+Balance}}, \mbox{\hyperlink{namespaceserif_1_1geometry_1_1surface_a42dd706422c3b8c6838ea505ff1212b8}{geometry\+::surface\+::\+Isobaric}}$>$
|
|
\item
|
|
using \mbox{\hyperlink{namespaceserif_1_1compile__time__checks_1_1barotropic__density_a49c3bd254d7b793129cead31e1803890}{serif\+::compile\+\_\+time\+\_\+checks\+::barotropic\+\_\+density\+::\+Plan}} = \mbox{\hyperlink{structserif_1_1compile__time__checks_1_1barotropic__density_1_1_bound_description_a71898f6acc7d23bf0e15c99999eaa2ec}{Bound\+Description\+::\+Plan}}
|
|
\item
|
|
using \mbox{\hyperlink{namespaceserif_1_1compile__time__checks_1_1barotropic__density_a099be2c2fae687a7eb1c9ca1a5cfdb4e}{serif\+::compile\+\_\+time\+\_\+checks\+::barotropic\+\_\+density\+::\+Rules}} = \mbox{\hyperlink{namespaceserif_1_1model_1_1normalization_a20221d8368d5bf0b36f03e7755fc6d64}{model\+::normalization\+::\+Plan\+For}}$<$normalization\+::\+Automatic\+Plan, normalization\+::\+Dimensionless, \mbox{\hyperlink{structserif_1_1compile__time__checks_1_1barotropic__density_1_1_bound_description}{Bound\+Description}}$>$
|
|
\end{DoxyCompactItemize}
|