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)
45 lines
3.6 KiB
TeX
45 lines
3.6 KiB
TeX
\doxysection{src/include/serif/solver/normalization/physical\+\_\+coordinates.hpp File Reference}
|
|
\hypertarget{physical__coordinates_8hpp}{}\label{physical__coordinates_8hpp}\index{src/include/serif/solver/normalization/physical\_coordinates.hpp@{src/include/serif/solver/normalization/physical\_coordinates.hpp}}
|
|
{\ttfamily \#include $<$concepts$>$}\newline
|
|
{\ttfamily \#include $<$type\+\_\+traits$>$}\newline
|
|
{\ttfamily \#include "{}serif/solver/normalization/plan.\+hpp"{}}\newline
|
|
Include dependency graph for physical\+\_\+coordinates.\+hpp\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{physical__coordinates_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]{physical__coordinates_8hpp__dep__incl}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsubsection*{Namespaces}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif}{serif}}
|
|
\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*{Typedefs}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
{\footnotesize template$<$discretization\+::blocks\+::\+Has\+Quantity TermT$>$ }\\using \mbox{\hyperlink{namespaceserif_1_1solver_1_1normalization_a72b7fb70be44d723b1115bd0561de14a}{serif\+::solver\+::normalization\+::\+Physical\+Value\+Rule}} = \mbox{\hyperlink{structserif_1_1utils_1_1dependencies_1_1_binding}{utils\+::dependencies\+::\+Binding}}$<$TermT, \mbox{\hyperlink{structserif_1_1solver_1_1normalization_1_1_physical_riesz_coordinate}{Physical\+Riesz\+Coordinate}}$<$typename Term\+T\+::\+Quantity, typename decltype(\mbox{\hyperlink{namespaceserif_1_1solver_1_1normalization_1_1detail_aa52112c59b823c93a41498c9b4d2f39b}{detail\+::default\+\_\+metric}}$<$TermT$>$())\+::type$>$$>$
|
|
\begin{DoxyCompactList}\small\item\em Describe an unknown from its existing quantity, support, and functional-\/space metadata. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$typename EquationT$>$ }\\using \mbox{\hyperlink{namespaceserif_1_1solver_1_1normalization_a487b77abc2a4a2b63e10a7c95ddfc0a1}{serif\+::solver\+::normalization\+::\+Physical\+Residual\+Rule}} = \mbox{\hyperlink{structserif_1_1utils_1_1dependencies_1_1_binding}{utils\+::dependencies\+::\+Binding}}$<$EquationT, \mbox{\hyperlink{structserif_1_1solver_1_1normalization_1_1_physical_riesz_coordinate}{Physical\+Riesz\+Coordinate}}$<$typename Equation\+T\+::\+Residual\+Quantity, typename decltype(\mbox{\hyperlink{namespaceserif_1_1solver_1_1normalization_1_1detail_aa52112c59b823c93a41498c9b4d2f39b}{detail\+::default\+\_\+metric}}$<$EquationT$>$())\+::type$>$$>$
|
|
\begin{DoxyCompactList}\small\item\em Describe a residual using the equation\textquotesingle{}s declared quantity, which may differ from the unknown it closes. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
{\footnotesize template$<$typename CoordinateT$>$ }\\consteval auto \mbox{\hyperlink{namespaceserif_1_1solver_1_1normalization_1_1detail_aa52112c59b823c93a41498c9b4d2f39b}{serif\+::solver\+::normalization\+::detail\+::default\+\_\+metric}} ()
|
|
\begin{DoxyCompactList}\small\item\em Select ordinary FE or algebraic metrics from the existing physical representation. \end{DoxyCompactList}\end{DoxyCompactItemize}
|