Skip to content

Commit 777efaf

Browse files
committed
Include documentation
1 parent bb815cd commit 777efaf

File tree

2 files changed

+52
-1
lines changed

2 files changed

+52
-1
lines changed

Source/Documentation/Manual/physics.rst

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1141,6 +1141,58 @@ with the ``ORTSTractionMotorType ( AC ) `` parameter, to be inserted in the Engi
11411141
section of the ENG file. The use of this motor will have an impact on wheel slip,
11421142
because the wheel speed never exceeds the frequency of the rotating magnetic field.
11431143
1144+
Traction force retardation
1145+
''''''''''''''''''''''''''
1146+
1147+
.. index::
1148+
single: ORTSTractiveForceRampUpRate
1149+
single: ORTSTractiveForceRampDownRate
1150+
single: ORTSTractiveForceRampDownToZeroRate
1151+
single: ORTSDynamicBrakeForceRampUpRate
1152+
single: ORTSDynamicBrakeForceRampDownRate
1153+
single: ORTSDynamicBrakeForceRampDownToZeroRate
1154+
single: ORTSDelayTimeBeforeUpdating
1155+
1156+
When the driver sets full throttle, the control electronics may not apply the full
1157+
tractive force instantly, but it will instead linearly apply force until reaching
1158+
the target demand. This can be tuned both for traction and dynamic braking by inserting
1159+
``ORTSTractiveForceRampUpRate``, ``ORTSTractiveForceRampDownRate``,
1160+
``ORTSTractiveForceRampDownToZeroRate``, ``ORTSDynamicBrakeForceRampUpRate``,
1161+
``ORTSDynamicBrakeForceRampDownRate`` and ``ORTSDynamicBrakeForceRampDownToZeroRate``
1162+
in the .eng file. The value of each parameter determines the force increase/decrease
1163+
rate in one second.
1164+
1165+
Example::
1166+
1167+
Engine (
1168+
ORTSTractiveForceRampUpRate ( 50kN )
1169+
ORTSTractiveForceRampDownRate ( 50kN )
1170+
ORTSTractiveForceRampDownToZeroRate ( 100kN )
1171+
ORTSDynamicBrakeForceRampUpRate ( 70kN )
1172+
ORTSDynamicBrakeForceRampDownRate ( 50kN )
1173+
ORTSDynamicBrakeForceRampDownToZeroRate ( 50kN )
1174+
)
1175+
1176+
Another possibility to avoid sudden variations in tractive force while the driver
1177+
is moving the throttle, is to only update the throttle/brake demand when the lever
1178+
has not been moved for a defined amount of time. This can be implemented using the
1179+
``ORTSDelayTimeBeforeUpdating``, which has to be inserted for the desired
1180+
controller in the ``EngineControllers`` block.
1181+
1182+
Example::
1183+
1184+
Engine (
1185+
EngineControllers (
1186+
Throttle ( 0 1 0.1 0
1187+
NumNotches ( 0 )
1188+
ORTSDelayTimeBeforeUpdating ( 0.5s )
1189+
)
1190+
Brake_Dynamic ( 0 1 0.1 0
1191+
NumNotches ( 0 )
1192+
ORTSDelayTimeBeforeUpdating ( 1s )
1193+
)
1194+
)
1195+
)
11441196

11451197
Steam Locomotives
11461198
-----------------

Source/Orts.Simulation/Simulation/RollingStocks/MSTSLocomotive.cs

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,6 @@
5959
using Orts.Simulation.RollingStocks.SubSystems.PowerTransmissions;
6060
using ORTS.Common;
6161
using ORTS.Scripting.Api;
62-
using SharpDX.Direct3D9;
6362
using System;
6463
using System.Collections.Generic;
6564
using System.Diagnostics;

0 commit comments

Comments
 (0)