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)
48 lines
1.7 KiB
TeX
48 lines
1.7 KiB
TeX
\doxysection{src/include/serif/equations/rigid\+\_\+rotation.hpp File Reference}
|
|
\hypertarget{rigid__rotation_8hpp}{}\label{rigid__rotation_8hpp}\index{src/include/serif/equations/rigid\_rotation.hpp@{src/include/serif/equations/rigid\_rotation.hpp}}
|
|
|
|
|
|
An equation implementing rigid rotation.
|
|
|
|
|
|
{\ttfamily \#include $<$cmath$>$}\newline
|
|
{\ttfamily \#include $<$stdexcept$>$}\newline
|
|
{\ttfamily \#include "{}serif/discretization/forms/value.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/utils/error/errors.\+hpp"{}}\newline
|
|
Include dependency graph for rigid\+\_\+rotation.\+hpp\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{rigid__rotation_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]{rigid__rotation_8hpp__dep__incl}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsubsection*{Classes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
class \mbox{\hyperlink{classserif_1_1equations_1_1_rigid_rotation}{serif\+::equations\+::\+Rigid\+Rotation}}
|
|
\begin{DoxyCompactList}\small\item\em A class that implements rigid rotation, providing methods to compute the centrifugal potential, its gradient, and its Hessian. \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}
|
|
An equation implementing rigid rotation.
|
|
|
|
\begin{DoxyAuthor}{Author}
|
|
Emily M. Boudreaux
|
|
\end{DoxyAuthor}
|