"Steam" container - Revision history

Pw3r: Fix incorrect range listed for 'cutoff' setting

2025-09-08T23:14:05Z

Fix incorrect range listed for 'cutoff' setting

← Older revision		Revision as of 23:14, 8 September 2025
Line 193:		Line 193:
	====cutoff====		====cutoff====
	:Type: Decimal		:Type: Decimal
	:Desc: ~~Ratio~~ (0.0 -> 1.0)~~. Position of cutoff control for test run~~.		:Desc: Position of cutoff control for test run on which test parameters are based (0.0 -> 0.75).

	====blower-effect====		====blower-effect====

Pw3r at 10:55, 23 December 2021

2021-12-23T10:55:35Z

Show changes

Pw3r at 07:47, 23 December 2021

2021-12-23T07:47:26Z

← Older revision		Revision as of 07:47, 23 December 2021
Line 59:		Line 59:
	====boiler-volume====		====boiler-volume====
	:Type: Decimal		:Type: Decimal
	:Desc: Volume in ~~Metres cubed~~. ~~This is~~ the ~~total capacity of~~ the ~~boiler~~.		:Desc: Volume of the boiler, in cubic metres.

			<span style="color: red">Note that in earlier versions of Trainz (pre TC3, trainz-build <2.8) this value was in litres, and newer versions of Trainz will multiply the value when it's read in from the config file.</span>

	====burn-rate====		====burn-rate====
	:Type: Decimal		:Type: Decimal
	:Desc: ~~How much~~ coal (kg) ~~is consumed per second when the loco is operating at the test parameters?~~		:Desc: The tested/'normal' rate at which the firebox burns coal, in kg/s (before being scaled down by drafting rate).

	====burn-rate-idle====		====burn-rate-idle====
	:Type: Decimal		:Type: Decimal
	:Desc: ~~How much~~ coal (kg) ~~is consumed per second when the loco is idle, purely to keep the fire burning?~~		:Desc: The rate at which the firebox constantly/idly burns coal, in kg/s (before being scaled down by drafting rate).

	====firebox-heating-surface-area====		====firebox-heating-surface-area====
	:Type: Decimal		:Type: Decimal
	:Desc: ~~Surface~~ area ~~of the firebox used~~ for ~~heating water. In practice, most of the water heating is done through~~ the firebox~~, not through~~ the ~~tubes. For this reason~~, ~~the surface area quoted should be that of all used sides of the firebox - normally front, back, top, left, right~~. Larger areas result in more ~~firebox to boiler~~ heat transfer - both cooling the fire and heating the water.		:Desc: Total surface area for heat transfer from the firebox to the boiler, in square metres. Larger areas result in more heat transfer, both cooling the fire and heating the water.

	~~====firebox-efficiency====~~
	~~:Type: Decimal~~
	:Desc: Ratio (0.0 -> 1.0). How efficient is the firebox - how much of the fire output is captured and used, and how much is lost? Higher numbers here mean the fire heats up faster, and stays hotter longer when you are trying to cool it down after a run. Lower numbers result in a more lethargic fire which takes longer to heat up, and will cool more quickly.

	====firebox-thermal-conductivity====		====firebox-thermal-conductivity====
	:Type: Decimal		:Type: Decimal
	:Desc: Technically watts per metre kelvin, but real numbers are no good here - many factors mean a steam loco is far from an ideal heat conductor ~~that~~ the equations are based around. 10 seems to be a good number, found by experimentation. A higher number here will mean more heat transfer from the fire to the boiler - resulting in higher pressure but also less fire temperature. Lower numbers will result in more fire temperature, but less heating.		:Desc: Technically watts per metre kelvin, but real numbers are no good here - many factors mean a steam loco is far from an ideal heat conductor than the equations are based around. 10 seems to be a good number, found by experimentation. A higher number here will mean more heat transfer from the fire to the boiler - resulting in higher pressure but also less fire temperature. Lower numbers will result in more fire temperature, but less heating.

	====firebox-plate-thickness====		====firebox-plate-thickness====
	:Type: Decimal		:Type: Decimal
	:Desc: Thickness of firebox plate in metres. 0.016 == 5/8" plate.		:Desc: Thickness of firebox plate in metres. 0.016 == 5/8" plate.

			====fuel-specific-heat-capacity====
			:Type: Decimal
			:Desc: Joules per kilogram kelvin. Amount of energy (joules) needed to raise the temperature of 1 kg of the fuel substance by one degree kelvin.

	====fuel-energy====		====fuel-energy====
	:Type: Decimal		:Type: Decimal
	:Desc: Joules per kilogram. Amount of energy (joules) that ~~can be~~ released by burning 1 kg of the fuel.		:Desc: Joules per kilogram. Amount of energy (joules) that is released by burning 1 kg of the fuel.

	====~~fuel~~-~~specific-heat-capacity~~====		====firebox-efficiency====
	:Type: Decimal		:Type: Decimal
	:Desc: ~~Joules per kilogram kelvin~~. ~~Amount of~~ energy ~~(joules) needed~~ to ~~raise~~ the ~~temperature of 1 kg of~~ the fuel ~~substance by one degree kelvin~~.		:Desc: Firebox efficiency scalar, from 0.0 to 1.0. This directly scales the energy released from fuel burn, in order to approximate various heat losses from the firebox into the environment. Higher numbers mean more energy from fuel burn, lower numbers mean more energy is lost/wasted.

	====initial-boiler-temperature====		====initial-boiler-temperature====

