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)
72 lines
6.6 KiB
TeX
72 lines
6.6 KiB
TeX
\doxysection{src/include/serif/geometry/surface/compilation.hpp File Reference}
|
|
\hypertarget{compilation_8hpp}{}\label{compilation_8hpp}\index{src/include/serif/geometry/surface/compilation.hpp@{src/include/serif/geometry/surface/compilation.hpp}}
|
|
{\ttfamily \#include "{}serif/geometry/surface/detail/relations.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/geometry/surface/isobaric.\+hpp"{}}\newline
|
|
Include dependency graph for compilation.\+hpp\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{compilation_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]{compilation_8hpp__dep__incl}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsubsection*{Classes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1geometry_1_1surface_1_1detail_1_1_pressure_surface_description}{serif\+::geometry\+::surface\+::detail\+::\+Pressure\+Surface\+Description$<$ EOS, Bindings, Row\+Quantity, Relation\+T, Resolve\+Carrier $>$}}
|
|
\begin{DoxyCompactList}\small\item\em Common physical metadata; numerical values and preparation belong to the dependency context and cache. \end{DoxyCompactList}\item
|
|
struct \mbox{\hyperlink{structserif_1_1geometry_1_1surface_1_1_pressure_surface_formulation}{serif\+::geometry\+::surface\+::\+Pressure\+Surface\+Formulation$<$ EOS, Bindings, Carrier $>$}}
|
|
\begin{DoxyCompactList}\small\item\em The boundary residual is carrier minus the EOS value at prescribed pressure; no carrier quantity is privileged. \end{DoxyCompactList}\item
|
|
struct \mbox{\hyperlink{structserif_1_1geometry_1_1surface_1_1_inverse_pressure_surface_formulation}{serif\+::geometry\+::surface\+::\+Inverse\+Pressure\+Surface\+Formulation$<$ EOS, Bindings, Relation $>$}}
|
|
\begin{DoxyCompactList}\small\item\em A selected explicit inverse relation; choosing it requires no numerical EOS inversion. \end{DoxyCompactList}\item
|
|
struct \mbox{\hyperlink{structserif_1_1geometry_1_1surface_1_1_direct_pressure_surface_formulation}{serif\+::geometry\+::surface\+::\+Direct\+Pressure\+Surface\+Formulation$<$ EOS, Bindings, Row\+Quantity, Relation $>$}}
|
|
\begin{DoxyCompactList}\small\item\em Enforce P\+\_\+\+EOS(state) -\/ P\+\_\+surface = 0 without inventing an inverse EOS relation. \end{DoxyCompactList}\item
|
|
struct \mbox{\hyperlink{structserif_1_1geometry_1_1surface_1_1_pressure_field_surface_formulation}{serif\+::geometry\+::surface\+::\+Pressure\+Field\+Surface\+Formulation$<$ EOS, Bindings $>$}}
|
|
\begin{DoxyCompactList}\small\item\em An existing pressure unknown enforces P -\/ P\+\_\+surface directly, without evaluating the EOS. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
\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*{Concepts}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
concept \mbox{\hyperlink{conceptserif_1_1geometry_1_1surface_1_1_pressure_surface_compilable}{serif\+::geometry\+::surface\+::\+Pressure\+Surface\+Compilable}}
|
|
\begin{DoxyCompactList}\small\item\em Whether the available state selects exactly one pressure-\/to-\/carrier EOS relation. \end{DoxyCompactList}\item
|
|
concept \mbox{\hyperlink{conceptserif_1_1geometry_1_1surface_1_1_direct_pressure_surface_compilable}{serif\+::geometry\+::surface\+::\+Direct\+Pressure\+Surface\+Compilable}}
|
|
\begin{DoxyCompactList}\small\item\em A direct pressure residual requires an explicitly chosen pressure relation and an input quantity whose equation row it replaces. \end{DoxyCompactList}\item
|
|
concept \mbox{\hyperlink{conceptserif_1_1geometry_1_1surface_1_1_pressure_surface_formulation_type}{serif\+::geometry\+::surface\+::\+Pressure\+Surface\+Formulation\+Type}}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Typedefs}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
{\footnotesize template$<$typename EOS, typename Bindings, typename Carrier = void$>$ }\\using \mbox{\hyperlink{namespaceserif_1_1geometry_1_1surface_aa7522c70fe18bcce1ad623ce570359fa}{serif\+::geometry\+::surface\+::pressure\+\_\+relation\+\_\+t}} = std\+::tuple\+\_\+element\+\_\+t$<$0, typename \mbox{\hyperlink{structserif_1_1geometry_1_1surface_1_1detail_1_1_matching_pressure_relations}{detail\+::\+Matching\+Pressure\+Relations}}$<$std\+::remove\+\_\+cvref\+\_\+t$<$EOS$>$, std\+::remove\+\_\+cvref\+\_\+t$<$Bindings$>$, Carrier, typename std\+::remove\+\_\+cvref\+\_\+t$<$EOS$>$\+::\+Relations$>$\+::\+Matches$>$
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Variables}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
{\footnotesize template$<$typename Candidate$>$ }\\constexpr bool \mbox{\hyperlink{namespaceserif_1_1geometry_1_1surface_1_1detail_a774fc18d061430aee5e69aff793478c1}{serif\+::geometry\+::surface\+::detail\+::is\+\_\+pressure\+\_\+surface\+\_\+formulation}} = false
|
|
\item
|
|
{\footnotesize template$<$typename EOS, typename Bindings, typename Carrier$>$ }\\constexpr bool \mbox{\hyperlink{namespaceserif_1_1geometry_1_1surface_1_1detail_a908e4213ab5097aee89b9c4be39242c3}{serif\+::geometry\+::surface\+::detail\+::is\+\_\+pressure\+\_\+surface\+\_\+formulation$<$ Pressure\+Surface\+Formulation$<$ EOS, Bindings, Carrier $>$ $>$}} = true
|
|
\item
|
|
{\footnotesize template$<$typename EOS, typename Bindings, typename Relation$>$ }\\constexpr bool \mbox{\hyperlink{namespaceserif_1_1geometry_1_1surface_1_1detail_a224afc0c9785f63f0dcb291c08f19578}{serif\+::geometry\+::surface\+::detail\+::is\+\_\+pressure\+\_\+surface\+\_\+formulation$<$ Inverse\+Pressure\+Surface\+Formulation$<$ EOS, Bindings, Relation $>$ $>$}} = true
|
|
\item
|
|
{\footnotesize template$<$typename EOS, typename Bindings, typename Row\+Quantity, typename Relation$>$ }\\constexpr bool \mbox{\hyperlink{namespaceserif_1_1geometry_1_1surface_1_1detail_a7277dc2467e4a5a6d8d19b225d2a7e87}{serif\+::geometry\+::surface\+::detail\+::is\+\_\+pressure\+\_\+surface\+\_\+formulation$<$ Direct\+Pressure\+Surface\+Formulation$<$ EOS, Bindings, Row\+Quantity, Relation $>$ $>$}} = true
|
|
\item
|
|
{\footnotesize template$<$typename EOS, typename Bindings$>$ }\\constexpr bool \mbox{\hyperlink{namespaceserif_1_1geometry_1_1surface_1_1detail_a326706a40ff30cb5de6adf4367ea8044}{serif\+::geometry\+::surface\+::detail\+::is\+\_\+pressure\+\_\+surface\+\_\+formulation$<$ Pressure\+Field\+Surface\+Formulation$<$ EOS, Bindings $>$ $>$}} = true
|
|
\end{DoxyCompactItemize}
|