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)
55 lines
3.8 KiB
TeX
55 lines
3.8 KiB
TeX
\doxysection{src/include/serif/solver/normalization/dimensionless.hpp File Reference}
|
|
\hypertarget{dimensionless_8hpp}{}\label{dimensionless_8hpp}\index{src/include/serif/solver/normalization/dimensionless.hpp@{src/include/serif/solver/normalization/dimensionless.hpp}}
|
|
{\ttfamily \#include $<$expected$>$}\newline
|
|
{\ttfamily \#include $<$string$>$}\newline
|
|
{\ttfamily \#include "{}serif/solver/normalization/metrics.\+hpp"{}}\newline
|
|
Include dependency graph for dimensionless.\+hpp\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{dimensionless_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]{dimensionless_8hpp__dep__incl}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsubsection*{Classes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1solver_1_1normalization_1_1_dimensionless_metric_geometry_3_01_reference_volume_metric_3_01_term_t_01_4_01_4}{serif\+::solver\+::normalization\+::\+Dimensionless\+Metric\+Geometry$<$ Reference\+Volume\+Metric$<$ Term\+T $>$ $>$}}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1solver_1_1normalization_1_1_dimensionless_metric_geometry_3_01geometry_1_1deforma6be1597e60f90b119b47e9401d531cd8}{serif\+::solver\+::normalization\+::\+Dimensionless\+Metric\+Geometry$<$ geometry\+::deformation\+::keys\+::\+Surface\+Metric $>$}}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1solver_1_1normalization_1_1_dimensionless_metric_geometry_3_01_unit_metric_01_4}{serif\+::solver\+::normalization\+::\+Dimensionless\+Metric\+Geometry$<$ Unit\+Metric $>$}}
|
|
\end{DoxyCompactItemize}
|
|
\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*{Enumerations}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
enum class \mbox{\hyperlink{namespaceserif_1_1solver_1_1normalization_ac75238439fd5d1610b177bf85e9376d9}{serif\+::solver\+::normalization\+::\+Reference\+Geometry}} \{ \mbox{\hyperlink{namespaceserif_1_1solver_1_1normalization_ac75238439fd5d1610b177bf85e9376d9a210ab9e731c9c36c2c38db15c28a8d1c}{serif\+::solver\+::normalization\+::volume}}
|
|
, \mbox{\hyperlink{namespaceserif_1_1solver_1_1normalization_ac75238439fd5d1610b177bf85e9376d9ad302e976c9dd527a9521a88c012437c5}{serif\+::solver\+::normalization\+::surface}}
|
|
, \mbox{\hyperlink{namespaceserif_1_1solver_1_1normalization_ac75238439fd5d1610b177bf85e9376d9ac7f6ad568392380a8f4b4cecbaccb64c}{serif\+::solver\+::normalization\+::algebraic}}
|
|
\}
|
|
\begin{DoxyCompactList}\small\item\em Identify the geometric convention of a reference coordinate metric. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
std\+::expected$<$ double, std\+::string $>$ \mbox{\hyperlink{namespaceserif_1_1solver_1_1normalization_1_1detail_aecca7e71a6ccda6c98bcfa54a36da0be}{serif\+::solver\+::normalization\+::detail\+::dimensionless\+\_\+riesz\+\_\+scale}} (\mbox{\hyperlink{namespaceserif_1_1discretization_1_1blocks_aca74ff25d2168fcdec080e03ebc023ea}{discretization\+::blocks\+::\+Represented\+Value\+Kind}} kind, \mbox{\hyperlink{namespaceserif_1_1solver_1_1normalization_ac75238439fd5d1610b177bf85e9376d9}{Reference\+Geometry}} geometry, double physical\+\_\+scale, double reference\+\_\+radius)
|
|
\begin{DoxyCompactList}\small\item\em Include reference geometry in the scale consumed by the existing Riesz factor calculation. \end{DoxyCompactList}\end{DoxyCompactItemize}
|