Emily Boudreaux
6b57738330
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)
65 lines
4.4 KiB
TeX
65 lines
4.4 KiB
TeX
\doxysection{src/include/serif/solver/normalization/metrics.hpp File Reference}
|
|
\hypertarget{metrics_8hpp}{}\label{metrics_8hpp}\index{src/include/serif/solver/normalization/metrics.hpp@{src/include/serif/solver/normalization/metrics.hpp}}
|
|
{\ttfamily \#include $<$concepts$>$}\newline
|
|
{\ttfamily \#include $<$type\+\_\+traits$>$}\newline
|
|
{\ttfamily \#include "{}serif/discretization/blocks/concepts.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/utils/dependencies/key\+\_\+list\+\_\+operations.\+hpp"{}}\newline
|
|
Include dependency graph for metrics.\+hpp\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{metrics_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]{metrics_8hpp__dep__incl}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsubsection*{Classes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1solver_1_1normalization_1_1_unit_metric}{serif\+::solver\+::normalization\+::\+Unit\+Metric}}
|
|
\begin{DoxyCompactList}\small\item\em A unit Gram metric for algebraic coordinates, still subject to physical scaling. \end{DoxyCompactList}\item
|
|
struct \mbox{\hyperlink{structserif_1_1solver_1_1normalization_1_1_reference_volume_metric}{serif\+::solver\+::normalization\+::\+Reference\+Volume\+Metric$<$ Term\+T $>$}}
|
|
\begin{DoxyCompactList}\small\item\em Identify a reference volume metric by its physical term, including its support and FE representation. \end{DoxyCompactList}\item
|
|
struct \mbox{\hyperlink{structserif_1_1solver_1_1normalization_1_1_metric_coordinates}{serif\+::solver\+::normalization\+::\+Metric\+Coordinates$<$ Metric\+T, typename $>$}}
|
|
\begin{DoxyCompactList}\small\item\em Metric keys advertise the coordinate identities they measure; a same-\/sized unrelated metric is insufficient. \end{DoxyCompactList}\item
|
|
struct \mbox{\hyperlink{structserif_1_1solver_1_1normalization_1_1_metric_coordinates_3_01_metric_t_00_01std_1_1void__t_7159054dec962eec3c70ff59a02679f9}{serif\+::solver\+::normalization\+::\+Metric\+Coordinates$<$ Metric\+T, std\+::void\+\_\+t$<$ typename Metric\+T\+::\+Coordinates $>$ $>$}}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1solver_1_1normalization_1_1_metric_coordinates_3_01_unit_metric_01_4}{serif\+::solver\+::normalization\+::\+Metric\+Coordinates$<$ Unit\+Metric $>$}}
|
|
\begin{DoxyCompactList}\small\item\em Permit a Euclidean norm of algebraic surface moments after their measure is made dimensionless. \end{DoxyCompactList}\item
|
|
struct \mbox{\hyperlink{structserif_1_1solver_1_1normalization_1_1_metric_coordinates_3_01geometry_1_1deformation_1_1keys_1_1_surface_metric_01_4}{serif\+::solver\+::normalization\+::\+Metric\+Coordinates$<$ geometry\+::deformation\+::keys\+::\+Surface\+Metric $>$}}
|
|
\begin{DoxyCompactList}\small\item\em Consume deformation\textquotesingle{}s existing metric directly in both native shape-\/coordinate roles. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
\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_1deformation}{serif\+::geometry\+::deformation}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1geometry_1_1deformation_1_1keys}{serif\+::geometry\+::deformation\+::keys}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1solver}{serif\+::solver}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1solver_1_1normalization}{serif\+::solver\+::normalization}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1solver_1_1normalization_1_1detail}{serif\+::solver\+::normalization\+::detail}}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Concepts}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
concept \mbox{\hyperlink{conceptserif_1_1solver_1_1normalization_1_1_metric_for}{serif\+::solver\+::normalization\+::\+Metric\+For}}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
{\footnotesize template$<$typename CoordinateT$>$ }\\consteval auto \mbox{\hyperlink{namespaceserif_1_1solver_1_1normalization_1_1detail_a2f6cffdd5ccfeb1a81f6f54c10c5f4f3}{serif\+::solver\+::normalization\+::detail\+::metric\+\_\+term}} ()
|
|
\begin{DoxyCompactList}\small\item\em Resolve assembled row identity without confusing a point-\/border row with its sampled field. \end{DoxyCompactList}\end{DoxyCompactItemize}
|