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)
60 lines
3.6 KiB
TeX
60 lines
3.6 KiB
TeX
\doxysection{src/include/serif/geometry/surface/samples.hpp File Reference}
|
|
\hypertarget{samples_8hpp}{}\label{samples_8hpp}\index{src/include/serif/geometry/surface/samples.hpp@{src/include/serif/geometry/surface/samples.hpp}}
|
|
{\ttfamily \#include $<$utility$>$}\newline
|
|
{\ttfamily \#include $<$vector$>$}\newline
|
|
{\ttfamily \#include "{}serif/geometry/surface/linearization.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/utils/dependencies/resource.\+hpp"{}}\newline
|
|
Include dependency graph for samples.\+hpp\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{samples_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]{samples_8hpp__dep__incl}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsubsection*{Classes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1geometry_1_1surface_1_1keys_1_1_equation_of_state}{serif\+::geometry\+::surface\+::keys\+::\+Equation\+Of\+State}}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1geometry_1_1surface_1_1keys_1_1_pressure_condition}{serif\+::geometry\+::surface\+::keys\+::\+Pressure\+Condition}}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1geometry_1_1surface_1_1keys_1_1_e_o_s_response}{serif\+::geometry\+::surface\+::keys\+::\+EOSResponse}}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1geometry_1_1surface_1_1keys_1_1_linearization}{serif\+::geometry\+::surface\+::keys\+::\+Linearization}}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1geometry_1_1surface_1_1_boundary_values}{serif\+::geometry\+::surface\+::\+Boundary\+Values$<$ Term $>$}}
|
|
\begin{DoxyCompactList}\small\item\em Values of one scalar term at an ordered collection of boundary points. \end{DoxyCompactList}\item
|
|
struct \mbox{\hyperlink{structserif_1_1geometry_1_1surface_1_1detail_1_1_boundary_value_tracking}{serif\+::geometry\+::surface\+::detail\+::\+Boundary\+Value\+Tracking}}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1geometry_1_1surface_1_1detail_1_1_pressure_condition_tracking}{serif\+::geometry\+::surface\+::detail\+::\+Pressure\+Condition\+Tracking}}
|
|
\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_1keys}{serif\+::geometry\+::surface\+::keys}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1geometry_1_1surface_1_1detail}{serif\+::geometry\+::surface\+::detail}}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
{\footnotesize template$<$Surface\+Scalar\+Term Term$>$ }\\auto \mbox{\hyperlink{namespaceserif_1_1geometry_1_1surface_a5d4b3151c0eec6aedd3bb2ce4259e52b}{serif\+::geometry\+::surface\+::boundary\+\_\+values}} (std\+::vector$<$ double $>$ values)
|
|
\begin{DoxyCompactList}\small\item\em Supply owned boundary samples to an ordinary dependency context, keyed by their physical term. \end{DoxyCompactList}\item
|
|
auto \mbox{\hyperlink{namespaceserif_1_1geometry_1_1surface_ad3e16057fff248ad6c7bd9a43959fc0e}{serif\+::geometry\+::surface\+::pressure\+\_\+condition}} (\mbox{\hyperlink{classserif_1_1geometry_1_1surface_1_1_isobaric_surface}{Isobaric\+Surface}} condition)
|
|
\begin{DoxyCompactList}\small\item\em Supply the isobaric condition as an owned dependency source, with pressure tracked by value. \end{DoxyCompactList}\end{DoxyCompactItemize}
|