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,59 @@
\doxysection{src/include/serif/backend/mfem/discretization/quadrature/mfem\+\_\+static\+\_\+order.hpp File Reference}
\hypertarget{mfem__static__order_8hpp}{}\label{mfem__static__order_8hpp}\index{src/include/serif/backend/mfem/discretization/quadrature/mfem\_static\_order.hpp@{src/include/serif/backend/mfem/discretization/quadrature/mfem\_static\_order.hpp}}
File containing the mfem\+\_\+form\+\_\+static\+\_\+order trait. This trait is used to determine the static order of an MFEM integrator for a given form type.
{\ttfamily \#include "{}serif/discretization/blocks/concepts.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/discretization/forms/operands.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/discretization/forms/concept.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/utils/types/type\+\_\+list.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/backend/mfem/discretization/quadrature/order.\+hpp"{}}\newline
Include dependency graph for mfem\+\_\+static\+\_\+order.\+hpp\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{mfem__static__order_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]{mfem__static__order_8hpp__dep__incl}
\end{center}
\end{figure}
\doxysubsubsection*{Classes}
\begin{DoxyCompactItemize}
\item
struct \mbox{\hyperlink{structserif_1_1discretization_1_1quadrature_1_1backend_1_1mfem_1_1_m_f_e_m_operand_list_order_3_cc28a4785da1749caa9ad5426658b10e}{serif\+::discretization\+::quadrature\+::backend\+::mfem\+::\+MFEMOperand\+List\+Order$<$ utils\+::types\+::\+Type\+List$<$ Operand\+Ts... $>$ $>$}}
\begin{DoxyCompactList}\small\item\em A specialization of the \doxylink{structserif_1_1discretization_1_1quadrature_1_1backend_1_1mfem_1_1_m_f_e_m_operand_list_order}{MFEMOperand\+List\+Order} struct for a list of operand types. This struct is used to compute the static order of an MFEM integrator for a given list of operands. \end{DoxyCompactList}\end{DoxyCompactItemize}
\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*{Variables}
\begin{DoxyCompactItemize}
\item
{\footnotesize template$<$forms\+::\+Form FormT$>$ }\\constexpr int \mbox{\hyperlink{namespaceserif_1_1discretization_1_1quadrature_1_1backend_1_1mfem_adc5eb9de9387b7b6d82b25593e2a12c8}{serif\+::discretization\+::quadrature\+::backend\+::mfem\+::mfem\+\_\+form\+\_\+static\+\_\+order}} = \mbox{\hyperlink{structserif_1_1discretization_1_1quadrature_1_1backend_1_1mfem_1_1_m_f_e_m_operand_list_order}{MFEMOperand\+List\+Order}}$<$typename Form\+T\+::operand\+\_\+types$>$\+::value
\begin{DoxyCompactList}\small\item\em A trait to determine the static order of an MFEM integrator for a given form type. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsection{Detailed Description}
File containing the mfem\+\_\+form\+\_\+static\+\_\+order trait. This trait is used to determine the static order of an MFEM integrator for a given form type.
\begin{DoxyAuthor}{Author}
Emily M. Boudreaux
\end{DoxyAuthor}