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

59 lines
1.4 KiB
Groff
Raw Permalink Normal View History

.TH "serif::solver::seed::FittedRadialSeed" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::solver::seed::FittedRadialSeed \- An explicitly stretched initial guess, distinct from an equilibrium Lane–Emden scaling\&.
.SH SYNOPSIS
.br
.PP
.PP
\fR#include <fitted\&.hpp>\fP
.SS "Public Attributes"
.in +1c
.ti -1c
.RI "\fBRadialSeed\fP \fBsource\fP"
.br
.ti -1c
.RI "\fBdimensions::LengthValue\fP \fBradius\fP"
.br
.ti -1c
.RI "\fBdimensions::MassValue\fP \fBmass\fP"
.br
.ti -1c
.RI "double \fBmoment_of_inertia\fP {}"
.br
.ti -1c
.RI "double \fBangular_velocity\fP {}"
.br
.in -1c
.SH "Detailed Description"
.PP
An explicitly stretched initial guess, distinct from an equilibrium Lane–Emden scaling\&.
.PP
\fBNote\fP
.RS 4
The source EOS, density and enthalpy stay unchanged at corresponding fractional radii\&. Gravity follows the stretched density; this generally breaks hydrostatic balance, intentionally\&.
.RE
.PP
.SH "Member Data Documentation"
.PP
.SS "double serif::solver::seed::FittedRadialSeed::angular_velocity {}"
.SS "\fBdimensions::MassValue\fP serif::solver::seed::FittedRadialSeed::mass"
.SS "double serif::solver::seed::FittedRadialSeed::moment_of_inertia {}"
.SS "\fBdimensions::LengthValue\fP serif::solver::seed::FittedRadialSeed::radius"
.SS "\fBRadialSeed\fP serif::solver::seed::FittedRadialSeed::source"
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.