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,54 @@
\doxysection{src/include/serif/discretization/quadrature/backend/mfem/concepts.hpp File Reference}
\hypertarget{discretization_2quadrature_2backend_2mfem_2concepts_8hpp}{}\label{discretization_2quadrature_2backend_2mfem_2concepts_8hpp}\index{src/include/serif/discretization/quadrature/backend/mfem/concepts.hpp@{src/include/serif/discretization/quadrature/backend/mfem/concepts.hpp}}
File containing concepts for the quadrature backend module. These concepts are used to constrain template parameters in the quadrature backend module.
{\ttfamily \#include "{}mfem/fem/intrules.\+hpp"{}}\newline
Include dependency graph for concepts.\+hpp\+:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=274pt]{discretization_2quadrature_2backend_2mfem_2concepts_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]{discretization_2quadrature_2backend_2mfem_2concepts_8hpp__dep__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_1quadrature}{serif\+::discretization\+::quadrature}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1discretization_1_1quadrature_1_1backend}{serif\+::discretization\+::quadrature\+::backend}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1discretization_1_1quadrature_1_1backend_1_1mfem}{serif\+::discretization\+::quadrature\+::backend\+::mfem}}
\end{DoxyCompactItemize}
\doxysubsubsection*{Concepts}
\begin{DoxyCompactItemize}
\item
concept \mbox{\hyperlink{conceptserif_1_1discretization_1_1quadrature_1_1backend_1_1mfem_1_1_has_reference_set_integration_rule}{serif\+::discretization\+::quadrature\+::backend\+::mfem\+::\+Has\+Reference\+Set\+Integration\+Rule}}
\begin{DoxyCompactList}\small\item\em A Has\+Reference\+Set\+Integration\+Rule is an integrator that can be configured with a reference to an integration rule. \end{DoxyCompactList}\item
concept \mbox{\hyperlink{conceptserif_1_1discretization_1_1quadrature_1_1backend_1_1mfem_1_1_has_pointer_set_integration_rule}{serif\+::discretization\+::quadrature\+::backend\+::mfem\+::\+Has\+Pointer\+Set\+Integration\+Rule}}
\begin{DoxyCompactList}\small\item\em A Has\+Pointer\+Set\+Integration\+Rule is an integrator that can be configured with a pointer to an integration rule. \end{DoxyCompactList}\item
concept \mbox{\hyperlink{conceptserif_1_1discretization_1_1quadrature_1_1backend_1_1mfem_1_1_has_set_int_rule}{serif\+::discretization\+::quadrature\+::backend\+::mfem\+::\+Has\+Set\+Int\+Rule}}
\begin{DoxyCompactList}\small\item\em A Has\+Set\+Int\+Rule is an integrator that can be configured with an integration rule by value. \end{DoxyCompactList}\item
concept \mbox{\hyperlink{conceptserif_1_1discretization_1_1quadrature_1_1backend_1_1mfem_1_1_configurable_integrator}{serif\+::discretization\+::quadrature\+::backend\+::mfem\+::\+Configurable\+Integrator}}
\begin{DoxyCompactList}\small\item\em A Configurable\+Integrator is an integrator that can be configured with an integration rule in some way (either by reference, by pointer, or by value). \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsection{Detailed Description}
File containing concepts for the quadrature backend module. These concepts are used to constrain template parameters in the quadrature backend module.
\begin{DoxyAuthor}{Author}
Emily M. Boudreaux
\end{DoxyAuthor}