Subsystem Setup

Contents

  1. 1 Subsystem Setup
    1. 1.1 Loco Brake Assembly
    2. 1.2 Train Brake Assembly
    3. 1.3 Max Power (kW 0-20000 (1kW = 1.341HP)
    4. 1.4 Max Force (kN 0-10000 (1kN = 225lbf)
    5. 1.5 Max Speed (mph 0-300)
    6. 1.6 Has Third Rail Power Supply
    7. 1.7 Startup Time
    8. 1.8 Shutdown Time
    9. 1.9 Tender Required (True/False)
    10. 1.10 Tractive Effort VS Cutoff CSV
    11. 1.11 Tractive Effort Linear VS Speed CSV
    12. 1.12 Cutoff Steam usage scalar (No units (0 – 2.0)
    13. 1.13 Speed Steam usage scalar (No units (0 – 2.0)
    14. 1.14 Total Steam usage scalar (No units (0 – 2.0)
    15. 1.15 Basic Steam Usage (Lb/hour (200 – 2000)
  2. 2 Injectors
    1. 2.1 Type (Live Steam or Exhaust Steam)
    2. 2.2 Min Boiler Pressure (PSI (10 – 100)
    3. 2.3 Min Injector Proportion (No units (0 – 1.0)
    4. 2.4 Max Injector Proportion (No units (0 – 1.0)
    5. 2.5 Size (mm (1 – 16.9)
    6. 2.6 Feed Rate Multiplier (No units (0 – 2)
    7. 2.7 Priming Failure Level (No units (0 – 1.5)
    8. 2.8 Steam Usage Multiplier
  3. 3 Firebox
    1. 3.1 Condition Change VS Temperature CSV
    2. 3.2 Burn Rate VS Steam Usage Rate CSV
    3. 3.3 Min Temperature (Celsius (100 – 2000)
    4. 3.4 Max Temperature (Celsius (>=500)
    5. 3.5 Critical Temperature (Celsius (>=500)
    6. 3.6 Max Fuel Mass (Lbs (>=1000)
    7. 3.7 Ideal Fuel Mass (Lbs (>=1000)
    8. 3.8 Grate limit (Lbs/hour (>=1000)
    9. 3.9 Basic Coal Usage Rate (Lb/hour (100 – 1000)
    10. 3.10 Min Stoking Rate (Lb/hour (0 – 1000)
    11. 3.11 Max Stoking Rate (Lb/hour (20 – 10000)
    12. 3.12 Min Steam Usage (Lb/hour (0– 1000)
    13. 3.13 Max Steam Usage (Lb/hour (1 – 10000)
    14. 3.14 Min Pressure for Stoker (PSI (20 – 300)
    15. 3.15 Smoke per Pound of Fuel (Units/pound. (50-1000)
    16. 3.16 Max Smoke Rate (Smoke Units (1 – 20)
  4. 4 Boiler
    1. 4.1 Volume (Cubic ft (50 – 10000)
    2. 4.2 Max Pressure (PSI (50 – 500)
    3. 4.3 Exhaust Limit (Lb/hour)
    4. 4.4 Blast Exponent (No units (0-1.0)
    5. 4.5 Max Output (Lb/hour (1000-100000)
    6. 4.6 Drafting Effect (No units (0 - 1.5)
    7. 4.7 Effectiveness (No units (1.0 - 2.0)
    8. 4.8 Max Water Height Multiple (No units)
    9. 4.9 Min Priming Level (No units (0.8 – 1.2)
    10. 4.10 Priming Factor (No units (0.8 – 1.0)
    11. 4.11 Reduction with Cocks Open (No units (0 – 1.0)
    12. 4.12 Priming Power Loss Prop (No units (0 – 1.0)
    13. 4.13 Max Water Mass (Lb)
    14. 4.14 Water Usage Increase Prop (No units (0 – 10.0)
    15. 4.15 Super Heater (No units (1 – 1.4)
    16. 4.16 Responsiveness (No units (1.0 - 1.5)
    17. 4.17 Length (Meters (1 – 20)
    18. 4.18 Gauge Height (Meters (0.01 -1)
  5. 5 Safety Valve
    1. 5.1 Pressure for Open (PSI)
    2. 5.2 Pressure for Close (PSI)
    3. 5.3 Steam Usage (Lb/hour (1000 – 20000)
  6. 6 Cylinders
    1. 6.1 Cylinder Cocks Efficiency (No units (0 - 1.0)
    2. 6.2 Automated Cylinder Cocks (0 or 1)
    3. 6.3 No of Cylinders
    4. 6.4 No of Strokes
    5. 6.5 Stroke
    6. 6.6 Diameter
    7. 6.7 Effectivity
  7. 7 Blower
    1. 7.1 Effect Exponent (No units (0 - 2.0)
    2. 7.2 Efficiency Exponent (No units (0 - 2.0)
    3. 7.3 Max Steam Usage Rate (Lb/hour (100-1500)
    4. 7.4 Proportion of Blast Effect (No units (0 - 1.0)
  8. 8 Regulator
    1. 8.1 Type (Single or Twin Port)
    2. 8.2 Second Valve Start Pos (No units (0 - 1.0)
    3. 8.3 Pilot Valve Full Opening (No units (0 – 1.0)
    4. 8.4 Main Valve Initial Opening (No units (0 – 1.0)
  9. 9 Generator
    1. 9.1 Present (True/False)
    2. 9.2 Min Working Pressure (PSI (100-300)
    3. 9.3 Steam Usage Rate (Lb/hour (100 – 500)
  10. 10 Compressor Ejector
    1. 10.1 Air System
      1. 10.1.1 Has Low Pressure Test (True/False)
      2. 10.1.2 Min Air Pressure
      3. 10.1.3 Cut Out Pressure (PSI)
      4. 10.1.4 Restart Pressure (PSI)
      5. 10.1.5 Reservoir Volume (PSI)
      6. 10.1.6 Main Res Max Air Pressure (PSI)
      7. 10.1.7 Compressor
      8. 10.1.8 Type
      9. 10.1.9 Power Rating
    2. 10.2 Small Ejector
      1. 10.2.1 Present (True / False)
      2. 10.2.2 Vacuum Creation Rate
      3. 10.2.3 Boiler Pressure for Max Vacuum
      4. 10.2.4 Boiler Pressure for Zero Vacuum
      5. 10.2.5 Steam Usage Rate (Lb/hour (0 – 1000)
    3. 10.3 Large Ejector
      1. 10.3.1 Present (True / False)
      2. 10.3.2 Vacuum Creation Rate (Inches Hg/Sec)
      3. 10.3.3 Boiler Pressure for Max Vacuum
      4. 10.3.4 Boiler Pressure for Zero Vacuum
      5. 10.3.5 Steam Usage Rate (Lb/hour (0 – 1500)
    4. 10.4 Vacuum Pump
      1. 10.4.1 Present (True/False)
      2. 10.4.2 Speed of Max Effect
      3. 10.4.3 Power (PSI/Sec)
    5. 10.5 Steam Heating
      1. 10.5.1 Present (True / False)
      2. 10.5.2 Max Pressure
      3. 10.5.3 Max Supply Rate (Lb/hour (0 – 1000)
      4. 10.5.4 Fuel Burn Rate (Lb/hour (0 – 1000)
    6. 10.6 Script Component
      1. 10.6.1 Name

Subsystem Setup

For setting up a steam simulation blueprint, click “Insert First” and select “Steam Sub System Blueprint” from the pop-up box.

Loco Brake Assembly

This defines the vehicle’s locomotive brakes. See separate Brake Blueprint Documentation.

Train Brake Assembly

This defines the train brakes. See separate Brake Blueprint Documentation.

Max Power (kW 0-20000 (1kW = 1.341HP)

This is the maximum power output of the locomotive, in kilowatts. It is more important to performance when travelling at high speeds.

In Train Simulator terms this is MaxPower.

Max Force (kN 0-10000 (1kN = 225lbf)

This is the maximum Tractive Effort of the locomotive, in kilowatts. This is more important for performance at low speeds. Tractive Effort is important when starting a train.

In Train Simulator terms this is MaxForce.

Max Speed (mph 0-300)

This is the point at which the simulation will stop producing any driving force to the wheels. It scales from 90% of this speed = Full simulation force & 100 % = 0 simulation force. This should ideally be set slightly higher than the actual max speed of a given loco.

In Train Simulator terms this is MaxVelocity.

Has Third Rail Power Supply

Non Functional for Steam Locos.

Startup Time

Non Functional for Steam Locos.

Shutdown Time

Non Functional for Steam Locos.

Tender Required (True/False)

This defines if the locomotive has a traditional tender on its own wheels or if it is a Tank Engine style setup with a coal bunk on the back of the footplate. 

True’ for Tender engines ‘False’ for Tank engines.

Tractive Effort VS Cutoff CSV

In this field, a custom ‘Tractive Effort vs Cutoff curve’ can be supplied in the form of a .csv (Comma Separated Variable) file. This maps the proportion of the Max Tractive Effort available at different settings of the Reverser (or “Cutoff”).

The .csv must be provided with Reverser/Cutoff setting in Column A and Proportion of Max Tractive Effort in Column B.

Tractive Effort Linear VS Speed CSV

In this section, a custom ‘Tractive Effort Linear vs Speed’ can be supplied in the form of a .csv (Comma Separated Variable) file. Generally, this would be a linear relationship but the facility is there to use non-linear values.

The .csv must be in the format shown below with Speed in Column A and Proportion of Max Tractive Effort in Column B

Cutoff Steam usage scalar (No units (0 – 2.0)

Use this to increase/decrease the steam usage due to cut off.

Speed Steam usage scalar (No units (0 – 2.0)

This is a multiplier for steam usage due to speed.

Total Steam usage scalar (No units (0 – 2.0)

This is a multiplier for total steam usage.

Basic Steam Usage (Lb/hour (200 – 2000)

This is the usage of steam for working the auxiliary units.

In Train Simulator terms this is BasicSteamUsage.

Injectors

The Injectors on a locomotive feed water to the boiler. Water in the boiler is consumed as steam is generated and it is essential that the water is replaced quickly to allow steam production to be maintained and to prevent a low water level. Injectors transfer water from the Tender to the Boiler.

Type (Live Steam or Exhaust Steam)

Injectors either use Live Steam from the Boiler or Exhaust Steam from the Cylinders to combine with water from the tender.

Min Boiler Pressure (PSI (10 – 100)

This is the minimum boiler pressure for Injector1 to function.

Min Injector Proportion (No units (0 – 1.0)

This is the minimum Water Valve Opening for Injector1 to function.

Max Injector Proportion (No units (0 – 1.0)

This is the maximum Water Valve Opening for Injector1 to function.

In Train Simulator terms these were all combined in the InjectorLimits1.

Size (mm (1 – 16.9)

This is the size of one of the cones inside the injector. The larger it is the greater the capacity of the injectors.

Feed Rate Multiplier (No units (0 – 2)

This is the Steam Usage and Feeding Rate of the Injector, lower values use less steam.

Priming Failure Level (No units (0 – 1.5)

This is the level of Priming at which the Injectors will fail.

Steam Usage Multiplier

This is the amount of steam used by the Injectors.

Firebox

Condition Change VS Temperature CSV

Here a custom ‘Condition Change vs Temperature’ can be supplied in the form of a .csv (Comma Separated Variable) file. This controls how the effectivity of the Fire decreases as the Temperature tends away from the Ideal Temperature.

Note: The temperature values in this .csv use arbitrary units and map on to the Min and Max Firebox Temperatures in Degrees Celsius supplied in the Firebox Blueprint. 

The .csv must be provided with Firebox Temperature in Column A and Condition Change in Column B.

Burn Rate VS Steam Usage Rate CSV

In this section, a custom ‘Burn Rate vs Steam Usage Rate’ can be supplied in the form of a .csv (Comma Separated Variable) file. This controls how the Fire condition and Steam Usage Rate interact.

The .csv must be in the format shown below with Steam Usage in Column A and Burn Rate in Column B.

Min Temperature (Celsius (100 – 2000)

This is the minimum temperature in the firebox to produce steam.

Max Temperature (Celsius (>=500)

This is the maximum temperature possible in the firebox.

Critical Temperature (Celsius (>=500)

The condition of the fire improves when above this temperature.

Max Fuel Mass (Lbs (>=1000)

This defines the maximum mass of firebox coal.

In Train Simulator terms this is the MaxFireMass.

Ideal Fuel Mass (Lbs (>=1000)

This is the mass of firebox coal that will give the greatest steam production. The closer the actual fire mass gets to the ideal mass the better the steam production.

In Train Simulator terms this is the IdealFireMass.

Grate limit (Lbs/hour (>=1000)

This is the amount of coal burnt in an hour.

In Train Simulator terms this is CoalBurnage.

Basic Coal Usage Rate (Lb/hour (100 – 1000)

This is how much coal is used for basic steam usage and maintaining the boiler temperature.

In Train Simulator terms this is BasicCoalUsage.

Min Stoking Rate (Lb/hour (0 – 1000)

This is the minimum amount of coal the fireman will shovel in an hour.

Max Stoking Rate (Lb/hour (20 – 10000)

This is the maximum amount of coal the fireman will shovel in an hour.

In Train Simulator terms this is the SteamFiremanMaxPossibleFiringRate.

Min Steam Usage (Lb/hour (0– 1000)

This is the minimum amount of steam used per hour. For example, while it is idling.

Max Steam Usage (Lb/hour (1 – 10000)

This is the maximum amount of steam used per hour.

Min Pressure for Stoker (PSI (20 – 300)

This is the minimum boiler pressure at which the mechanical stoker can be used.

Smoke per Pound of Fuel (Units/pound. (50-1000)

This is the amount of Smoke produced per pound of fuel. This is a cosmetic feature that affects the amount of smoke coming out of the chimney but has not yet been implemented.

Max Smoke Rate (Smoke Units (1 – 20)

This is the amount of Smoke produced per second; which again affects the amount of smoke coming out of the chimney. As above, this is not yet implemented.

Boiler

Volume (Cubic ft (50 – 10000)

This is the usable volume of the boiler.

In Train Simulator terms this is the BoilerVolume.

Max Pressure (PSI (50 – 500)

This is the Boiler Pressure at which the Safety Valves lift.

In Train Simulator terms this is the MaxBoilerPressure.

Exhaust Limit (Lb/hour)

This is the maximum mass of steam that can pass out the cylinders and chimney.

Blast Exponent (No units (0-1.0)

Exhaust steam is released from the cylinders, via the blast-pipe located inside the smokebox. Aimed up the chimney, the jet of steam blasting up through the smoke-box draws air through the fire and along the boiler tubes and out the chimney. This parameter simulates the efficiency of the Blast Pipe and impacts the Firebox Temperature.

Max Output (Lb/hour (1000-100000)

This is the maximum rate that the boiler can produce steam.

Drafting Effect (No units (0 - 1.5)

This is how well the fire produces energy. Lower values mean the fire is easier to burn.

Effectiveness (No units (1.0 - 2.0)

This is how effective the boiler is at producing steam.

Max Water Height Multiple (No units)

<Undefined>

Min Priming Level (No units (0.8 – 1.2)

Priming is when water from the boiler gets into the steam pipe, usually caused by too high water level. This can damage the engine and drastically reduce performance. This parameter is the lowest water level that Priming will occur at and how quickly it occurs.

Priming Factor (No units (0.8 – 1.0)

This is how sensitive the locomotive is to priming.

Reduction with Cocks Open (No units (0 – 1.0)

This is how much priming is reduced by opening the Cylinder Cocks.

Priming Power Loss Prop (No units (0 – 1.0)

This is how much Priming affects Tractive Effort.

Max Water Mass (Lb)

This is the maximum amount of water that the Boiler can contain.

Water Usage Increase Prop (No units (0 – 10.0)

This is the rate of water loss from priming.

Super Heater (No units (1 – 1.4)

This is the efficiency of the superheater if present (1 means no Superheating). Higher values increase steam production and Tractive Effort.

Responsiveness (No units (1.0 - 1.5)

This is how quickly the Boiler responds to firing changes.

In Train Simulator terms this is the BoilerResponsiveness.

Length (Meters (1 – 20)

This is the length of the Boiler. It affects the boiler performance on steep gradients.

In Train Simulator terms this is the BoilerLength.

Gauge Height (Meters (0.01 -1)

<undefined>

Safety Valve

Pressure for Open (PSI)

This is the amount that the boiler pressure has to reach for the safety valves to open.

Pressure for Close (PSI)

This is the amount that the boiler pressure has to fall below the maximum for the safety valves to close.

Steam Usage (Lb/hour (1000 – 20000)

This is how much steam the Safety Valves use when they lift in an emergency.

Cylinders

Cylinder Cocks Efficiency (No units (0 - 1.0)

This is how much steam the Cylinder Cocks use when they are open.

Automated Cylinder Cocks (0 or 1)

This turns on or off the automatic Cylinder Cocks. This is only active when Priming is on.

In Train Simulator terms this is the SteamCylinderCocksOperation.

No of Cylinders

This is the number of Cylinders that the locomotive has.

No of Strokes

This is the number of Strokes of Cylinder per one revolution of the Driving Wheels.

Stroke

This is the length of Cylinder Stroke in inches.

Diameter

This is the diameter of Cylinder in inches.

Effectivity

<undefined>

Blower

The Blower is a means of providing a draught for the fire when no exhaust is available. It is used to maintain a draught on the fire. It is controlled by the driver, who will open a valve in the cab to allow live steam from the boiler to escape into the chimney whenever there is no exhaust steam from the cylinders to provide the draught.

The draught from the blower keeps the gases from the fire flowing through the tubes to the smoke box and prevents the possibility of a reversal of the flow with the resultant blowback of fire into the cab.

Effect Exponent (No units (0 - 2.0)

This defines how much the Blower affects the fire. Values less than 1 increase the blowers effect.

Efficiency Exponent (No units (0 - 2.0)

<Undefined>

Max Steam Usage Rate (Lb/hour (100-1500)

This is the maximum amount of steam used by the Blower.

Proportion of Blast Effect (No units (0 - 1.0)

This is the effect of the Blower compared with the normal damping effect of the exhaust.

Regulator

Type (Single or Twin Port)

Twin port was only used in the UK. A Twin Port Regulator has two valves (Main and Pilot) in the regulator controlled by the regulator handle. The Pilot Valve is smaller and lets a limited amount of steam to the cylinders. It's used for starting a light train and maintaining a constant speed. The Main Valve is bigger, giving more steam pressure to the cylinders. The Main Valve is used when you need more power.

Second Valve Start Pos (No units (0 - 1.0)

The rotation of the regulator needed to start the second valve operating.

Pilot Valve Full Opening (No units (0 – 1.0)

This is the effect of the Pilot Valve being fully open.

Main Valve Initial Opening (No units (0 – 1.0)

This is the proportion of the maximum effect when the Main Valve is first opened.

Generator

The generator provides electricity for carriage lighting and other systems not located on the locomotive.

Present (True/False)

This value defines whether a generator is available.

Min Working Pressure (PSI (100-300)

This is the minimum Pressure for the Generator to work.

Steam Usage Rate (Lb/hour (100 – 500)

This is the amount of steam used by the Generator.

Compressor Ejector

If the locomotive has Air Brakes it needs a Compressor to supply air.

If the locomotive has Vacuum Brakes it needs an Ejector to create a vacuum.

Air System

Has Low Pressure Test (True/False)

When Brakes are released in an Air Brake System, the pressure in the Main Reservoir falls. If ‘True’ is selected here, once the pressure falls to a certain pressure Restart Pressure then the Generator kicks in and restores Main Reservoir Pressure.

Min Air Pressure

<undefined>

Cut Out Pressure (PSI)

This is the Main Reservoir Pressure at which the Generator cuts out.

Restart Pressure (PSI)

This is the Main Reservoir Pressure at which the Generator cuts in.

Reservoir Volume (PSI)

This is the Volume of the Main Reservoir. This affects how much the Main Reservoir Pressure falls when the Air Brakes are released.

Main Res Max Air Pressure (PSI)

This is the maximum pressure in Main Reservoir, and will normally be the same as ‘Restart Pressure’.

Compressor

Type

Non Functional for Steam Locos.

Power Rating

Non Functional for Steam Locos.

Small Ejector

Present (True / False)

This value defines whether a small ejector is available.

Vacuum Creation Rate

The rate at which the vacuum is created in Inches Hg/Sec

Boiler Pressure for Max Vacuum

<undefined>

Boiler Pressure for Zero Vacuum

<undefined>

Steam Usage Rate (Lb/hour (0 – 1000)

This is the amount of steam used by the Small Ejector.

In Train Simulator terms this is the VacuumBrakesSmallEjectorUsageRate.

Large Ejector

The Large Ejector maintains the Vacuum against leakage.

Present (True / False)

This value defines whether a large ejector is available.

Vacuum Creation Rate (Inches Hg/Sec)

This is the rate at which the vacuum is created

Boiler Pressure for Max Vacuum

<Undefined>

Boiler Pressure for Zero Vacuum

<Undefined>

Steam Usage Rate (Lb/hour (0 – 1500)

This is the amount of steam used by the Large Ejector.

In Train Simulator terms this is the VacuumBrakesLargeEjectorUsageRate.

Vacuum Pump

Present (True/False)

<Undefined>

Speed of Max Effect

<Undefined>

Power (PSI/Sec)

<Undefined>

Steam Heating

Steam from the locomotive can also be used to heat the carriages or vehicles it is hauling. In here you can define the details of this heating equipment.

Present (True / False)

This value defines whether a large ejector is available.

Max Pressure

<undefined>

Max Supply Rate (Lb/hour (0 – 1000)

This is the amount of steam used.

Fuel Burn Rate (Lb/hour (0 – 1000)

This is the amount of fuel used.

Script Component

Name

This is where you specify the LUA Simulation Script created for this locomotive.