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)
71 lines
5.9 KiB
TeX
71 lines
5.9 KiB
TeX
\doxysection{src/include/serif/geometry/surface/detail/relations.hpp File Reference}
|
|
\hypertarget{geometry_2surface_2detail_2relations_8hpp}{}\label{geometry_2surface_2detail_2relations_8hpp}\index{src/include/serif/geometry/surface/detail/relations.hpp@{src/include/serif/geometry/surface/detail/relations.hpp}}
|
|
{\ttfamily \#include $<$tuple$>$}\newline
|
|
{\ttfamily \#include $<$type\+\_\+traits$>$}\newline
|
|
{\ttfamily \#include "{}serif/discretization/forms/value.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/eos/models/concepts.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/utils/dependencies/key\+\_\+list\+\_\+operations.\+hpp"{}}\newline
|
|
Include dependency graph for relations.\+hpp\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{geometry_2surface_2detail_2relations_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]{geometry_2surface_2detail_2relations_8hpp__dep__incl}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsubsection*{Classes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1geometry_1_1surface_1_1detail_1_1_are_surface_bindings}{serif\+::geometry\+::surface\+::detail\+::\+Are\+Surface\+Bindings$<$ Bindings $>$}}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1geometry_1_1surface_1_1detail_1_1_are_surface_bindings_3_01utils_1_1dependencies_33dad547b0588cd763bce0759f4383af}{serif\+::geometry\+::surface\+::detail\+::\+Are\+Surface\+Bindings$<$ utils\+::dependencies\+::\+Bindings$<$ Entries... $>$ $>$}}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1geometry_1_1surface_1_1detail_1_1_relation_quantities_3_01eos_1_1relations_1_1_re1b8d421eb19c677a1d593d3260bf1965}{serif\+::geometry\+::surface\+::detail\+::\+Relation\+Quantities$<$ eos\+::relations\+::\+Relation$<$ Output, Inputs... $>$ $>$}}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1geometry_1_1surface_1_1detail_1_1_matching_pressure_relations_3_01_e_o_s_00_01_bi22092ddedc36636ca6905aa0fdd58d03}{serif\+::geometry\+::surface\+::detail\+::\+Matching\+Pressure\+Relations$<$ EOS, Bindings, Carrier, eos\+::relations\+::\+Relation\+Catalog$<$ Relations... $>$ $>$}}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1geometry_1_1surface_1_1detail_1_1_surface_operands_3_01utils_1_1dependencies_1_1_25be7268bd6650387d9a2a09b407eacf}{serif\+::geometry\+::surface\+::detail\+::\+Surface\+Operands$<$ utils\+::dependencies\+::\+Key\+List$<$ Terms... $>$ $>$}}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1geometry_1_1surface_1_1detail_1_1_unique_terms_3_01utils_1_1types_1_1_type_list_3_01_terms_8_8_8_01_4_01_4}{serif\+::geometry\+::surface\+::detail\+::\+Unique\+Terms$<$ utils\+::types\+::\+Type\+List$<$ Terms... $>$ $>$}}
|
|
\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_surface_scalar_term}{serif\+::geometry\+::surface\+::\+Surface\+Scalar\+Term}}
|
|
\begin{DoxyCompactList}\small\item\em Scalar thermodynamic data may come from any declared scalar space; boundary enforcement is a separate backend capability. \end{DoxyCompactList}\item
|
|
concept \mbox{\hyperlink{conceptserif_1_1geometry_1_1surface_1_1_surface_state_bindings}{serif\+::geometry\+::surface\+::\+Surface\+State\+Bindings}}
|
|
\begin{DoxyCompactList}\small\item\em Reuse dependency bindings, retaining distinct quantity roles even when they refer to one term. \end{DoxyCompactList}\item
|
|
concept \mbox{\hyperlink{conceptserif_1_1geometry_1_1surface_1_1_surface_residual_row}{serif\+::geometry\+::surface\+::\+Surface\+Residual\+Row}}
|
|
\begin{DoxyCompactList}\small\item\em The quantity enforcing the boundary must have an actual equation row, not just sampled values. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Typedefs}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
{\footnotesize template$<$typename Bindings, typename Quantities$>$ }\\using \mbox{\hyperlink{namespaceserif_1_1geometry_1_1surface_1_1detail_affe56c83289a5430500032dd0ef9f976}{serif\+::geometry\+::surface\+::detail\+::\+Bound\+Terms}} = typename \mbox{\hyperlink{structserif_1_1geometry_1_1surface_1_1detail_1_1_unique_terms}{Unique\+Terms}}$<$\mbox{\hyperlink{namespaceserif_1_1utils_1_1dependencies_ad50a04df4c202c11f49d6a2cf594b5da}{utils\+::dependencies\+::\+Resolved\+Targets}}$<$Bindings, Quantities$>$$>$\+::\+Type
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
{\footnotesize template$<$typename EOS, typename Relation, typename... Quantities$>$ }\\consteval bool \mbox{\hyperlink{namespaceserif_1_1geometry_1_1surface_1_1detail_a6b9bf00206e7f1eb178b35e8156162d7}{serif\+::geometry\+::surface\+::detail\+::supports\+\_\+partials}} (\mbox{\hyperlink{structserif_1_1utils_1_1dependencies_1_1_key_list}{utils\+::dependencies\+::\+Key\+List}}$<$ Quantities... $>$)
|
|
\begin{DoxyCompactList}\small\item\em Check only the derivatives of unknown state; prescribed pressure has no Newton column. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$typename EOS, typename Bindings, typename Carrier, typename Relation$>$ }\\consteval bool \mbox{\hyperlink{namespaceserif_1_1geometry_1_1surface_1_1detail_a84652446a03bf04dc70a63b365d2e380}{serif\+::geometry\+::surface\+::detail\+::matches\+\_\+pressure\+\_\+relation}} ()
|
|
\begin{DoxyCompactList}\small\item\em A resolved carrier must be supplied by one pressure-\/input relation, with all remaining inputs and partials available. \end{DoxyCompactList}\end{DoxyCompactItemize}
|