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)
66 lines
5.8 KiB
TeX
66 lines
5.8 KiB
TeX
\doxysection{src/include/serif/model/execution\+\_\+validation.hpp File Reference}
|
|
\hypertarget{execution__validation_8hpp}{}\label{execution__validation_8hpp}\index{src/include/serif/model/execution\_validation.hpp@{src/include/serif/model/execution\_validation.hpp}}
|
|
{\ttfamily \#include "{}serif/model/equilibrium\+\_\+plan.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/model/validation.\+hpp"{}}\newline
|
|
Include dependency graph for execution\+\_\+validation.\+hpp\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{execution__validation_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]{execution__validation_8hpp__dep__incl}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsubsection*{Classes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1model_1_1detail_1_1_cartesian_couplings_3_01utils_1_1dependencies_1_1_key_list_3_1aeac7cb8e4197c8efc3cb5c64082687}{serif\+::model\+::detail\+::\+Cartesian\+Couplings$<$ utils\+::dependencies\+::\+Key\+List$<$ Rows... $>$, utils\+::dependencies\+::\+Key\+List$<$ Fields... $>$ $>$}}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1model_1_1detail_1_1_execution_surface}{serif\+::model\+::detail\+::\+Execution\+Surface$<$ Plan, typename $>$}}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1model_1_1detail_1_1_execution_surface_3_01_plan_00_01std_1_1void__t_3_01typename_01_plan_1_1_surface_01_4_01_4}{serif\+::model\+::detail\+::\+Execution\+Surface$<$ Plan, std\+::void\+\_\+t$<$ typename Plan\+::\+Surface $>$ $>$}}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1model_1_1detail_1_1_execution_inputs}{serif\+::model\+::detail\+::\+Execution\+Inputs$<$ Plan, typename $>$}}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1model_1_1detail_1_1_execution_inputs_3_01_plan_00_01std_1_1void__t_3_01typename_0fa90771a73a9f7619c8ad46d39189df1}{serif\+::model\+::detail\+::\+Execution\+Inputs$<$ Plan, std\+::void\+\_\+t$<$ typename Plan\+::\+Physical\+Inputs, typename Plan\+::\+Inactive\+Rows $>$ $>$}}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1model_1_1detail_1_1_equilibrium_couplings}{serif\+::model\+::detail\+::\+Equilibrium\+Couplings$<$ Description, Surface $>$}}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Namespaces}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif}{serif}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1model}{serif\+::model}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1model_1_1detail}{serif\+::model\+::detail}}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Concepts}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
concept \mbox{\hyperlink{conceptserif_1_1model_1_1_executable_equilibrium_description}{serif\+::model\+::\+Executable\+Equilibrium\+Description}}
|
|
\begin{DoxyCompactList}\small\item\em Recognize current equation backends without instantiating an invalid complete plan. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Typedefs}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
{\footnotesize template$<$Executable\+Equilibrium\+Description Description, typename Plan$>$ }\\using \mbox{\hyperlink{namespaceserif_1_1model_a1a9e18895b6021d27952932da09eb71b}{serif\+::model\+::\+Actual\+Equilibrium\+Couplings}} = typename \mbox{\hyperlink{structserif_1_1model_1_1detail_1_1_equilibrium_couplings}{detail\+::\+Equilibrium\+Couplings}}$<$Description, \mbox{\hyperlink{structserif_1_1model_1_1detail_1_1_execution_surface}{detail\+::\+Execution\+Surface}}$<$Plan$>$$>$\+::\+Type
|
|
\begin{DoxyCompactList}\small\item\em Inspect the actual derivative producers admitted by the explicitly supplied physical formulation. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
{\footnotesize template$<$Dimensional\+Scalar\+Specification Specification, typename Rows, typename Inactive\+Rows, typename Actual, typename Bindings$>$ }\\consteval bool \mbox{\hyperlink{namespaceserif_1_1model_1_1detail_afb30e6c6a4f8c30445f235bba5d44413}{serif\+::model\+::detail\+::generated\+\_\+physics\+\_\+is\+\_\+present}} ()
|
|
\begin{DoxyCompactList}\small\item\em Demand an explicitly supplied generated equation and effect before inferring closed-\/row zeros. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$typename Rows, typename Inactive\+Rows, typename Actual, typename Bindings, typename... Specifications$>$ }\\consteval bool \mbox{\hyperlink{namespaceserif_1_1model_1_1detail_a277ce1ffbd3bd2cc6afee1f566484846}{serif\+::model\+::detail\+::generated\+\_\+physics\+\_\+are\+\_\+present}} (\mbox{\hyperlink{structserif_1_1utils_1_1types_1_1_type_list}{utils\+::types\+::\+Type\+List}}$<$ Specifications... $>$)
|
|
\begin{DoxyCompactList}\small\item\em Check only numerical-\/provider admission; physical endpoint ownership is checked separately. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$typename Rows, typename... Required$>$ }\\consteval bool \mbox{\hyperlink{namespaceserif_1_1model_1_1detail_adcfc1df7cc2e1114d6d15b41fee9b712}{serif\+::model\+::detail\+::equation\+\_\+rows\+\_\+exist}} (\mbox{\hyperlink{structserif_1_1utils_1_1dependencies_1_1_key_list}{utils\+::dependencies\+::\+Key\+List}}$<$ Required... $>$)
|
|
\begin{DoxyCompactList}\small\item\em Every surface carrier must have an equation row in the selected layout. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$typename Model, typename Description, typename Plan, typename Bindings = Default\+Specification\+Bindings, typename Explicit\+Zero\+Couplings = utils\+::dependencies\+::\+Key\+List$<$$>$$>$ }\\consteval bool \mbox{\hyperlink{namespaceserif_1_1model_a85f2ca250e5b86d7c907d7db1428d852}{serif\+::model\+::executable\+\_\+model\+\_\+topology}} ()
|
|
\begin{DoxyCompactList}\small\item\em Validate a complete selected formulation without inferring solvability or selecting physics. \end{DoxyCompactList}\end{DoxyCompactItemize}
|