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)
88 lines
3.1 KiB
Groff
88 lines
3.1 KiB
Groff
.TH "serif::geometry::deformation::RadialInterpolation" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::geometry::deformation::RadialInterpolation \- A checked, immutable interpolation table; changing a radial law never revalidates its topology\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
\fR#include <radial_interpolation\&.hpp>\fP
|
|
.SS "Public Member Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "const \fBRadialInterpolationData\fP & \fBdata\fP () const noexcept"
|
|
.br
|
|
.RI "Inspect the canonical nodes, interpolation rows and logical shell geometry without mutating them\&. "
|
|
.ti -1c
|
|
.RI "std::size_t \fBscalar_dof_count\fP () const noexcept"
|
|
.br
|
|
.RI "Return the volume scalar-node count, independent of vector layout\&. "
|
|
.ti -1c
|
|
.RI "std::size_t \fBsurface_node_count\fP () const noexcept"
|
|
.br
|
|
.RI "Return the number of canonical stellar surface nodes\&. "
|
|
.in -1c
|
|
.SS "Private Member Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "\fBRadialInterpolation\fP (\fBRadialInterpolationData\fP \fBdata\fP)"
|
|
.br
|
|
.RI "Accept ownership only after the explicit factory has checked the table\&. "
|
|
.in -1c
|
|
.SS "Private Attributes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "\fBRadialInterpolationData\fP \fBm_data\fP"
|
|
.br
|
|
.in -1c
|
|
.SS "Friends"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "std::expected< \fBRadialInterpolation\fP, \fBDeformationFailure\fP > \fBmake_radial_interpolation\fP (\fBRadialInterpolationData\fP \fBdata\fP)"
|
|
.br
|
|
.RI "Check imported or backend-generated reference rows once before sharing them with radial laws\&. "
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
A checked, immutable interpolation table; changing a radial law never revalidates its topology\&.
|
|
.SH "Constructor & Destructor Documentation"
|
|
.PP
|
|
.SS "serif::geometry::deformation::RadialInterpolation::RadialInterpolation (\fBRadialInterpolationData\fP data)\fR [inline]\fP, \fR [explicit]\fP, \fR [private]\fP"
|
|
|
|
.PP
|
|
Accept ownership only after the explicit factory has checked the table\&.
|
|
.SH "Member Function Documentation"
|
|
.PP
|
|
.SS "const \fBRadialInterpolationData\fP & serif::geometry::deformation::RadialInterpolation::data () const\fR [inline]\fP, \fR [nodiscard]\fP, \fR [noexcept]\fP"
|
|
|
|
.PP
|
|
Inspect the canonical nodes, interpolation rows and logical shell geometry without mutating them\&.
|
|
.SS "std::size_t serif::geometry::deformation::RadialInterpolation::scalar_dof_count () const\fR [inline]\fP, \fR [nodiscard]\fP, \fR [noexcept]\fP"
|
|
|
|
.PP
|
|
Return the volume scalar-node count, independent of vector layout\&.
|
|
.SS "std::size_t serif::geometry::deformation::RadialInterpolation::surface_node_count () const\fR [inline]\fP, \fR [nodiscard]\fP, \fR [noexcept]\fP"
|
|
|
|
.PP
|
|
Return the number of canonical stellar surface nodes\&.
|
|
.SH "Friends And Related Symbol Documentation"
|
|
.PP
|
|
.SS "std::expected< \fBRadialInterpolation\fP, \fBDeformationFailure\fP > make_radial_interpolation (\fBRadialInterpolationData\fP data)\fR [friend]\fP"
|
|
|
|
.PP
|
|
Check imported or backend-generated reference rows once before sharing them with radial laws\&.
|
|
.SH "Member Data Documentation"
|
|
.PP
|
|
.SS "\fBRadialInterpolationData\fP serif::geometry::deformation::RadialInterpolation::m_data\fR [private]\fP"
|
|
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|