Files
MeanField_SERiF/docs/man/man3/serif_geometry_deformation_SphericalHarmonicSurface.3

54 lines
1.6 KiB
Groff
Raw Normal View History

.TH "serif::geometry::deformation::SphericalHarmonicSurface" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::geometry::deformation::SphericalHarmonicSurface \- Represent radial displacement lengths with normalized real spherical harmonics on the reference surface\&.
.SH SYNOPSIS
.br
.PP
.PP
\fR#include <models\&.hpp>\fP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "bool \fBoperator==\fP (const \fBSphericalHarmonicSurface\fP &) const =default"
.br
.RI "A changed center or harmonic selection changes the physical representation\&. "
.in -1c
.SS "Public Attributes"
.in +1c
.ti -1c
.RI "std::array< double, 3 > \fBreference_center\fP {}"
.br
.ti -1c
.RI "int \fBmaximum_degree\fP {4}"
.br
.ti -1c
.RI "std::optional< int > \fBmaximum_azimuthal_order\fP {}"
.br
.in -1c
.SH "Detailed Description"
.PP
Represent radial displacement lengths with normalized real spherical harmonics on the reference surface\&.
.SH "Member Function Documentation"
.PP
.SS "bool serif::geometry::deformation::SphericalHarmonicSurface::operator== (const \fBSphericalHarmonicSurface\fP & ) const\fR [nodiscard]\fP, \fR [default]\fP"
.PP
A changed center or harmonic selection changes the physical representation\&.
.SH "Member Data Documentation"
.PP
.SS "std::optional<int> serif::geometry::deformation::SphericalHarmonicSurface::maximum_azimuthal_order {}"
.SS "int serif::geometry::deformation::SphericalHarmonicSurface::maximum_degree {4}"
.SS "std::array<double, 3> serif::geometry::deformation::SphericalHarmonicSurface::reference_center {}"
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.