Pcas1986: Corrected minimum and maximum volumes, and fusible-plug-volume. Should have been expressed in litres.

2014-06-23T12:33:23Z

Corrected minimum and maximum volumes, and fusible-plug-volume. Should have been expressed in litres.

← Older revision		Revision as of 12:33, 23 June 2014
Line 21:		Line 21:
	min-fire-temperature 500		min-fire-temperature 500
	max-fire-temperature 1300		max-fire-temperature 1300
	minimum-volume ~~8.0~~		minimum-volume 8000
	maximum-volume ~~9.0~~		maximum-volume 9000
	fusible-plug-volume ~~7.5~~		fusible-plug-volume 7500
	boiler-heat-loss 2.0		boiler-heat-loss 2.0
	piston-angular-offsets 0.0174,1.5254,3.0333,4.5413		piston-angular-offsets 0.0174,1.5254,3.0333,4.5413

Pcas1986: Added sort criterion

2014-02-12T03:02:18Z

Added sort criterion

← Older revision		Revision as of 03:02, 12 February 2014
Line 253:		Line 253:
	''TBD''		''TBD''

	[[Category:Config Container]]		[[Category:Config Container\|S]]

Pencil42: Updated with additional information from http://forums.auran.com/trainz/showthread.php?p=308677

2010-08-31T23:16:36Z

Updated with additional information from http://forums.auran.com/trainz/showthread.php?p=308677

← Older revision		Revision as of 23:16, 31 August 2010
Line 83:		Line 83:
	====firebox-plate-thickness====		====firebox-plate-thickness====
	:Type: Decimal		:Type: Decimal
	:Desc: Thickness of firebox plate in metres.		:Desc: Thickness of firebox plate in metres. 0.016 == 5/8" plate.

	====fuel-energy====		====fuel-energy====
Line 99:		Line 99:
	====max-coal-mass====		====max-coal-mass====
	:Type: Decimal		:Type: Decimal
	:Desc: Maximum amount (kg) of ~~coal~~ it's possible to cram in the firebox, before it starts falling out.		:Desc: Maximum amount (kg) of fuel it's possible to cram in the firebox, before it starts falling out.

	====ideal-coal-mass====		====ideal-coal-mass====
	:Type: Decimal		:Type: Decimal
	:Desc: Ideal amount (kg) of ~~coal~~ to have in the firebox for optimal burning. This value will appear as "100%" on the interface, and will burn the best.		:Desc: Ideal amount (kg) of fuel to have in the firebox for optimal burning. This value will appear as "100%" on the interface, and will burn the best.

	====min-fire-temperature====		====min-fire-temperature====
