Files
MeanField_SERiF/docs/latex/dir_1cd4bc29af7d9f4b3445a3b3eda8de98.tex

40 lines
3.4 KiB
TeX
Raw Normal View History

\doxysection{src/include/serif/equations Directory Reference}
\hypertarget{dir_1cd4bc29af7d9f4b3445a3b3eda8de98}{}\label{dir_1cd4bc29af7d9f4b3445a3b3eda8de98}\index{src/include/serif/equations Directory Reference@{src/include/serif/equations Directory Reference}}
Directory dependency graph for equations\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{dir_1cd4bc29af7d9f4b3445a3b3eda8de98_dep}
\end{center}
\end{figure}
\doxysubsubsection*{Files}
\begin{DoxyCompactItemize}
\item
file \mbox{\hyperlink{angular__momentum_8hpp}{angular\+\_\+momentum.\+hpp}}
\begin{DoxyCompactList}\small\item\em File containing the angular momentum constraint equation, which enforces a global constraint on the total angular momentum of a system. \end{DoxyCompactList}\item
file \mbox{\hyperlink{barotropic__density_8hpp}{barotropic\+\_\+density.\+hpp}}
\item
file \mbox{\hyperlink{barycenter_8hpp}{barycenter.\+hpp}}
\item
file \mbox{\hyperlink{companion_8hpp}{companion.\+hpp}}
\item
file \mbox{\hyperlink{equations_2concepts_8hpp}{concepts.\+hpp}}
\begin{DoxyCompactList}\small\item\em Concepts for equations, contributions, and pointwise evaluation. \end{DoxyCompactList}\item
file \mbox{\hyperlink{equations_2contributions_8hpp}{contributions.\+hpp}}
\begin{DoxyCompactList}\small\item\em File containing the Contribution struct. This is effectively a helper struct for authoring equations with fewer lines of boiler-\/plate. The idea here is that every equation must report certain members so that the backend can inspect at compile time. An author could certainly write these members themselves, but the Contribution struct auto generates those members based on its template parameters. Therefore, by inheriting from the Contribution struct an equation author can avoid writing those members themselves. Note that while this is inheritance it is still a compile-\/time relation. Contribution does not add any runtime overhead to the equation. \end{DoxyCompactList}\item
file \mbox{\hyperlink{equations_2equations_8hpp}{equations.\+hpp}}
\begin{DoxyCompactList}\small\item\em File containing the equations module. This module contains the equations used in the SERiF framework. \end{DoxyCompactList}\item
file \mbox{\hyperlink{mass__normalization_8hpp}{mass\+\_\+normalization.\+hpp}}
\begin{DoxyCompactList}\small\item\em File containing the mass normalization equation, which enforces a global constraint on the total mass of a system. \end{DoxyCompactList}\item
file \mbox{\hyperlink{point_8hpp}{point.\+hpp}}
\begin{DoxyCompactList}\small\item\em File containing the definitions of the Equation\+Point and Point\+Linearization structs, which are used to represent the values and derivatives of operands at a given point in space. \end{DoxyCompactList}\item
file \mbox{\hyperlink{primal__gravity_8hpp}{primal\+\_\+gravity.\+hpp}}
\item
file \mbox{\hyperlink{registry_8hpp}{registry.\+hpp}}
\begin{DoxyCompactList}\small\item\em System for registering multiple equations. The idea here is that a model will be defined partly by an equation registry (e.\+g. all the equations that must be satisfied for a given model). \end{DoxyCompactList}\item
file \mbox{\hyperlink{rigid__rotation_8hpp}{rigid\+\_\+rotation.\+hpp}}
\begin{DoxyCompactList}\small\item\em An equation implementing rigid rotation. \end{DoxyCompactList}\item
file \mbox{\hyperlink{equations_2surface__potential_8hpp}{surface\+\_\+potential.\+hpp}}
\end{DoxyCompactItemize}