68 lines
2.0 KiB
Groff
68 lines
2.0 KiB
Groff
|
.TH "src/include/serif/geometry/deformation/surface_embedding.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
||
|
|
.ad l
|
||
|
|
.nh
|
||
|
|
.SH NAME
|
||
|
|
src/include/serif/geometry/deformation/surface_embedding.hpp
|
||
|
|
.SH SYNOPSIS
|
||
|
|
.br
|
||
|
|
.PP
|
||
|
|
\fR#include <array>\fP
|
||
|
|
.br
|
||
|
|
\fR#include <cstddef>\fP
|
||
|
|
.br
|
||
|
|
\fR#include <expected>\fP
|
||
|
|
.br
|
||
|
|
\fR#include <span>\fP
|
||
|
|
.br
|
||
|
|
\fR#include <vector>\fP
|
||
|
|
.br
|
||
|
|
\fR#include 'serif/geometry/deformation/failure\&.hpp'\fP
|
||
|
|
.br
|
||
|
|
\fR#include 'serif/geometry/deformation/models\&.hpp'\fP
|
||
|
|
.br
|
||
|
|
\fR#include 'serif/geometry/deformation/spaces\&.hpp'\fP
|
||
|
|
.br
|
||
|
|
\fR#include 'serif/geometry/deformation/workspace\&.hpp'\fP
|
||
|
|
.br
|
||
|
|
|
||
|
|
.SS "Classes"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "struct \fBserif::geometry::deformation::SphericalHarmonicMode\fP"
|
||
|
|
.br
|
||
|
|
.RI "Identify a real harmonic, with negative orders using sine and positive orders using cosine\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "class \fBserif::geometry::deformation::SurfaceEmbedding\fP"
|
||
|
|
.br
|
||
|
|
.RI "Own a linear conversion from radial displacement lengths to Cartesian surface displacements\&. "
|
||
|
|
.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 "std::expected< \fBSurfaceEmbedding\fP, \fBDeformationFailure\fP > \fBserif::geometry::deformation::build_surface_embedding\fP (const \fBNodalRadialSurface\fP &model, std::span< const std::array< double, 3 > > positions)"
|
||
|
|
.br
|
||
|
|
.RI "Compile fixed radial directions from ordered physical reference positions without retaining backend objects\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "std::expected< \fBSurfaceEmbedding\fP, \fBDeformationFailure\fP > \fBserif::geometry::deformation::build_surface_embedding\fP (const \fBSphericalHarmonicSurface\fP &model, std::span< const std::array< double, 3 > > positions)"
|
||
|
|
.br
|
||
|
|
.RI "Sample physically normalized real harmonics and reject unresolved modes without renormalizing or dropping coordinates\&. "
|
||
|
|
.in -1c
|
||
|
|
.SH "Author"
|
||
|
|
.PP
|
||
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|