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)
77 lines
2.5 KiB
Groff
77 lines
2.5 KiB
Groff
.TH "serif::solver::continuation::AngularMomentum" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::solver::continuation::AngularMomentum
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
\fR#include <stellar_parameters\&.hpp>\fP
|
|
.SS "Public Types"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "using \fBSpecification\fP = \fBmodel::FixedAngularMomentum\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "using \fBValue\fP = \fBdimensions::AngularMomentumValue\fP"
|
|
.br
|
|
.in -1c
|
|
.SS "Static Public Member Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "static \fBValue\fP \fBread\fP (const \fBSpecification\fP &value) noexcept"
|
|
.br
|
|
.RI "Read the prescribed angular momentum, independently of solved angular velocity\&. "
|
|
.ti -1c
|
|
.RI "static bool \fBvalid\fP (\fBValue\fP value) noexcept"
|
|
.br
|
|
.RI "Match the nonnegative rotation prescription\&. "
|
|
.ti -1c
|
|
.RI "static \fBValue\fP \fBstarting_value\fP (\fBValue\fP) noexcept"
|
|
.br
|
|
.RI "Start from the nonrotating family member\&. "
|
|
.in -1c
|
|
.SS "Static Public Attributes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "static constexpr std::string_view \fBname\fP = 'angular momentum'"
|
|
.br
|
|
.ti -1c
|
|
.RI "static constexpr std::string_view \fBstable_id\fP = 'fixed_angular_momentum\&.target'"
|
|
.br
|
|
.in -1c
|
|
.SH "Member Typedef Documentation"
|
|
.PP
|
|
.SS "using \fBserif::solver::continuation::AngularMomentum::Specification\fP = \fBmodel::FixedAngularMomentum\fP"
|
|
|
|
.SS "using \fBserif::solver::continuation::AngularMomentum::Value\fP = \fBdimensions::AngularMomentumValue\fP"
|
|
|
|
.SH "Member Function Documentation"
|
|
.PP
|
|
.SS "static \fBValue\fP serif::solver::continuation::AngularMomentum::read (const \fBSpecification\fP & value)\fR [inline]\fP, \fR [static]\fP, \fR [nodiscard]\fP, \fR [noexcept]\fP"
|
|
|
|
.PP
|
|
Read the prescribed angular momentum, independently of solved angular velocity\&.
|
|
.SS "static \fBValue\fP serif::solver::continuation::AngularMomentum::starting_value (\fBValue\fP )\fR [inline]\fP, \fR [static]\fP, \fR [nodiscard]\fP, \fR [noexcept]\fP"
|
|
|
|
.PP
|
|
Start from the nonrotating family member\&.
|
|
.SS "static bool serif::solver::continuation::AngularMomentum::valid (\fBValue\fP value)\fR [inline]\fP, \fR [static]\fP, \fR [nodiscard]\fP, \fR [noexcept]\fP"
|
|
|
|
.PP
|
|
Match the nonnegative rotation prescription\&.
|
|
.SH "Member Data Documentation"
|
|
.PP
|
|
.SS "std::string_view serif::solver::continuation::AngularMomentum::name = 'angular momentum'\fR [static]\fP, \fR [constexpr]\fP"
|
|
|
|
.SS "std::string_view serif::solver::continuation::AngularMomentum::stable_id = 'fixed_angular_momentum\&.target'\fR [static]\fP, \fR [constexpr]\fP"
|
|
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|