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)
44 lines
5.2 KiB
TeX
44 lines
5.2 KiB
TeX
\doxysection{src/compile\+\_\+time\+\_\+checks/serif/eos/consumers\+\_\+meanfield.cpp File Reference}
|
|
\hypertarget{consumers__meanfield_8cpp}{}\label{consumers__meanfield_8cpp}\index{src/compile\_time\_checks/serif/eos/consumers\_meanfield.cpp@{src/compile\_time\_checks/serif/eos/consumers\_meanfield.cpp}}
|
|
{\ttfamily \#include "{}serif/eos/models/concepts.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/eos/models/polytropic.\+hpp"{}}\newline
|
|
Include dependency graph for consumers\+\_\+meanfield.\+cpp\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{consumers__meanfield_8cpp__incl}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsubsection*{Classes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1compile__time__checks_1_1eos__meanfield_1_1consumer__contracts_1_1_single_relation_e_o_s}{serif\+::compile\+\_\+time\+\_\+checks\+::eos\+\_\+meanfield\+::consumer\+\_\+contracts\+::\+Single\+Relation\+EOS$<$ Output, Input, Has\+Derivative $>$}}
|
|
\begin{DoxyCompactList}\small\item\em Describe exactly one EOS relation; unrelated consumer capabilities remain absent. \end{DoxyCompactList}\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_1eos__meanfield}{serif\+::compile\+\_\+time\+\_\+checks\+::eos\+\_\+meanfield}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1compile__time__checks_1_1eos__meanfield_1_1consumer__contracts}{serif\+::compile\+\_\+time\+\_\+checks\+::eos\+\_\+meanfield\+::consumer\+\_\+contracts}}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Typedefs}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
using \mbox{\hyperlink{namespaceserif_1_1compile__time__checks_1_1eos__meanfield_1_1consumer__contracts_a5f258cc5a4b85dc7a7949e10cad7084b}{serif\+::compile\+\_\+time\+\_\+checks\+::eos\+\_\+meanfield\+::consumer\+\_\+contracts\+::\+Density\+Closure}} = \mbox{\hyperlink{structserif_1_1compile__time__checks_1_1eos__meanfield_1_1consumer__contracts_1_1_single_relation_e_o_s}{Single\+Relation\+EOS}}$<$\mbox{\hyperlink{structserif_1_1dimensions_1_1_mass_density}{dimensions\+::\+Mass\+Density}}, \mbox{\hyperlink{structserif_1_1dimensions_1_1_specific_enthalpy}{dimensions\+::\+Specific\+Enthalpy}}, true$>$
|
|
\item
|
|
using \mbox{\hyperlink{namespaceserif_1_1compile__time__checks_1_1eos__meanfield_1_1consumer__contracts_a75980261f5a0175a1b2c1e780f624d33}{serif\+::compile\+\_\+time\+\_\+checks\+::eos\+\_\+meanfield\+::consumer\+\_\+contracts\+::\+Density\+Without\+Derivative}} = \mbox{\hyperlink{structserif_1_1compile__time__checks_1_1eos__meanfield_1_1consumer__contracts_1_1_single_relation_e_o_s}{Single\+Relation\+EOS}}$<$\mbox{\hyperlink{structserif_1_1dimensions_1_1_mass_density}{dimensions\+::\+Mass\+Density}}, \mbox{\hyperlink{structserif_1_1dimensions_1_1_specific_enthalpy}{dimensions\+::\+Specific\+Enthalpy}}, false$>$
|
|
\item
|
|
using \mbox{\hyperlink{namespaceserif_1_1compile__time__checks_1_1eos__meanfield_1_1consumer__contracts_a019dfbd0bd9705fdee7cc016987a5136}{serif\+::compile\+\_\+time\+\_\+checks\+::eos\+\_\+meanfield\+::consumer\+\_\+contracts\+::\+Enthalpy\+Pressure}} = \mbox{\hyperlink{structserif_1_1compile__time__checks_1_1eos__meanfield_1_1consumer__contracts_1_1_single_relation_e_o_s}{Single\+Relation\+EOS}}$<$\mbox{\hyperlink{structserif_1_1dimensions_1_1_pressure}{dimensions\+::\+Pressure}}, \mbox{\hyperlink{structserif_1_1dimensions_1_1_specific_enthalpy}{dimensions\+::\+Specific\+Enthalpy}}, true$>$
|
|
\item
|
|
using \mbox{\hyperlink{namespaceserif_1_1compile__time__checks_1_1eos__meanfield_1_1consumer__contracts_adeddbb2f8c97ea992abe15ed82e90600}{serif\+::compile\+\_\+time\+\_\+checks\+::eos\+\_\+meanfield\+::consumer\+\_\+contracts\+::\+Density\+Seed}} = \mbox{\hyperlink{structserif_1_1compile__time__checks_1_1eos__meanfield_1_1consumer__contracts_1_1_single_relation_e_o_s}{Single\+Relation\+EOS}}$<$\mbox{\hyperlink{structserif_1_1dimensions_1_1_specific_enthalpy}{dimensions\+::\+Specific\+Enthalpy}}, \mbox{\hyperlink{structserif_1_1dimensions_1_1_mass_density}{dimensions\+::\+Mass\+Density}}, false$>$
|
|
\item
|
|
using \mbox{\hyperlink{namespaceserif_1_1compile__time__checks_1_1eos__meanfield_1_1consumer__contracts_adb153b7d333b7ffe2fab9dfc0fb3912c}{serif\+::compile\+\_\+time\+\_\+checks\+::eos\+\_\+meanfield\+::consumer\+\_\+contracts\+::\+General\+EOS}} = \mbox{\hyperlink{structserif_1_1compile__time__checks_1_1eos__meanfield_1_1consumer__contracts_1_1_single_relation_e_o_s}{Single\+Relation\+EOS}}$<$\mbox{\hyperlink{structserif_1_1dimensions_1_1_specific_enthalpy}{dimensions\+::\+Specific\+Enthalpy}}, \mbox{\hyperlink{structserif_1_1dimensions_1_1_pressure}{dimensions\+::\+Pressure}}, false$>$
|
|
\item
|
|
using \mbox{\hyperlink{namespaceserif_1_1compile__time__checks_1_1eos__meanfield_1_1consumer__contracts_a8ac71c7158ec3a4593d2ba4dbda594e3}{serif\+::compile\+\_\+time\+\_\+checks\+::eos\+\_\+meanfield\+::consumer\+\_\+contracts\+::\+Density\+From\+Enthalpy}} = \mbox{\hyperlink{namespaceserif_1_1eos_1_1relations_a537de2b3f7c974159bc5639b831117c4}{eos\+::relations\+::\+Density\+From\+Specific\+Enthalpy}}
|
|
\end{DoxyCompactItemize}
|