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)
56 lines
3.5 KiB
TeX
56 lines
3.5 KiB
TeX
\doxysection{src/include/serif/eos/models/concepts.hpp File Reference}
|
|
\hypertarget{eos_2models_2concepts_8hpp}{}\label{eos_2models_2concepts_8hpp}\index{src/include/serif/eos/models/concepts.hpp@{src/include/serif/eos/models/concepts.hpp}}
|
|
|
|
|
|
File containing concepts for the eos module. These concepts are used to constrain template parameters in the eos module.
|
|
|
|
|
|
{\ttfamily \#include "{}serif/eos/models/traits.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/eos/relations/relations.\+hpp"{}}\newline
|
|
Include dependency graph for concepts.\+hpp\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{eos_2models_2concepts_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_2models_2concepts_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_1models}{serif\+::eos\+::models}}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Concepts}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
concept \mbox{\hyperlink{conceptserif_1_1eos_1_1models_1_1_e_o_s_model}{serif\+::eos\+::models\+::\+EOSModel}}
|
|
\begin{DoxyCompactList}\small\item\em A concept to determine if a type is an equation of state model. A type is a valid EOSModel if it satisfies the is\+\_\+equation\+\_\+of\+\_\+state\+\_\+model\+\_\+v trait. \end{DoxyCompactList}\item
|
|
concept \mbox{\hyperlink{conceptserif_1_1eos_1_1models_1_1_e_o_s_supporting_relation}{serif\+::eos\+::models\+::\+EOSSupporting\+Relation}}
|
|
\begin{DoxyCompactList}\small\item\em A concept to determine if a type is an equation of state model that supports a given relation. A type is a valid EOSSupporting\+Relation if it satisfies the supports\+\_\+relation\+\_\+v trait. \end{DoxyCompactList}\item
|
|
concept \mbox{\hyperlink{conceptserif_1_1eos_1_1models_1_1_e_o_s_supporting_partial_derivative}{serif\+::eos\+::models\+::\+EOSSupporting\+Partial\+Derivative}}
|
|
\begin{DoxyCompactList}\small\item\em A concept to determine if a type is an equation of state model that supports a given relation and a given input quantity. A type is a valid EOSSupporting\+Partial\+Derivative if it satisfies the supports\+\_\+partial\+\_\+derivative\+\_\+v trait. \end{DoxyCompactList}\item
|
|
concept \mbox{\hyperlink{conceptserif_1_1eos_1_1models_1_1_e_o_s_supporting_second_partial_derivative}{serif\+::eos\+::models\+::\+EOSSupporting\+Second\+Partial\+Derivative}}
|
|
\begin{DoxyCompactList}\small\item\em Require a declared EOS relation and its analytic second partial. \end{DoxyCompactList}\item
|
|
concept \mbox{\hyperlink{conceptserif_1_1eos_1_1models_1_1_structure_seed_e_o_s}{serif\+::eos\+::models\+::\+Structure\+Seed\+EOS}}
|
|
\begin{DoxyCompactList}\small\item\em A concept to determine if a type is an equation of state model that can be used in the current SERiF seed initialization system. This is satisfied for types that are both valid EOSModels and which also support the relation for computing specific enthalpy from density. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
|
|
|
|
\doxysubsection{Detailed Description}
|
|
File containing concepts for the eos module. These concepts are used to constrain template parameters in the eos module.
|
|
|
|
\begin{DoxyAuthor}{Author}
|
|
Emily M. Boudreaux
|
|
\end{DoxyAuthor}
|