Line 115:		Line 115:
	====minimum-volume====		====minimum-volume====
	:Type: Decimal		:Type: Decimal
	:Desc: Volume in Litres. This is the amount of water in the boiler that corresponds to the bottom of the sight glass - 0% on the interface.		:Desc: Volume in Litres. This is the amount of water in the boiler that corresponds to the bottom of the sight glass - 0% on the interface. Defaults to 80% boiler-volume.

	====maximum-volume====		====maximum-volume====
	:Type: Decimal		:Type: Decimal
	:Desc: Volume in Litres. This is the amount of water in the boiler that corresponds to the top of the sight glass - 100% on the interface. It should be above the 'minimum volume'.		:Desc: Volume in Litres. This is the amount of water in the boiler that corresponds to the top of the sight glass - 100% on the interface. It should be above the 'minimum volume'. Defaults to 90% boiler-volume.

	====fusible-plug-volume====		====fusible-plug-volume====
	:Type: Decimal		:Type: Decimal
	:Desc: Volume in Litres. This is the amount of water in the boiler at which point the fusible plugs will kick in. It should be below the 'minimum volume'.		:Desc: Volume in Litres. This is the amount of water in the boiler at which point the fusible plugs will kick in. It should be below the 'minimum volume'. Defaults to 75% boiler-volume.

	====boiler-heat-loss====		====boiler-heat-loss====
	:Type: Decimal		:Type: Decimal
	:Desc: ~~TBD~~		:Desc: factor used to cool boiler water over time. Bigger number == more cooling. Magic number (unknown units). Sample: 2.2

	====piston-angular-offsets====		====piston-angular-offsets====
Line 163:		Line 163:
	====shovel-coal-mass====		====shovel-coal-mass====
	:Type: Decimal		:Type: Decimal
	:Desc: How ~~much coal~~ does the fireman move each time he shovels?		:Desc: How many kg of fuel does the fireman move each time he shovels?

	====water-injector-rate====		====water-injector-rate====
Line 203:		Line 203:
	====starting-coal====		====starting-coal====
	:Type: Decimal		:Type: Decimal
	:Desc: Kilograms of coal to start with in the firebox. Ideal value will be used if this is not present.		:Desc: Kilograms of coal to start with in the firebox. Ideal-coal-mass value will be used if this is not present.

	====starting-water====		====starting-water====
	:Type: Decimal		:Type: Decimal
	:Desc: Volume of water (in Litres) to start with in the boiler. 50% ~~level~~ (halfway between 'max' and 'min' on the sight glass) ~~will be used if this is not present.~~		:Desc: Volume of water (in Litres) to start with in the boiler. Will default to 85% boiler-volume (equivalent to halfway between 'max' and 'min' on the sight glass.)

	====starting-boiler-steam====		====starting-boiler-steam====
Line 215:		Line 215:
	====steam-chest-volume====		====steam-chest-volume====
	:Type: Decimal		:Type: Decimal
	:Desc: Volume (metres cubed) of the steam chest.		:Desc: Volume (metres cubed) of the steam chest. A good estimate if unknown is piston-volume-max * number of cylinders (source 5AT website).

	====steam-chest-max-flow====		====steam-chest-max-flow====
Line 235:		Line 235:
	====tractive-effort-constant====		====tractive-effort-constant====
	:Type: Decimal		:Type: Decimal
	:Desc: ~~''TBD''~~		:Desc: Used to calculate theoretical performance along with cylinder dimensions for the AI to use. Defaults to 0.4 * number_of_cylinders.

	====number-cylinders====		====number-cylinders====

Windwalkr: Steam container moved to "Steam" container

2010-03-09T09:19:40Z

Steam container moved to "Steam" container

← Older revision	Revision as of 09:19, 9 March 2010
(No difference)

Windwalkr: 1 revision

2010-02-03T13:59:47Z

1 revision

← Older revision	Revision as of 13:59, 3 February 2010
(No difference)

Pencil42: /* starting-water */

2009-03-23T01:28:19Z

starting-water

New page

The steam container is a top-level [[config.txt file]] entry used by [[KIND Steam-engine|Steam Enginespec]] assets.

==Supported Tags==

The Steam container supports the following tags. Each tag is show here with its default value.

steam
{
boiler-volume 10.0
burn-rate 0.5
burn-rate-idle 0.01
firebox-heating-surface-area 20
firebox-efficiency 0.75
firebox-thermal-conductivity 10
firebox-plate-thickness 0.016
fuel-energy 27912000
fuel-specific-heat-capacity 1260
initial-boiler-temperature 373
max-coal-mass 1000
ideal-coal-mass 500
min-fire-temperature 500
max-fire-temperature 1300
minimum-volume 8.0
maximum-volume 9.0
fusible-plug-volume 7.5
boiler-heat-loss 2.0
piston-angular-offsets 0.0174,1.5254,3.0333,4.5413
piston-volume-min 0.0272
piston-volume-max 0.1505
piston-area 0.1734
safety-valve-low-pressure 1653
safety-valve-low-flow 0.05
safety-valve-high-pressure 1684
safety-valve-high-flow 0.1
shovel-coal-mass 5.0
water-injector-rate 3.0
water-injector-rate2 3.0
boiler-efficency-idle 0.75
boiler-efficency 0.4
boiler-efficency-min 0.25
speed 15.0
cutoff 0.4
blower-effect 0.5
blower-max-flow 2.5
starting-coal 500
starting-water 7500.0
starting-boiler-steam 10.0
steam-chest-volume 0.1233
steam-chest-max-flow 25.0
valve-lap-percent 0.05
hand-brake-max-force 1000
super-heating-constant 100
tractive-effort-constant 0.8
number-cylinders 2
number-power-strokes 2
legacy-piston-count 4
}

