LIBRARY

TranslationalComponents

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

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

Types

• Components.Regularization - Type of regularization near zero speed for sign-dependent force and torque models.

• Interfaces.PartialAbsoluteSensor - Base model for an ideal mechanical sensor measuring absolute flange variables by ensuring zero force interaction.

• Interfaces.PartialCompliant - Base model for a 1D translational compliant connection.

• Interfaces.PartialCompliantWithRelativeStates - Base model for a 1D translational compliant connection using relative displacement and relative velocity as states.

• Interfaces.PartialElementaryOneFlangeAndSupport - Base model for a one-flange translational component with support.

• Interfaces.PartialElementaryOneFlangeAndSupport2 - Partial model for a component with one translational 1D flange and a support.

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

• Interfaces.PartialElementaryTwoFlangesAndSupport2 - Partial model for a component with two translational 1D flanges and a support.

• Interfaces.PartialForce - Partial model of a force acting at the flange (accelerates the flange).

• Interfaces.PartialRelativeSensor - Base two-port element for relative sensing, ensuring conservation of flow between its connection points.

• Interfaces.PartialRigid - Models a massless, rigid connection of a defined length between two translational 1D flanges.

• Interfaces.PartialTwoFlanges - Base component representing a one-dimensional mechanical component with two translational connection points (flanges).

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

Components

• Components.Damper - Linear translational damper relating force to relative velocity.

• Components.ElastoGap - 1D translational spring damper combination with gap.

• Components.Fixed - Constrains a translational flange to a fixed position.

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

• Components.IdealRollingWheel - Simple 1-dim. model of an ideal rolling wheel without inertia.

• Components.Mass - Represents a sliding mass with inertia, subject to external and gravitational forces.

• Components.PrescribeInitialAcceleration - Defines a specific initial acceleration for a one-dimensional mechanical translational flange.

• Components.PrescribeInitialEquilibrium - Sets the initial velocity and acceleration of a connected flange to zero.

• Components.PrescribeInitialPosition - Sets the initial position of a translational mechanical flange.

• Components.PrescribeInitialVelocity - Sets an initial velocity condition for a translational mechanical flange.

• Components.RelativeStates - Definition of relative state variables.

• Components.Rod - Rod without inertia.

• Components.RollingResistance - Resistance of a rolling wheel.

• Components.Spring - Linear 1D translational spring relating force to displacement via Hooke's Law.

• Components.SpringDamper - Models a linear translational spring and a linear translational damper connected in parallel.

• Sensors.AccelerationSensor - Ideal sensor measuring the absolute translational acceleration of a flange.

• Sensors.ForceSensor - Ideal sensor measuring the translational force transmitted between two flanges.

• Sensors.MultiSensor - Ideal sensor measuring absolute velocity, transmitted force, and power flow between two mechanical flanges.

• Sensors.PositionSensor - Measures the absolute linear position of a mechanical translational flange.

• Sensors.PowerSensor - Ideal sensor measuring the translational power flowing through a point.

• Sensors.RelativeAccelerationSensor - Ideal sensor measuring the relative acceleration between two translational flanges.

• Sensors.RelativePositionSensor - Measures the ideal relative translational position between two mechanical flanges.

• Sensors.RelativeSpeedSensor - Deprecated alias for RelativeVelocitySensor.

• Sensors.RelativeVelocitySensor - Ideal sensor measuring the relative translational velocity between two mechanical flanges.

• Sensors.SpeedSensor - Deprecated alias for VelocitySensor.

• Sensors.VelocitySensor - Ideal sensor that measures the absolute translational velocity of a mechanical flange.

• Sources.Accelerate - Deprecated alias for AccelerationSource.

• Sources.AccelerationSource - Forced movement of a flange according to an acceleration signal.

• Sources.ConstantForce - Constant force, not dependent on speed.

• Sources.ConstantSpeed - Deprecated alias for ConstantVelocity.

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

• Sources.Force - An ideal force source that applies equal and opposite forces to two translational mechanical flanges, controlled by an external signal.

• Sources.ForceStep - Force step at a given time.

• Sources.InverseSpeedDependentForce - Force reciprocal dependent on speed.

• Sources.LinearSpeedDependentForce - Linear dependency of force versus speed.

• Sources.Position - Forced movement of a flange according to a reference position.

• Sources.QuadraticSpeedDependentForce - Quadratic dependency of force versus speed.

• Sources.SignForce - Constant force changing sign with speed.

• Sources.Speed - Deprecated alias for VelocitySource.

• Sources.VelocitySource - Forced movement of a flange according to a reference speed.

Examples

• Examples.Accelerate - Use of model Accelerate.

• Examples.Damper - Demonstrate the use of damper models.

• Examples.ElastoGap - Demonstrate usage of ElastoGap.

• Examples.InitialConditions - Setting of initial conditions.

• Examples.Oscillator - Oscillator demonstrates the use of initial conditions.

• Examples.PreLoad - Preload of a spool using ElastoGap models.

• Examples.Sensors - Demonstrate sensors for translational systems.

• Examples.SignConvention - Examples for the used sign conventions.

• Examples.WhyArrows - Demonstrate the importance of arrow direction in Translational models.

Tests

• Components.Tests.AllComponents - Smoke test exercising all available translational components in a single model.

• Components.Tests.MassDamperSpringFixed - A one-dimensional translational mechanical system composed of a mass, spring, and damper connected to a fixed point.

• Sensors.Tests.RelativeSensors - A test rig for sensors measuring relative translational motion between two independently forced masses.

• Sensors.Tests.Sensors - Test environment for verifying absolute position, speed, and acceleration sensors monitoring a mass driven by a constant force.

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

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

• Sources.Tests.TestBraking - Test of braking force models.