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)
58 lines
5.7 KiB
TeX
58 lines
5.7 KiB
TeX
\doxysection{src/include/serif/backend/mfem/geometry/surface/boundary\+\_\+inputs.hpp File Reference}
|
|
\hypertarget{boundary__inputs_8hpp}{}\label{boundary__inputs_8hpp}\index{src/include/serif/backend/mfem/geometry/surface/boundary\_inputs.hpp@{src/include/serif/backend/mfem/geometry/surface/boundary\_inputs.hpp}}
|
|
{\ttfamily \#include "{}serif/backend/mfem/discretization/coefficient\+\_\+tracking.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/backend/mfem/geometry/surface/boundary\+\_\+data.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/geometry/surface/samples.\+hpp"{}}\newline
|
|
Include dependency graph for boundary\+\_\+inputs.\+hpp\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{boundary__inputs_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]{boundary__inputs_8hpp__dep__incl}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsubsection*{Classes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1geometry_1_1surface_1_1backend_1_1mfem_1_1keys_1_1_boundary_discretization}{serif\+::geometry\+::surface\+::backend\+::mfem\+::keys\+::\+Boundary\+Discretization}}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1geometry_1_1surface_1_1backend_1_1mfem_1_1keys_1_1_boundary_samples}{serif\+::geometry\+::surface\+::backend\+::mfem\+::keys\+::\+Boundary\+Samples$<$ Term $>$}}
|
|
\begin{DoxyCompactList}\small\item\em Keep sampled boundary state distinct from volume coefficient sources for the same term. \end{DoxyCompactList}\item
|
|
struct \mbox{\hyperlink{structserif_1_1geometry_1_1surface_1_1backend_1_1mfem_1_1detail_1_1_boundary_tracking}{serif\+::geometry\+::surface\+::backend\+::mfem\+::detail\+::\+Boundary\+Tracking}}
|
|
\begin{DoxyCompactList}\small\item\em Shared traces have stable identity; validation catches changes outside the coefficient vectors. \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_1backend}{serif\+::geometry\+::surface\+::backend}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1geometry_1_1surface_1_1backend_1_1mfem}{serif\+::geometry\+::surface\+::backend\+::mfem}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1geometry_1_1surface_1_1backend_1_1mfem_1_1keys}{serif\+::geometry\+::surface\+::backend\+::mfem\+::keys}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1geometry_1_1surface_1_1backend_1_1mfem_1_1detail}{serif\+::geometry\+::surface\+::backend\+::mfem\+::detail}}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
{\footnotesize template$<$typename Boundary, typename EOSResource$>$ }\\auto \mbox{\hyperlink{namespaceserif_1_1geometry_1_1surface_1_1backend_1_1mfem_a44b6568f3c7dff51a72dd2a9dc41f944}{serif\+::geometry\+::surface\+::backend\+::mfem\+::make\+\_\+pressure\+\_\+boundary\+\_\+metadata}} (std\+::shared\+\_\+ptr$<$ const Boundary $>$ boundary, EOSResource equation\+\_\+of\+\_\+state, \mbox{\hyperlink{classserif_1_1geometry_1_1surface_1_1_isobaric_surface}{Isobaric\+Surface}} condition)
|
|
\begin{DoxyCompactList}\small\item\em Share boundary metadata with a model\textquotesingle{}s common coefficient context. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$typename Boundary, typename EOSResource, typename Coefficients, typename... Terms$>$ }\\auto \mbox{\hyperlink{namespaceserif_1_1geometry_1_1surface_1_1backend_1_1mfem_1_1detail_a9d3c24765edaf5688574811c4f38eaa3}{serif\+::geometry\+::surface\+::backend\+::mfem\+::detail\+::pressure\+\_\+boundary\+\_\+inputs}} (std\+::shared\+\_\+ptr$<$ const Boundary $>$ boundary, EOSResource equation\+\_\+of\+\_\+state, \mbox{\hyperlink{classserif_1_1geometry_1_1surface_1_1_isobaric_surface}{Isobaric\+Surface}} condition, const Coefficients \&coefficients, \mbox{\hyperlink{structserif_1_1utils_1_1dependencies_1_1_key_list}{utils\+::dependencies\+::\+Key\+List}}$<$ Terms... $>$)
|
|
\begin{DoxyCompactList}\small\item\em Preserve standard coefficient keys and policies in a standalone boundary context. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$typename Boundary, utils\+::dependencies\+::\+Is\+Resource EOSResource, utils\+::dependencies\+::\+Is\+Dependency\+Context Coefficients$>$ \newline
|
|
requires std\+::same\+\_\+as$<$typename EOSResource\+::\+Key, \mbox{\hyperlink{structserif_1_1geometry_1_1surface_1_1keys_1_1_equation_of_state}{surface\+::keys\+::\+Equation\+Of\+State}}$>$ \&\& std\+::same\+\_\+as$<$std\+::remove\+\_\+cvref\+\_\+t$<$typename EOSResource\+::\+Target$>$, typename Boundary\+::\+Formulation\+::\+Equation\+Of\+State$>$ \&\& utils\+::dependencies\+::\+Satisfies\+Key\+List$<$typename Coefficients\+::\+Bindings, typename Boundary\+::\+Formulation\+::\+State\+Terms$>$}\\auto \mbox{\hyperlink{namespaceserif_1_1geometry_1_1surface_1_1backend_1_1mfem_a9030962e1ff6d46eb932189d09319948}{serif\+::geometry\+::surface\+::backend\+::mfem\+::make\+\_\+pressure\+\_\+boundary\+\_\+inputs}} (std\+::shared\+\_\+ptr$<$ const Boundary $>$ boundary, EOSResource equation\+\_\+of\+\_\+state, \mbox{\hyperlink{classserif_1_1geometry_1_1surface_1_1_isobaric_surface}{Isobaric\+Surface}} condition, const Coefficients \&coefficients)
|
|
\begin{DoxyCompactList}\small\item\em Bind the physical condition, explicitly tracked EOS, and borrowed field coefficients without evaluating them. \end{DoxyCompactList}\end{DoxyCompactItemize}
|