====boiler-volume====
:Type: Decimal
:Desc: Volume in Metres cubed. This is the total capacity of the boiler.

====burn-rate====
:Type: Decimal
:Desc: How much coal (kg) is consumed per second when the loco is operating at the test parameters?

====burn-rate-idle====
:Type: Decimal
:Desc: How much coal (kg) is consumed per second when the loco is idle, purely to keep the fire burning?

====firebox-heating-surface-area====
:Type: Decimal
:Desc: Surface area of the firebox used for heating water. In practice, most of the water heating is done through the firebox, not through the tubes. For this reason, the surface area quoted should be that of all used sides of the firebox - normally front, back, top, left, right. Larger areas result in more firebox to boiler heat transfer - both cooling the fire and heating the water.

====firebox-efficiency====
:Type: Decimal
:Desc: Ratio (0.0 -> 1.0). How efficient is the firebox - how much of the fire output is captured and used, and how much is lost? Higher numbers here mean the fire heats up faster, and stays hotter longer when you are trying to cool it down after a run. Lower numbers result in a more lethargic fire which takes longer to heat up, and will cool more quickly.

====firebox-thermal-conductivity====
:Type: Decimal
:Desc: Technically watts per metre kelvin, but real numbers are no good here - many factors mean a steam loco is far from an ideal heat conductor that the equations are based around. 10 seems to be a good number, found by experimentation. A higher number here will mean more heat transfer from the fire to the boiler - resulting in higher pressure but also less fire temperature. Lower numbers will result in more fire temperature, but less heating.

====firebox-plate-thickness====
:Type: Decimal
:Desc: Thickness of firebox plate in metres.

====fuel-energy====
:Type: Decimal
:Desc: Joules per kilogram. Amount of energy (joules) that can be released by burning 1 kg of the fuel.

====fuel-specific-heat-capacity====
:Type: Decimal
:Desc: Joules per kilogram kelvin. Amount of energy (joules) needed to raise the temperature of 1 kg of the fuel substance by one degree kelvin.

====initial-boiler-temperature====
:Type: Decimal
:Desc: Degrees kelvin. This value will determine whether the engine is 'ready to go' or needs 'warming up' prior to a run when first placed.

====max-coal-mass====
:Type: Decimal
:Desc: Maximum amount (kg) of coal it's possible to cram in the firebox, before it starts falling out.

====ideal-coal-mass====
:Type: Decimal
:Desc: Ideal amount (kg) of coal to have in the firebox for optimal burning. This value will appear as "100%" on the interface, and will burn the best.

====min-fire-temperature====
:Type: Decimal
:Desc: Degrees K. A higher value here makes the loco 'wake up' quicker, but too high a value will make it build pressure even when left idle.

====max-fire-temperature====
:Type: Decimal
:Desc: Degrees K. Lowering top end fire temperature will have the effect of limiting both top end boiler pressure and maximum water heating ability when working hard.

====minimum-volume====
:Type: Decimal
:Desc: Volume in Litres. This is the amount of water in the boiler that corresponds to the bottom of the sight glass - 0% on the interface.

====maximum-volume====
:Type: Decimal
:Desc: Volume in Litres. This is the amount of water in the boiler that corresponds to the top of the sight glass - 100% on the interface. It should be above the 'minimum volume'.

====fusible-plug-volume====
:Type: Decimal
:Desc: Volume in Litres. This is the amount of water in the boiler at which point the fusible plugs will kick in. It should be below the 'minimum volume'.

====boiler-heat-loss====
:Type: Decimal
:Desc: TBD

====piston-angular-offsets====
:Type: Decimal Array
:Desc: Values are specified in radians. Amount of wheel rotation required to rotate each piston to maximum travel from starting position. Will depend on how the valve gear has been animated in max. One value per piston.

====piston-volume-min====
:Type: Decimal
:Desc: clearance volume of a piston - i.e. the volume at minimum travel. This value greatly affects the level of front-end power available to a specific loco.

