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)
47 lines
3.2 KiB
TeX
47 lines
3.2 KiB
TeX
\doxysection{src/include/serif/geometry/deformation/composition.hpp File Reference}
|
|
\hypertarget{composition_8hpp}{}\label{composition_8hpp}\index{src/include/serif/geometry/deformation/composition.hpp@{src/include/serif/geometry/deformation/composition.hpp}}
|
|
{\ttfamily \#include $<$memory$>$}\newline
|
|
{\ttfamily \#include $<$type\+\_\+traits$>$}\newline
|
|
{\ttfamily \#include $<$utility$>$}\newline
|
|
{\ttfamily \#include $<$vector$>$}\newline
|
|
{\ttfamily \#include "{}serif/geometry/deformation/actions.\+hpp"{}}\newline
|
|
Include dependency graph for composition.\+hpp\+:\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{composition_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]{composition_8hpp__dep__incl}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsubsection*{Classes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
class \mbox{\hyperlink{classserif_1_1geometry_1_1deformation_1_1_composed_deformation}{serif\+::geometry\+::deformation\+::\+Composed\+Deformation$<$ Surface\+Map, Extension\+Map $>$}}
|
|
\begin{DoxyCompactList}\small\item\em Compose shape-\/to-\/surface and surface-\/to-\/volume maps with the complete derivative chain rule. \end{DoxyCompactList}\item
|
|
struct \mbox{\hyperlink{structserif_1_1geometry_1_1deformation_1_1_composed_deformation_1_1_curvature_workspace}{serif\+::geometry\+::deformation\+::\+Composed\+Deformation$<$ Surface\+Map, Extension\+Map $>$\+::\+Curvature\+Workspace}}
|
|
\begin{DoxyCompactList}\small\item\em Nonlinear actions retain the tangent and the two contributions to the shape-\/force derivative. \end{DoxyCompactList}\item
|
|
struct \mbox{\hyperlink{structserif_1_1geometry_1_1deformation_1_1_composed_deformation_1_1_workspace}{serif\+::geometry\+::deformation\+::\+Composed\+Deformation$<$ Surface\+Map, Extension\+Map $>$\+::\+Workspace}}
|
|
\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
|
|
{\footnotesize template$<$Deformation\+Map Surface\+Map, Deformation\+Map Extension\+Map$>$ \newline
|
|
requires std\+::same\+\_\+as$<$typename Surface\+Map\+::\+Output\+Space, typename Extension\+Map\+::\+Input\+Space$>$}\\std\+::expected$<$ \mbox{\hyperlink{classserif_1_1geometry_1_1deformation_1_1_composed_deformation}{Composed\+Deformation}}$<$ Surface\+Map, Extension\+Map $>$, \mbox{\hyperlink{structserif_1_1geometry_1_1deformation_1_1_deformation_failure}{Deformation\+Failure}} $>$ \mbox{\hyperlink{namespaceserif_1_1geometry_1_1deformation_a43ceea2db7df958a0bec16629328afc4}{serif\+::geometry\+::deformation\+::compose\+\_\+deformation}} (std\+::shared\+\_\+ptr$<$ const Surface\+Map $>$ surface, std\+::shared\+\_\+ptr$<$ const Extension\+Map $>$ extension)
|
|
\begin{DoxyCompactList}\small\item\em Validate factor sizes before constructing an owning mathematical composition. \end{DoxyCompactList}\end{DoxyCompactItemize}
|