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)
50 lines
3.0 KiB
TeX
50 lines
3.0 KiB
TeX
\doxysection{src/include/serif/solver/normalization/keys.hpp File Reference}
|
|
\hypertarget{solver_2normalization_2keys_8hpp}{}\label{solver_2normalization_2keys_8hpp}\index{src/include/serif/solver/normalization/keys.hpp@{src/include/serif/solver/normalization/keys.hpp}}
|
|
{\ttfamily \#include "{}serif/discretization/blocks/base.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/discretization/blocks/keys.\+hpp"{}}\newline
|
|
Include dependency graph for keys.\+hpp\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=290pt]{solver_2normalization_2keys_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]{solver_2normalization_2keys_8hpp__dep__incl}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsubsection*{Classes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1solver_1_1normalization_1_1keys_1_1_scales}{serif\+::solver\+::normalization\+::keys\+::\+Scales}}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1solver_1_1normalization_1_1keys_1_1_normalization}{serif\+::solver\+::normalization\+::keys\+::\+Normalization}}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1solver_1_1normalization_1_1keys_1_1_factors}{serif\+::solver\+::normalization\+::keys\+::\+Factors$<$ Kind, Coordinate\+T $>$}}
|
|
\begin{DoxyCompactList}\small\item\em Distinguish state and residual factors even when they share the same physical term. \end{DoxyCompactList}\item
|
|
struct \mbox{\hyperlink{structserif_1_1solver_1_1normalization_1_1keys_1_1_prescription}{serif\+::solver\+::normalization\+::keys\+::\+Prescription$<$ Prescription\+T $>$}}
|
|
\begin{DoxyCompactList}\small\item\em Bind the exact custom prescription named by a runtime-\/prepared coordinate. \end{DoxyCompactList}\item
|
|
struct \mbox{\hyperlink{structserif_1_1solver_1_1normalization_1_1keys_1_1_reference_binding}{serif\+::solver\+::normalization\+::keys\+::\+Reference\+Binding$<$ Term\+T $>$}}
|
|
\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_1keys}{serif\+::solver\+::normalization\+::keys}}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Typedefs}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
using \mbox{\hyperlink{namespaceserif_1_1solver_1_1normalization_1_1keys_a01d33c80ce728df0cb2687eebe9ea921}{serif\+::solver\+::normalization\+::keys\+::\+Layout}} = \mbox{\hyperlink{structserif_1_1discretization_1_1blocks_1_1keys_1_1_layout}{discretization\+::blocks\+::keys\+::\+Layout}}
|
|
\begin{DoxyCompactList}\small\item\em \doxylink{structserif_1_1solver_1_1normalization_1_1keys_1_1_normalization}{Normalization} consumes the same coordinate layout as every other numerical service. \end{DoxyCompactList}\end{DoxyCompactItemize}
|