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)
22 lines
2.8 KiB
TeX
22 lines
2.8 KiB
TeX
\doxysection{src/include/serif/dimensions Directory Reference}
|
|
\hypertarget{dir_8ff718c0e05ebec7bd22ed9b2ac38248}{}\label{dir_8ff718c0e05ebec7bd22ed9b2ac38248}\index{src/include/serif/dimensions Directory Reference@{src/include/serif/dimensions Directory Reference}}
|
|
Directory dependency graph for dimensions\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=178pt]{dir_8ff718c0e05ebec7bd22ed9b2ac38248_dep}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsubsection*{Files}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
file \mbox{\hyperlink{dimensions_8hpp}{dimensions.\+hpp}}
|
|
\begin{DoxyCompactList}\small\item\em File containing prue dimensions. Note that this is not intended to be (nor does it have the capability to be) a general dimensional analysis library. There is no understanding here that, for example, a dimension of length\texorpdfstring{$^\wedge$}{\string^}2 is an area. Rather, the purpose of this is to force developers to be explicit about what values they are passing to what functions. Further, most of this system is built to be compile time constant. This means that the compiler can still apply many optimizations. Note that the dimensions here do not contain a value, rather these are {\itshape just} the concept of a dimension. To store a value you must use a Quantity and Quantity\+Value. \end{DoxyCompactList}\item
|
|
file \mbox{\hyperlink{partial_8hpp}{partial.\+hpp}}
|
|
\begin{DoxyCompactList}\small\item\em Compile time tools to represent a partial derivative of one quantity wrt. another quantity. Note that this system is not responsible for computing partials or in fact derivatives of any kind. Rather, it is responsible for forcing the developer --- or compiler at least --- to ask for a specific, explicit, partial and have to spell out what that is. That in turn gives the compiler enough information to do a lot of downstream things. A motivating example would be automatic verification of the provided EOS against all partials that might be needed to ensure they are all exported by the EOS. \end{DoxyCompactList}\item
|
|
file \mbox{\hyperlink{quantities_8hpp}{quantities.\+hpp}}
|
|
\begin{DoxyCompactList}\small\item\em This file contains the code to associate numeric data to a dimension. We call this a Quantity and a Quantity\+Value. \end{DoxyCompactList}\item
|
|
file \mbox{\hyperlink{type__alias_8hpp}{type\+\_\+alias.\+hpp}}
|
|
\begin{DoxyCompactList}\small\item\em This file contains type aliases for the dimensions and quantities used in the discretization. This is solely useful in so far as it means we do not need to type out the longer Quantity\+Value$<$\+Dimension$>$ type for each of the dimensions and quantities used in the discretization. This is a convenience file that is used to make the code more readable and maintainable. \end{DoxyCompactList}\end{DoxyCompactItemize}
|