"Throttle-power" container

From TrainzOnline
(Difference between revisions)
Jump to: navigation, search
(pipetrick)
(Expand on how Trainz code determines power output for engines with more than 8 throttle notches)
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{ORP-top}}
+
The Throttle-power container is a top-level [[config.txt file]] entry used by [[KIND Engine|Enginespec]] assets.
==Parent Class==
+
The Throttle-power container is a top-level Enginespec [[config.txt file]] entry used by [[KIND Engine]] assets.
+
  
 
==Supported Tags==
 
==Supported Tags==
{{Related value|"Motor" container|sect=#throttle-notches|throttle-notches}}
 
The Throttle-power container has 'nn elements' defining a sequence of paired numeric data sets grouped into subcontainers ({{wp|Array data structure|data array}}s) that depend on the type of motive power at each throttle setting. Each subcontainer or array refers to a specific throttle notch of a particular engine's performance curves, points on a graph to incorporate into the simulation dynamic models.
 
# The first (index of zero) value(s) correspond to zero power or neutral and have neither thrust nor speed values (both are zero factors).
 
# The majority of the Throttle-power container then has a sequence of numeric subcontainers matching in numbers the integer count define in the [["Motor"_container#throttle-notches|"Motor" container]]'s 'throttle-notches' tag value.
 
# The Throttle-power containers last listed index of subcontainers must match the number of the integer defined by the  value given the '''[["Motor"_container#throttle-notches|"Motor" container's 'throttle-notches' tag]]'''. This value will generally be 8, or 32.
 
:*'''{the set: 0, 1, 2, {{...}}, 6, 7, 8} for diesels ''' and  {{...}}
 
:*'''{the set: 0, 1, {{...}}, 30, 31, 32} for electric or diesel-electric powered locos.'''
 
# A unit with dynamic brakes will have a double array of 8 or 32 values, corresponding to dynamic braking engaged (deceleration or braking mode) or not engaged (acceleration).
 
  
Within each subcontainer, there are a series of numeric named lines. Each line specifies a speed (m/s) and a {{wp|Tractive force|tractive effort}} ({{wp|Newton (unit)|kiloNewtons (kN)}}) value. Together, these points define a tractive effort graph for a specific throttle notch.
+
The Throttle-power container has a sequence of numeric subcontainers. Each one refers to a specific throttle notch.
 +
 
 +
Within each subcontainer, there are a series of numeric named lines. Each line specifies a speed (m/s) and a tractive effort (kN) value. Together, these points define a tractive effort graph for a specific throttle notch.
 +
 
 +
Note that a maximum of 8 such containers is supported, to match the common use-case of 8 throttle notches. Any extra containers will be unused. For engine assets with more than 8 throttle notches, the maximum throttle notch will map to the notch 8 data in the config file, the middle throttle notch will map to notch 4, etc. The game code will use linear interpolation to determine the power output for the other (in between) throttle notches, as required.
  
 
==Example throttle-power container==
 
==Example throttle-power container==
  
 
Here is an example throttle-power container. (Several notches have been omitted for brevity - the format is identical throughout).
 
Here is an example throttle-power container. (Several notches have been omitted for brevity - the format is identical throughout).
[[File:Three-loco-styles.jpg|thumb|right|450px|Three loco styles shown together in Victoria, Australia.]]
+
 
 
  throttle-power
 
  throttle-power
 
  {
 
  {
Line 35: Line 29:
 
     13.0                                0
 
     13.0                                0
 
   }
 
   }
  ...
+
   
  ...
+
  ....
  ...
+
   
 
   8
 
   8
 
   {
 
   {
Line 53: Line 47:
 
   }
 
   }
 
  }
 
  }
[[file:Inclined Normal Force.png|thumb|right|350px|Weight is a force which depends on the part of the mass bearing straight down in a gravitational field. When the surface is inclined, that part of the weight at right angles to the track/surface, called the normal component or force diminishes as some of it now acts downhill which we sometimes call ''dead-weight'', and ''that component'' now has to be lifted while friction, declines as the normal force declines.]]
 
*Note that ''in the example's figures'' the high notch thrust values are way beyond what the loco can actually thrust against the track at low speeds - in other words, this loco cannot be opened up to full throttle at very low speeds, otherwise it's wheels will slip.
 
* The maximum tractive effort a {{wp|locomotive engine}} can put onto the rails before slipping is configured in the loco config file—the reason for this is that the weight of the loco (''also set in the loco config file'') will affect this value since {{wp|Friction|frictional force}} opposes slippage and friction is directly dependent upon the '{{wp|Normal Force}}' exerted by a mass on a surface.
 
* As the slope of a grade increases it affects (diminishes) the component of the normal force producing friction against the rails. With a diminished frictional coefficient the tendency to slip increases proportionally to the {{wp|sine}} of the angle of pitch of the grade.
 
* It is a well known factor of pragmatic rail operations that traincars have less braking ability or can only apply reduced tractive effort on grades. The decline in the Normal Force with an increase in grade is why friction is commensurately reduced, and wheel slippage commensurately is more likely. Similarly, lubrication of the rails reduces frictional forces in a foul weather situation, again reducing braking ability and allowable pre-slip traction.
 
* See also: {{wp|Tractive_force#Defining_tractive_effort|Defining Tractive Effort}} on Wikipedia.
 
  
[[Category:Config Container|throttle-power]]
+
Note that the high notch values are way beyond what the loco can actually put into the track at low speed - this loco cannot be opened up to full throttle at very low speeds, otherwise it's wheels will slip. The max tractive effort it can put into the rails before slipping is configured in the loco config file - the reason for this is that the weight of the loco (also set in the loco config file) will affect this value.
{{Cont-Engine|throttle-power}}
+
 
{{ORP-bot|throttle-power}}
+
[[Category:Config Container]]

Latest revision as of 14:00, 8 September 2025

The Throttle-power container is a top-level config.txt file entry used by Enginespec assets.

[edit] Supported Tags

The Throttle-power container has a sequence of numeric subcontainers. Each one refers to a specific throttle notch.

Within each subcontainer, there are a series of numeric named lines. Each line specifies a speed (m/s) and a tractive effort (kN) value. Together, these points define a tractive effort graph for a specific throttle notch.

Note that a maximum of 8 such containers is supported, to match the common use-case of 8 throttle notches. Any extra containers will be unused. For engine assets with more than 8 throttle notches, the maximum throttle notch will map to the notch 8 data in the config file, the middle throttle notch will map to notch 4, etc. The game code will use linear interpolation to determine the power output for the other (in between) throttle notches, as required.

[edit] Example throttle-power container

Here is an example throttle-power container. (Several notches have been omitted for brevity - the format is identical throughout).

throttle-power
{
  0
  {
    0                                   0
  }
  
  1
  {
    0                                   165
    2.2                                 83
    4.4                                 55
    6.6                                 41
    8.8                                 33
    13.0                                0
  }

....

  8
  {
    0                                   1320
    2.2                                 800
    4.4                                 750
    5.5                                 700
    6.6                                 480
    8.8                                 250
    11.25                               200
    13.3                                195
    28.5                                190
    30.0                                26
    31.0                                0
  }
}

Note that the high notch values are way beyond what the loco can actually put into the track at low speed - this loco cannot be opened up to full throttle at very low speeds, otherwise it's wheels will slip. The max tractive effort it can put into the rails before slipping is configured in the loco config file - the reason for this is that the weight of the loco (also set in the loco config file) will affect this value.

Personal tools