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)
49 lines
1.9 KiB
TeX
49 lines
1.9 KiB
TeX
\doxysection{src/include/serif/equations/mass\+\_\+normalization.hpp File Reference}
|
|
\hypertarget{mass__normalization_8hpp}{}\label{mass__normalization_8hpp}\index{src/include/serif/equations/mass\_normalization.hpp@{src/include/serif/equations/mass\_normalization.hpp}}
|
|
|
|
|
|
File containing the mass normalization equation, which enforces a global constraint on the total mass of a system.
|
|
|
|
|
|
{\ttfamily \#include $<$cmath$>$}\newline
|
|
{\ttfamily \#include $<$string\+\_\+view$>$}\newline
|
|
{\ttfamily \#include "{}serif/equations/contributions.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/equations/point.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/utils/error/errors.\+hpp"{}}\newline
|
|
Include dependency graph for mass\+\_\+normalization.\+hpp\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{mass__normalization_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]{mass__normalization_8hpp__dep__incl}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsubsection*{Classes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
class \mbox{\hyperlink{classserif_1_1equations_1_1_mass_normalization}{serif\+::equations\+::\+Mass\+Normalization}}
|
|
\begin{DoxyCompactList}\small\item\em Mass normalization equation, which enforces a global constraint on the total mass of a system. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Namespaces}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif}{serif}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1equations}{serif\+::equations}}
|
|
\end{DoxyCompactItemize}
|
|
|
|
|
|
\doxysubsection{Detailed Description}
|
|
File containing the mass normalization equation, which enforces a global constraint on the total mass of a system.
|
|
|
|
\begin{DoxyAuthor}{Author}
|
|
Emily M. Boudreaux
|
|
\end{DoxyAuthor}
|