Files
MeanField_SERiF/docs/latex/reference__tracking_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

49 lines
3.4 KiB
TeX

\doxysection{src/include/serif/backend/mfem/shared/reference\+\_\+tracking.hpp File Reference}
\hypertarget{reference__tracking_8hpp}{}\label{reference__tracking_8hpp}\index{src/include/serif/backend/mfem/shared/reference\_tracking.hpp@{src/include/serif/backend/mfem/shared/reference\_tracking.hpp}}
{\ttfamily \#include $<$vector$>$}\newline
Include dependency graph for reference\+\_\+tracking.\+hpp\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=205pt]{reference__tracking_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]{reference__tracking_8hpp__dep__incl}
\end{center}
\end{figure}
\doxysubsubsection*{Classes}
\begin{DoxyCompactItemize}
\item
struct \mbox{\hyperlink{structserif_1_1backend_1_1mfem_1_1shared_1_1_reference_mesh_snapshot}{serif\+::backend\+::mfem\+::shared\+::\+Reference\+Mesh\+Snapshot}}
\begin{DoxyCompactList}\small\item\em The external mesh metadata consumed by a graph input. \end{DoxyCompactList}\item
struct \mbox{\hyperlink{structserif_1_1backend_1_1mfem_1_1shared_1_1_reference_space_snapshot}{serif\+::backend\+::mfem\+::shared\+::\+Reference\+Space\+Snapshot}}
\begin{DoxyCompactList}\small\item\em Identity and revision of the space that gives coefficients their physical meaning. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsubsection*{Namespaces}
\begin{DoxyCompactItemize}
\item
namespace \mbox{\hyperlink{namespacemfem}{mfem}}
\item
namespace \mbox{\hyperlink{namespaceserif}{serif}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1backend}{serif\+::backend}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1backend_1_1mfem}{serif\+::backend\+::mfem}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1backend_1_1mfem_1_1shared}{serif\+::backend\+::mfem\+::shared}}
\end{DoxyCompactItemize}
\doxysubsubsection*{Functions}
\begin{DoxyCompactItemize}
\item
\mbox{\hyperlink{structserif_1_1backend_1_1mfem_1_1shared_1_1_reference_mesh_snapshot}{Reference\+Mesh\+Snapshot}} \mbox{\hyperlink{namespaceserif_1_1backend_1_1mfem_1_1shared_a8a3fceba5f26f630d7b01619661300d9}{serif\+::backend\+::mfem\+::shared\+::mesh\+\_\+snapshot}} (const \+::mfem\+::\+Mesh \texorpdfstring{$\ast$}{*}mesh, bool coordinates, bool materials)
\begin{DoxyCompactList}\small\item\em Capture topology and boundary labels, optionally including coordinates and material labels. \end{DoxyCompactList}\item
\mbox{\hyperlink{structserif_1_1backend_1_1mfem_1_1shared_1_1_reference_space_snapshot}{Reference\+Space\+Snapshot}} \mbox{\hyperlink{namespaceserif_1_1backend_1_1mfem_1_1shared_a4030e24e89961c729b925e20eec7401c}{serif\+::backend\+::mfem\+::shared\+::space\+\_\+snapshot}} (const \+::mfem\+::\+Finite\+Element\+Space \&space)
\begin{DoxyCompactList}\small\item\em Capture refinement and coefficient layout without copying the finite-\/element space. \end{DoxyCompactList}\item
bool \mbox{\hyperlink{namespaceserif_1_1backend_1_1mfem_1_1shared_a54d5ed483c0157702271d831602c9277}{serif\+::backend\+::mfem\+::shared\+::mesh\+\_\+matches}} (const \mbox{\hyperlink{structserif_1_1backend_1_1mfem_1_1shared_1_1_reference_mesh_snapshot}{Reference\+Mesh\+Snapshot}} \&snapshot, const \+::mfem\+::\+Mesh \texorpdfstring{$\ast$}{*}mesh)
\begin{DoxyCompactList}\small\item\em Compare the selected dependencies without allocating another copy of the mesh labels. \end{DoxyCompactList}\end{DoxyCompactItemize}