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)
62 lines
4.7 KiB
TeX
62 lines
4.7 KiB
TeX
\doxysection{src/include/serif/geometry/surface/automatic.hpp File Reference}
|
|
\hypertarget{automatic_8hpp}{}\label{automatic_8hpp}\index{src/include/serif/geometry/surface/automatic.hpp@{src/include/serif/geometry/surface/automatic.hpp}}
|
|
{\ttfamily \#include "{}serif/geometry/surface/detail/automatic\+\_\+relations.\+hpp"{}}\newline
|
|
Include dependency graph for automatic.\+hpp\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{automatic_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]{automatic_8hpp__dep__incl}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsubsection*{Classes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1geometry_1_1surface_1_1detail_1_1_selected_pressure_surface}{serif\+::geometry\+::surface\+::detail\+::\+Selected\+Pressure\+Surface$<$ Candidates $>$}}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1geometry_1_1surface_1_1detail_1_1_selected_pressure_surface_3_01std_1_1tuple_3_01_candidate_01_4_01_4}{serif\+::geometry\+::surface\+::detail\+::\+Selected\+Pressure\+Surface$<$ std\+::tuple$<$ Candidate $>$ $>$}}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1geometry_1_1surface_1_1_automatic_pressure_surface}{serif\+::geometry\+::surface\+::\+Automatic\+Pressure\+Surface$<$ EOS, Available\+Terms, Actual\+Rows, Solved\+Terms, Preferred\+Field $>$}}
|
|
\begin{DoxyCompactList}\small\item\em Compile an isobaric condition from available physical fields, actual equation rows, and the EOS catalog. \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_1detail_1_1_eligible_surface_row}{serif\+::geometry\+::surface\+::detail\+::\+Eligible\+Surface\+Row}}
|
|
\begin{DoxyCompactList}\small\item\em Strong boundary enforcement requires an actual solved, scalar H1 equation row. \end{DoxyCompactList}\item
|
|
concept \mbox{\hyperlink{conceptserif_1_1geometry_1_1surface_1_1_automatic_pressure_surface_compilable}{serif\+::geometry\+::surface\+::\+Automatic\+Pressure\+Surface\+Compilable}}
|
|
\begin{DoxyCompactList}\small\item\em Whether the available equations and numerical backend select one implementable isobaric residual. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Enumerations}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
enum class \mbox{\hyperlink{namespaceserif_1_1geometry_1_1surface_a739898ab5e92990aaeb57582842b1d1c}{serif\+::geometry\+::surface\+::\+Pressure\+Surface\+Selection}} \{ \mbox{\hyperlink{namespaceserif_1_1geometry_1_1surface_a739898ab5e92990aaeb57582842b1d1ca42bd4c0819c498d1c1ab622de74d6f82}{serif\+::geometry\+::surface\+::supported}}
|
|
, \mbox{\hyperlink{namespaceserif_1_1geometry_1_1surface_a739898ab5e92990aaeb57582842b1d1ca7060e0481896e00b3f7d20f1e8e2749a}{serif\+::geometry\+::surface\+::unavailable}}
|
|
, \mbox{\hyperlink{namespaceserif_1_1geometry_1_1surface_a739898ab5e92990aaeb57582842b1d1ca1f2a1ba9f974029c8e43ae8f59637f4c}{serif\+::geometry\+::surface\+::ambiguous}}
|
|
\}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
{\footnotesize template$<$int Priority, typename EOS, typename Field, typename Fields, typename Rows, typename Solved\+Terms, typename Preferred\+Field$>$ }\\consteval auto \mbox{\hyperlink{namespaceserif_1_1geometry_1_1surface_1_1detail_a47569b6917cba9e92e76c0e678a88077}{serif\+::geometry\+::surface\+::detail\+::field\+\_\+candidates}} ()
|
|
\begin{DoxyCompactList}\small\item\em Search one precedence level, without asking the EOS for a relation when pressure is already an unknown. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$int Priority, typename EOS, typename Rows, typename Solved\+Terms, typename Preferred\+Field, typename... Fields$>$ }\\consteval auto \mbox{\hyperlink{namespaceserif_1_1geometry_1_1surface_1_1detail_a28aa7b0cb90c30abf0891e0dc118b7b3}{serif\+::geometry\+::surface\+::detail\+::select\+\_\+candidates}} (\mbox{\hyperlink{structserif_1_1utils_1_1dependencies_1_1_key_list}{utils\+::dependencies\+::\+Key\+List}}$<$ Fields... $>$ fields)
|
|
\begin{DoxyCompactList}\small\item\em Prefer a pressure unknown, then an explicit inverse, then a direct pressure residual. \end{DoxyCompactList}\end{DoxyCompactItemize}
|