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)
60 lines
5.4 KiB
TeX
60 lines
5.4 KiB
TeX
\doxysection{src/include/serif/eos/relations/relations.hpp File Reference}
|
|
\hypertarget{eos_2relations_2relations_8hpp}{}\label{eos_2relations_2relations_8hpp}\index{src/include/serif/eos/relations/relations.hpp@{src/include/serif/eos/relations/relations.hpp}}
|
|
|
|
|
|
File containing the thermodynamic relations used in the eos module. These relations are used to compute various thermodynamic quantities from other quantities.
|
|
|
|
|
|
{\ttfamily \#include "{}serif/eos/relations/catalog.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/dimensions/dimensions.\+hpp"{}}\newline
|
|
Include dependency graph for relations.\+hpp\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{eos_2relations_2relations_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]{eos_2relations_2relations_8hpp__dep__incl}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsubsection*{Namespaces}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif}{serif}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1eos}{serif\+::eos}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1eos_1_1relations}{serif\+::eos\+::relations}}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Typedefs}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
using \mbox{\hyperlink{namespaceserif_1_1eos_1_1relations_ac555319520c74d14fb945024aefe4dfd}{serif\+::eos\+::relations\+::\+Pressure\+From\+Density}} = \mbox{\hyperlink{structserif_1_1eos_1_1relations_1_1_relation}{Relation}}$<$\mbox{\hyperlink{structserif_1_1dimensions_1_1_pressure}{dimensions\+::\+Pressure}}, \mbox{\hyperlink{structserif_1_1dimensions_1_1_mass_density}{dimensions\+::\+Mass\+Density}}$>$
|
|
\begin{DoxyCompactList}\small\item\em A relation to compute pressure from density. \end{DoxyCompactList}\item
|
|
using \mbox{\hyperlink{namespaceserif_1_1eos_1_1relations_a8b0ab5938c9b254628f6acb2c84389f5}{serif\+::eos\+::relations\+::\+Density\+From\+Pressure}} = \mbox{\hyperlink{structserif_1_1eos_1_1relations_1_1_relation}{Relation}}$<$\mbox{\hyperlink{structserif_1_1dimensions_1_1_mass_density}{dimensions\+::\+Mass\+Density}}, \mbox{\hyperlink{structserif_1_1dimensions_1_1_pressure}{dimensions\+::\+Pressure}}$>$
|
|
\begin{DoxyCompactList}\small\item\em A relation to compute density at a prescribed pressure. \end{DoxyCompactList}\item
|
|
using \mbox{\hyperlink{namespaceserif_1_1eos_1_1relations_a43e126ea01a149f642ba5e3c6aebf4f3}{serif\+::eos\+::relations\+::\+Pressure\+Potential\+From\+Density}} = \mbox{\hyperlink{structserif_1_1eos_1_1relations_1_1_relation}{Relation}}$<$\mbox{\hyperlink{structserif_1_1dimensions_1_1_barotropic_pressure_potential}{dimensions\+::\+Barotropic\+Pressure\+Potential}}, \mbox{\hyperlink{structserif_1_1dimensions_1_1_mass_density}{dimensions\+::\+Mass\+Density}}$>$
|
|
\begin{DoxyCompactList}\small\item\em Evaluate A(density), whose derivative on the positive barotropic branch is (d\+P/density)/density. \end{DoxyCompactList}\item
|
|
using \mbox{\hyperlink{namespaceserif_1_1eos_1_1relations_ae7cf9462c33962f4ade777ea5a560670}{serif\+::eos\+::relations\+::\+Pressure\+From\+Specific\+Enthalpy}} = \mbox{\hyperlink{structserif_1_1eos_1_1relations_1_1_relation}{Relation}}$<$\mbox{\hyperlink{structserif_1_1dimensions_1_1_pressure}{dimensions\+::\+Pressure}}, \mbox{\hyperlink{structserif_1_1dimensions_1_1_specific_enthalpy}{dimensions\+::\+Specific\+Enthalpy}}$>$
|
|
\begin{DoxyCompactList}\small\item\em A relation to compute pressure from specific enthalpy. \end{DoxyCompactList}\item
|
|
using \mbox{\hyperlink{namespaceserif_1_1eos_1_1relations_ad3bc12d4673999d6b90a6c3d9838ae52}{serif\+::eos\+::relations\+::\+Specific\+Enthalpy\+From\+Density}} = \mbox{\hyperlink{structserif_1_1eos_1_1relations_1_1_relation}{Relation}}$<$\mbox{\hyperlink{structserif_1_1dimensions_1_1_specific_enthalpy}{dimensions\+::\+Specific\+Enthalpy}}, \mbox{\hyperlink{structserif_1_1dimensions_1_1_mass_density}{dimensions\+::\+Mass\+Density}}$>$
|
|
\begin{DoxyCompactList}\small\item\em A relation to compute specific enthalpy from density. \end{DoxyCompactList}\item
|
|
using \mbox{\hyperlink{namespaceserif_1_1eos_1_1relations_aaf50999b585768be908f8da3e50fcea9}{serif\+::eos\+::relations\+::\+Specific\+Enthalpy\+From\+Pressure}} = \mbox{\hyperlink{structserif_1_1eos_1_1relations_1_1_relation}{Relation}}$<$\mbox{\hyperlink{structserif_1_1dimensions_1_1_specific_enthalpy}{dimensions\+::\+Specific\+Enthalpy}}, \mbox{\hyperlink{structserif_1_1dimensions_1_1_pressure}{dimensions\+::\+Pressure}}$>$
|
|
\begin{DoxyCompactList}\small\item\em A relation to compute specific enthalpy from pressure. \end{DoxyCompactList}\item
|
|
using \mbox{\hyperlink{namespaceserif_1_1eos_1_1relations_a537de2b3f7c974159bc5639b831117c4}{serif\+::eos\+::relations\+::\+Density\+From\+Specific\+Enthalpy}} = \mbox{\hyperlink{structserif_1_1eos_1_1relations_1_1_relation}{Relation}}$<$\mbox{\hyperlink{structserif_1_1dimensions_1_1_mass_density}{dimensions\+::\+Mass\+Density}}, \mbox{\hyperlink{structserif_1_1dimensions_1_1_specific_enthalpy}{dimensions\+::\+Specific\+Enthalpy}}$>$
|
|
\begin{DoxyCompactList}\small\item\em A relation to compute density from specific enthalpy. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
|
|
|
|
\doxysubsection{Detailed Description}
|
|
File containing the thermodynamic relations used in the eos module. These relations are used to compute various thermodynamic quantities from other quantities.
|
|
|
|
\begin{DoxyAuthor}{Author}
|
|
Emily M. Boudreaux
|
|
\end{DoxyAuthor}
|