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)
44 lines
1.3 KiB
Groff
44 lines
1.3 KiB
Groff
.TH "serif::geometry::deformation::PowerLawRadialExtension" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::geometry::deformation::PowerLawRadialExtension \- Extend surface motion toward a fixed stellar center using a power of logical reference radius\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
\fR#include <models\&.hpp>\fP
|
|
.SS "Public Member Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "bool \fBoperator==\fP (const \fBPowerLawRadialExtension\fP &) const =default"
|
|
.br
|
|
.RI "The radial power changes the interior response even for unchanged surface motion\&. "
|
|
.in -1c
|
|
.SS "Public Attributes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "double \fBradial_power\fP {2\&.0}"
|
|
.br
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
Extend surface motion toward a fixed stellar center using a power of logical reference radius\&.
|
|
.SH "Member Function Documentation"
|
|
.PP
|
|
.SS "bool serif::geometry::deformation::PowerLawRadialExtension::operator== (const \fBPowerLawRadialExtension\fP & ) const\fR [nodiscard]\fP, \fR [default]\fP"
|
|
|
|
.PP
|
|
The radial power changes the interior response even for unchanged surface motion\&.
|
|
.SH "Member Data Documentation"
|
|
.PP
|
|
.SS "double serif::geometry::deformation::PowerLawRadialExtension::radial_power {2\&.0}"
|
|
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|