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)
59 lines
4.6 KiB
TeX
59 lines
4.6 KiB
TeX
\doxysection{src/include/serif/backend/mfem/geometry/surface/boundary\+\_\+data.hpp File Reference}
|
|
\hypertarget{boundary__data_8hpp}{}\label{boundary__data_8hpp}\index{src/include/serif/backend/mfem/geometry/surface/boundary\_data.hpp@{src/include/serif/backend/mfem/geometry/surface/boundary\_data.hpp}}
|
|
{\ttfamily \#include $<$memory$>$}\newline
|
|
{\ttfamily \#include $<$utility$>$}\newline
|
|
{\ttfamily \#include "{}serif/backend/mfem/discretization/boundary\+\_\+trace.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/geometry/surface/compilation.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/backend/mfem/discretization/term\+\_\+coefficients.\+hpp"{}}\newline
|
|
Include dependency graph for boundary\+\_\+data.\+hpp\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{boundary__data_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__data_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_1_pressure_boundary}{serif\+::geometry\+::surface\+::backend\+::mfem\+::\+Pressure\+Boundary$<$ Formulation\+T, Traces $>$}}
|
|
\begin{DoxyCompactList}\small\item\em The selected equation rows and the finite-\/element traces supplying their physical state. \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_1detail}{serif\+::geometry\+::surface\+::backend\+::mfem\+::detail}}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Concepts}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
concept \mbox{\hyperlink{conceptserif_1_1geometry_1_1surface_1_1backend_1_1mfem_1_1_pressure_boundary_formulation}{serif\+::geometry\+::surface\+::backend\+::mfem\+::\+Pressure\+Boundary\+Formulation}}
|
|
\begin{DoxyCompactList}\small\item\em Isobaric rows are scalar nodal H1 equations with continuous scalar or global EOS inputs. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
{\footnotesize template$<$typename... Terms$>$ }\\consteval bool \mbox{\hyperlink{namespaceserif_1_1geometry_1_1surface_1_1backend_1_1mfem_1_1detail_a71b5b314fbbdb22f19c7b13b89aa452c}{serif\+::geometry\+::surface\+::backend\+::mfem\+::detail\+::supported\+\_\+boundary\+\_\+terms}} (\mbox{\hyperlink{structserif_1_1utils_1_1dependencies_1_1_key_list}{utils\+::dependencies\+::\+Key\+List}}$<$ Terms... $>$)
|
|
\begin{DoxyCompactList}\small\item\em Strong nodal rows need a unique trace for every thermodynamic input. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$Pressure\+Boundary\+Formulation Formulation, typename Coefficients, typename... Terms$>$ }\\auto \mbox{\hyperlink{namespaceserif_1_1geometry_1_1surface_1_1backend_1_1mfem_1_1detail_a2e3c5291d5db363fd8bbfe0a071b122f}{serif\+::geometry\+::surface\+::backend\+::mfem\+::detail\+::make\+\_\+pressure\+\_\+boundary}} (const Coefficients \&coefficients, \mbox{\hyperlink{structserif_1_1utils_1_1dependencies_1_1_key_list}{utils\+::dependencies\+::\+Key\+List}}$<$ Terms... $>$)
|
|
\begin{DoxyCompactList}\small\item\em Compile each unique field once, including quantities that share one coefficient term. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$Pressure\+Boundary\+Formulation Formulation, utils\+::dependencies\+::\+Is\+Dependency\+Context Coefficients$>$ \newline
|
|
requires utils\+::dependencies\+::\+Satisfies\+Key\+List$<$typename Coefficients\+::\+Bindings, typename Formulation\+::\+State\+Terms$>$}\\auto \mbox{\hyperlink{namespaceserif_1_1geometry_1_1surface_1_1backend_1_1mfem_a0cdab175178018f861bd59555badd9cd}{serif\+::geometry\+::surface\+::backend\+::mfem\+::make\+\_\+pressure\+\_\+boundary}} (const Coefficients \&coefficients)
|
|
\begin{DoxyCompactList}\small\item\em Compile nodal boundary traces explicitly; this does not sample coefficients or evaluate the EOS. \end{DoxyCompactList}\end{DoxyCompactItemize}
|