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,46 @@
\doxysection{src/include/serif/backend/mfem/geometry/surface/pressure\+\_\+field\+\_\+block.hpp File Reference}
\hypertarget{pressure__field__block_8hpp}{}\label{pressure__field__block_8hpp}\index{src/include/serif/backend/mfem/geometry/surface/pressure\_field\_block.hpp@{src/include/serif/backend/mfem/geometry/surface/pressure\_field\_block.hpp}}
{\ttfamily \#include $<$cmath$>$}\newline
{\ttfamily \#include $<$memory$>$}\newline
{\ttfamily \#include $<$utility$>$}\newline
{\ttfamily \#include $<$vector$>$}\newline
{\ttfamily \#include "{}serif/backend/mfem/geometry/surface/boundary\+\_\+rows.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/backend/mfem/operators/replaced\+\_\+rows.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/utils/dependencies/key\+\_\+list\+\_\+operations.\+hpp"{}}\newline
Include dependency graph for pressure\+\_\+field\+\_\+block.\+hpp\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{pressure__field__block_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[height=550pt]{pressure__field__block_8hpp__dep__incl}
\end{center}
\end{figure}
\doxysubsubsection*{Namespaces}
\begin{DoxyCompactItemize}
\item
namespace \mbox{\hyperlink{namespaceserif}{serif}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1geometry}{serif\+::geometry}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1geometry_1_1surface}{serif\+::geometry\+::surface}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1geometry_1_1surface_1_1backend}{serif\+::geometry\+::surface\+::backend}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1geometry_1_1surface_1_1backend_1_1mfem}{serif\+::geometry\+::surface\+::backend\+::mfem}}
\end{DoxyCompactItemize}
\doxysubsubsection*{Functions}
\begin{DoxyCompactItemize}
\item
{\footnotesize template$<$typename Field, Pressure\+Boundary\+Formulation Formulation, typename Traces$>$ \newline
requires utils\+::dependencies\+::\+Contains\+Key$<$Field, typename Formulation\+::\+State\+Terms$>$}\\std\+::shared\+\_\+ptr$<$ const \+::mfem\+::\+Sparse\+Matrix $>$ \mbox{\hyperlink{namespaceserif_1_1geometry_1_1surface_1_1backend_1_1mfem_a7a699a99f4f03919e5b8693e1d435ed8}{serif\+::geometry\+::surface\+::backend\+::mfem\+::pressure\+\_\+field\+\_\+trace}} (const \mbox{\hyperlink{structserif_1_1geometry_1_1surface_1_1backend_1_1mfem_1_1_pressure_boundary}{Pressure\+Boundary}}$<$ Formulation, Traces $>$ \&boundary, const std\+::vector$<$ \mbox{\hyperlink{namespaceserif_1_1geometry_1_1surface_a38dcffacd50298452984a55e3c69b83a}{Surface\+Linearization}}$<$ Formulation $>$ $>$ \&linearizations)
\begin{DoxyCompactList}\small\item\em Freeze one EOS partial times its finite-\/element trace in selected boundary-\/row coordinates. \end{DoxyCompactList}\item
{\footnotesize template$<$typename Field, Pressure\+Boundary\+Formulation Formulation, typename Traces$>$ }\\\mbox{\hyperlink{classserif_1_1operators_1_1backend_1_1mfem_1_1_linearized_block}{operators\+::backend\+::mfem\+::\+Linearized\+Block}} \mbox{\hyperlink{namespaceserif_1_1geometry_1_1surface_1_1backend_1_1mfem_acbdc28a4e02b05f57cbe369e02cefc94}{serif\+::geometry\+::surface\+::backend\+::mfem\+::pressure\+\_\+field\+\_\+block}} (\mbox{\hyperlink{classserif_1_1operators_1_1backend_1_1mfem_1_1_linearized_block}{operators\+::backend\+::mfem\+::\+Linearized\+Block}} volume, const \mbox{\hyperlink{structserif_1_1geometry_1_1surface_1_1backend_1_1mfem_1_1_pressure_boundary}{Pressure\+Boundary}}$<$ Formulation, Traces $>$ \&boundary, const std\+::vector$<$ \mbox{\hyperlink{namespaceserif_1_1geometry_1_1surface_a38dcffacd50298452984a55e3c69b83a}{Surface\+Linearization}}$<$ Formulation $>$ $>$ \&linearizations)
\begin{DoxyCompactList}\small\item\em Install one field\textquotesingle{}s accepted isobaric derivative rows on its physical volume block. \end{DoxyCompactList}\end{DoxyCompactItemize}