Code development platform for open source projects from the European Union institutions :large_blue_circle: EU Login authentication by SMS has been phased out. To see alternatives please check here

Skip to content
Snippets Groups Projects
Commit e632a76f authored by Markus Quaritsch's avatar Markus Quaritsch
Browse files

Merge branch 'feature/VECTO-110-documentation' of...

Merge branch 'feature/VECTO-110-documentation' of https://webgate.ec.europa.eu/CITnet/stash/scm/~emkrispmi/vecto-sim into feature/VECTO-110-documentation

Conflicts:
	User Manual/3-simulation-models/TC.md
	User Manual/files.txt
	User Manual/help.html
parents 82385fd3 584fca89
Branches
Tags
No related merge requests found
Showing
with 170 additions and 102 deletions
......@@ -4,7 +4,7 @@
###Description
The Engine File (.veng) defines all engine-related parameters and input files like Fuel Consumption Map and Full Load Curve.
The [Engine File (.veng)](#engine-file) defines all engine-related parameters and input files like Fuel Consumption Map and Full Load Curve.
###Relative File Paths
......@@ -32,7 +32,7 @@ Inertia including Flywheel \[kgm²\]
The [Full Load and Drag Curves (.vfld)](#full-load-and-drag-curves-.vfld) Note that gear-specific full load curves can be defined in the [Gearbox File](#gearbox-editor) to limit the maximum gearbox input torque.
The [Full Load and Drag Curves (.vfld)](#full-load-and-drag-curves-.vfld) Note that gear-specific full load curves can be defined in the [Gearbox File](#gearbox-file) to limit the maximum gearbox input torque.
The input file (.vfld) file format is described
[here](#full-load-and-drag-curves-.vfld).
......
......@@ -9,7 +9,7 @@
The Gearbox File (.vgbx) defines alls gearbox-related input parameters like gear ratios and transmission loss maps. See [Gear Shift Model](#gear-shift-model) for details.
The [Gearbox File (.vgbx)](#gearbox-file) defines alls gearbox-related input parameters like gear ratios and transmission loss maps. See [Gear Shift Model](#gear-shift-model) for details.
###Relative File Paths
......@@ -49,7 +49,7 @@ Use the ![add](pics/plus-circle-icon.png) and ![remove](pics/minus-circle-icon.p
- Gear **"A"** defines the ratio of the axle transmission / differential.
- Column **"TC"** (AT only) defines which gears are using the torque converter (lock-up clutch open).
- Column **"Loss Map or Efficiency"** allows to define either a constant efficiency value or a [loss map (.vtlm)](#transmission-loss-map-.vtlm).
- Column **"Loss Map or Efficiency"** allows to define either a constant efficiency value or a [loss map (.vtlm)](#transmission-loss-map).
- Column **"Shift polygons"** defines the [Shift Polygons InputFile (.vgbs)](#shift-polygons-input-file-.vgbs) for each gear. Not required in [Declaration Mode](#declaration-mode). See [GearShift Model](#gear-shift-model) for details.
- Column **"Full Load Curves"** defines the [Full Load Curve for (.vfld)](#full-load-and-drag-curves-.vfld) each gear. It is used for torque limiting and [generic shift polygons](#gear-shift-model) in Declaration Mode. If no file is defined the engine full load curve will be used.
......
......@@ -6,7 +6,7 @@
###Description
The job file (.vecto) includes all informations to run a VECTO calculation. It defines the vehicle and the driving cycle(s) to be used for calculation. In summary it defines:
The [job file (.vecto)](#job-file) includes all informations to run a VECTO calculation. It defines the vehicle and the driving cycle(s) to be used for calculation. In summary it defines:
- Filepath to the [Vehicle File (.vveh)](#vehicle-editor) which defines the not-engine/gearbox-related vehicle parameters
- Filepath to the [Engine File (.veng)](#engine-editor) which includes full load curve(s) and the fuel consumption map
......@@ -30,7 +30,7 @@ VECTO automatically uses relative paths if the input file (e.g. Vehicle File) is
: Enables [Engine Only Mode](#engine-only-mode). Only the following parameters are needed for this mode:
- Filepath to the [Engine File (.veng)](#engine-editor)
- [Driving Cycles](#driving-cycle-.vdri) including engine torque (or power) and engine speed
- [Driving Cycles](#driving-cycles) including engine torque (or power) and engine speed
Filepath to the Vehicle File (.vveh)
......@@ -43,7 +43,7 @@ Filepath ot the Gearbox File(.vgbx)
: Files can be created and edited using the [Gearbox Editor](#gearbox-editor).
Auxiliaries
: This list contains all auxiliaries used for calculation. The auxiliaries are configured using the [Auxiliary Dialog](#auxiliary-dialog). For each auxiliary an [Auxiliary Input File (.vaux)](#auxiliary-input-file-.vaux) must be provided and the [driving cycle](#driving-cycle-.vdri) must include the corresponding supply power.
: This list contains all auxiliaries used for calculation. The auxiliaries are configured using the [Auxiliary Dialog](#auxiliary-dialog). For each auxiliary an [Auxiliary Input File (.vaux)](#auxiliary-input-file-.vaux) must be provided and the [driving cycle](#driving-cycles) must include the corresponding supply power.
**Double-click** entries to edit with the [Auxiliary Dialog](#auxiliary-dialog).
: ![addaux](pics/plus-circle-icon.png) Add new Auxiliary
......@@ -52,7 +52,7 @@ Auxiliaries
: See [Auxiliaries](#auxiliaries) for details.
Cycles
: List of cycles used for calculation. The .vdri format is described [here](#driving-cycle-.vdri).
: List of cycles used for calculation. The .vdri format is described [here](#driving-cycles).
**Double-click** an entry to open the file (see [File Open Command](#settings)).
**Click** selected items to edit file paths.
......@@ -79,7 +79,7 @@ Acceleration Limiting
###Chart Area
If a valid [Vehicle File](#vehicle-editor), [Engine File](#engine-editor) and [Gearbox File](#gearbox-editor) is loaded into the Editor the main vehicle parameters like HDV class and axle configuration are shown here. The plot shows the full load curve(s) and shift polygons. In [Declaration Mode](#declaration-mode) the **generic** shift polygons are shown, not the ones from the Gearbox File.
If a valid [Vehicle File](#vehicle-editor), [Engine File](#engine-file) and [Gearbox File](#gearbox-file) is loaded into the Editor the main vehicle parameters like HDV class and axle configuration are shown here. The plot shows the full load curve(s) and shift polygons. In [Declaration Mode](#declaration-mode) the **generic** shift polygons are shown, not the ones from the Gearbox File.
###Controls
......
......@@ -6,13 +6,13 @@
###Description
The Vehicle File (.vveh) defines the main vehicle/chassis parameters like axles including [RRC](#rolling-resistance-coefficient)s, air resistance and weight.
The [Vehicle File (.vveh)](#vehicle-file) defines the main vehicle/chassis parameters like axles including [RRC](#rolling-resistance-coefficient)s, air resistance and weight.
###Relative File Paths
It is recommended to define relative filepaths. This way the Job File and all input files can be moved without having to update the paths.
Example: "Demo\RT1.vrlm" points to the "Demo" subdirectory of the Vehicle File's directoy.
Example: "Demo\\RT1.vrlm" points to the "Demo" subdirectory of the Vehicle File's directoy.
VECTO automatically uses relative paths if the input file (e.g. Retarder Losses File) is in the same directory as the Vehicle File. (The Vehicle File must be saved before browsing for input files.)
......@@ -64,14 +64,14 @@ If available a **Retarder Torque Loss Map** can be defined here to consider idli
***Note: Do not use this function if the retarder's losses are already included in the Transmission Loss Maps!***
Three options are available:
: - Included in Transmission Loss Maps: Use this if the [Transmission Loss Maps](#transmission-loss-map-.vtlm) already include retarder losses.
: - Included in Transmission Loss Maps: Use this if the [Transmission Loss Maps](#transmission-loss-map) already include retarder losses.
- Primary Retarder (before gearbox): The rpm ratio is relative to the engine speed
- Secondary Retarder (after gearbox): The rpm ratio is relative to the cardan shaft speed
Both, primary and secondary retarders, require an [Retarder Loss Torque Input File (.vrlm)](#retarder-loss-torque-input-file-.vrlm).
###Cross Wind Correction
###Cross Wind Correction Options
Four different options are available:
......
......@@ -79,11 +79,11 @@ In this tab the global calculation settings can be changed.
![cb](pics/checkbox.png) Cycle Distance Correction
: Toggle Cycle Distance Correction. Always ON in Declaration Mode. Cycle Distance Correction monitors the driven distance in each time step and, if necessary, adds or removes time steps in order to keep the original distance given in the driving cycle.
: - If **enabled** the vehicle drives the same **distance** as given in the driving cycle
- If ***disabled*** the vehicle travels the same **time** as given in the driving cycle (Note that distance-based cycles (see [here](#driving-cycle-.vdri)) are always converted to time-based cycles internally)
- If ***disabled*** the vehicle travels the same **time** as given in the driving cycle (Note that distance-based cycles (see [here](#driving-cycles)) are always converted to time-based cycles internally)
![cb](pics/checkbox.png) Use gears/rpm's form driving cycle
: If activated VECTO will use gear and/or engine speed defintions included in the driving cycle (see [here](#driving-cycle-.vdri)).
: If activated VECTO will use gear and/or engine speed defintions included in the driving cycle (see [here](#driving-cycles)).
![cb](pics/checkbox.png) Write modal results
......
......@@ -2,5 +2,25 @@
User Manual
====================================
![](pics/VECTOlarge.png)\
\
Version: VECTO 2.2 / VectoCore 3.0.2 / VectoCmd 3.0.2
---
VECTO is a tool for the calculation of energy consumption and CO~2~ emissions of vehicles. It models the components of a heavy-duty vehicle and simulates a virtual drive on a route. The goal is to provide a standardized way of calculating the energy consumption (fuel consumption) and corresponding CO~2~ emissions.
This User Manual consists of 4 Parts:
- [Graphical User Interface](#user-interface):
: Here graphical user interface of VECTO with all windows and configuration possibilities is described.
- [Calculation Modes](#calculation-modes):
: The calculation modes of VECTO are described here (Declaration, Engineering, ...).
- [Simulation Models](#simulation-models):
: This chapter describes the used component models and formulas which are implemented in the software.
- [Input and Output](#input-and-output):
: The input and output file formats are described in this chapter.
VECTO 2.2
##Batch Mode
<div class="vecto2">
In Batch Mode a list of vehicles is run with a list of driving cycles. Each vehicle defined in the Job List is calculated with each driving cycle defined in the Driving Cycle List. Note that the Driving Cycle List is only visible if Batch Mode is enabled in the Main Form / Options Tab.
......@@ -12,3 +13,10 @@ In Batch Mode a list of vehicles is run with a list of driving cycles. Each vehi
- Modal results (.vmod) for each job file and driving cycle. One file for each vehicle/cycle combination.
- Average/sum results (.vsum / .vsum.json). One file in total containing results for each vehicle/cycle combination.
</div>
<div class="vecto3">
VECTO V3.x doesn't support Batch mode anymore. The same functionality can be achieved by referencing every needed cycle file in the job files.
</div>
##Standard Mode
This is the default calculation mode in VECTO. It is active when both [Batch](#batch-mode) and [Declaration](#declaration-mode) Mode are disabled. In this mode a predefined list of job files (.vecto) is run. Each job file defines a vehicle and a list of driving cycles.
###Requirements
- One or more checked job files in the Job List
- Each job file must include at least one driving cycle
###Results
- Modal results (.vmod) for each job file and driving cycle. One file for each cycle.
- Average/sum results (.vsum / .vsum.json). One file in total containing results for each calculation.
Calculation Modes
=================
The Calculation Mode can be changed in the Options Tab of the [Main Form](#main-form). VECTO is running in Standard Mode when Batch Mode and Declaration Mode is disabled.
Note that [Engine Only Mode](#engine-only-mode) is not an actual calculation mode and can be set for each [Job File](#job-editor) individually and used in Standard and Batch Mode.
- [Standard Mode](#standard-mode)
- [Batch Mode](#batch-mode)
- [Declaration Mode](#declaration-mode)
#Calculation Modes
VECTO supports different calculation modes for declaring a vehicle, validation of test-results, or experimenting with different parameters and components. These modes are described here.
- [**Declaration Mode**](#declaration-mode)
: In this mode a vehicle can be declared. Many simulation parameters are predefined to provide a generic way of comparing the emissions.
- [**Engineering Mode**](#engineering-mode)
: This mode is for experimenting and validation of a vehicle. There exist several options how the driving cycle may be defined (Target speed, Measured Speed, Pwheel).
- [**Engine Only Mode**](#engine-only-mode)
: This mode is for validation of a measured engine component. Only the engine is simulated in this mode.
In the GUI the Calculation Mode can be changed via the Options Tab of the [Main Form](#main-form).
In the Command Line the Calculation Mode is Declaration by default, but can be changed to Engineering with the "-eng" flag.
<div class="vecto2">
A so called [Batch Mode](#batch-mode) exists in VECTO v2.2, which simulates every given job file with every given cycle file. This has nothing to do with the command line, it is just a convenience function to combine job files and cycle files.
</div>
<div class="vecto3">
VECTO V3.x doesn't support Batch mode anymore. The same functionality can be achieved by referencing every needed cycle file in the job files.
</div>
##Declaration Mode
In Declaration Mode all input parameters that are not user-defined in official certification are locked in the user interface and automatically defined by VECTO during calculation. Calculations will be performed for each mission profile (of the corresponding HDV class) with three different loadings each: Empty, full and with reference loading.
In Declaration Mode many input parameters are predefined for the official certification. They are locked in the user interface and will automatically be set by VECTO during calculation. Calculations will be performed for each mission profile (of the corresponding HDV class) with three different loadings each: Empty, full, and reference loading.
Declaration Mode can be activated in the [Options Tab](#main-form).
###Requirements
- One or more checked job files in the Job List
- The job files don't need to include driving cycles. These are automatically assigned.
###Results
- Modal results (.vmod). One file for each vehicle/cycle/loading combination.
- Sum results (.vsum). One file for each invocation of VECTO.
- Results overview (.pdf). One file for each job.
- Modal results (.vmod) for each job file and driving cycle. One file for each cycle.
- Average/sum results (.vsum / .vsum.json). One file in total containing results for each calculation.
- Results overview (.pdf). One file for each job file.
##Engine-Only Mode
When this mode is enabled in the Job File then VECTO only calculates the fuel consumption based on a load cycle (engine speed and torque). In the [Job File](#job-file) only the following parameters are needed:
- Filepath to the Engine File (.veng)
- Driving Cycles including engine torque (or power) and engine speed
The driving cycle also has to be in a special format which is described here: [Engine Only Driving Cycle](#engine-only-mode-engine-only-driving-cycle).
##Engineering Mode
The Engineering Mode lets the user define every aspect in the components of the vehicle and the driving cycle. This is for experimenting and validation purposes.
In this mode the given list of job files is simulated with the respective driving cycles. Each job file defines a separate vehicle.
<div class="vecto2">
This is the default calculation mode in VECTO V2.
</div>
<div class="vecto3">
In VectoCMD V3.x the default mode is Declaration Mode.
</div>
###Requirements
- One or more checked job files in the Job List
- Each job file must include at least one driving cycle
###Results
- Modal results (.vmod). One file for each vehicle/cycle combination.
- Sum results (.vsum). One file for each invocation of VECTO.
###Options###
The option depends on the driving cycle and cannot be chosen explicitely. For more information see [Driving Cycles](#driving-cycles).
###Target Speed
This option is the a target vehicle speed distance based cycle (like in Declaration Mode). With this option experiments can be made by the manufacturer.
###Measured Speed
See [Measured speed, time-based cycle](#engineering-mode-measured-speed-time-based-cycle).
###Measured Speed with Gear
See [Measured speed with gear, time-based cycle](#engineering-mode-measured-speed-with-gear-time-based-cycle).
###Pwheel (SiCo)
In Pwheel mode the measured power at the wheels is given, and the simulation takes that as input.
For more information see [P~wheel~-Input (SiCo Mode)](#pwheel-input-sico-mode).
##Acceleration Limiting
VECTO limits the vehicle acceleration and deceleration according to speed-dependent limits. These limits are defined in the [Acceleration Limiting Input File](#acceleration-limiting-input-file-.vacc) (.vacc). Note that the full load curve also limits acceleration. If the engine cannot provide the required power the vehicle might accelerate below the defined acceleration limit.
This function cannot be disabled. If acceleration and/or deceleration should not be limited during calculation the values in the Acceleration Limiting file (.vacc) have to be changed accordingly.
Parameters in [Job File](#job-editor):
: - Filepath of the [Acceleration Limiting Input File](#acceleration-limiting-input-file-.vacc) (.vacc)
The input file format is described [here](#acceleration-limiting-input-file-.vacc).
##Engine Only Mode
When this mode is enabled in the Job File then VECTO only calculates the fuel consumption based on a load cycle (engine speed and torque). In the [Job File](#job-editor) only the following parameters are needed:
- Filepath to the Engine File (.veng)
- Driving Cycles including engine torque (or power) and engine speed
The [driving cylce (.vdri)](#driving-cycle-.vdri) must contain:
- Engine speed: header: &lt;n&gt;
- Engine torque &lt;Me&gt; ***or*** engine power &lt;Pe&gt; at clutch. To explicitly define *motoring operation* use the **&lt;DRAG&gt;** keyword,see below. VECTO replaces the keyword with the motoring torque/power from the [.vfld file](../GUI/ENG-Editor.html#fld) during calculation.
- \[Optional\] Additional power demand (aux) &lt;Padd&gt;
**Note that VECTO adds the engine's inertia to the given power demand!**
**Example .vdri cycle:**
![](pics/VECTO-EngOnlyCycle.svg)
##Transient Full Load
VECTO uses a PT1 function to model transient torque build up using this formula:
$P_{fld\ dyn_{i}} = \frac{1}{T(n_{i})+1} \cdot [P_{fld\ stat}(n_{i})+T(n_{i}) \cdot P_{act_{i-1}}]$
where:
| | |
| ------------------ | -----------------------------------------------------------------------------------------|
| n~i~ | current engine speed |
| T(n~i~) | PT1 time constant at engine speed n~i~ (col. 4 in [.vfld file](#full-load-and-drag-curves-.vfld)) |
| P\_fld\_stat(n~i~) | Static full load at engine speed n~i~ (col. 2 in [.vfld file](#full-load-and-drag-curves-.vfld)) |
| P\_act~i-1~ | Engine power in previous time step |
#Functions
\ No newline at end of file
##Acceleration Limiting
To model a realistic driver behavior, VECTO limits the vehicle acceleration and deceleration according to speed-dependent limits. These limits are defined in the [Acceleration Limiting Input File (.vacc)](#acceleration-limiting-input-file-.vacc), which is defined in the [Job File](#job-file).
* If the engine can't provide the required power, the vehicle might accelerate slower than the defined driver limit.
* The minimum deceleration can always be maintained via the brakes.
* In [Measured Speed Mode](#engineering-mode-measured-speed) this limits are not used, due to the nature of this mode (speeds and accelerations are already real measured values, therefore VECTO uses these directly).
![](pics/AccLimit.png)
The Image shows the acceleration and deceleration limits depending on the current vehicle speed.
......@@ -26,7 +26,7 @@ For each auxiliary the power demand is calculated using the following steps:
| n~Eng~ | Calculated engine speed. | \[1/min\] |
| TransRatio | Speed ratio between auxiliary and engine. [Defined in the Auxiliary File](#auxiliary-input-file-.vaux). | \[-\] |
| n~aux~ | Auxiliary speed | \[1/min\] |
| P~supply~ | Effective supply power demand. [Defined in the driving cycle](#driving-cycle-.vdri). | \[kW\] |
| P~supply~ | Effective supply power demand. [Defined in the driving cycle](#driving-cycles). | \[kW\] |
| EffToSply | Consumer efficiency. [Defined in the Auxiliary File](#auxiliary-input-file-.vaux). | \[-\] |
| P~auxOut~ | Auxiliary output power | \[kW\] |
| EffMap | Auxiliary efficiency map. [Defined in the Auxiliary File](#auxiliary-input-file-.vaux). | \[kW\] = f( \[1/min\], \[kW\] ) |
......@@ -40,7 +40,7 @@ For each auxiliary the power demand is calculated using the following steps:
Each auxiliary must be defined in the [Job File](#job-editor) and each [driving cycle](#driving-cycle-.vdri) used with this vehicle must include supply power for each auxiliary. To link the supply power in the driving cycle to the correct auxiliary in the Job File an ID is used. The corresponding supply power is then named *"&lt;Aux\_ID&gt;"*.
Each auxiliary must be defined in the [Job File](#job-file) and each [driving cycle](#driving-cycles) used with this vehicle must include supply power for each auxiliary. To link the supply power in the driving cycle to the correct auxiliary in the Job File an ID is used. The corresponding supply power is then named *"&lt;Aux\_ID&gt;"*.
***Example:*** *The Auxiliary with the ID "ALT" (in the Job File) is linked to the supply power in the column "&lt;AUX\_ALT&gt;" in the driving cylce.*
......@@ -2,7 +2,7 @@
Both functions control the vehicle's behaviour on uneven road sections (slope ≠ 0) and can be configured in the [Job File](#job-editor)'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.
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.
###Overspeed
......@@ -16,7 +16,7 @@ Overspeed activates as soon as the total power demand at the wheels (Pwheel) fal
*Example with target (purple) and actual speed (orange) on the top left axis, slope (brown) on the top right axis. The bottom graph shows engine power (blue), motoring curve (orange) and mechanical brake power (green). In this example Overspeed is allowed until the vehicle's speed exceeds target speed by 5 \[km/h\].*
Parameters in [Job File](#job-editor):
Parameters in [Job File](#job-file):
: - **Minimum speed \[km/h\]**. Below this speed the function is disabled.
- **Max. Overspeed \[km/h\]** (relative to target speed)
......@@ -30,7 +30,7 @@ Instead of using the engine brake (with no fuel consumption) Eco-Roll shifts to
*Example of Eco-Roll. Target (purple) and actual speed (orange) on the top left axis, slope (brown) on the top right axis. The bottom graph shows engine power (blue), motoring curve (orange) and mechanical brake power (green). The engine is idling while the vehicle rolls freely and braking when the upper speed limit is reached.*
Parameters in [Job File](#job-editor):
Parameters in [Job File](#job-file):
: - **Minimum speed \[km/h\]** Below this speed the function is disabled.
- **Max. Overspeed \[km/h\]** (relative to target speed)
- **Max. Underspeed \[km/h\]** (relative to target speed)
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment