Merge pull request #481 in VECTO/vecto-sim from ~EMQUARIMA/vecto-sim:develop to develop

* commit 'aa630858':
  Releasing VECTO 3.2.0
  update user manual
  update license header in new files
  release checlist
  update user manual
  more work on user manual
  updating screenshots for help
  adding vsum-files of several vehicles (comparison)
  updating documentation: xml schema of output
  updating user manual
  bugfix: hasing overwriting date
  fix writing json file
  adding vehicle height to generic vehicle
  fix: xml export, gearbox form: only allow export in declaration mode
  adding input field for vehicle height (required for declaration-mode cross-wind correction in engineering mode)
  adding changelog to release notes
  help: adding platform requirements
  updating changelog
  update Version numbers

Documentation/User Manual/1-user-interface/0_start.md

 
+Platform Requirements
+=====================
+
+Hardware Requirements
+
+   + Microsoft Windows PC running Microsoft Windows 7 or later
+
+Software Requirements
+
+   + Microsoft .NET Framework 4.5
+
+
+
 User Manual
 ====================================
 ![](pics/VECTOlarge.png)\
 \
-Version: VECTO 3.1 / VectoCore 3.1.0 / VectoCmd 3.1.0
+Version: VECTO 3.2 / VectoCore 3.2.0 / VectoCmd 3.2.0
 
 ---
 
