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)
36 lines
1.9 KiB
TeX
36 lines
1.9 KiB
TeX
\doxysection{src/include/serif/equations/hydrostatic\+\_\+equilibrium.hpp File Reference}
|
|
\hypertarget{hydrostatic__equilibrium_8hpp}{}\label{hydrostatic__equilibrium_8hpp}\index{src/include/serif/equations/hydrostatic\_equilibrium.hpp@{src/include/serif/equations/hydrostatic\_equilibrium.hpp}}
|
|
{\ttfamily \#include $<$algorithm$>$}\newline
|
|
{\ttfamily \#include $<$cmath$>$}\newline
|
|
{\ttfamily \#include $<$string\+\_\+view$>$}\newline
|
|
{\ttfamily \#include "{}serif/discretization/blocks/fields.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/equations/point.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/equations/rigid\+\_\+rotation.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/utils/error/errors.\+hpp"{}}\newline
|
|
Include dependency graph for hydrostatic\+\_\+equilibrium.\+hpp\+:\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{hydrostatic__equilibrium_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]{hydrostatic__equilibrium_8hpp__dep__incl}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsubsection*{Classes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
class \mbox{\hyperlink{classserif_1_1equations_1_1_barotropic_hydrostatic_equilibrium}{serif\+::equations\+::\+Barotropic\+Hydrostatic\+Equilibrium}}
|
|
\begin{DoxyCompactList}\small\item\em The constraint balancing the pressure gradient, gravitational potential, and centrifugal potential. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Namespaces}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif}{serif}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1equations}{serif\+::equations}}
|
|
\begin{DoxyCompactList}\small\item\em The equations namespace, intended to be, to the best of my design ability, where the vast majority of the actual physics lives. \end{DoxyCompactList}\end{DoxyCompactItemize}
|