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,51 @@
\doxysection{src/include/serif/model/computations/point\+\_\+constraints.hpp File Reference}
\hypertarget{point__constraints_8hpp}{}\label{point__constraints_8hpp}\index{src/include/serif/model/computations/point\_constraints.hpp@{src/include/serif/model/computations/point\_constraints.hpp}}
{\ttfamily \#include $<$limits$>$}\newline
{\ttfamily \#include $<$memory$>$}\newline
{\ttfamily \#include $<$tuple$>$}\newline
{\ttfamily \#include $<$type\+\_\+traits$>$}\newline
{\ttfamily \#include $<$utility$>$}\newline
{\ttfamily \#include $<$vector$>$}\newline
{\ttfamily \#include "{}serif/discretization/blocks/system\+\_\+layout.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/model/computations/interior.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/operators/backend/mfem/linearized\+\_\+block.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/operators/backend/mfem/nodal\+\_\+computations.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/operators/backend/mfem/point\+\_\+border.\+hpp"{}}\newline
Include dependency graph for point\+\_\+constraints.\+hpp\+:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{point__constraints_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=348pt]{point__constraints_8hpp__dep__incl}
\end{center}
\end{figure}
\doxysubsubsection*{Classes}
\begin{DoxyCompactItemize}
\item
struct \mbox{\hyperlink{structserif_1_1model_1_1computations_1_1_point_constraint_contribution}{serif\+::model\+::computations\+::\+Point\+Constraint\+Contribution$<$ Scope $>$}}
\begin{DoxyCompactList}\small\item\em Identify an affine point constraint independently of its carrier equation. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsubsection*{Namespaces}
\begin{DoxyCompactItemize}
\item
namespace \mbox{\hyperlink{namespaceserif}{serif}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1model}{serif\+::model}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1model_1_1computations}{serif\+::model\+::computations}}
\end{DoxyCompactItemize}
\doxysubsubsection*{Functions}
\begin{DoxyCompactItemize}
\item
{\footnotesize template$<$operators\+::backend\+::mfem\+::\+Affine\+Point\+Equation Equation, typename Discretization$>$ }\\auto \mbox{\hyperlink{namespaceserif_1_1model_1_1computations_a2eabbe2235856dcd00f55ad11646ab40}{serif\+::model\+::computations\+::point\+\_\+constraint\+\_\+discretization}} (const Equation \&, const Discretization \&discretization)
\begin{DoxyCompactList}\small\item\em Select the declared physical point using the model\textquotesingle{}s existing carrier and border bindings. \end{DoxyCompactList}\item
{\footnotesize template$<$typename Scope, typename Equation, typename Schema, discretization\+::blocks\+::\+System\+Layout\+Type Layout$>$ }\\auto \mbox{\hyperlink{namespaceserif_1_1model_1_1computations_a7bcc6674f47293ad74513c06c136d300}{serif\+::model\+::computations\+::point\+\_\+constraint\+\_\+contribution}} (Layout layout)
\begin{DoxyCompactList}\small\item\em Convert one accepted affine point border into physical residual and sparse off-\/diagonal blocks. \end{DoxyCompactList}\item
{\footnotesize template$<$typename Scope = void, operators\+::backend\+::mfem\+::\+Affine\+Point\+Equation Equation, typename Schema, discretization\+::blocks\+::\+System\+Layout\+Type Layout$>$ \newline
requires utils\+::dependencies\+::\+Contains\+Key$<$typename Equation\+::\+Test, typename Layout\+::\+Values$>$ \&\& utils\+::dependencies\+::\+Contains\+Key$<$typename Equation\+::\+Test, typename Layout\+::\+Residuals$>$ \&\& utils\+::dependencies\+::\+Contains\+Key$<$typename Equation\+::\+Border, typename Layout\+::\+Values$>$ \&\& utils\+::dependencies\+::\+Contains\+Key$<$typename Equation\+::\+Border, typename Layout\+::\+Residuals$>$}\\auto \mbox{\hyperlink{namespaceserif_1_1model_1_1computations_afc5a24222d49c1192e52d3e07921db16}{serif\+::model\+::computations\+::make\+\_\+point\+\_\+constraint\+\_\+computations}} (Equation equation, const \mbox{\hyperlink{structserif_1_1operators_1_1backend_1_1mfem_1_1_point_border_discretization}{operators\+::backend\+::mfem\+::\+Point\+Border\+Discretization}}$<$ Equation, Schema $>$ \&discretization, Layout layout)
\begin{DoxyCompactList}\small\item\em Add the existing nodal stages and their contribution to the model\textquotesingle{}s one dependency graph. \end{DoxyCompactList}\end{DoxyCompactItemize}