CCG/Steam-Engine
(New page: ==KIND: STEAM-ENGINE== ===Description=== The special engine specification for steam locomotives which defines the detailed performance requirements such as throttle requirements, engine a...) |
(→Steam Container) |
||
(2 intermediate revisions by one user not shown) | |||
Line 14: | Line 14: | ||
A TYPICAL ASSET OF THIS KIND MAY HAVE THE FOLLOWING TAGS: | A TYPICAL ASSET OF THIS KIND MAY HAVE THE FOLLOWING TAGS: | ||
− | <font color="red">steam-engine</font> | + | <font color="red">kind ''"steam-engine"''</font> |
− | + | ||
kuid ''kuid'' | kuid ''kuid'' | ||
trainz-build ''data'' | trainz-build ''data'' | ||
Line 22: | Line 21: | ||
category-era ''data'' | category-era ''data'' | ||
username ''data'' | username ''data'' | ||
− | |||
<font color="red">flowsize</font> | <font color="red">flowsize</font> | ||
Line 257: | Line 255: | ||
;max-coal-mass | ;max-coal-mass | ||
:Maximum volume of coal. | :Maximum volume of coal. | ||
− | |||
− | |||
− | |||
;minimum-volume | ;minimum-volume | ||
− | :The minimum volume of the | + | :The 'minimum' volume of the boiler (in millilitres). It's important to note that this is not literally 'empty', but rather the value at which the water gauge will read empty. By default this is 80% of the boiler volume. |
+ | ;maximum-volume | ||
+ | :The 'maximum' volume of the boiler (in millilitres). It's important to note that this is not literally 'full', but rather the value at which the water gauge will read full. By default this is 90% of the boiler volume. | ||
====Mass Container==== | ====Mass Container==== |
Latest revision as of 14:25, 22 December 2021
Contents |
[edit] KIND: STEAM-ENGINE
[edit] Description
The special engine specification for steam locomotives which defines the detailed performance requirements such as throttle requirements, engine and braking performance, boiler capacity and steam attributes.
[edit] Container Structure
A well formed steam-engine kind has the following container structure:
See Chapter 7 for an example asset of this kind.
A TYPICAL ASSET OF THIS KIND MAY HAVE THE FOLLOWING TAGS:
kind "steam-engine" kuid kuid trainz-build data category-class data category-region data category-era data username data flowsize trainbrakepipe data epreservoirpipe data no3pipe data no4pipe data auxreservoirvent data auxreservoir_no3 data auxreservoir_trainbrakepipe data autobrakecylindervent data auxreservoir_autobrakecylinder data equaliser_mainreservoir data equaliservent data equaliserventhandleoff data equaliserventemergency data no3pipevent data no3pipe_mainreservoir data compressor data trainbrakepipe_reservoir data trainbrakepipevent data no3pipe_autobrakecylinder data epreservoirpipe_autobrakecylinder data mainreservoir_ep data vacuumbrakepipe data vacuumbrakepipereleasevent data vacuumbrakepipevent data vacuumbrakereservoir_vacuumbrakepipe data vacuumbrakecylinder_vacuumbrakepipe data highspeedexhauster_vacuumbrakepipe data volume scale data trainbrakepipe data epreservoirpipe data no3pipe data no4pipe data auxreservoir data autobrakecylinder data vacuumbrakepipe data vacuumbrakereservoir data vacuumbrakecylinder data mainreservoir data equaliser data independantbrakecylinder data pressure scale data compressor data mainreservoir data highspeedexhauster data brakepipe data brakeinitial data brakefull data indbrakefull data trainbrakepipe_start data epreservoirpipe_start data no3pipe_start data no4pipe_start data auxreservoir_start data autobrakecylinder_start data vacuumbrakepipe_start data vacuumbrakereservoir_start data vacuumbrakecylinder_start data mainreservoir_start data equaliser_start data independantbrakecylinder_start data mass scale data fuel data motor resistance data adhesion data maxvoltage data maxspeed data brakeratio data max-accel data max-decel data axle-count data surface-area data moving-friction-coefficient data air-drag-coefficient data throttle-notches data steam firebox-to-boiler-heat-flow data firebox-efficiency data boiler-volume data minimum-volume data maximum-volume data initial-boiler-temperature data water-injector-rate data piston-volume-min data piston-volume-max data piston-area data piston-angular-offsets data firebox-to-boiler-heat-flow-idle data burn-rate-idle data boiler-to-piston-flow data piston-to-atmosphere-flow data safety-valve-low-pressure data safety-valve-low-flow data safety-valve-high-pressure data safety-valve-high-flow data max-fire-coal-mass data max-fire-temperature data shovel-coal-mass data burn-rate data fuel-energy data firebox-volume data main-reservoir-volume data westinghouse-volume data thumbnails 0 image file width data height data
[edit] TAGS AND CONTAINERS
The following tags are further defined in Chapter 5:
- kuid
- Generated automatically by Content Manager.
- trainz-build
- Automatically set to 2.9 for 2009 assets.
- category-class
- Should be one of the following: "AS" - Steam Loco & Tender, "AT" - Steam Tank.
- See the "Motive Power" section of Category Class.
- category-region
- See Category Region for a list of valid category-region values.
- category-era
- See Category Era for a list of valid category-era values.
- username
- Asset username. Though this asset doesn't appear in the Surveyor menu, the username is used to identify the asset in the "Content Manager" and "Content Creator Plus" programs.
- kind
- Must be "steam-engine".
[edit] Additional Containers
As well as containing all of the common tags and containers detailed in Chapter 5 , the steam-engine kind also contains additional containers and tags that are specialised to the requirements of the kind.
[edit] Steam Container
The Steam Container stores specialised variables related to steam engines.
The Steam Containers has the following tags:
- boiler-to-piston-flow
- Relative energy.
- boiler-volume
- Physical volume of boiler in litres.
- burn-rate
- Coal consumption rate.
- burn-rate-idle
- Coal consumption rate when idle.
- firebox-efficiency
- Atmosphere leakage. 1.0 = No leakage.
- firebox-to-boiler-heat-flow
- Rate of heat flow from firebox to boiler and viseversa.
- firebox-to-boiler-heat-flow-idle
- Rate of heat flow from firebox to boiler when idle.
- firebox-volume
- Physical volume of firebox in litres.
- fuel-energy
- Relative energy in kilojoules per kilogram of coal.
- main-reservoir-volume
- Main reservoir volume in litres.
- max-fire-coal-mass
- The maximum mass of coal the firebox can take in kilograms.
- max-fire-temperature
- Maximum heat obtainable in degrees K. (Kelvin scale temperature).
- piston-angular-offsets
- Leave this setting.
- piston-volume-min
- The volume of the space in the cylinder ahead of the piston at the end of a full stroke.
- piston-volume-max
- The volume of the space in the cylinder ahead of the piston at the end of a full stroke.
- piston-area
- The cross section of one piston in m2. It is assumed there is one piston only on each side of the locomotive.
- piston-to-atmosphere-flow
- Atmospheric leakage from piston. Nominal hole size.
- safety-valve-low-pressure
- When boiler pressure hits this value in kPa the safety-valve-low-flow release is initiated.
- safety-valve-low-flow
- Lower pressure valve release. Nominal hole size.
- safety-valve-high-pressure
- When boiler pressure hits this value in kPa the safety- valve-low-flow release is initiated.
- safety-valve-high-flow
- Higher pressure valve release. Nominal hole size.
- shovel-coal-mass
- Amount of coal in one shovel load in kg.
- water-injector-rate
- Water injection rate into boiler in litres/second.
- westinghouse-volume
- Westinghouse volume in litres.
- initial-boiler-temperature
- Boiler temperature on loading Trainz.
- max-coal-mass
- Maximum volume of coal.
- minimum-volume
- The 'minimum' volume of the boiler (in millilitres). It's important to note that this is not literally 'empty', but rather the value at which the water gauge will read empty. By default this is 80% of the boiler volume.
- maximum-volume
- The 'maximum' volume of the boiler (in millilitres). It's important to note that this is not literally 'full', but rather the value at which the water gauge will read full. By default this is 90% of the boiler volume.
[edit] Mass Container
The mass container stores information related to fuel consumption. These tags aren't in use and shouldn't generally be used.
The mass container has the following tags:
- scale
- Multiplies fuel mass by given value, not currently in use, generally leave this setting.
- fuel
- Fuel level, not currently in use, generally leave this setting.
[edit] Motor Container
The Motor Container stores an assortment of values related to motor function, particularly that of DCC.
- resistance
- Power figure for DCC, higher resistance value=less power.
- adhesion
- Adhesion parameter, higher value=greater adhesion.
- maxvoltage
- Generally leave this setting.maxspeed.
- maxspeed
- Maximum speed for DCC, expressed in metres per second.
- brakeratio
- Brake force for pressure reduction.
- max-accel
- Parameters for DCC acceleration & deceleration.
- max-decel
- Parameters for DCC acceleration & deceleration.
- throttle-notches
- Number of throttle notches.
- axle-count
- Resistance - Axle Count.
- surface-area
- Resistance - Surface Area.
- moving-friction-coefficient
- Resistance - Moving friction.
- air-drag-coefficient
- Resistance - Air drag.
[edit] Flowsize Container
Flowsize settings specify the rate of flow through the pipes. Generally these setting should be left unaltered.
The Flowsize Container has the following tags:
- trainbrakepipe
- Flowsize of the brake pipe.
- epreservoirpipe
- Flowsize of the electric pneumatic braking.
- no3pipe
- Flowsize of the independent brake pipe.
- no4pipe
- Flowsize of the bail pipe.
- auxreservoirvent
- Flowsize of the auxiliary reservoir vent.
- auxreservoir_no3
- Flowsize of the auxiliary independent brake pipe.
- auxreservoir_trainbrakepipe
- Flowsize of the auxiliary reservoir brake pipe.
- autobrakecylindervent
- Flowsize of the automatic brake cylinder vent.
- auxreservoir_autobrakecylinder
- Flowsize of the auxiliary reservoir automatic brake cylinder.
- equaliser_mainreservoir
- Flowsize of the equaliser main reservoir.
- equaliservent
- Flowsize of the equaliser vent.
- equaliserventhandleoff
- Flowsize of the equaliser to the atmosphere when in the "handle off" position.
- equaliserventemergency
- Flowsize of the emergency equaliser vent.
- no3pipevent
- Flowsize of the independent brake pipe.
- no3pipe_mainreservoir
- Flowsize of the independent brake main reservoir.
- compressor
- Flowsize of the compressor.
- trainbrakepipe_reservoir
- Flowsize of the brake pipe reservoir.
- trainbrakepipevent
- Flowsize of the brake pipe vent.
- no3pipe_autobrakecylinder
- Flowsize of the independent automatic brake pipe cylinder.
- epreservoirpipe-autobrakecylinder
- Flowsize of the electro pneumatic automatic brake cylinder reservoir.
- mainreservoir_ep
- Flowsize of the electro pneumatic main reservoir.
- vacuumbrakepipe
- Flowsize of the vacuum brake pipe.
- vacuumbrakepipereleasevent
- Flowsize of the vacuum brake pipe release vent.
- vacuumbrakepipevent
- Flowsize of the vacuum brake pipe vent.
- vacuumbrakereservoir_vacuumbrakepipe
- Flowsize of the vacuum brake pipe reservoir.
- vacuumbrakecylinder_vacuumbrakepipe
- Flowsize of the vacuum brake pipe cylinder.
- highspeedexhauster_vacuumbrakepipe
- Flowsize of the high speed exhauser vacuum brake pipe.
[edit] Volume Container
The volume container stores information regarding the size of pipes and appliances. Generally these settings should remain unaltered.
The Volume Container has the following tags:
- scale
- Multiplies volume by given value, generally leave this setting.
- trainbrakepipe
- Brake pipe volume.
- epreservoirpipe
- For electro pneumatic braking - not currently in use, generally leave this setting.
- no3pipe
- Independent brake pipe.
- no4pipe
- Bail pipe - not currently in use, generally leave this setting.
- auxreservoir
- Auxiliary reservoir volume.
- autobrakecylinder
- Brake cylinder volume.
- vacuumbrakepipe
- For vacuum braking - not currently in use, generally leave this setting.
- vacuumbrakereservoir
- For vacuum braking - not currently in use, generally leave this setting.
- vacuumbrakecylinder
- For vacuum braking - not currently in use, generally leave this setting.
- mainreservoir
- Main reservoir volume.
- equaliser
- Equalising reservoir volume.
- independantbrakecylinder
- Loco brake cylinder volume.
[edit] Steam-Power Coordinate Container
This container is a graph, similar to the throttle anddynamic-brake graphs for Velocity incoming, Power multiplier outgoing.
- Coordinate Element
- The steam-power graph provides a speed (m/s) vs power (multiplier) modifier which controls the power output ofthe pistons on a steam train. This is intended to allow fine adjustments to a working steam engine, and should not be used for large adjustments to the performance characteristics, eg.
0 1.0 20 1.1
[edit] THIS KIND SUPPORTS THE FOLLOWING:
- CONTAINERS
- String Table, Chinese String Table, Czech String Table, Dutch String Table, French String Table, German String Table, Italian String Table, Polish String Table, Russian String Table, Spanish String Table, KUID Table, ObsoleteTable, Thumbnails, Privileges, Extensions, Throttle Power Container, Dynamic Brake Container, Pressure Container, Mass Container, Motor Container, Flowsize Container, Volume Container, Steam container, Steam-Power.
- TAGS
- kuid, trainz-build, category-class, category-region, category-era, username, kind, author, category-keyword, class, contact-email, contact-website, description, description-cn, description-cz, description-de, description-es, description-fr, description-it, description-pl, description-nl, description-ru, license, organisation, username-cn, username-cz, username-de, username-es, username-fr, username-it, username-nl, username-pl, username-ru.