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,48 @@
\doxysection{src/include/serif/backend/mfem/discretization/reconstruction.hpp File Reference}
\hypertarget{reconstruction_8hpp}{}\label{reconstruction_8hpp}\index{src/include/serif/backend/mfem/discretization/reconstruction.hpp@{src/include/serif/backend/mfem/discretization/reconstruction.hpp}}
{\ttfamily \#include $<$memory$>$}\newline
{\ttfamily \#include $<$vector$>$}\newline
{\ttfamily \#include "{}mfem/fem/fe/fe\+\_\+base.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/discretization/blocks/fields.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/discretization/reconstruction/surface\+\_\+power.\+hpp"{}}\newline
Include dependency graph for reconstruction.\+hpp\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{reconstruction_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]{reconstruction_8hpp__dep__incl}
\end{center}
\end{figure}
\doxysubsubsection*{Classes}
\begin{DoxyCompactItemize}
\item
struct \mbox{\hyperlink{structserif_1_1discretization_1_1backend_1_1mfem_1_1_element_reconstruction}{serif\+::discretization\+::backend\+::mfem\+::\+Element\+Reconstruction}}
\begin{DoxyCompactList}\small\item\em An element\textquotesingle{}s radial reconstruction; the enclosing plan owns its profile. \end{DoxyCompactList}\item
class \mbox{\hyperlink{classserif_1_1discretization_1_1backend_1_1mfem_1_1_reconstruction_plan}{serif\+::discretization\+::backend\+::mfem\+::\+Reconstruction\+Plan}}
\begin{DoxyCompactList}\small\item\em Immutable reconstruction selected on material-\/side surface elements and validated against their interfaces. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsubsection*{Namespaces}
\begin{DoxyCompactItemize}
\item
namespace \mbox{\hyperlink{namespacemfem}{mfem}}
\item
namespace \mbox{\hyperlink{namespaceserif}{serif}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1discretization}{serif\+::discretization}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1discretization_1_1backend}{serif\+::discretization\+::backend}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1discretization_1_1backend_1_1mfem}{serif\+::discretization\+::backend\+::mfem}}
\end{DoxyCompactItemize}
\doxysubsubsection*{Functions}
\begin{DoxyCompactItemize}
\item
{\footnotesize template$<$typename Term, typename Binding$>$ }\\std\+::shared\+\_\+ptr$<$ const \mbox{\hyperlink{classserif_1_1discretization_1_1backend_1_1mfem_1_1_reconstruction_plan}{Reconstruction\+Plan}} $>$ \mbox{\hyperlink{namespaceserif_1_1discretization_1_1backend_1_1mfem_a2295d9e8ec9934e4b1dd6690822ee9b8}{serif\+::discretization\+::backend\+::mfem\+::make\+\_\+reconstruction}} (const \mbox{\hyperlink{structserif_1_1discretization_1_1reconstruction_1_1_surface_power}{reconstruction\+::\+Surface\+Power}}$<$ Term $>$ \&specification, const Binding \&binding)
\begin{DoxyCompactList}\small\item\em Resolve a surface-\/power request against a typed binding before publishing the discretization. \end{DoxyCompactList}\end{DoxyCompactItemize}