Skip to content

Commit 938b320

Browse files
committed
Add documentation for new parameters
1 parent d406c67 commit 938b320

File tree

1 file changed

+47
-0
lines changed

1 file changed

+47
-0
lines changed

Source/Documentation/Manual/physics.rst

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2300,6 +2300,10 @@ pressure rises above the auxiliary reservoir pressure, the brake
23002300
cylinder pressure is released completely at a rate determined by the
23012301
retainer setting.
23022302

2303+
BrakeEquipmentType() can also contain a "Distributing_Valve" instead of a
2304+
"triple_valve" or a "distributor", for locomotives fitted with the
2305+
Westinghouse ET-6 distributing valve or similar equipment.
2306+
23032307
Selecting :ref:`Graduated Release Air Brakes <options-general>` in *Menu >
23042308
Options* will force self-lapping notches in the brake controller to have
23052309
graduated release. It will also force graduated release of brakes in triple
@@ -2352,6 +2356,7 @@ The following notch positions can be defined for the train brake at ``Engine(Eng
23522356
single: TrainBrakesControllerSlowServiceStart
23532357
single: TrainBrakesControllerFullServiceStart
23542358
single: TrainBrakesControllerHoldStart
2359+
single: TrainBrakesControllerHoldEngineStart
23552360
single: TrainBrakesControllerEPHoldStart
23562361
single: TrainBrakesControllerSelfLapStart
23572362
single: TrainBrakesControllerRunningStart
@@ -2371,6 +2376,7 @@ The following notch positions can be defined for the train brake at ``Engine(Eng
23712376
single: ORTSTrainBrakesControllerMaxOverchargePressure
23722377
single: ORTSTrainBrakesControllerOverchargeEliminationRate
23732378
single: ORTSTrainBrakesControllerSlowApplicationRate
2379+
single: EngineBrakesControllerBailOffStart
23742380

23752381
**RELEASE and RUNNING tokens**
23762382

@@ -2430,6 +2436,15 @@ Brake Token: ``TrainBrakesControllerReleaseStart``
24302436

24312437
- Connects brake pipe to ejector(s) and/or vacuum pump. Brakes may be released by operating large or small ejector.
24322438

2439+
Brake Token: ``EngineBrakesControllerBailOffStart``
2440+
2441+
- Operation: Air, EP, Vacuum
2442+
- Brake Systems: Air single pipe, Air twin pipe, EP, Vacuum single pipe
2443+
- Description:
2444+
2445+
- Engine brake: bail off engine brakes
2446+
- Train brake: no change
2447+
24332448
**LAP, HOLDING and NEUTRAL tokens**
24342449

24352450
Brake Token: ``TrainBrakesControllerRunningStart``
@@ -2504,6 +2519,15 @@ Brake Token: ``TrainBrakesControllerNeutralHandleOffStart``
25042519
- Air brakes: Train pipe pressure is held without compensation for leakage.
25052520
- EP brakes: Brake application is held at any value.
25062521
- Vacuum brakes: Train pipe vacuum is held without compensation for leakage.
2522+
2523+
Brake Token: ``TrainBrakesControllerHoldEngineStart``
2524+
2525+
- Operation: Air, EP, Vacuum
2526+
- Brake Systems: Air single pipe, Air twin pipe, EP, Vacuum single pipe
2527+
- Description: HOLD ENGINE
2528+
2529+
- Engine brakes: engine brake cylinder pressure is held at current value.
2530+
- Train brakes: same as RELEASE/RUNNING
25072531

25082532

25092533
**SELF LAPPING APPLY tokens**
@@ -2875,6 +2899,23 @@ defined in a DynamicBrakeForceCurves table that works like the
28752899
DynamicBrakeForceCurves defined in the ENG file, than one is created
28762900
based on the MSTS parameter values.
28772901

2902+
It is possible to use dynamic brakes as a replacement for air brakes
2903+
when they are available (dynamic brake blending). During blending operation,
2904+
the following parameters will adjust the behaviour of air brakes:
2905+
2906+
.. index::
2907+
single: DynamicBrakeHasAutoBailOff
2908+
single: ORTSDynamicBrakesHasPartialBailOff
2909+
2910+
- ``Engine(DynamicBrakeHasAutoBailOff`` -- Set to 1 if brake cylinders are
2911+
emptied while dynamic brake is active
2912+
- ``Engine(ORTSDynamicBrakesHasPartialBailOff`` -- Only used if the parameter
2913+
above is set to 1. When ORTSDynamicBrakesHasPartialBailOff is set to 0 (default),
2914+
air brakes will be fully released when dynamic brake is providing at least the 85%
2915+
of the total train brake demand. When set to 1, only part of the air from the brake
2916+
cylinder is released, so the total air+dynamic brake force equals the total brake demand.
2917+
2918+
28782919
Native Open Rails Braking Parameters
28792920
------------------------------------
28802921

@@ -2898,6 +2939,8 @@ MaxAuxilaryChargingRate and EmergencyResChargingRate.
28982939
single: ORTSBrakeServiceTimeFactor
28992940
single: ORTSBrakeEmergencyTimeFactor
29002941
single: ORTSBrakePipeTimeFactor
2942+
single: ORTSEPBrakeControlsBrakePipe
2943+
single: ORTSCompressorIsMuControlled
29012944

29022945
- ``Wagon(BrakePipeVolume`` -- Volume of car's brake pipe in cubic feet
29032946
(default .5).
@@ -2919,6 +2962,8 @@ MaxAuxilaryChargingRate and EmergencyResChargingRate.
29192962
for twin pipe systems, if the main reservoir pipe is used for charging the auxiliary
29202963
reservoirs. If set to false, the main reservoir pipe will not be used
29212964
by the brake system.
2965+
- ``Wagon(ORTSEPBrakeControlsBrakePipe`` -- Set to 1 for UIC EP brake: brake pipe
2966+
pressure is electrically controlled at every fitted car.
29222967
- ``Engine(ORTSMainResChargingRate`` -- Rate of main reservoir pressure change
29232968
in psi per second when the compressor is on (default .4).
29242969
- ``Engine(ORTSEngineBrakeReleaseRate`` -- Rate of engine brake pressure
@@ -2942,6 +2987,8 @@ MaxAuxilaryChargingRate and EmergencyResChargingRate.
29422987
(default .003).
29432988
- ``Engine(AirBrakeMaxMainResPipePressure`` -- Pressure in Main Reservoir
29442989
Pipe for twin pipe braking systems (default = Main Reservoir Pressure).
2990+
- ``Engine(ORTSCompressorIsMuControlled`` -- Set to 1 if compressors from
2991+
all locomotives are synchronized.
29452992

29462993
.. _physics-retainers:
29472994

0 commit comments

Comments
 (0)