Files
MeanField_SERiF/docs/man/man3/harmonics.cpp.3

57 lines
1.8 KiB
Groff
Raw Normal View History

.TH "src/lib/serif/geometry/deformation/harmonics.cpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/lib/serif/geometry/deformation/harmonics.cpp
.SH SYNOPSIS
.br
.PP
\fR#include 'serif/geometry/deformation/detail/harmonics\&.hpp'\fP
.br
\fR#include <algorithm>\fP
.br
\fR#include <cmath>\fP
.br
\fR#include <cstdint>\fP
.br
\fR#include <limits>\fP
.br
\fR#include <numbers>\fP
.br
.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
.ti -1c
.RI "namespace \fBserif::geometry::deformation::detail\fP"
.br
.in -1c
.SS "Functions"
.in +1c
.ti -1c
.RI "std::expected< std::vector< \fBSphericalHarmonicMode\fP >, \fBDeformationFailure\fP > \fBserif::geometry::deformation::detail::make_harmonic_modes\fP (const \fBSphericalHarmonicSurface\fP &model, std::size_t node_count)"
.br
.RI "Validate harmonic cutoffs before allocating a basis or enumerating modes\&. "
.ti -1c
.RI "std::expected< std::vector< double >, \fBDeformationFailure\fP > \fBserif::geometry::deformation::detail::sample_harmonic_basis\fP (const \fBSphericalHarmonicSurface\fP &model, std::span< const \fBSphericalHarmonicMode\fP > modes, std::span< const std::array< double, 3 > > directions)"
.br
.RI "Use normalized Legendre recurrence to avoid factorial growth while preserving the Condon–Shortley phase\&. "
.ti -1c
.RI "\fBDeformationStatus\fP \fBserif::geometry::deformation::detail::check_independent_harmonics\fP (std::span< const double > basis, std::size_t node_count, std::size_t mode_count)"
.br
.RI "Check sampled rank on a private copy, leaving physical coefficients and basis normalization unchanged\&. "
.in -1c
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.