update user manual

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
+##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 configuration.
+Engine torque limitations are modeled by limiting the engine full-load curve to the defined maximum torque, i.e., the orignial 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.
+
+
+<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/GearShift.md

-##Gear Shift Model
+##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

-##Gear Shift Rules for AMT Gearbox
+##Gearbox: MT and AMT Gearshift Rules
 
-###Computation of  Shift Polygons in Declaration Mode (According to ACEA Whitebook 2016)
+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)
@@ -26,12 +28,22 @@ and limited to the gear's maximum input speed.
 
 * 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
+    - 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
 
@@ -53,3 +65,7 @@ and limited to the gear's maximum input speed.
 - 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
+
+* 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 +32,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.
 

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

 ##Transmission Losses
 
-Every transmission component uses the following formula for calculating the torques at input and output side of the component:
+Every transmission component (gearbox, angledrive, axlegear, ...) uses the following formula for calculating the torques at input and output side of the component:
 
 $T_{output} = (T_{input} - T_{loss}) * r_{gear}$
 

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

-##Cross Wind Correction
+##Vehicle: Cross Wind Correction
 
 
 VECTO offers three different modes to consider cross wind influence on the drag coefficient. It is configured in the [Vehicle File](#vehicle-file).

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

-##Rolling Resistance Coefficient
+##Vehicle: Rolling Resistance Coefficient
 
 
 The rolling resistance is calculated using a speed-independent rolling resistance coefficient (RRC).

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

@@ -3,17 +3,19 @@
 In this chapter the used component models for the simulation are described.
 
 * [Powertrain and Components Structure](#powertrain-and-components-structure)
-* [Driver: Acceleration Limiting](#acceleration-limiting)
-* [Driver: Look-Ahead Coasting](#look-ahead-coasting)
-* [ADAS: Overspeed](#overspeed)
-* [Vehicle: Cross Wind Correction](#cross-wind-correction)
-* [Vehicle: Rolling Resistance Coefficient](#rolling-resistance-coefficient)
+* [Driver: Acceleration Limiting](#driver-acceleration-limiting)
+* [Driver: Look-Ahead Coasting](#driver-look-ahead-coasting)
+* [ADAS: Overspeed](#driver-overspeed)
+* [Vehicle: Cross Wind Correction](#vehicle-cross-wind-correction)
+* [Vehicle: Rolling Resistance Coefficient](#vehicle-rolling-resistance-coefficient)
 * [Engine Start/Stop](#engine-startstop)
-* [Engine: Fuel Consumption Calculation](#fuel-consumption-calculation)
-* [Engine: Transient Full Load](#transient-full-load)
-* [Engine: WHTC Correction](#transient-full-load)
+* [Engine: Fuel Consumption Calculation](#engine-fuel-consumption-calculation)
+* [Engine: Transient Full Load](#engine-transient-full-load)
+* [Engine: WHTC Correction](#engine-wthc-correction)
 * [Engine Torque and Engine Speed Limitations](#engine-torque-and-engine-speed-limitations)
-* [Gear Shift Model](#gear-shift-model)
+* [Gearbox: Gear Shift Model](#gearbox-gear-shift-model)
+* [Gearbox: MT and AMT Gearshift Rules](#gearbox-mt-and-amt-gear-shift-rules)
+* [Gearbox: AT Gearshift Rules](#gearbox-at-gear-shift-rules)
 * [Torque Converter Model](#torque-converter-model)
 * [Auxiliaries](#auxiliaries)
 * [Engine Only Mode](#engine-only-mode)

Documentation/User Manual/5-input-and-output-files/XML_DeclarationReport.md

+##XML Declaration Report
+
+<div class="declaration">
+In Declaration Mode VECTO generates two reports according to the Technical Annex for vehicle certification:
+
+* Manufacturer Report
+* Customer Information Report
+
+Both reports are in XML format and contain a description of the simulated vehicle and the simulation results. The format is described in the following resources:
+
+* [Manufacturer Report XML schema](../XML/XSD/VectoOutputManufacturer.xsd)
+* [Manufacturer Report XML schema diagram](VectoOutputDeclaration.pdf)
+* [Customer Report XML schema](../XML/XSD/VectoOutputCustomer.xsd)
+* [Customer Report XML schema diagram](VectoOutputDeclarationCustomer.pdf)
+
+Sample reports are distributed with the generic vehicles.
+
+</div>

Documentation/User Manual/5-input-and-output-files/XML_Job-File_DeclarationMode.md

+##XML Job-File (Declaration Mode)
+
+<div class="declaration">
+For vehicle certification the input data (vehicle data) has to be provided in XML format. Please see the following resources for more information:
+
+* [XML schema description](VectoInputDeclaration.1.0.pdf)
+* [XML schema diagram](../XML/XSD/VectoInput.xsd)
+* [Example of an XML Job-File](../XML/Examples/vecto_vehicle-sample.xml)
+
+</div>
\ No newline at end of file

Documentation/User Manual/5-input-and-output-files/input-output.md

@@ -7,10 +7,10 @@ Vecto uses data files for input and output of data. These are stored in differen
 
 - [JSON](#json)
 - [Vecto CSV](#csv)
-
+- [XML](#xml-job-file-declaration-mode)
 
 **Output:**
 
 - [JSON](#json)
 - [Vecto CSV](#csv)
-- PDF (for Declaration Report)
+- [XML Declaration Report](#xml-declaration-report)

Documentation/User Manual/files.txt

@@ -28,17 +28,19 @@
 3-simulation-models/Engine_FC.md
 3-simulation-models/Engine_DynamicFullLoad.md
 3-simulation-models/Engine_WHTC.md
+3-simulation-models/Engine_Speed_Torque_limitations.md
 3-simulation-models/Transmission_Losses.md
 3-simulation-models/Gearbox_AT.md
 3-simulation-models/GearShift.md
 3-simulation-models/Gearshift_AMT.md
 3-simulation-models/Gearshift_AT.md
-3-simulation-models/Engine_Speed_Torque_limitations.md
 3-simulation-models/TC.md
 3-simulation-models/Auxiliaries.md
 3-simulation-models/PwheelInput.md
 3-simulation-models/PTO.md
 5-input-and-output-files/input-output.md
+5-input-and-output-files/XML_Job-File_DeclarationMode.md
+5-input-and-output-files/XML_DeclarationReport.md
 5-input-and-output-files/CSV.md
 5-input-and-output-files/JSON.md
 5-input-and-output-files/VECTO.md