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)
61 lines
1.8 KiB
Groff
61 lines
1.8 KiB
Groff
.TH "src/include/serif/geometry/deformation/composition.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
src/include/serif/geometry/deformation/composition.hpp
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
\fR#include <memory>\fP
|
|
.br
|
|
\fR#include <type_traits>\fP
|
|
.br
|
|
\fR#include <utility>\fP
|
|
.br
|
|
\fR#include <vector>\fP
|
|
.br
|
|
\fR#include 'serif/geometry/deformation/actions\&.hpp'\fP
|
|
.br
|
|
|
|
.SS "Classes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "class \fBserif::geometry::deformation::ComposedDeformation< SurfaceMap, ExtensionMap >\fP"
|
|
.br
|
|
.RI "Compose shape-to-surface and surface-to-volume maps with the complete derivative chain rule\&. "
|
|
.ti -1c
|
|
.RI "struct \fBserif::geometry::deformation::ComposedDeformation< SurfaceMap, ExtensionMap >::CurvatureWorkspace\fP"
|
|
.br
|
|
.RI "Nonlinear actions retain the tangent and the two contributions to the shape-force derivative\&. "
|
|
.ti -1c
|
|
.RI "struct \fBserif::geometry::deformation::ComposedDeformation< SurfaceMap, ExtensionMap >::Workspace\fP"
|
|
.br
|
|
.in -1c
|
|
.SS "Namespaces"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "namespace \fBserif\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::geometry\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::geometry::deformation\fP"
|
|
.br
|
|
.in -1c
|
|
.SS "Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "template<DeformationMap SurfaceMap, DeformationMap ExtensionMap>
|
|
.br
|
|
requires std::same_as<typename SurfaceMap::OutputSpace, typename ExtensionMap::InputSpace>std::expected< \fBComposedDeformation\fP< SurfaceMap, ExtensionMap >, \fBDeformationFailure\fP > \fBserif::geometry::deformation::compose_deformation\fP (std::shared_ptr< const SurfaceMap > surface, std::shared_ptr< const ExtensionMap > extension)"
|
|
.br
|
|
.RI "Validate factor sizes before constructing an owning mathematical composition\&. "
|
|
.in -1c
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|