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

41
docs/latex/utils_8hpp.tex Normal file
View File

@@ -0,0 +1,41 @@
\doxysection{src/include/serif/discretization/domain/schema/utils.hpp File Reference}
\hypertarget{utils_8hpp}{}\label{utils_8hpp}\index{src/include/serif/discretization/domain/schema/utils.hpp@{src/include/serif/discretization/domain/schema/utils.hpp}}
File containing utility functions for working with Domain\+Schemas.
{\ttfamily \#include $<$mfem.\+hpp$>$}\newline
{\ttfamily \#include "{}serif/discretization/domain/concepts.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/discretization/domain/schema/concepts.\+hpp"{}}\newline
Include dependency graph for utils.\+hpp\+:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{utils_8hpp__incl}
\end{center}
\end{figure}
\doxysubsubsection*{Namespaces}
\begin{DoxyCompactItemize}
\item
namespace \mbox{\hyperlink{namespaceserif}{serif}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1discretization}{serif\+::discretization}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1discretization_1_1domain}{serif\+::discretization\+::domain}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1discretization_1_1domain_1_1schema}{serif\+::discretization\+::domain\+::schema}}
\end{DoxyCompactItemize}
\doxysubsubsection*{Functions}
\begin{DoxyCompactItemize}
\item
{\footnotesize template$<$Is\+Domain\+Or\+Set DomainT, Is\+Schema SchemaT$>$ }\\mfem\+::\+Array$<$ int $>$ \mbox{\hyperlink{namespaceserif_1_1discretization_1_1domain_1_1schema_a0a546d50196396de51e7480cb5e25145}{serif\+::discretization\+::domain\+::schema\+::make\+\_\+attribute\+\_\+marker}} (const mfem\+::\+Mesh \&mesh)
\begin{DoxyCompactList}\small\item\em Build the 0/1 marker array MFEM wants when an integrator or an essential BC should apply only on part of the mesh. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsection{Detailed Description}
File containing utility functions for working with Domain\+Schemas.
\begin{DoxyAuthor}{Author}
Emily M. Boudreaux
\end{DoxyAuthor}