LIBRARY

RotationalComponents

This is the documentation for the RotationalComponents library. Here you will find the documentation for the various definitions contained in RotationalComponents.

Note that this documentation is automatically generated primarily from the doc strings and metadata associated with those definitions.

Types

• Interfaces.PartialAbsoluteSensor - Base ideal sensor for measuring absolute spline variables with no torque interaction.

• Interfaces.PartialCompliant - Defines a generic compliant rotational connection between two shaft splines.

• Interfaces.PartialCompliantWithRelativeStates - Defines relative angular states for compliant rotational connections.

• Interfaces.PartialElementaryOneSplineAndSupport - A base model for a mechanical component with a primary rotational spline and an interconnected support spline.

• Interfaces.PartialElementaryRotationalToTranslational - Base model defining the mechanical interfaces for transforming rotational motion into translational motion.

• Interfaces.PartialElementaryTwoSplinesAndSupport - A foundational model for a mechanical component with two rotational shaft interfaces and a supporting housing, establishing torque balance.

• Interfaces.PartialRelativeSensor - A foundational partial model for measuring relative kinematic variables between two ideal mechanical splines.

• Interfaces.PartialTorque - Partial model of torque that accelerates the flange.

• Interfaces.PartialTwoSplines - Base component providing two independent spline instances.

• Sources.ReferenceType - Type of reference signal handling for position and speed source components.

• Sources.Regularization - Type of regularization near zero speed for sign-dependent torque models.

Components

• Components.Damper - Models a linear rotational mechanical damping element where torque is proportional to relative angular velocity.

• Components.Disc - 1-dim. rotational rigid component without inertia, where right spline is rotated

• Components.Fixed - Represents a mechanical rotational element fixed at a specified angle.

• Components.IdealGear - An ideal mechanical gear unit with a fixed housing, connecting two rotational shafts.

• Components.IdealGearR2T - Gearbox transforming rotational into translational motion.

• Components.IdealPlanetaryGear - Ideal planetary gear set with three rotational flanges (sun, ring, carrier).

• Components.IdealRollingWheel - Ideal rolling wheel converting rotational motion to translational motion and vice-versa, without inertia.

• Components.Inertia - A 1D-rotational component with inertia, subject to torques from two splines.

• Components.PrescribeInitialAcceleration - Defines an initial angular acceleration for a rotational mechanical spline.

• Components.PrescribeInitialEquilibrium - Sets initial zero angular velocity and zero angular acceleration for a rotational connector.

• Components.PrescribeInitialPosition - Sets a specific initial angular position for a rotational spline connector.

• Components.PrescribeInitialVelocity - Sets a defined initial angular velocity to a rotational mechanical connector.

• Components.RackAndPinion - Models an ideal rack and pinion system, converting rotational motion to translational motion.

• Components.RelativeStates - Definition of relative state variables.

• Components.Spring - Ideal linear rotational spring.

• Components.SpringDamper - Models a linear 1D rotational spring and damper acting in parallel.

• Sensors.AccelerationSensor - Measures the absolute angular acceleration of a rotational spline.

• Sensors.AngleSensor - Measures the absolute rotational angle of a connected spline.

• Sensors.MultiSensor - Ideal sensor to measure the absolute angular velocity, torque, and power between two splines.

• Sensors.PowerSensor - Measures the instantaneous rotational power transmitted between two mechanical rotational splines.

• Sensors.RelativeAccelerationSensor - Ideal sensor that measures the relative angular acceleration between two rotational mechanical splines.

• Sensors.RelativeAngleSensor - Ideal sensor to measure the relative angle between two splines.

• Sensors.RelativeVelocitySensor - Ideal sensor for measuring the relative angular velocity between two rotational splines.

• Sensors.TorqueSensor - Ideal sensor measuring the torque transmitted between two rotational splines.

• Sensors.VelocitySensor - Measures the ideal absolute angular velocity of a rotational mechanical flange.

• Sources.AccelerationSource - Defines the forced angular movement of a spline based on an input acceleration signal.

• Sources.ConstantSpeed - Deprecated alias for ConstantVelocity.

• Sources.ConstantTorque - Constant torque, not dependent on speed.

• Sources.ConstantVelocity - Constant speed, not dependent on torque.

• Sources.InverseSpeedDependentTorque - Torque reciprocal dependent on speed.

• Sources.LinearSpeedDependentTorque - Linear dependency of torque versus speed.

• Sources.Position - Forced movement of a spline according to a reference angle signal.

• Sources.QuadraticSpeedDependentTorque - Quadratic dependency of torque versus speed.

• Sources.SignTorque - Constant torque changing sign with speed.

• Sources.SpeedSource - Deprecated alias for VelocitySource.

• Sources.Torque2 - Input signal acting as torque on two splines.

• Sources.TorqueSource - Ideal source applying an externally specified torque to a rotational spline.

• Sources.TorqueStep - Constant torque, not dependent on speed.

• Sources.VelocitySource - Forced movement of a spline according to a reference angular velocity signal.

Examples

• Examples.CompareBrakingTorque - Compare different braking torques.

• Examples.ElasticBearing - Example to show possible usage of support flange.

• Examples.First - First example: simple drive train.

• Examples.FirstGrounded - First example: simple drive train with grounded elements.

• Examples.TwoInertiasWithDrivingTorque - A mechanical system of two rotational inertias coupled by a spring and damper, driven by a sinusoidal torque.

Tests

• Sources.Tests.AllComponents - Tests Position, VelocitySource, AccelerationSource, and Torque2 components,

• Sources.Tests.ConstantVelocity - Test for ConstantVelocity source, matching MSL ModelicaTest.Rotational.AllComponents topology.

• Sources.Tests.Position - Test of the Position source component with all ReferenceType enum variants,

• Sources.Tests.TestBraking - Test for braking torque sources, matching MSL ModelicaTest.Rotational.TestBraking.

• Sources.Tests.Torque2 - Test for Torque2: two inertias driven by a torque acting between them, matching the MSL test topology.

• Sources.Tests.TorqueStep - Test for TorqueStep source, matching MSL ModelicaTest.Rotational.AllComponents topology.

• Sources.Tests.VelocitySource - Test for VelocitySource with Filtered and Exact modes, matching MSL ModelicaTest.Rotational.TestSpeed.