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)
53 lines
2.9 KiB
TeX
53 lines
2.9 KiB
TeX
\doxysection{src/include/serif/eos/relations/concepts.hpp File Reference}
|
|
\hypertarget{eos_2relations_2concepts_8hpp}{}\label{eos_2relations_2concepts_8hpp}\index{src/include/serif/eos/relations/concepts.hpp@{src/include/serif/eos/relations/concepts.hpp}}
|
|
|
|
|
|
File containing concepts for the eos relations module. These concepts are used to constrain template parameters in the eos relations module.
|
|
|
|
|
|
{\ttfamily \#include "{}serif/eos/relations/traits.\+hpp"{}}\newline
|
|
Include dependency graph for concepts.\+hpp\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{eos_2relations_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_2relations_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_1relations}{serif\+::eos\+::relations}}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Concepts}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
concept \mbox{\hyperlink{conceptserif_1_1eos_1_1relations_1_1_catalog_containing_relation}{serif\+::eos\+::relations\+::\+Catalog\+Containing\+Relation}}
|
|
\begin{DoxyCompactList}\small\item\em A concept used to constrain a type to a catalog that contains a given relation. \end{DoxyCompactList}\item
|
|
concept \mbox{\hyperlink{conceptserif_1_1eos_1_1relations_1_1_relation_containing_input}{serif\+::eos\+::relations\+::\+Relation\+Containing\+Input}}
|
|
\begin{DoxyCompactList}\small\item\em A concept used to constrain a type to a relation that contains a given input quantity. \end{DoxyCompactList}\item
|
|
concept \mbox{\hyperlink{conceptserif_1_1eos_1_1relations_1_1_valid_thermodynamic_relation}{serif\+::eos\+::relations\+::\+Valid\+Thermodynamic\+Relation}}
|
|
\begin{DoxyCompactList}\small\item\em A concept used to constrain a type to a valid thermodynamic relation. A type is a valid thermodynamic relation if it satisfies the is\+\_\+thermodynamic\+\_\+relation\+\_\+v trait. \end{DoxyCompactList}\item
|
|
concept \mbox{\hyperlink{conceptserif_1_1eos_1_1relations_1_1_valid_relation_catalog}{serif\+::eos\+::relations\+::\+Valid\+Relation\+Catalog}}
|
|
\begin{DoxyCompactList}\small\item\em A concept used to constrain a type to a valid relation catalog. A type is a valid relation catalog if it satisfies the is\+\_\+valid\+\_\+relation\+\_\+catalog\+\_\+v trait. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
|
|
|
|
\doxysubsection{Detailed Description}
|
|
File containing concepts for the eos relations module. These concepts are used to constrain template parameters in the eos relations module.
|
|
|
|
\begin{DoxyAuthor}{Author}
|
|
Emily M. Boudreaux
|
|
\end{DoxyAuthor}
|