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)
51 lines
2.1 KiB
TeX
51 lines
2.1 KiB
TeX
\doxysection{src/include/serif/equations/centering.hpp File Reference}
|
|
\hypertarget{centering_8hpp}{}\label{centering_8hpp}\index{src/include/serif/equations/centering.hpp@{src/include/serif/equations/centering.hpp}}
|
|
|
|
|
|
File containing the Centering\+Constraint equation, which fixes the material point at the computational origin.
|
|
|
|
|
|
{\ttfamily \#include $<$array$>$}\newline
|
|
{\ttfamily \#include $<$string\+\_\+view$>$}\newline
|
|
{\ttfamily \#include "{}serif/equations/contributions.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/equations/point.\+hpp"{}}\newline
|
|
Include dependency graph for centering.\+hpp\+:\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{centering_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]{centering_8hpp__dep__incl}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsubsection*{Classes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1equations_1_1_centering_constraint}{serif\+::equations\+::\+Centering\+Constraint}}
|
|
\begin{DoxyCompactList}\small\item\em \doxylink{conceptserif_1_1equations_1_1_equation}{Equation} that fixes the material point at the computational origin. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Namespaces}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif}{serif}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1equations}{serif\+::equations}}
|
|
\begin{DoxyCompactList}\small\item\em The equations namespace, intended to be, to the best of my design ability, where the vast majority of the actual physics lives. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
|
|
|
|
\doxysubsection{Detailed Description}
|
|
File containing the Centering\+Constraint equation, which fixes the material point at the computational origin.
|
|
|
|
\begin{DoxyAuthor}{Author}
|
|
Emily M. Boudreaux
|
|
\end{DoxyAuthor}
|
|
|
|
|
|
\begin{DoxyNote}{Note}
|
|
This is probably the simplest equation we have right now and therefore may serve as a useful example to learn from.
|
|
\end{DoxyNote}
|