@@ -21,6 +34,6 @@ This User Manual consists of 4 Parts:
 - [Input and Output](#input-and-output):
     : Describes the input and output file formats.
 
-This user manual describes verson 3.1.x of Vecto. 
+This user manual describes verson 3.2.x of Vecto. 
 
 

Documentation/User Manual/1-user-interface/F_VEH-Editor.md

 ##Vehicle Editor
 
-![](pics/VEH-Editor.jpg)
+![](pics/VEH-Editor.PNG)
 
 ###Description
 
 The [Vehicle File (.vveh)](#vehicle-file) defines the main vehicle/chassis parameters like axles including [RRC](#rolling-resistance-coefficient)s, air resistance and weight.
 
+The Vehicle Editor contains 3 tabs to edit all vehicle-related parameters. The 'General' tab allows to input mass, loading, air resistance, vehicle axles, etc. The 'Powertrain' allows to define the retarder, an optional angle drive, or PTO consumer. In the third tab the engine torque can be limited to a maximum for individual gears.
+
 ###Relative File Paths
 
 It is recommended to use relative filepaths. This way the Job File and all input files can be moved without having to update the paths.

Documentation/User Manual/1-user-interface/G_ENG-Editor.md

 ##Engine Editor
 
-![](pics/ENG-Editor.jpg)
+![](pics/ENG-Editor.PNG)
 
 ###Description
 

Documentation/User Manual/1-user-interface/H_GBX-Editor.md

@@ -2,7 +2,7 @@
 
 
 
-![](pics/GBX-Editor.png)
+![](pics/GBX-Editor.PNG)
 
 
 ###Description

Documentation/User Manual/3-simulation-models/ADAS_EcoRoll.md

-##Overspeed
-
+##Driver: Overspeed
 
 
 Both functions control the vehicle's behaviour on uneven road sections (slope ≠ 0) and can be configured in the [Job File](#job-file)'s Driver Assist Tab. Overspeed is designed to model an average driver's behaviour without the aid of driver assistance systems. Eco-Roll  represents an optional driver assistance feature. For this reason vehicles without Eco-Roll should always have the Overspeed function enabled.

Documentation/User Manual/3-simulation-models/Driver_AccLimit.md

-##Acceleration Limiting
+##Driver: Acceleration Limiting
 
 VECTO limits the vehicle acceleration and deceleration depending on current vehicle speed, to model a realistic driver behavior. These limits are defined in the [Acceleration Limiting Input File (.vacc)](#acceleration-limiting-input-file-.vacc), which can be set in the [Job File](#job-file). In Declaration mode this is already predefined.
 

Documentation/User Manual/3-simulation-models/Driver_LAC.md

-##Look-Ahead Coasting
+##Driver: Look-Ahead Coasting
 
 Look-Ahead Coasting is a function that aims on modelling real driver behaviour. It is a forward-looking function that detects forthcoming reductions in target speed in the mission profile (e.g. speed limit, etc.) and induces an early deceleration using engine braking before applying mechanical brakes according to the [deceleration limit](#acceleration-limiting).
 

Documentation/User Manual/3-simulation-models/Engine_FC.md

-##Fuel Consumption Calculation
+##Engine: Fuel Consumption Calculation
 
 
 The base FC value is interpolated from the stationary [FC map](#fuel-consumption-map-.vmap). If necessary the base value is corrected to compensate for unconsidered auxiliary energy consumption for vehicles with Start/Stop. In Declaration Mode additionally the WHTC correction is applied, see below.

Documentation/User Manual/3-simulation-models/Engine_Speed_Torque_limitations.md

+
+##Engine Torque and Engine Speed Limitations
+
+The engine's maximum speed and maximum torque may be limited by either the gearbox (due to mechanical constraints) or the vehicle control.
+Engine torque limitations are modeled by limiting the engine full-load curve to the defined maximum torque, i.e., the original engine full-load curve is cropped at the defined maximum torque for a certain gear. Limits regarding the gearbox' maximum input speed are modeled by intersecting (and limiting) the upshift line with the max. input speed. In the last gear, where no upshifts are possible, the engine speed is limited to the gearbox' maximum input speed.
+
+Gear shift polygons are calculated by VECTO based on the overall (i.e. from gearbox and vehicle control) cropped engine fullload curve.
+
+
+<div class="engineering">
+In Engineering Mode, speed and torque limits can be defined and will be effective for every gear.
+</div>
+
+<div class="declaration">
+In Declaration Mode, the following rules restrict the limitations of engine torque:
+
+###Transmission Input-Speed Limitations
+
+* Applicable for every gear
+
+###Transmission Torque Limitations
+
+* For higher 50% of gears (i.e., gears 7 to 12 for a 12-gear transmission):
+    - Transmissions max torque > 90% of engine max torque: max. torque limitation *not* applicable (VECTO extrapolates loss-maps)
+    - Transmissions max torque <= 90% of engine max torque: max. torque limitation applicable
+* For lower 50% of gears (i.e., gears 1 to 6 for a 12-gear transmission):
+    - Transmission torque limit is always applicable
+
+###Vehicle defined Torque Limitations
+
+* For higher 50% of gears (i.e., gears 7 to 12 for a 12-gear transmission):
+    - Torque limit > 95% of engine max torque: max. torque limitation *not* applicable (VECTO extrapolates loss-maps)
+    - Torque limit <= 90% of engine max torque: max. torque limitation applicable
+* For lower 50% of gears (i.e., gears 1 to 6 for a 12-gear transmission):
+    - Torque limit is *not* applicable
+
+</div>
+
+

Documentation/User Manual/3-simulation-models/Engine_StartStop.md

 ##Engine Start/Stop
 
 Eco-Roll is not implemented in Vecto 3.1.
+

Documentation/User Manual/3-simulation-models/Engine_WHTC.md

-##Engine: WHTC Correction
+##Engine: Correction Factors
 
 <div class="declaration">
 In declaration mode the fuel consumption is corrected as follows:
@@ -26,9 +26,9 @@ with the correction factor CF~urb~, CF~rur~, CF~mot~ coming from the [Engine](#e
 | Interurban bus     | 45%     | 36%     | 19%     |
 | Coach              | 0%      | 22%     | 78%     |
 
-In order to balance the trade-off between emissions and fuel consumption during cold and hot starting conditions an additional balancing factor $CF_{C/H}$ is determined from the overall specific fuel consumption over the cold start and hot start WHTC test. This value is part of the output from the engine component tool.
+In order to balance the trade-off between emissions and fuel consumption during cold and hot starting conditions an additional balancing factor $CF_{C/H}$ is determined from the overall specific fuel consumption over the cold start and hot start WHTC test. Additional correction factors considered are regarding the net calorific value of the fuel ($CF_{NCV}$) and exhaust after-treatment systems ($CF_{RegPer}$). This values are part of the output from the engine component tool.
 
-The WHTC-corrected fuel consumption is then calculated with: $FC_{whtc} = FC \cdot CF_{total} \cdot CF_{C/H}$
+The WHTC-corrected fuel consumption is then calculated with: $FC_{whtc} = FC \cdot CF_{total} \cdot CF_{C/H} \cdot CF_{RegPer} \cdot CF_{NCV}$
 </div>
 
 <div class="engineering">

Documentation/User Manual/3-simulation-models/GearShift.md

-##Gear Shift Model (MT, AMT)
+##Gearbox: Gear Shift Model
 
 
 The Gear Shift Model is based on shift curves that define the engine speed for up- and down- shifting as a function of engine torque. As soon as the engine operation point passes one of the shift curves a gear change is initiated.
@@ -45,13 +45,4 @@ Early Upshift (allow upshifts inside the shift polygons) is enabled for AMT only
 ![](pics/GBX-Editor-shift2.svg)
 
 
-###Generic shift conditions
 
-- Only allow upshifts if the vehicle is not decelerating **and** the estimated acceleration in the next gear is higher than a certain threshold (default: 0.1 m/s²)
-- Do not allow downshifts with less time than a certain amount after an upshift (default 10 s)
-- Do not allow upshifts with less time than a certain amount after an downshift (default 10 s)
-
-Parameters in [Gearbox File](#gearbox-file):
-: - **DownshiftAferUpshiftDelay**
-- **UpshiftAfterDownshiftDelay**
-- **UpshiftMinAcceleration**

Documentation/User Manual/3-simulation-models/GearShift_AMT.md

+##Gearbox: MT and AMT Gearshift Rules
+
+This section describes the gearshift rules for manual and automatic manual transmission models. When a gearshift is triggered, gears may be skipped for both MT and AMT gearboxes (see [Gearbox: Gear Shift Model](#gearbox-gear-shift-model)). Early Upshift (see [Gearbox: Gear Shift Model](#gearbox-gear-shift-model)) is only enabled for AMT gearboxes.
+
+###Shift Polygons in Declaration Mode (According to ACEA Whitebook 2016)
+
+####1. Computation of Characteristic Points
+![](pics/shiftlines_1.PNG)
+
+####2. Definition of Shift Lines
+![](pics/shiftlines_2.PNG)
+
+####3. Exception 1: Margin to Max-Torque line (Downshift)
+![](pics/shiftlines_3.PNG)
+
+Note: Line L1 is shiftet parallel so that it satisfies the max-torque margin condition, not intersected.
+
+####4. Exception 2: Minimal Distance between Downshift and Upshift Lines
+![](pics/shiftlines_4.PNG)
+
+####5. Final Gearshift Lines (Example)
+![](pics/shiftlines_5.PNG)
+
+If the gearbox defines a maximum input speed for certain gears the upshift line may further be intersected 
+and limited to the gear's maximum input speed.
+
+###Upshift rules
+
+* If the engine speed is higher than the gearbox maximum input speed or engine n_{95h} speed (whichever is lower)
+* If all of the following conditions are met:
+    - The vehicle is not decelerating AND
+    - Engine operation point (speed and torque) is above (right of) the upshift line AND
+    - The acceleration in the next gear is above a certain threshold if the driver is accelerating, i.e., acceleration_nextGear > min(Min. acceleration   threshold, Driver acceleration) AND
+    - The last gearshift was longer than a certain threshold (Declaration Mode: 2s) ago AND
+    - The last downshift was longer than a certain threshold (Declaration Mode: 10s) ago
+
+###Upshift rules for Early Upshift (AMT only)
+
+* If the engine speed is higher than the gearbox maximum input speed or engine n_{95h} speed (whichever is lower)
+* If all of the following conditions are met:
+    - The vehicle is not decelerating AND
+    - The engine's operating point (speed and torque) is above the downshift line with a certain margin to the max. torque (torque reserve) AND
+    - The acceleration in the next gear is above a certain threshold if the driver is accelerating, i.e., acceleration_nextGear > min(Min. acceleration   threshold, Driver acceleration) AND
+    - The last gearshift was longer than a certain threshold (Declaration Mode: 2s) ago AND
+    - The last downshift was longer than a certain threshold (Declaration Mode: 10s) ago
+
+
+###Downshift
+
+* If the engine speed is lower than the engine's idle speed
+* If all of the following conditions are met:
+    - Engine operation point (speed and torque) is below (left of) the downshift line AND
+    - The last gearshift was longer than a certain threshold (Declaration Mode: 2s) ago AND
+    - The last upshift was longer than a certain threshold (Declaration Mode: 10s) ago
+
+
+###Shift parameters
+
+- Gearshift lines
+- Engine idle speed
+- Gearbox max. input speed
+- Engien n_{95h} speed
+- Min. time between two consecutive gearshifts.
+- Min. time for upshift after a downshift
+- Min. time for downshift after an upshift
+- Min. acceleration in next gear
+
+For Skip Gears and Early Upshift the following additional parameters are required:
+
+- Torque reserve
+

Documentation/User Manual/3-simulation-models/GearShift_AT.md

-##Gear shift rules for AT Gearbox
+##Gearbox: AT Gearshift Rules
 
-The gear shift rules for automatic gearboxes differ from AMT and MT.
-
-Gears are shifted sequentially:
+For AT gearboxes neither Skip Gears nor Early upshift (see [Gearbox: Gear Shift Model](#gearbox-gear-shift-model)) are enabled. Moreover, the gears are shifted strictly sequentially:
 
 - 1C -> 1L -> 2L -> ...  (torque converter only in 1st gear)
 - 1C -> 2C -> 2L -> ...  (torque converter in 1st and 2nd gear)
 
+###Shift Polygons in Declaration Mode
+
+The shift lines in Declaration Mode only apply for trucks and gearboxes with serial torque converter (AT-S).
+
+* Downshift line: 700 rpm (torque independent, vertical line)
+* Upshift line: 900 rpm for torque <= 0; 1150 rpm @ Engine's maximum torque
+
+![](pics/at_gearbox_shiftlines.PNG)
+
 ###Upshift rules
 
-+ If engine speed and engine torque in the next gear (see shift sequence) is above the upshift line AND
++ If engine speed and engine torque in the *next gear* (see shift sequence) is above the upshift line AND
 + the acceleration in the next gear is above a certain threshold if the driver is accelerating, i.e., acceleration_nextGear > min(Min. acceleration threshold, Driver acceleration)
 
 The user interface allows to enter two acceleration thresholds, one for locked gear to locked gear shifts and another vor converter to locked gear shifts. For converter to converter shifts the latter threshold applies.
@@ -27,4 +34,7 @@ The user interface allows to enter two acceleration thresholds, one for locked g
 
 - Min. time between two consecutive gearshifts.
 - Min. acceleration after gearshift for L to L gear shifts
-- Min. acceleration after gearhsift for C to L (and C to C) gear shifts
+- Min. acceleration after gearhsift for C to L gear shifts
+- Min. acceleration after gearshift for C to C geear shifts
+
+

Documentation/User Manual/3-simulation-models/Gearbox_AT.md

-##AT Gearbox Model
+##Gearbox: AT Gearbox Model
 
 Vecto supports both, AT gearboxes with serial torque converter and AT gearboxes with power split. Internally, both gearbox types are simulated using a power train architecture with the torque converter in series.
 
@@ -31,9 +31,7 @@ Model parameters: shift time ($t_s$), inertia factor ($f_I$)
 
 ![Engine speed, clutch speed during power-shift](pics/powershiftlosses.png)
 
-$T_{PS,loss} = |(T_{GBX,in} + T_{inertia}) * \Delta\omega_F| * t_s / dt$
-
-$T_{inertia} = f_I * I_{engine} * \Delta\omega_I / dt$
+$T_{PS,loss} = |T_{GBX,in}  * \Delta\omega_F| * t_s / dt$
 
 $\Delta\omega_I = \omega_{engine,1} - \omega_{engine,2}$