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

60 lines
4.5 KiB
TeX

\doxysection{src/include/serif/backend/mfem/solver/admissibility/geometry.hpp File Reference}
\hypertarget{geometry_8hpp}{}\label{geometry_8hpp}\index{src/include/serif/backend/mfem/solver/admissibility/geometry.hpp@{src/include/serif/backend/mfem/solver/admissibility/geometry.hpp}}
{\ttfamily \#include $<$algorithm$>$}\newline
{\ttfamily \#include $<$memory$>$}\newline
{\ttfamily \#include $<$tuple$>$}\newline
{\ttfamily \#include $<$vector$>$}\newline
{\ttfamily \#include "{}serif/backend/mfem/geometry/deformation/geometry\+\_\+step.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/backend/mfem/mapping/domain\+\_\+mapper.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/backend/mfem/model/graph.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/model/state.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/discretization/blocks/vector\+\_\+view.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/solver/nonlinear/options.\+hpp"{}}\newline
Include dependency graph for geometry.\+hpp\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{geometry_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=270pt]{geometry_8hpp__dep__incl}
\end{center}
\end{figure}
\doxysubsubsection*{Classes}
\begin{DoxyCompactItemize}
\item
struct \mbox{\hyperlink{structserif_1_1solver_1_1admissibility_1_1backend_1_1mfem_1_1_geometry_sampling_rules}{serif\+::solver\+::admissibility\+::backend\+::mfem\+::\+Geometry\+Sampling\+Rules}}
\begin{DoxyCompactList}\small\item\em The union of reference rules used by geometry inspection and all volume equations. \end{DoxyCompactList}\item
class \mbox{\hyperlink{classserif_1_1solver_1_1admissibility_1_1backend_1_1mfem_1_1_geometry_direction}{serif\+::solver\+::admissibility\+::backend\+::mfem\+::\+Geometry\+Direction}}
\begin{DoxyCompactList}\small\item\em Retain one accepted displacement and direction while backtracking changes the current candidate. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsubsection*{Namespaces}
\begin{DoxyCompactItemize}
\item
namespace \mbox{\hyperlink{namespaceserif}{serif}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1solver}{serif\+::solver}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1solver_1_1admissibility}{serif\+::solver\+::admissibility}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1solver_1_1admissibility_1_1backend}{serif\+::solver\+::admissibility\+::backend}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1solver_1_1admissibility_1_1backend_1_1mfem}{serif\+::solver\+::admissibility\+::backend\+::mfem}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1solver_1_1admissibility_1_1backend_1_1mfem_1_1detail}{serif\+::solver\+::admissibility\+::backend\+::mfem\+::detail}}
\end{DoxyCompactItemize}
\doxysubsubsection*{Functions}
\begin{DoxyCompactItemize}
\item
{\footnotesize template$<$typename Equation, typename Scope = typename Equation\+::\+Test$>$ }\\auto \mbox{\hyperlink{namespaceserif_1_1solver_1_1admissibility_1_1backend_1_1mfem_1_1detail_a14f2f312884fd466ede4519ed391e73f}{serif\+::solver\+::admissibility\+::backend\+::mfem\+::detail\+::equation\+\_\+rule\+\_\+keys}} ()
\begin{DoxyCompactList}\small\item\em Identify each contribution\textquotesingle{}s reference-\/basis computation without preparing a physical linearization. \end{DoxyCompactList}\item
std\+::shared\+\_\+ptr$<$ const std\+::vector$<$ \mbox{\hyperlink{structserif_1_1mapping_1_1_d_m_fixed_mesh_geometry}{mapping\+::\+DMFixed\+Mesh\+Geometry}} $>$ $>$ \mbox{\hyperlink{namespaceserif_1_1solver_1_1admissibility_1_1backend_1_1mfem_1_1detail_a5ad215c49ad82d5bbafd979944927c7f}{serif\+::solver\+::admissibility\+::backend\+::mfem\+::detail\+::sample\+\_\+reference\+\_\+geometry}} (\+::mfem\+::\+Mesh \&mesh, const int element, const \+::mfem\+::\+Integration\+Rule \&rule)
\begin{DoxyCompactList}\small\item\em Sample the fixed reference-\/mesh geometry of one rule once, for reuse by every step limit. \end{DoxyCompactList}\item
{\footnotesize template$<$typename Bound$>$ }\\auto \mbox{\hyperlink{namespaceserif_1_1solver_1_1admissibility_1_1backend_1_1mfem_a0c7ecdea3647e3ecaa70b6f3d48ef193}{serif\+::solver\+::admissibility\+::backend\+::mfem\+::make\+\_\+geometry\+\_\+computations}} (const std\+::shared\+\_\+ptr$<$ const Bound $>$ \&bound)
\begin{DoxyCompactList}\small\item\em Let the dependency graph retain geometry sampling data for unchanged FE bindings. \end{DoxyCompactList}\end{DoxyCompactItemize}