.TH "serif::model::FixedAngularMomentum" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::model::FixedAngularMomentum \- Prescribe angular momentum while angular velocity remains an independent solved coordinate\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fR#include <fixed_angular_momentum\&.hpp>\fP
.SS "Classes"

.in +1c
.ti -1c
.RI "struct \fBParameters\fP"
.br
.in -1c
.SS "Public Types"

.in +1c
.ti -1c
.RI "using \fBScalarDescription\fP"
.br
.ti -1c
.RI "using \fBTargetValue\fP = ScalarDescription::TargetValue"
.br
.ti -1c
.RI "using \fBModelDefinition\fP"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBFixedAngularMomentum\fP (\fBTargetValue\fP angular_momentum)"
.br
.RI "Require finite nonnegative angular momentum about the default z axis\&. "
.ti -1c
.RI "\fBFixedAngularMomentum\fP (\fBParameters\fP parameters)"
.br
.RI "Validate the physical target and normalize a finite nonzero rotation axis\&. "
.ti -1c
.RI "\fBTargetValue\fP \fBtarget\fP () const noexcept"
.br
.RI "Inspect the prescribed total angular momentum\&. "
.ti -1c
.RI "const std::array< double, 3 > & \fBaxis\fP () const noexcept"
.br
.RI "Read the normalized rotation axis\&. "
.ti -1c
.RI "const std::array< double, 3 > & \fBcenter\fP () const noexcept"
.br
.RI "Read the point through which the rotation axis passes\&. "
.in -1c
.SS "Private Attributes"

.in +1c
.ti -1c
.RI "\fBTargetValue\fP \fBm_target\fP"
.br
.ti -1c
.RI "std::array< double, 3 > \fBm_axis\fP"
.br
.ti -1c
.RI "std::array< double, 3 > \fBm_center\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
Prescribe angular momentum while angular velocity remains an independent solved coordinate\&. 
.SH "Member Typedef Documentation"
.PP 
.SS "using \fBserif::model::FixedAngularMomentum::ModelDefinition\fP"
\fBInitial value:\fP
.nf
 SpecificationDefinition<FixedAngularMomentum, "FixedAngularMomentum", SpecificationRole::invariant, GeneratedStateKind::physical_coordinate,
                                                        ScalarDescription, Reads<state::Density, state::SurfaceShape, state::OwnGeneratedCoordinate>,
                                                        Changes<equation::SurfaceShapeBalance, equation::HydrostaticBalance>>
.PP
.fi

.SS "using \fBserif::model::FixedAngularMomentum::ScalarDescription\fP"
\fBInitial value:\fP
.nf
 ScalarConstraint<dimensions::AngularMomentum, dimensions::AngularVelocity, dimensions::AngularMomentum,
                                                   "fixed_angular_momentum\&.angular_velocity", "Omega", "fixed_angular_momentum\&.residual", "R_J">
.PP
.fi

.SS "using \fBserif::model::FixedAngularMomentum::TargetValue\fP = ScalarDescription::TargetValue"

.SH "Constructor & Destructor Documentation"
.PP 
.SS "serif::model::FixedAngularMomentum::FixedAngularMomentum (\fBTargetValue\fP angular_momentum)\fR [explicit]\fP"

.PP
Require finite nonnegative angular momentum about the default z axis\&. Use the default rotation axis for a dimensional angular momentum target\&. 
.SS "serif::model::FixedAngularMomentum::FixedAngularMomentum (\fBParameters\fP parameters)\fR [explicit]\fP"

.PP
Validate the physical target and normalize a finite nonzero rotation axis\&. Preserve arbitrary finite axes and centers without overflowing the normalization calculation\&. 
.SH "Member Function Documentation"
.PP 
.SS "const std::array< double, 3 > & serif::model::FixedAngularMomentum::axis () const\fR [inline]\fP, \fR [nodiscard]\fP, \fR [noexcept]\fP"

.PP
Read the normalized rotation axis\&. 
.SS "const std::array< double, 3 > & serif::model::FixedAngularMomentum::center () const\fR [inline]\fP, \fR [nodiscard]\fP, \fR [noexcept]\fP"

.PP
Read the point through which the rotation axis passes\&. 
.SS "\fBTargetValue\fP serif::model::FixedAngularMomentum::target () const\fR [inline]\fP, \fR [nodiscard]\fP, \fR [noexcept]\fP"

.PP
Inspect the prescribed total angular momentum\&. 
.SH "Member Data Documentation"
.PP 
.SS "std::array<double, 3> serif::model::FixedAngularMomentum::m_axis\fR [private]\fP"

.SS "std::array<double, 3> serif::model::FixedAngularMomentum::m_center\fR [private]\fP"

.SS "\fBTargetValue\fP serif::model::FixedAngularMomentum::m_target\fR [private]\fP"


.SH "Author"
.PP 
Generated automatically by Doxygen for SERiF from the source code\&.