serif::model::FixedAngularMomentum Class Reference

Prescribe angular momentum while angular velocity remains an independent solved coordinate. More...

#include <fixed_angular_momentum.hpp>

Collaboration diagram for serif::model::FixedAngularMomentum:

Classes
struct	Parameters

Public Types
using	ScalarDescription
using	TargetValue = ScalarDescription::TargetValue
using	ModelDefinition

Public Member Functions
	FixedAngularMomentum (TargetValue angular_momentum)
	Require finite nonnegative angular momentum about the default z axis.
	FixedAngularMomentum (Parameters parameters)
	Validate the physical target and normalize a finite nonzero rotation axis.
TargetValue	target () const noexcept
	Inspect the prescribed total angular momentum.
const std::array< double, 3 > &	axis () const noexcept
	Read the normalized rotation axis.
const std::array< double, 3 > &	center () const noexcept
	Read the point through which the rotation axis passes.

Private Attributes
TargetValue	m_target
std::array< double, 3 >	m_axis
std::array< double, 3 >	m_center

Detailed Description

Prescribe angular momentum while angular velocity remains an independent solved coordinate.

Member Typedef Documentation

ModelDefinition

using serif::model::FixedAngularMomentum::ModelDefinition

Initial value:

 SpecificationDefinition<FixedAngularMomentum, "FixedAngularMomentum", SpecificationRole::invariant, GeneratedStateKind::physical_coordinate,
                                                        ScalarDescription, Reads<state::Density, state::SurfaceShape, state::OwnGeneratedCoordinate>,
                                                        Changes<equation::SurfaceShapeBalance, equation::HydrostaticBalance>>

ScalarDescription

using serif::model::FixedAngularMomentum::ScalarDescription

Initial value:

 ScalarConstraint<dimensions::AngularMomentum, dimensions::AngularVelocity, dimensions::AngularMomentum,
                                                   "fixed_angular_momentum.angular_velocity", "Omega", "fixed_angular_momentum.residual", "R_J">

TargetValue

using serif::model::FixedAngularMomentum::TargetValue = ScalarDescription::TargetValue

Constructor & Destructor Documentation

FixedAngularMomentum() [1/2]

serif::model::FixedAngularMomentum::FixedAngularMomentum ( TargetValue angular_momentum )

explicit

Require finite nonnegative angular momentum about the default z axis.

Use the default rotation axis for a dimensional angular momentum target.

FixedAngularMomentum() [2/2]

serif::model::FixedAngularMomentum::FixedAngularMomentum ( Parameters parameters )

explicit

Validate the physical target and normalize a finite nonzero rotation axis.

Preserve arbitrary finite axes and centers without overflowing the normalization calculation.

Member Function Documentation

axis()

const std::array< double, 3 > & serif::model::FixedAngularMomentum::axis ( ) const

inlinenodiscardnoexcept

Read the normalized rotation axis.

center()

const std::array< double, 3 > & serif::model::FixedAngularMomentum::center ( ) const

inlinenodiscardnoexcept

Read the point through which the rotation axis passes.

target()

TargetValue serif::model::FixedAngularMomentum::target ( ) const

inlinenodiscardnoexcept

Inspect the prescribed total angular momentum.

Member Data Documentation

m_axis

std::array<double, 3> serif::model::FixedAngularMomentum::m_axis

private

m_center

std::array<double, 3> serif::model::FixedAngularMomentum::m_center

private

m_target

TargetValue serif::model::FixedAngularMomentum::m_target

private

---

The documentation for this class was generated from the following files:

• src/include/serif/model/specifications/fixed_angular_momentum.hpp
• src/lib/serif/model/specifications.cpp