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
7.2 KiB
TeX
58 lines
7.2 KiB
TeX
\doxysection{src/include/serif/geometry/deformation/backend/mfem/geometry\+\_\+inspection.hpp File Reference}
|
|
\hypertarget{backend_2mfem_2geometry__inspection_8hpp}{}\label{backend_2mfem_2geometry__inspection_8hpp}\index{src/include/serif/geometry/deformation/backend/mfem/geometry\_inspection.hpp@{src/include/serif/geometry/deformation/backend/mfem/geometry\_inspection.hpp}}
|
|
{\ttfamily \#include $<$expected$>$}\newline
|
|
{\ttfamily \#include $<$span$>$}\newline
|
|
{\ttfamily \#include $<$utility$>$}\newline
|
|
{\ttfamily \#include "{}mfem/fem/fespace.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/geometry/deformation/geometry\+\_\+inspection.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/geometry/deformation/linearization.\+hpp"{}}\newline
|
|
Include dependency graph for geometry\+\_\+inspection.\+hpp\+:\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{backend_2mfem_2geometry__inspection_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]{backend_2mfem_2geometry__inspection_8hpp__dep__incl}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsubsection*{Namespaces}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif}{serif}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1discretization}{serif\+::discretization}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1discretization_1_1backend}{serif\+::discretization\+::backend}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1discretization_1_1backend_1_1mfem}{serif\+::discretization\+::backend\+::mfem}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1mapping}{serif\+::mapping}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1geometry}{serif\+::geometry}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1geometry_1_1deformation}{serif\+::geometry\+::deformation}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1geometry_1_1deformation_1_1backend}{serif\+::geometry\+::deformation\+::backend}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1geometry_1_1deformation_1_1backend_1_1mfem}{serif\+::geometry\+::deformation\+::backend\+::mfem}}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
std\+::expected$<$ \mbox{\hyperlink{structserif_1_1geometry_1_1deformation_1_1_deformation_geometry_report}{Deformation\+Geometry\+Report}}, \mbox{\hyperlink{structserif_1_1geometry_1_1deformation_1_1_deformation_failure}{Deformation\+Failure}} $>$ \mbox{\hyperlink{namespaceserif_1_1geometry_1_1deformation_1_1backend_1_1mfem_aef20e8c17f47349faa80aa0b85575842}{serif\+::geometry\+::deformation\+::backend\+::mfem\+::inspect\+\_\+deformation\+\_\+geometry}} (const \+::mfem\+::\+Finite\+Element\+Space \&displacement\+\_\+space, const \+::mfem\+::\+Vector \&displacement)
|
|
\begin{DoxyCompactList}\small\item\em Inspect a serial displacement in the finite-\/element space\textquotesingle{}s native true-\/\+DOF ordering. \end{DoxyCompactList}\item
|
|
std\+::expected$<$ \mbox{\hyperlink{structserif_1_1geometry_1_1deformation_1_1_deformation_geometry_report}{Deformation\+Geometry\+Report}}, \mbox{\hyperlink{structserif_1_1geometry_1_1deformation_1_1_deformation_failure}{Deformation\+Failure}} $>$ \mbox{\hyperlink{namespaceserif_1_1geometry_1_1deformation_1_1backend_1_1mfem_a2c08beab5c6dcd24197b13ce83ae411a}{serif\+::geometry\+::deformation\+::backend\+::mfem\+::inspect\+\_\+deformation\+\_\+geometry}} (const \+::mfem\+::\+Finite\+Element\+Space \&displacement\+\_\+space, const \+::mfem\+::\+Vector \&displacement, \mbox{\hyperlink{classserif_1_1discretization_1_1backend_1_1mfem_1_1_tensor_basis_cache}{discretization\+::backend\+::mfem\+::\+Tensor\+Basis\+Cache}} \&basis\+\_\+cache, const \mbox{\hyperlink{classserif_1_1mapping_1_1_domain_mapper}{mapping\+::\+Domain\+Mapper}} \texorpdfstring{$\ast$}{*}reference\+\_\+geometry=nullptr)
|
|
\begin{DoxyCompactList}\small\item\em Reuse existing tensor plans between inspections while reading current reference mesh Jacobians. \end{DoxyCompactList}\item
|
|
std\+::expected$<$ \mbox{\hyperlink{structserif_1_1geometry_1_1deformation_1_1_deformation_geometry_report}{Deformation\+Geometry\+Report}}, \mbox{\hyperlink{structserif_1_1geometry_1_1deformation_1_1_deformation_failure}{Deformation\+Failure}} $>$ \mbox{\hyperlink{namespaceserif_1_1geometry_1_1deformation_1_1backend_1_1mfem_a3cdf0f6dfef389c9f9871bb5293bacdb}{serif\+::geometry\+::deformation\+::backend\+::mfem\+::inspect\+\_\+deformation\+\_\+geometry}} (const \+::mfem\+::\+Finite\+Element\+Space \&displacement\+\_\+space, std\+::span$<$ const double $>$ displacement, \+::mfem\+::\+Ordering\+::\+Type coefficient\+\_\+ordering)
|
|
\begin{DoxyCompactList}\small\item\em Inspect true coefficients with an explicit ordering, including deformation\textquotesingle{}s component-\/block by\+NODES vectors. \end{DoxyCompactList}\item
|
|
std\+::expected$<$ \mbox{\hyperlink{structserif_1_1geometry_1_1deformation_1_1_deformation_geometry_report}{Deformation\+Geometry\+Report}}, \mbox{\hyperlink{structserif_1_1geometry_1_1deformation_1_1_deformation_failure}{Deformation\+Failure}} $>$ \mbox{\hyperlink{namespaceserif_1_1geometry_1_1deformation_1_1backend_1_1mfem_a0a50313961b20be41570a838f7dc94a9}{serif\+::geometry\+::deformation\+::backend\+::mfem\+::inspect\+\_\+deformation\+\_\+geometry}} (const \+::mfem\+::\+Finite\+Element\+Space \&displacement\+\_\+space, std\+::span$<$ const double $>$ displacement, \+::mfem\+::\+Ordering\+::\+Type coefficient\+\_\+ordering, \mbox{\hyperlink{classserif_1_1discretization_1_1backend_1_1mfem_1_1_tensor_basis_cache}{discretization\+::backend\+::mfem\+::\+Tensor\+Basis\+Cache}} \&basis\+\_\+cache, const \mbox{\hyperlink{classserif_1_1mapping_1_1_domain_mapper}{mapping\+::\+Domain\+Mapper}} \texorpdfstring{$\ast$}{*}reference\+\_\+geometry=nullptr)
|
|
\begin{DoxyCompactList}\small\item\em Inspect explicitly ordered true coefficients using the same caller-\/owned canonical basis cache. \end{DoxyCompactList}\item
|
|
{\footnotesize template$<$Deformation\+Map Map$>$ \newline
|
|
requires std\+::same\+\_\+as$<$typename Map\+::\+Output\+Space, \mbox{\hyperlink{structserif_1_1geometry_1_1deformation_1_1spaces_1_1_volume_displacement}{spaces\+::\+Volume\+Displacement}}$>$}\\std\+::expected$<$ \mbox{\hyperlink{structserif_1_1geometry_1_1deformation_1_1_validated_displacement}{Validated\+Displacement}}, \mbox{\hyperlink{structserif_1_1geometry_1_1deformation_1_1_deformation_failure}{Deformation\+Failure}} $>$ \mbox{\hyperlink{namespaceserif_1_1geometry_1_1deformation_1_1backend_1_1mfem_a609b4d83a3a4476e889a5e7613e8d556}{serif\+::geometry\+::deformation\+::backend\+::mfem\+::build\+\_\+validated\+\_\+displacement}} (const Map \&map, std\+::span$<$ const double $>$ parameters, const \+::mfem\+::\+Finite\+Element\+Space \&displacement\+\_\+space, const double determinant\+\_\+floor=0.\+0)
|
|
\begin{DoxyCompactList}\small\item\em Generate a displacement and publish it only when every sampled computational determinant exceeds the floor. The map must produce component-\/block coefficients for the supplied displacement space. Repeated solver work can compose evaluate\+\_\+displacement and inspect\+\_\+deformation\+\_\+geometry as ordinary dependency computations. \end{DoxyCompactList}\end{DoxyCompactItemize}
|