Files
MeanField_SERiF/docs/latex/boundary__computations_8hpp.tex
Emily Boudreaux 6b57738330 docs(docs): built docs
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)
2026-11-09 14:09:44 -05:00

48 lines
4.0 KiB
TeX

\doxysection{src/include/serif/backend/mfem/geometry/surface/boundary\+\_\+computations.hpp File Reference}
\hypertarget{boundary__computations_8hpp}{}\label{boundary__computations_8hpp}\index{src/include/serif/backend/mfem/geometry/surface/boundary\_computations.hpp@{src/include/serif/backend/mfem/geometry/surface/boundary\_computations.hpp}}
{\ttfamily \#include "{}serif/backend/mfem/geometry/surface/boundary\+\_\+inputs.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/geometry/surface/computations.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/backend/mfem/shared/finite.\+hpp"{}}\newline
Include dependency graph for boundary\+\_\+computations.\+hpp\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{boundary__computations_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__computations_8hpp__dep__incl}
\end{center}
\end{figure}
\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*{Functions}
\begin{DoxyCompactItemize}
\item
{\footnotesize template$<$typename Term, typename Boundary, typename Input$>$ }\\std\+::expected$<$ \mbox{\hyperlink{structserif_1_1geometry_1_1surface_1_1_boundary_values}{Boundary\+Values}}$<$ Term $>$, \mbox{\hyperlink{structserif_1_1geometry_1_1surface_1_1_surface_failure}{Surface\+Failure}} $>$ \mbox{\hyperlink{namespaceserif_1_1geometry_1_1surface_1_1backend_1_1mfem_1_1detail_ad382741c020dabcb33cfd49bf0c1186a}{serif\+::geometry\+::surface\+::backend\+::mfem\+::detail\+::sample\+\_\+boundary\+\_\+values}} (const Boundary \&boundary, const Input \&input)
\begin{DoxyCompactList}\small\item\em Sample the same fixed linear trace used by the boundary tangent and its transpose. \end{DoxyCompactList}\item
{\footnotesize template$<$Pressure\+Boundary\+Formulation Formulation, typename... Terms$>$ }\\auto \mbox{\hyperlink{namespaceserif_1_1geometry_1_1surface_1_1backend_1_1mfem_1_1detail_a043710a62582c74193688e016c9ed42e}{serif\+::geometry\+::surface\+::backend\+::mfem\+::detail\+::pressure\+\_\+boundary\+\_\+computations}} (\mbox{\hyperlink{structserif_1_1utils_1_1dependencies_1_1_key_list}{utils\+::dependencies\+::\+Key\+List}}$<$ Terms... $>$)
\begin{DoxyCompactList}\small\item\em Declare one sampled value column per unique physical term, without a separate preparation owner. \end{DoxyCompactList}\item
{\footnotesize template$<$Pressure\+Boundary\+Formulation Formulation$>$ }\\auto \mbox{\hyperlink{namespaceserif_1_1geometry_1_1surface_1_1backend_1_1mfem_ac06e575bc3d225a40ae5e1f1a6468849}{serif\+::geometry\+::surface\+::backend\+::mfem\+::make\+\_\+pressure\+\_\+boundary\+\_\+computations}} ()
\begin{DoxyCompactList}\small\item\em Combine finite-\/element sampling with the unchanged thermodynamic graph; coefficient sources can also feed volume equations. \end{DoxyCompactList}\item
{\footnotesize template$<$Pressure\+Boundary\+Formulation Formulation$>$ }\\auto \mbox{\hyperlink{namespaceserif_1_1geometry_1_1surface_1_1backend_1_1mfem_a0b70b4645642fd03cd6fc473f52f8861}{serif\+::geometry\+::surface\+::backend\+::mfem\+::make\+\_\+pressure\+\_\+boundary\+\_\+graph}} ()
\begin{DoxyCompactList}\small\item\em Construct a standalone isobaric boundary graph with the ordinary dependency-\/cache lifecycle. \end{DoxyCompactList}\end{DoxyCompactItemize}