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)
52 lines
1.3 KiB
Groff
52 lines
1.3 KiB
Groff
.TH "src/include/serif/geometry/deformation/radial_interpolation.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
src/include/serif/geometry/deformation/radial_interpolation.hpp
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
\fR#include <utility>\fP
|
|
.br
|
|
\fR#include <vector>\fP
|
|
.br
|
|
\fR#include 'serif/geometry/deformation/failure\&.hpp'\fP
|
|
.br
|
|
|
|
.SS "Classes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "struct \fBserif::geometry::deformation::RadialInterpolationData\fP"
|
|
.br
|
|
.RI "Own the surface interpolation shared by the stellar and vacuum extensions\&. "
|
|
.ti -1c
|
|
.RI "class \fBserif::geometry::deformation::RadialInterpolation\fP"
|
|
.br
|
|
.RI "A checked, immutable interpolation table; changing a radial law never revalidates its topology\&. "
|
|
.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< \fBRadialInterpolation\fP, \fBDeformationFailure\fP > \fBserif::geometry::deformation::make_radial_interpolation\fP (\fBRadialInterpolationData\fP data)"
|
|
.br
|
|
.RI "Check imported or backend-generated reference rows once before sharing them with radial laws\&. "
|
|
.in -1c
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|