Skip to content

Commit 1edb2e5

Browse files
committed
Add documentation for new parameters
1 parent 1079783 commit 1edb2e5

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
@@ -2276,6 +2276,10 @@ pressure rises above the auxiliary reservoir pressure, the brake
22762276
cylinder pressure is released completely at a rate determined by the
22772277
retainer setting.
22782278

2279+
BrakeEquipmentType() can also contain a "Distributing_Valve" instead of a
2280+
"triple_valve" or a "distributor", for locomotives fitted with the
2281+
Westinghouse ET-6 distributing valve or similar equipment.
2282+
22792283
Selecting :ref:`Graduated Release Air Brakes <options-general>` in *Menu >
22802284
Options* will force self-lapping notches in the brake controller to have
22812285
graduated release. It will also force graduated release of brakes in triple
@@ -2328,6 +2332,7 @@ The following notch positions can be defined for the train brake at ``Engine(Eng
23282332
single: TrainBrakesControllerSlowServiceStart
23292333
single: TrainBrakesControllerFullServiceStart
23302334
single: TrainBrakesControllerHoldStart
2335+
single: TrainBrakesControllerHoldEngineStart
23312336
single: TrainBrakesControllerEPHoldStart
23322337
single: TrainBrakesControllerSelfLapStart
23332338
single: TrainBrakesControllerRunningStart
@@ -2347,6 +2352,7 @@ The following notch positions can be defined for the train brake at ``Engine(Eng
23472352
single: ORTSTrainBrakesControllerMaxOverchargePressure
23482353
single: ORTSTrainBrakesControllerOverchargeEliminationRate
23492354
single: ORTSTrainBrakesControllerSlowApplicationRate
2355+
single: EngineBrakesControllerBailOffStart
23502356

23512357
**RELEASE and RUNNING tokens**
23522358

@@ -2406,6 +2412,15 @@ Brake Token: ``TrainBrakesControllerReleaseStart``
24062412

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

2415+
Brake Token: ``EngineBrakesControllerBailOffStart``
2416+
2417+
- Operation: Air, EP, Vacuum
2418+
- Brake Systems: Air single pipe, Air twin pipe, EP, Vacuum single pipe
2419+
- Description:
2420+
2421+
- Engine brake: bail off engine brakes
2422+
- Train brake: no change
2423+
24092424
**LAP, HOLDING and NEUTRAL tokens**
24102425

24112426
Brake Token: ``TrainBrakesControllerRunningStart``
@@ -2480,6 +2495,15 @@ Brake Token: ``TrainBrakesControllerNeutralHandleOffStart``
24802495
- Air brakes: Train pipe pressure is held without compensation for leakage.
24812496
- EP brakes: Brake application is held at any value.
24822497
- Vacuum brakes: Train pipe vacuum is held without compensation for leakage.
2498+
2499+
Brake Token: ``TrainBrakesControllerHoldEngineStart``
2500+
2501+
- Operation: Air, EP, Vacuum
2502+
- Brake Systems: Air single pipe, Air twin pipe, EP, Vacuum single pipe
2503+
- Description: HOLD ENGINE
2504+
2505+
- Engine brakes: engine brake cylinder pressure is held at current value.
2506+
- Train brakes: same as RELEASE/RUNNING
24832507

24842508

24852509
**SELF LAPPING APPLY tokens**
@@ -2849,6 +2873,23 @@ defined in a DynamicBrakeForceCurves table that works like the
28492873
DynamicBrakeForceCurves defined in the ENG file, than one is created
28502874
based on the MSTS parameter values.
28512875

2876+
It is possible to use dynamic brakes as a replacement for air brakes
2877+
when they are available (dynamic brake blending). During blending operation,
2878+
the following parameters will adjust the behaviour of air brakes:
2879+
2880+
.. index::
2881+
single: DynamicBrakeHasAutoBailOff
2882+
single: ORTSDynamicBrakesHasPartialBailOff
2883+
2884+
- ``Engine(DynamicBrakeHasAutoBailOff`` -- Set to 1 if brake cylinders are
2885+
emptied while dynamic brake is active
2886+
- ``Engine(ORTSDynamicBrakesHasPartialBailOff`` -- Only used if the parameter
2887+
above is set to 1. When ORTSDynamicBrakesHasPartialBailOff is set to 0 (default),
2888+
air brakes will be fully released when dynamic brake is providing at least the 85%
2889+
of the total train brake demand. When set to 1, only part of the air from the brake
2890+
cylinder is released, so the total air+dynamic brake force equals the total brake demand.
2891+
2892+
28522893
Native Open Rails Braking Parameters
28532894
------------------------------------
28542895

@@ -2872,6 +2913,8 @@ MaxAuxilaryChargingRate and EmergencyResChargingRate.
28722913
single: ORTSBrakeServiceTimeFactor
28732914
single: ORTSBrakeEmergencyTimeFactor
28742915
single: ORTSBrakePipeTimeFactor
2916+
single: ORTSEPBrakeControlsBrakePipe
2917+
single: ORTSCompressorIsMuControlled
28752918

28762919
- ``Wagon(BrakePipeVolume`` -- Volume of car's brake pipe in cubic feet
28772920
(default .5).
@@ -2893,6 +2936,8 @@ MaxAuxilaryChargingRate and EmergencyResChargingRate.
28932936
for twin pipe systems, if the main reservoir pipe is used for charging the auxiliary
28942937
reservoirs. If set to false, the main reservoir pipe will not be used
28952938
by the brake system.
2939+
- ``Wagon(ORTSEPBrakeControlsBrakePipe`` -- Set to 1 for UIC EP brake: brake pipe
2940+
pressure is electrically controlled at every fitted car.
28962941
- ``Engine(ORTSMainResChargingRate`` -- Rate of main reservoir pressure change
28972942
in psi per second when the compressor is on (default .4).
28982943
- ``Engine(ORTSEngineBrakeReleaseRate`` -- Rate of engine brake pressure
@@ -2916,6 +2961,8 @@ MaxAuxilaryChargingRate and EmergencyResChargingRate.
29162961
(default .003).
29172962
- ``Engine(AirBrakeMaxMainResPipePressure`` -- Pressure in Main Reservoir
29182963
Pipe for twin pipe braking systems (default = Main Reservoir Pressure).
2964+
- ``Engine(ORTSCompressorIsMuControlled`` -- Set to 1 if compressors from
2965+
all locomotives are synchronized.
29192966

29202967
.. _physics-retainers:
29212968

0 commit comments

Comments
 (0)