GearedRotorScenario
Robotics scenarios · Implementation: mlsysim/engine/scenario_definitions/robotics/plant.py.
Construct this scenario with keyword inputs. The fields below show the types and defaults declared by this class.
A rotor seen through a gear_ratio reduction, beside a link of load_inertia.
Notes
Equation: Compose mlsysim.solvers.GearedRotorModel.
Assumptions: The stated fields are inputs to mlsysim.solvers.GearedRotorModel; its documented validity regime, units, and modeling choices apply unchanged.
Excludes: This scenario adds no measurement, empirical calibration, or mechanisms beyond mlsysim.solvers.GearedRotorModel.
References
Derivation: this scenario binds its input fields to the referenced implementation contracts: mlsysim.solvers.GearedRotorModel. The methods below identify any additional arithmetic.
Examples
>>> from mlsysim import Scenarios
>>> case = Scenarios.GearedRotorFlywheel
>>> type(case.result).__name__
'GearedRotorResult'Attributes
| Name | Description |
|---|---|
| flywheel_radius | |
| gear_ratio | |
| load_inertia | |
| result | Evaluate this scenario through mlsysim.solvers.GearedRotorModel.solve. Equation: |
| rotor_inertia | |
| rotor_mass |
gear_ratio
Type: float.
Declared default: required.
rotor_mass
Type: Quantity.
Declared default: required.
rotor_inertia
Type: Quantity.
Declared default: required.
flywheel_radius
Type: Quantity.
Declared default: required.
load_inertia
Type: Quantity.
Declared default: required.
result
engine.scenario_types.GearedRotorScenario.result
Evaluate this scenario through mlsysim.solvers.GearedRotorModel.solve. Equation: pass the stated fields to that implementation; its contract defines the calculation and feasibility tests. Units: each returned field follows the referenced result schema; no independent equation is evaluated by this wrapper.