docs(docs): built docs

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)
This commit is contained in:
2026-11-09 14:09:44 -05:00
parent d9c4919477
commit 6b57738330
32596 changed files with 4155414 additions and 0 deletions

View File

@@ -0,0 +1,49 @@
\doxysection{src/include/serif/backend/mfem/mapping/compactification/variation.hpp File Reference}
\hypertarget{compactification_2variation_8hpp}{}\label{compactification_2variation_8hpp}\index{src/include/serif/backend/mfem/mapping/compactification/variation.hpp@{src/include/serif/backend/mfem/mapping/compactification/variation.hpp}}
File containing the structures for the variation of the compactification mapping.
{\ttfamily \#include "{}mfem/linalg/vector.\+hpp"{}}\newline
{\ttfamily \#include "{}mfem/linalg/densemat.\+hpp"{}}\newline
Include dependency graph for variation.\+hpp\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=344pt]{compactification_2variation_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]{compactification_2variation_8hpp__dep__incl}
\end{center}
\end{figure}
\doxysubsubsection*{Classes}
\begin{DoxyCompactItemize}
\item
struct \mbox{\hyperlink{structserif_1_1mapping_1_1compactification_1_1_exterior_map_direction}{serif\+::mapping\+::compactification\+::\+Exterior\+Map\+Direction}}
\begin{DoxyCompactList}\small\item\em Structure representing the direction of the variation in the exterior domain mapping. This includes the variation of the displaced position and the variation of the displacement Jacobian. \end{DoxyCompactList}\item
struct \mbox{\hyperlink{structserif_1_1mapping_1_1compactification_1_1_exterior_map_variation}{serif\+::mapping\+::compactification\+::\+Exterior\+Map\+Variation}}
\begin{DoxyCompactList}\small\item\em Structure representing the variation of the exterior domain mapping. This includes the variation of the physical position and the variation of the mapping Jacobian. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsubsection*{Namespaces}
\begin{DoxyCompactItemize}
\item
namespace \mbox{\hyperlink{namespaceserif}{serif}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1mapping}{serif\+::mapping}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1mapping_1_1compactification}{serif\+::mapping\+::compactification}}
\end{DoxyCompactItemize}
\doxysubsection{Detailed Description}
File containing the structures for the variation of the compactification mapping.
\begin{DoxyAuthor}{Author}
Emily M. Boudreaux
\end{DoxyAuthor}