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)
49 lines
1.3 KiB
Groff
49 lines
1.3 KiB
Groff
.TH "serif::geometry::deformation::SphericalHarmonicMode" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::geometry::deformation::SphericalHarmonicMode \- Identify a real harmonic, with negative orders using sine and positive orders using cosine\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
\fR#include <surface_embedding\&.hpp>\fP
|
|
.SS "Public Member Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "bool \fBoperator==\fP (const \fBSphericalHarmonicMode\fP &) const =default"
|
|
.br
|
|
.RI "Mode identity includes the sign of the azimuthal order\&. "
|
|
.in -1c
|
|
.SS "Public Attributes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "int \fBdegree\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "int \fBorder\fP"
|
|
.br
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
Identify a real harmonic, with negative orders using sine and positive orders using cosine\&.
|
|
.SH "Member Function Documentation"
|
|
.PP
|
|
.SS "bool serif::geometry::deformation::SphericalHarmonicMode::operator== (const \fBSphericalHarmonicMode\fP & ) const\fR [nodiscard]\fP, \fR [default]\fP"
|
|
|
|
.PP
|
|
Mode identity includes the sign of the azimuthal order\&.
|
|
.SH "Member Data Documentation"
|
|
.PP
|
|
.SS "int serif::geometry::deformation::SphericalHarmonicMode::degree"
|
|
|
|
.SS "int serif::geometry::deformation::SphericalHarmonicMode::order"
|
|
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|