====piston-volume-max====
:Type: Decimal
:Desc: Total volume of a piston at maximum travel - i.e. the swept volume (stroke*area) plus the clearance volume.

====piston-area====
:Type: Decimal
:Desc: Surface area of the piston (metres squared).

====safety-valve-low-pressure====
:Type: Decimal
:Desc: Pressure (absolute, and in kPa) at which the low pressure safety valve will blow.

====safety-valve-low-flow====
:Type: Decimal
:Desc: Kilograms per second of steam that escape through the low pressure safety valve. Note: Too high a value will result in a 'sawtooth' boiler pressure, and repeated short hisses from the safety valve.

====safety-valve-high-pressure====
:Type: Decimal
:Desc: Pressure (absolute, and in kPa) at which the high pressure safety valve will blow.

====safety-valve-high-flow====
:Type: Decimal
:Desc: Kilograms per second of steam that escape through the high pressure safety valve. Remember that both valves will be open at this point.

====shovel-coal-mass====
:Type: Decimal
:Desc: How much coal does the fireman move each time he shovels?

====water-injector-rate====
:Type: Decimal
:Desc: litres of water moved into the boiler per second through the first injector when fully on.

====water-injector-rate2====
:Type: Decimal
:Desc: litres of water moved into the boiler per second through the second injector when fully on.

====boiler-efficency-idle====
:Type: Decimal
:Desc: Ratio (0.0 -> 1.0). Maximum efficiency of boiler - e.g. when loco idle.

====boiler-efficency====
:Type: Decimal
:Desc: Ratio (0.0 -> 1.0). Efficiency of boiler when working at test parameters.

====boiler-efficency-min====
:Type: Decimal
:Desc: Minimum boiler efficiency. Calculated efficiency will not fall below this value.

====speed====
:Type: Decimal
:Desc: Speed of test run on which test parameters are based.

====cutoff====
:Type: Decimal
:Desc: Ratio (0.0 -> 1.0). Position of cutoff control for test run.

====blower-effect====
:Type: Decimal
:Desc: Multiplier. Sets the effectiveness of the blower. Value is the draft effect of working the loco at the test parameters compared with running the blower at maximum boiler pressure but the loco otherwise idle.

====blower-max-flow====
:Type: Decimal
:Desc: Kilograms per second of steam used by blower at max boiler pressure and max setting.

====starting-coal====
:Type: Decimal
:Desc: Kilograms of coal to start with in the firebox. Ideal value will be used if this is not present.

====starting-water====
:Type: Decimal
:Desc: Volume of water (in Litres) to start with in the boiler. 50% level (halfway between 'max' and 'min' on the sight glass) will be used if this is not present.

====starting-boiler-steam====
:Type: Decimal
:Desc: Amount of steam to start with in the boiler. If this is too high, a false 'high pressure' will be reported at initial startup (but working the loco will reduce it). If it is too low, the boiler will boil water to build pressure, so using a low value (maybe even zero?) is suggested.

====steam-chest-volume====
:Type: Decimal
:Desc: Volume (metres cubed) of the steam chest.

====steam-chest-max-flow====
:Type: Decimal
:Desc: Max flow (kilograms per second) of steam from boiler to steam chest with regulator fully open.

====valve-lap-percent====
:Type: Decimal
:Desc: Ratio (0.0 -> 1.0)

====hand-brake-max-force====
:Type: Decimal
:Desc: Maximum force exerted by handbrake.

====super-heating-constant====
:Type: Decimal
:Desc: Degrees (kelvin) to increase temperature of steam between boiler and steam chest. High superheat results in more power at the front end.

====tractive-effort-constant====
:Type: Decimal
:Desc: ''TBD''

====number-cylinders====
:Type: Integer
:Desc: Number of cylinders.

====number-power-strokes====
:Type: Integer
:Desc: Number of power strokes per revolution. Two is by far the most common number, but this can be other numbers in extreme cases.

====legacy-piston-count====
:Type: Decimal
:Desc: Used for loading old (TRS2006) saved sessions. An omission in the TRS2006 save format causes a loco with a different number of pistons not to load properly. The number of pistons often needs to be changed when updating old enginespecs, as previously engines had to have twice as many single acting pistons, rather than the correct number of double acting pistons as they do now. This value is to record the old number of pistons so that old sessions can still be loaded.

==Example steam container==

''TBD''

[[Category:Config Container]]