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)
50 lines
3.8 KiB
TeX
50 lines
3.8 KiB
TeX
\doxysection{src/include/serif/geometry/deformation/surface\+\_\+embedding.hpp File Reference}
|
|
\hypertarget{surface__embedding_8hpp}{}\label{surface__embedding_8hpp}\index{src/include/serif/geometry/deformation/surface\_embedding.hpp@{src/include/serif/geometry/deformation/surface\_embedding.hpp}}
|
|
{\ttfamily \#include $<$array$>$}\newline
|
|
{\ttfamily \#include $<$cstddef$>$}\newline
|
|
{\ttfamily \#include $<$expected$>$}\newline
|
|
{\ttfamily \#include $<$span$>$}\newline
|
|
{\ttfamily \#include $<$vector$>$}\newline
|
|
{\ttfamily \#include "{}serif/geometry/deformation/failure.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/geometry/deformation/models.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/geometry/deformation/spaces.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/geometry/deformation/workspace.\+hpp"{}}\newline
|
|
Include dependency graph for surface\+\_\+embedding.\+hpp\+:\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{surface__embedding_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]{surface__embedding_8hpp__dep__incl}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsubsection*{Classes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1geometry_1_1deformation_1_1_spherical_harmonic_mode}{serif\+::geometry\+::deformation\+::\+Spherical\+Harmonic\+Mode}}
|
|
\begin{DoxyCompactList}\small\item\em Identify a real harmonic, with negative orders using sine and positive orders using cosine. \end{DoxyCompactList}\item
|
|
class \mbox{\hyperlink{classserif_1_1geometry_1_1deformation_1_1_surface_embedding}{serif\+::geometry\+::deformation\+::\+Surface\+Embedding}}
|
|
\begin{DoxyCompactList}\small\item\em Own a linear conversion from radial displacement lengths to Cartesian surface displacements. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
\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}}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
std\+::expected$<$ \mbox{\hyperlink{classserif_1_1geometry_1_1deformation_1_1_surface_embedding}{Surface\+Embedding}}, \mbox{\hyperlink{structserif_1_1geometry_1_1deformation_1_1_deformation_failure}{Deformation\+Failure}} $>$ \mbox{\hyperlink{namespaceserif_1_1geometry_1_1deformation_acb2008299cc4c40f49e8c9c0086e5356}{serif\+::geometry\+::deformation\+::build\+\_\+surface\+\_\+embedding}} (const \mbox{\hyperlink{structserif_1_1geometry_1_1deformation_1_1_nodal_radial_surface}{Nodal\+Radial\+Surface}} \&model, std\+::span$<$ const std\+::array$<$ double, 3 $>$ $>$ positions)
|
|
\begin{DoxyCompactList}\small\item\em Compile fixed radial directions from ordered physical reference positions without retaining backend objects. \end{DoxyCompactList}\item
|
|
std\+::expected$<$ \mbox{\hyperlink{classserif_1_1geometry_1_1deformation_1_1_surface_embedding}{Surface\+Embedding}}, \mbox{\hyperlink{structserif_1_1geometry_1_1deformation_1_1_deformation_failure}{Deformation\+Failure}} $>$ \mbox{\hyperlink{namespaceserif_1_1geometry_1_1deformation_a21c05b3c7115c90ea951ee87a1efc714}{serif\+::geometry\+::deformation\+::build\+\_\+surface\+\_\+embedding}} (const \mbox{\hyperlink{structserif_1_1geometry_1_1deformation_1_1_spherical_harmonic_surface}{Spherical\+Harmonic\+Surface}} \&model, std\+::span$<$ const std\+::array$<$ double, 3 $>$ $>$ positions)
|
|
\begin{DoxyCompactList}\small\item\em Sample physically normalized real harmonics and reject unresolved modes without renormalizing or dropping coordinates. \end{DoxyCompactList}\end{DoxyCompactItemize}
|