tboudreaux/MeanField_SERiF
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(docs): built docs

Browse Source 
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:
Emily Boudreaux
2026-11-09 14:09:44 -05:00
parent d9c4919477
commit 6b57738330
32596 changed files with 4155414 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

80
docs/latex/model_2normalization_2plan_8hpp.tex Normal file
View File

@@ -0,0 +1,80 @@
\doxysection{src/include/serif/model/normalization/plan.hpp File Reference}
\hypertarget{model_2normalization_2plan_8hpp}{}\label{model_2normalization_2plan_8hpp}\index{src/include/serif/model/normalization/plan.hpp@{src/include/serif/model/normalization/plan.hpp}}
{\ttfamily \#include "{}serif/model/equilibrium\+\_\+plan.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/solver/normalization/configuration.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/solver/normalization/physical\+\_\+coordinates.\+hpp"{}}\newline
Include dependency graph for plan.\+hpp\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{model_2normalization_2plan_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]{model_2normalization_2plan_8hpp__dep__incl}
\end{center}
\end{figure}
\doxysubsubsection*{Classes}
\begin{DoxyCompactItemize}
\item
struct \mbox{\hyperlink{structserif_1_1model_1_1normalization_1_1_surface_rows}{serif\+::model\+::normalization\+::\+Surface\+Rows}}
\begin{DoxyCompactList}\small\item\em Reduced equation rows whose volume residual is replaced by the selected surface condition. \end{DoxyCompactList}\item
struct \mbox{\hyperlink{structserif_1_1model_1_1normalization_1_1_infinity_rows}{serif\+::model\+::normalization\+::\+Infinity\+Rows}}
\begin{DoxyCompactList}\small\item\em Potential rows replaced by the zero trace at compactified infinity. \end{DoxyCompactList}\item
struct \mbox{\hyperlink{structserif_1_1model_1_1normalization_1_1detail_1_1_metric}{serif\+::model\+::normalization\+::detail\+::\+Metric$<$ Term, Spatial $>$}}
\item
struct \mbox{\hyperlink{structserif_1_1model_1_1normalization_1_1detail_1_1_metric_3_01_term_00_01true_01_4}{serif\+::model\+::normalization\+::detail\+::\+Metric$<$ Term, true $>$}}
\item
struct \mbox{\hyperlink{structserif_1_1model_1_1normalization_1_1detail_1_1_value_rule}{serif\+::model\+::normalization\+::detail\+::\+Value\+Rule$<$ Coordinates, Term $>$}}
\item
struct \mbox{\hyperlink{structserif_1_1model_1_1normalization_1_1detail_1_1_value_rule_3_01_coordinates_00_01blocks_1_1s6181de8228cf67ac62b0bb26ce893d18}{serif\+::model\+::normalization\+::detail\+::\+Value\+Rule$<$ Coordinates, blocks\+::surface\+\_\+deformation\+::coefficients $>$}}
\item
struct \mbox{\hyperlink{structserif_1_1model_1_1normalization_1_1detail_1_1_surface_rule}{serif\+::model\+::normalization\+::detail\+::\+Surface\+Rule$<$ Method, Row, Plan, Surface $>$}}
\item
struct \mbox{\hyperlink{structserif_1_1model_1_1normalization_1_1detail_1_1_surface_rule_3_01_method_00_01_row_00_01_plan_00_01true_01_4}{serif\+::model\+::normalization\+::detail\+::\+Surface\+Rule$<$ Method, Row, Plan, true $>$}}
\item
struct \mbox{\hyperlink{structserif_1_1model_1_1normalization_1_1detail_1_1_infinity_rule}{serif\+::model\+::normalization\+::detail\+::\+Infinity\+Rule$<$ Method, Row, Plan $>$}}
\begin{DoxyCompactList}\small\item\em Pointwise infinity values have potential units rather than integrated Poisson units. \end{DoxyCompactList}\item
struct \mbox{\hyperlink{structserif_1_1model_1_1normalization_1_1detail_1_1_residual_rules_3_01dependencies_1_1_bindings8ae21b420e3ee2d2d8fefb8d9e1c0a2d}{serif\+::model\+::normalization\+::detail\+::\+Residual\+Rules$<$ dependencies\+::\+Bindings$<$ Interior... $>$, dependencies\+::\+Bindings$<$ Shape... $>$ $>$}}
\item
struct \mbox{\hyperlink{structserif_1_1model_1_1normalization_1_1detail_1_1_automatic_rules_3_01_coordinates_00_01_plan_2165af7291a01b342399f3d4c91269bc}{serif\+::model\+::normalization\+::detail\+::\+Automatic\+Rules$<$ Coordinates, Plan, dependencies\+::\+Key\+List$<$ Values... $>$, utils\+::types\+::\+Type\+List$<$ Equations... $>$ $>$}}
\begin{DoxyCompactList}\small\item\em Equation residual quantities remain independent from the unknowns occupying their rows. \end{DoxyCompactList}\item
struct \mbox{\hyperlink{structserif_1_1model_1_1normalization_1_1detail_1_1_select_plan}{serif\+::model\+::normalization\+::detail\+::\+Select\+Plan$<$ Selection, Coordinates, Bound $>$}}
\item
struct \mbox{\hyperlink{structserif_1_1model_1_1normalization_1_1detail_1_1_select_plan_3_01numerical_1_1_automatic_plan623b68464037961175cd0cd5497a8533}{serif\+::model\+::normalization\+::detail\+::\+Select\+Plan$<$ numerical\+::\+Automatic\+Plan, Coordinates, Bound $>$}}
\item
struct \mbox{\hyperlink{structserif_1_1model_1_1normalization_1_1detail_1_1_method_metrics}{serif\+::model\+::normalization\+::detail\+::\+Method\+Metrics$<$ Method $>$}}
\item
struct \mbox{\hyperlink{structserif_1_1model_1_1normalization_1_1detail_1_1_method_metrics_3_01numerical_1_1_physical_ri59e7e5d30bf277ed2aa8ca08965e58d5}{serif\+::model\+::normalization\+::detail\+::\+Method\+Metrics$<$ numerical\+::\+Physical\+Riesz\+Coordinate$<$ Quantity, Metric $>$ $>$}}
\item
struct \mbox{\hyperlink{structserif_1_1model_1_1normalization_1_1detail_1_1_method_metrics_3_01numerical_1_1_dimensionle77eb4298faeedf634410387693165bcc}{serif\+::model\+::normalization\+::detail\+::\+Method\+Metrics$<$ numerical\+::\+Dimensionless\+Riesz\+Coordinate$<$ Quantity, Metric, Geometry $>$ $>$}}
\item
struct \mbox{\hyperlink{structserif_1_1model_1_1normalization_1_1detail_1_1_method_metrics_3_01numerical_1_1_with_point_0f74fae7b838e6c6114b73e0ab3c53a7}{serif\+::model\+::normalization\+::detail\+::\+Method\+Metrics$<$ numerical\+::\+With\+Point\+Rows$<$ Method, Quantity, Selection $>$ $>$}}
\item
struct \mbox{\hyperlink{structserif_1_1model_1_1normalization_1_1detail_1_1_rule_metrics_3_01dependencies_1_1_bindings_3_01_rules_8_8_8_01_4_01_4}{serif\+::model\+::normalization\+::detail\+::\+Rule\+Metrics$<$ dependencies\+::\+Bindings$<$ Rules... $>$ $>$}}
\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_1normalization}{serif\+::model\+::normalization}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1model_1_1normalization_1_1detail}{serif\+::model\+::normalization\+::detail}}
\end{DoxyCompactItemize}
\doxysubsubsection*{Typedefs}
\begin{DoxyCompactItemize}
\item
{\footnotesize template$<$typename Coordinates, typename Quantity, typename \mbox{\hyperlink{structserif_1_1model_1_1normalization_1_1detail_1_1_metric}{Metric}}$>$ }\\using \mbox{\hyperlink{namespaceserif_1_1model_1_1normalization_1_1detail_af648340a894464602b52db78f895be2f}{serif\+::model\+::normalization\+::detail\+::\+Coordinate}} = numerical\+::\+Dimensionless\+Riesz\+Coordinate$<$Quantity, \mbox{\hyperlink{structserif_1_1model_1_1normalization_1_1detail_1_1_metric}{Metric}}$>$
\item
{\footnotesize template$<$typename Selection, typename Coordinates, typename Bound$>$ }\\using \mbox{\hyperlink{namespaceserif_1_1model_1_1normalization_a20221d8368d5bf0b36f03e7755fc6d64}{serif\+::model\+::normalization\+::\+Plan\+For}} = typename \mbox{\hyperlink{structserif_1_1model_1_1normalization_1_1detail_1_1_select_plan}{detail\+::\+Select\+Plan}}$<$Selection, Coordinates, Bound$>$\+::\+Type
\begin{DoxyCompactList}\small\item\em Compile automatic physics-\/aware rules or retain the user\textquotesingle{}s complete explicit plan. \end{DoxyCompactList}\item
{\footnotesize template$<$typename Plan$>$ }\\using \mbox{\hyperlink{namespaceserif_1_1model_1_1normalization_a9bca7844875f31e08df105bc8da44c69}{serif\+::model\+::normalization\+::\+Metrics\+For}}
\begin{DoxyCompactList}\small\item\em Assemble each metric once even when several state and residual rules share it. \end{DoxyCompactList}\end{DoxyCompactItemize}