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)
40 lines
3.4 KiB
TeX
40 lines
3.4 KiB
TeX
\doxysection{src/lib/serif/backend/mfem/geometry/deformation/radial\+\_\+locator.cpp File Reference}
|
|
\hypertarget{radial__locator_8cpp}{}\label{radial__locator_8cpp}\index{src/lib/serif/backend/mfem/geometry/deformation/radial\_locator.cpp@{src/lib/serif/backend/mfem/geometry/deformation/radial\_locator.cpp}}
|
|
{\ttfamily \#include $<$algorithm$>$}\newline
|
|
{\ttfamily \#include $<$cmath$>$}\newline
|
|
{\ttfamily \#include $<$limits$>$}\newline
|
|
{\ttfamily \#include "{}mfem/mesh/mesh.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/backend/mfem/geometry/deformation/detail/radial\+\_\+locator.\+hpp"{}}\newline
|
|
Include dependency graph for radial\+\_\+locator.\+cpp\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{radial__locator_8cpp__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_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}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1geometry_1_1deformation_1_1backend_1_1mfem_1_1detail}{serif\+::geometry\+::deformation\+::backend\+::mfem\+::detail}}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
double \mbox{\hyperlink{namespaceserif_1_1geometry_1_1deformation_1_1backend_1_1mfem_1_1detail_a6e6de6a39085122a94b23c06512e48e8}{serif\+::geometry\+::deformation\+::backend\+::mfem\+::detail\+::logical\+\_\+radius}} (const \+::mfem\+::\+Vector \&position)
|
|
\begin{DoxyCompactList}\small\item\em compute the cubical local radius of a given position vector. Alternative put\+: compute the $L\infty$ norm of the position vector (i.\+e. the maximum absolute value of its components) \end{DoxyCompactList}\item
|
|
std\+::expected$<$ double, \mbox{\hyperlink{structserif_1_1geometry_1_1deformation_1_1_deformation_failure}{Deformation\+Failure}} $>$ \mbox{\hyperlink{namespaceserif_1_1geometry_1_1deformation_1_1backend_1_1mfem_1_1detail_af74cbfc2f3db601dcb00258dace52361}{serif\+::geometry\+::deformation\+::backend\+::mfem\+::detail\+::boundary\+\_\+logical\+\_\+radius}} (\+::mfem\+::\+Mesh \&mesh, int attribute)
|
|
\begin{DoxyCompactList}\small\item\em Compute the logical radius of a boundary shell in a mesh, given the mesh and the boundary attribute. \end{DoxyCompactList}\item
|
|
std\+::expected$<$ \mbox{\hyperlink{structserif_1_1geometry_1_1deformation_1_1backend_1_1mfem_1_1detail_1_1_located_boundary_point}{Located\+Boundary\+Point}}, \mbox{\hyperlink{structserif_1_1geometry_1_1deformation_1_1_deformation_failure}{Deformation\+Failure}} $>$ \mbox{\hyperlink{namespaceserif_1_1geometry_1_1deformation_1_1backend_1_1mfem_1_1detail_a82e9f8756275515ac2ba12399df8680a}{serif\+::geometry\+::deformation\+::backend\+::mfem\+::detail\+::locate\+\_\+boundary\+\_\+point}} (\+::mfem\+::\+Mesh \&mesh, int attribute, const \+::mfem\+::\+Vector \&target)
|
|
\begin{DoxyCompactList}\small\item\em Locate a projected logical ray on a quadrilateral shell. \end{DoxyCompactList}\end{DoxyCompactItemize}
|