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)
49 lines
4.0 KiB
TeX
49 lines
4.0 KiB
TeX
\doxysection{src/include/serif/geometry/surface/computations.hpp File Reference}
|
|
\hypertarget{surface_2computations_8hpp}{}\label{surface_2computations_8hpp}\index{src/include/serif/geometry/surface/computations.hpp@{src/include/serif/geometry/surface/computations.hpp}}
|
|
{\ttfamily \#include $<$tuple$>$}\newline
|
|
{\ttfamily \#include $<$type\+\_\+traits$>$}\newline
|
|
{\ttfamily \#include $<$utility$>$}\newline
|
|
{\ttfamily \#include "{}serif/geometry/surface/detail/batches.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/utils/dependencies/computation\+\_\+graph.\+hpp"{}}\newline
|
|
Include dependency graph for computations.\+hpp\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{surface_2computations_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]{surface_2computations_8hpp__dep__incl}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsubsection*{Namespaces}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif}{serif}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1geometry}{serif\+::geometry}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1geometry_1_1surface}{serif\+::geometry\+::surface}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1geometry_1_1surface_1_1detail}{serif\+::geometry\+::surface\+::detail}}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
{\footnotesize template$<$Pressure\+Surface\+Formulation\+Type Formulation, template$<$ typename $>$ typename Sample\+Key, typename... Terms$>$ }\\auto \mbox{\hyperlink{namespaceserif_1_1geometry_1_1surface_1_1detail_a6fb1453555097c81109991e4f078c65a}{serif\+::geometry\+::surface\+::detail\+::make\+\_\+surface\+\_\+eos\+\_\+computation}} (\mbox{\hyperlink{structserif_1_1utils_1_1dependencies_1_1_key_list}{utils\+::dependencies\+::\+Key\+List}}$<$ Terms... $>$)
|
|
\begin{DoxyCompactList}\small\item\em Declare the exact EOS inputs from the formulation, so derivative metadata and cache dependencies cannot diverge. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$Pressure\+Surface\+Formulation\+Type Formulation, template$<$ typename $>$ typename Sample\+Key$>$ }\\auto \mbox{\hyperlink{namespaceserif_1_1geometry_1_1surface_1_1detail_a5950b9769f365cfaf0089b8e7d0182da}{serif\+::geometry\+::surface\+::detail\+::make\+\_\+surface\+\_\+linearization\+\_\+computation}} ()
|
|
\begin{DoxyCompactList}\small\item\em Keep the inexpensive boundary residual separate from the reusable EOS response and its partials. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$Pressure\+Surface\+Formulation\+Type Formulation, template$<$ typename $>$ typename Sample\+Key = std\+::type\+\_\+identity\+\_\+t$>$ }\\auto \mbox{\hyperlink{namespaceserif_1_1geometry_1_1surface_aaae557ab0921c03cea6ca410571aea07}{serif\+::geometry\+::surface\+::make\+\_\+pressure\+\_\+surface\+\_\+computations}} ()
|
|
\begin{DoxyCompactList}\small\item\em Expose the existing EOS and residual stages for composition with backend sampling or other physics. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$Pressure\+Surface\+Formulation\+Type Formulation$>$ }\\auto \mbox{\hyperlink{namespaceserif_1_1geometry_1_1surface_a22a6164aca39d466c509c4e9d73bd0a3}{serif\+::geometry\+::surface\+::make\+\_\+pressure\+\_\+surface\+\_\+graph}} ()
|
|
\begin{DoxyCompactList}\small\item\em Describe the isobaric calculation as an ordinary dependency graph, without evaluating the EOS. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$typename EOS, typename Bindings, typename Carrier = void$>$ \newline
|
|
requires Pressure\+Surface\+Compilable$<$EOS, Bindings, Carrier$>$}\\auto \mbox{\hyperlink{namespaceserif_1_1geometry_1_1surface_a221522d5871c62fa8e9b4aa7493b19ee}{serif\+::geometry\+::surface\+::make\+\_\+pressure\+\_\+surface\+\_\+graph}} ()
|
|
\begin{DoxyCompactList}\small\item\em Infer a unique carrier-\/resolved formulation directly from an EOS and the available physical state. \end{DoxyCompactList}\end{DoxyCompactItemize}
|