Files
MeanField_SERiF/docs/latex/catalog_8hpp.tex

56 lines
2.7 KiB
TeX
Raw Permalink Normal View History

\doxysection{src/include/serif/eos/relations/catalog.hpp File Reference}
\hypertarget{catalog_8hpp}{}\label{catalog_8hpp}\index{src/include/serif/eos/relations/catalog.hpp@{src/include/serif/eos/relations/catalog.hpp}}
File containing the Relation and Relation\+Catalog structs. These structs are used to represent relations between physical quantities and to group them into catalogs for use in EOS models.
{\ttfamily \#include "{}serif/utils/misc/concepts/type\+\_\+uniqueness.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/utils/misc/std\+\_\+helper/variadic\+\_\+cleaning.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/dimensions/quantities.\+hpp"{}}\newline
Include dependency graph for catalog.\+hpp\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{catalog_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]{catalog_8hpp__dep__incl}
\end{center}
\end{figure}
\doxysubsubsection*{Classes}
\begin{DoxyCompactItemize}
\item
struct \mbox{\hyperlink{structserif_1_1eos_1_1relations_1_1_relation}{serif\+::eos\+::relations\+::\+Relation$<$ Output, Inputs $>$}}
\begin{DoxyCompactList}\small\item\em A struct to represent a relation between physical quantities. This is used to define the relations that an EOS model supports. \end{DoxyCompactList}\item
struct \mbox{\hyperlink{structserif_1_1eos_1_1relations_1_1_relation_catalog}{serif\+::eos\+::relations\+::\+Relation\+Catalog$<$ Relations $>$}}
\begin{DoxyCompactList}\small\item\em A struct to represent a catalog of relations between physical quantities. This is used to group relations for use in EOS models. \end{DoxyCompactList}\end{DoxyCompactItemize}
\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*{Functions}
\begin{DoxyCompactItemize}
\item
{\footnotesize template$<$typename... Ts$>$ }\\consteval std\+::size\+\_\+t \mbox{\hyperlink{namespaceserif_1_1eos_1_1relations_a1b57d195e9d643b262222f5d50ed1dd0}{serif\+::eos\+::relations\+::\+Count\+Variadic\+Arguments}} () noexcept
\end{DoxyCompactItemize}
\doxysubsection{Detailed Description}
File containing the Relation and Relation\+Catalog structs. These structs are used to represent relations between physical quantities and to group them into catalogs for use in EOS models.
\begin{DoxyAuthor}{Author}
Emily M. Boudreaux
\end{DoxyAuthor}