Files
MeanField_SERiF/docs/latex/parameters_8hpp.tex

79 lines
5.4 KiB
TeX
Raw Normal View History

\doxysection{src/include/serif/solver/continuation/parameters.hpp File Reference}
\hypertarget{parameters_8hpp}{}\label{parameters_8hpp}\index{src/include/serif/solver/continuation/parameters.hpp@{src/include/serif/solver/continuation/parameters.hpp}}
{\ttfamily \#include $<$array$>$}\newline
{\ttfamily \#include $<$concepts$>$}\newline
{\ttfamily \#include $<$expected$>$}\newline
{\ttfamily \#include $<$ranges$>$}\newline
{\ttfamily \#include $<$string$>$}\newline
{\ttfamily \#include $<$string\+\_\+view$>$}\newline
{\ttfamily \#include $<$type\+\_\+traits$>$}\newline
{\ttfamily \#include "{}serif/dimensions/quantities.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/utils/dependencies/key\+\_\+list\+\_\+operations.\+hpp"{}}\newline
Include dependency graph for parameters.\+hpp\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{parameters_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]{parameters_8hpp__dep__incl}
\end{center}
\end{figure}
\doxysubsubsection*{Classes}
\begin{DoxyCompactItemize}
\item
struct \mbox{\hyperlink{structserif_1_1solver_1_1continuation_1_1_failure}{serif\+::solver\+::continuation\+::\+Failure}}
\item
struct \mbox{\hyperlink{structserif_1_1solver_1_1continuation_1_1_parameter_descriptor}{serif\+::solver\+::continuation\+::\+Parameter\+Descriptor}}
\item
struct \mbox{\hyperlink{structserif_1_1solver_1_1continuation_1_1_specification_traits}{serif\+::solver\+::continuation\+::\+Specification\+Traits$<$ Specification $>$}}
\begin{DoxyCompactList}\small\item\em Add continuation access without imposing numerical dependencies on a physical prescription. \end{DoxyCompactList}\item
struct \mbox{\hyperlink{structserif_1_1solver_1_1continuation_1_1detail_1_1_parameter_catalog}{serif\+::solver\+::continuation\+::detail\+::\+Parameter\+Catalog$<$ Owner, typename $>$}}
\item
struct \mbox{\hyperlink{structserif_1_1solver_1_1continuation_1_1detail_1_1_parameter_catalog_3_01_owner_00_01std_1_1voi5161f0c73bf59261ed7e070b2817ab78}{serif\+::solver\+::continuation\+::detail\+::\+Parameter\+Catalog$<$ Owner, std\+::void\+\_\+t$<$ typename Owner\+::\+Continuation\+Parameters $>$ $>$}}
\item
struct \mbox{\hyperlink{structserif_1_1solver_1_1continuation_1_1detail_1_1_catalog}{serif\+::solver\+::continuation\+::detail\+::\+Catalog$<$ Owner, typename $>$}}
\item
struct \mbox{\hyperlink{structserif_1_1solver_1_1continuation_1_1detail_1_1_catalog_3_01_owner_00_01std_1_1void__t_3_01td5020aa27649aff8f8879d1dd1a70f31}{serif\+::solver\+::continuation\+::detail\+::\+Catalog$<$ Owner, std\+::void\+\_\+t$<$ typename Specification\+Traits$<$ Owner $>$\+::\+Parameters $>$ $>$}}
\item
struct \mbox{\hyperlink{structserif_1_1solver_1_1continuation_1_1detail_1_1_required_dependents}{serif\+::solver\+::continuation\+::detail\+::\+Required\+Dependents$<$ Parameter, typename $>$}}
\item
struct \mbox{\hyperlink{structserif_1_1solver_1_1continuation_1_1detail_1_1_required_dependents_3_01_parameter_00_01std_407798e603a2438024a6e90d9406a3b0}{serif\+::solver\+::continuation\+::detail\+::\+Required\+Dependents$<$ Parameter, std\+::void\+\_\+t$<$ typename Parameter\+::\+Required\+Dependent\+Parameters $>$ $>$}}
\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_1continuation}{serif\+::solver\+::continuation}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1solver_1_1continuation_1_1detail}{serif\+::solver\+::continuation\+::detail}}
\end{DoxyCompactItemize}
\doxysubsubsection*{Concepts}
\begin{DoxyCompactItemize}
\item
concept \mbox{\hyperlink{conceptserif_1_1solver_1_1continuation_1_1_coordinate_value}{serif\+::solver\+::continuation\+::\+Coordinate\+Value}}
\item
concept \mbox{\hyperlink{conceptserif_1_1solver_1_1continuation_1_1_physical_parameter}{serif\+::solver\+::continuation\+::\+Physical\+Parameter}}
\begin{DoxyCompactList}\small\item\em A typed physical parameter owns its domain predicate, units, owner, and stable identity. \end{DoxyCompactList}\item
concept \mbox{\hyperlink{conceptserif_1_1solver_1_1continuation_1_1_identified_specification}{serif\+::solver\+::continuation\+::\+Identified\+Specification}}
\begin{DoxyCompactList}\small\item\em Require explicit identity data, never an object address or incidental memory representation. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsubsection*{Typedefs}
\begin{DoxyCompactItemize}
\item
{\footnotesize template$<$typename... Parameters$>$ }\\using \mbox{\hyperlink{namespaceserif_1_1solver_1_1continuation_af4abf5dbb21b2d1032b766c80c2138d4}{serif\+::solver\+::continuation\+::\+Parameter\+List}} = \mbox{\hyperlink{structserif_1_1utils_1_1dependencies_1_1_key_list}{utils\+::dependencies\+::\+Key\+List}}$<$Parameters...$>$
\end{DoxyCompactItemize}
\doxysubsubsection*{Functions}
\begin{DoxyCompactItemize}
\item
{\footnotesize template$<$Coordinate\+Value Value$>$ }\\constexpr double \mbox{\hyperlink{namespaceserif_1_1solver_1_1continuation_aad8111501ecddde8dd9e0d3264b8c1db}{serif\+::solver\+::continuation\+::coordinate\+\_\+value}} (Value value) noexcept
\begin{DoxyCompactList}\small\item\em Convert physical units only at the coordinate-\/controller boundary. \end{DoxyCompactList}\end{DoxyCompactItemize}