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.7 KiB
TeX
52 lines
5.7 KiB
TeX
\doxysection{src/include/serif/eos/evaluation.hpp File Reference}
|
|
\hypertarget{eos_2evaluation_8hpp}{}\label{eos_2evaluation_8hpp}\index{src/include/serif/eos/evaluation.hpp@{src/include/serif/eos/evaluation.hpp}}
|
|
|
|
|
|
File containing the evaluate and partial\+\_\+derivative functions. These functions are used to evaluate relations and partial derivatives for a given EOS model.
|
|
|
|
|
|
{\ttfamily \#include "{}serif/eos/models/concepts.\+hpp"{}}\newline
|
|
Include dependency graph for evaluation.\+hpp\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{eos_2evaluation_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_2evaluation_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}}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
{\footnotesize template$<$dimensions\+::\+Thermodynamic\+Quantity\+Type OutputQ, models\+::\+EOSModel EOS, dimensions\+::\+Quantity\+Value\+Type... Input\+Values$>$ \newline
|
|
requires models\+::\+EOSSupporting\+Relation$<$EOS, \mbox{\hyperlink{structserif_1_1eos_1_1relations_1_1_relation}{relations\+::\+Relation}}$<$OutputQ, \mbox{\hyperlink{namespaceserif_1_1dimensions_a726ea17ab3c500d045d2605915ecfcd6}{dimensions\+::\+Quantity\+OfT}}$<$Input\+Values$>$...$>$$>$}\\constexpr \mbox{\hyperlink{classserif_1_1dimensions_1_1_quantity_value}{dimensions\+::\+Quantity\+Value}}$<$ OutputQ $>$ \mbox{\hyperlink{namespaceserif_1_1eos_ade79763ef51f539b78059d8898a2d2a2}{serif\+::eos\+::evaluate}} (const EOS \&eos, const Input\+Values... input\+Values) noexcept(noexcept(eos.\+evaluate(\mbox{\hyperlink{structserif_1_1eos_1_1relations_1_1_relation}{relations\+::\+Relation}}$<$ OutputQ, \mbox{\hyperlink{namespaceserif_1_1dimensions_a726ea17ab3c500d045d2605915ecfcd6}{dimensions\+::\+Quantity\+OfT}}$<$ Input\+Values $>$... $>$\{\}, input\+Values...)))
|
|
\begin{DoxyCompactList}\small\item\em Evaluates a relation for a given EOS model. This function is used to evaluate relations for a given EOS model. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$dimensions\+::\+Thermodynamic\+Quantity\+Type OutputQ, dimensions\+::\+Thermodynamic\+Quantity\+Type InputQ, models\+::\+EOSModel EOS, dimensions\+::\+Quantity\+Value\+Type... Input\+Values$>$ \newline
|
|
requires models\+::\+EOSSupporting\+Partial\+Derivative$<$EOS, \mbox{\hyperlink{structserif_1_1eos_1_1relations_1_1_relation}{relations\+::\+Relation}}$<$OutputQ, \mbox{\hyperlink{namespaceserif_1_1dimensions_a726ea17ab3c500d045d2605915ecfcd6}{dimensions\+::\+Quantity\+OfT}}$<$Input\+Values$>$...$>$, InputQ$>$}\\constexpr \mbox{\hyperlink{classserif_1_1dimensions_1_1_partial_derivative}{dimensions\+::\+Partial\+Derivative}}$<$ OutputQ, InputQ $>$ \mbox{\hyperlink{namespaceserif_1_1eos_a2d0ca00b47c2dfa34d75bae9456fe390}{serif\+::eos\+::partial\+\_\+derivative}} (const EOS \&eos, const Input\+Values... input\+Values) noexcept(noexcept(eos.\+partial\+\_\+derivative(\mbox{\hyperlink{structserif_1_1eos_1_1relations_1_1_relation}{relations\+::\+Relation}}$<$ OutputQ, \mbox{\hyperlink{namespaceserif_1_1dimensions_a726ea17ab3c500d045d2605915ecfcd6}{dimensions\+::\+Quantity\+OfT}}$<$ Input\+Values $>$... $>$\{\}, \mbox{\hyperlink{structserif_1_1dimensions_1_1_with_respect_to}{dimensions\+::\+With\+Respect\+To}}$<$ InputQ $>$\{\}, input\+Values...)))
|
|
\begin{DoxyCompactList}\small\item\em Evaluates a partial derivative of a relation for a given EOS model. This function is used to evaluate partial derivatives of relations for a given EOS model. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$dimensions\+::\+Thermodynamic\+Quantity\+Type OutputQ, dimensions\+::\+Thermodynamic\+Quantity\+Type First\+Input, dimensions\+::\+Thermodynamic\+Quantity\+Type Second\+Input, models\+::\+EOSModel EOS, dimensions\+::\+Quantity\+Value\+Type... Input\+Values$>$ \newline
|
|
requires models\+::\+EOSSupporting\+Second\+Partial\+Derivative$<$EOS, \mbox{\hyperlink{structserif_1_1eos_1_1relations_1_1_relation}{relations\+::\+Relation}}$<$OutputQ, \mbox{\hyperlink{namespaceserif_1_1dimensions_a726ea17ab3c500d045d2605915ecfcd6}{dimensions\+::\+Quantity\+OfT}}$<$Input\+Values$>$...$>$, First\+Input, Second\+Input$>$}\\constexpr \mbox{\hyperlink{classserif_1_1dimensions_1_1_second_partial_derivative}{dimensions\+::\+Second\+Partial\+Derivative}}$<$ OutputQ, First\+Input, Second\+Input $>$ \mbox{\hyperlink{namespaceserif_1_1eos_ad41c8ebf0663a55e74ba55bc35e560b4}{serif\+::eos\+::second\+\_\+partial\+\_\+derivative}} (const EOS \&eos, const Input\+Values... input\+Values) noexcept(noexcept(eos.\+second\+\_\+partial\+\_\+derivative(\mbox{\hyperlink{structserif_1_1eos_1_1relations_1_1_relation}{relations\+::\+Relation}}$<$ OutputQ, \mbox{\hyperlink{namespaceserif_1_1dimensions_a726ea17ab3c500d045d2605915ecfcd6}{dimensions\+::\+Quantity\+OfT}}$<$ Input\+Values $>$... $>$\{\}, \mbox{\hyperlink{structserif_1_1dimensions_1_1_with_respect_to}{dimensions\+::\+With\+Respect\+To}}$<$ First\+Input $>$\{\}, \mbox{\hyperlink{structserif_1_1dimensions_1_1_with_respect_to}{dimensions\+::\+With\+Respect\+To}}$<$ Second\+Input $>$\{\}, input\+Values...)))
|
|
\begin{DoxyCompactList}\small\item\em Dispatch an analytic second partial without imposing an EOS-\/specific state. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
|
|
|
|
\doxysubsection{Detailed Description}
|
|
File containing the evaluate and partial\+\_\+derivative functions. These functions are used to evaluate relations and partial derivatives for a given EOS model.
|
|
|
|
\begin{DoxyAuthor}{Author}
|
|
Emily M. Boudreaux
|
|
\end{DoxyAuthor}
|