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,47 @@
\doxysection{src/include/serif/backend/mfem/operators/element\+\_\+data.hpp File Reference}
\hypertarget{element__data_8hpp}{}\label{element__data_8hpp}\index{src/include/serif/backend/mfem/operators/element\_data.hpp@{src/include/serif/backend/mfem/operators/element\_data.hpp}}
{\ttfamily \#include $<$array$>$}\newline
{\ttfamily \#include $<$memory$>$}\newline
{\ttfamily \#include $<$vector$>$}\newline
{\ttfamily \#include "{}mfem/fem/intrules.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/backend/mfem/mapping/volume\+\_\+cache.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/backend/mfem/mapping/data.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/backend/mfem/discretization/basis\+\_\+evaluation.\+hpp"{}}\newline
Include dependency graph for element\+\_\+data.\+hpp\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{element__data_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]{element__data_8hpp__dep__incl}
\end{center}
\end{figure}
\doxysubsubsection*{Classes}
\begin{DoxyCompactItemize}
\item
struct \mbox{\hyperlink{structserif_1_1operators_1_1backend_1_1mfem_1_1_element_basis}{serif\+::operators\+::backend\+::mfem\+::\+Element\+Basis$<$ Operand\+Count $>$}}
\begin{DoxyCompactList}\small\item\em Fixed-\/mesh basis samples; independent of the current coefficient values and displacement. \end{DoxyCompactList}\item
struct \mbox{\hyperlink{structserif_1_1operators_1_1backend_1_1mfem_1_1_element_geometry}{serif\+::operators\+::backend\+::mfem\+::\+Element\+Geometry$<$ Operand\+Count $>$}}
\begin{DoxyCompactList}\small\item\em Physical mapping and mapped bases for one frozen displacement. \end{DoxyCompactList}\item
struct \mbox{\hyperlink{structserif_1_1operators_1_1backend_1_1mfem_1_1_element_data}{serif\+::operators\+::backend\+::mfem\+::\+Element\+Data$<$ Operand\+Count $>$}}
\begin{DoxyCompactList}\small\item\em Weighted equation data retains the exact basis, geometry, and samples used to compute it. \end{DoxyCompactList}\item
class \mbox{\hyperlink{classserif_1_1operators_1_1backend_1_1mfem_1_1_basis_evaluation}{serif\+::operators\+::backend\+::mfem\+::\+Basis\+Evaluation}}
\begin{DoxyCompactList}\small\item\em Represents an element-\/local basis evaluation operator, supporting dense or tensor contractions, pointwise mappings, and transpose application. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsubsection*{Namespaces}
\begin{DoxyCompactItemize}
\item
namespace \mbox{\hyperlink{namespaceserif}{serif}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1operators}{serif\+::operators}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1operators_1_1backend}{serif\+::operators\+::backend}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1operators_1_1backend_1_1mfem}{serif\+::operators\+::backend\+::mfem}}
\end{DoxyCompactItemize}