From ced7e52607091396325414cbc8bf668bc9821a77 Mon Sep 17 00:00:00 2001
From: Markus Quaritsch <markus.quaritsch@tugraz.at>
Date: Tue, 1 Dec 2020 14:13:09 +0100
Subject: [PATCH] updating user manual: vsum, vmod colums after e-motor
 refactoring; equations for thermal derating of e-motor

---
 .../3-simulation-models/Electric_Motor.md     |  5 +--
 .../5-input-and-output-files/VMOD.md          | 32 ++++++++++++-------
 .../5-input-and-output-files/VSUM.md          | 19 +++++++----
 3 files changed, 36 insertions(+), 20 deletions(-)

diff --git a/Documentation/User Manual/3-simulation-models/Electric_Motor.md b/Documentation/User Manual/3-simulation-models/Electric_Motor.md
index 92ccfc93c2..0c2444186e 100644
--- a/Documentation/User Manual/3-simulation-models/Electric_Motor.md	
+++ b/Documentation/User Manual/3-simulation-models/Electric_Motor.md	
@@ -50,13 +50,14 @@ The basic principal of the thermal de-rating is as follows: based on the continu
 
 $E_\textrm{th,buf} = P_\textrm{loss,cont} * t_\textrm{ovl}$
 
-$P_\textrm{loss,cont} = P_\textrm{map, el}(\frac{P_\textrm{cont}}{n_\textrm{P, cont}}, n_\textrm{P, cont}) - P_\textrm{cont}$
+$P_\textrm{loss,cont} = P_\textrm{cont} - P_\textrm{map, el}(\frac{P_\textrm{cont}}{n_\textrm{P, cont}}, n_\textrm{P, cont})$
 
 In every simulation step the losses of the electric machine are accumulated:
 
-$E_{\textrm{ovl,} i + 1} = E_{\textrm{ovl,} i} + P_\textrm{loss, i} * dt$
+$E_{\textrm{ovl,} i + 1} = E_{\textrm{ovl,} i} + (P_\textrm{loss, i} - P_\textrm{loss,cont}) * dt$
 
 $P_\textrm{loss, i} = T_\textrm{em, mech} * n_\textrm{em} - P_\textrm{map, el}(T_\textrm{em, mech}, n_\textrm{em})$
 
+
 If $E_\textrm{ovl, i}$ reaches the overload capacity $E_\textrm{th,buf}$ the power of the electric machine is limited to the continuous power until $E_\textrm{ovl,i}$ goes below the overload capacity multiplied by a certain factor. Then the maximum torque is available again.
 
diff --git a/Documentation/User Manual/5-input-and-output-files/VMOD.md b/Documentation/User Manual/5-input-and-output-files/VMOD.md
index 65e207e96b..5b98fd21e6 100644
--- a/Documentation/User Manual/5-input-and-output-files/VMOD.md	
+++ b/Documentation/User Manual/5-input-and-output-files/VMOD.md	
@@ -97,18 +97,26 @@ $P_{avg} = \frac{1}{simulation interval} \int{P(t) dt}$.
 | PCCSegment                 |           | 1 if a PCC segment was identified in the pre-processing (gradient below threshold where vehicle accelerates on its own without engine power) , 0 otherwise                                                                                                                                                                                                                                                     |
 | PCCState                   |           | 0: not inside PCC segment, 1: inside PCC segment, 2: PCC use-case 1 active, 3: PCC use-case 2 active                                                                                                                                                                                                                                                                                                           |
 | ICE On                     |           | 0 if the combustion engine is switched off (either during stand-still or eco-roll), 1 otherwise                                                                                                                                                                                                                                                                                                                |
-| n_em<\_POS>                | [rpm]     | Angular speed of the electric motor at position *POS*                                                                                                                                                                                                                                                                                                                                                          |
-| T_em<\_POS>                | [Nm]      | Torque applied by the electric motor at position *POS*.Positive values mean that the electric motor acts as generator, negative torque values mean that the electric motor propels the vehicle                                                                                                                                                                                                                 |
-| T_em<\_POS>\_mot_max       | [Nm]      | Maximum torque the electric machine can apply to propel the vehicle. This already considers the maximum current the battery can provide                                                                                                                                                                                                                                                                        |
-| T_em<\_POS>\_gen_max       | [Nm]      | Maximum torque the electric machine can apply to generate electric power. This already considers the maximum charge current the battery can handle.                                                                                                                                                                                                                                                            |
-| P_em<\_POS>\_in            | [kW]      | Power at the electric machine's input shaft                                                                                                                                                                                                                                                                                                                                                                    |
-| P_em<\_POS>\_out           | [kW]      | Power at the electric machine's output shaft                                                                                                                                                                                                                                                                                                                                                                   |
-| P_em<\_POS>\_mech          | [kW]      | Mechanical power the electric machine applies to the drivetrain. Positive values mean that electric energy is generated while negative values mean that the electric machine drives the vehicle.                                                                                                                                                                                                               |
-| P_em<\_POS>\_el            | [kW]      | Electric power generated or consumed by the elctric machine                                                                                                                                                                                                                                                                                                                                                    |
-| P_em<\_POS>\_drive_max     | [kW]      | Maximum power the electric motor can provide to drive the vehicle. This already considers the maximum electric power the battery can provide.                                                                                                                                                                                                                                                                  |
-| P_em<\_POS>\_gen_max       | [kW]      | Maximum power the electric machine can generate. This already considers the maximum charge power the battery can handle.                                                                                                                                                                                                                                                                                       |
-| P_em<\_POS>\_loss          | [kW]      | Losses in the electric machine due to converting electric power to mechanical power                                                                                                                                                                                                                                                                                                                            |
-| P_em<\_POS>\_inertia_loss  | [kW]      | Inertia loses of the electric machine                                                                                                                                                                                                                                                                                                                                                                          |
+| i\_<POS}-em                | [-]       | Ratio between drivetrain and electric motor shaft
+| n\_<POS>-em_avg            | [rpm]     | Angular speed of the electric motor at position *POS*                                                                                                                                                                                                                                                                                                                                                          |
+| T\_<POS>-em                | [Nm]      | Torque at the shaft of  electric motor at position *POS*. Positive values mean that the electric motor acts as generator, negative torque values mean that the electric motor propels the vehicle                                                                                                                                                                                                              |
+| T\_<POS>-em_map            | [Nm]      | Torque internal torque of the electric motor at posision *POS*. Takes into account the electric motor's intertia. Positive values mean that the electric motor acts as generator, negative torque values mean that the electric motor propels the vehicle                                                                                                                                                      |
+| T\_<POS>-em_drive_max      | [Nm]      | Maximum torque the electric machine can apply to propel the vehicle. This already considers the maximum current the battery can provide                                                                                                                                                                                                                                                                        |
+| T\_<POS>-em_gen_max        | [Nm]      | Maximum torque the electric machine can apply to generate electric power. This already considers the maximum charge current the battery can handle.                                                                                                                                                                                                                                                            |
+| P\_<POS>-em_drive_max      | [kW]      | Maximum power the electric motor can provide to drive the vehicle. This already considers the maximum electric power the battery can provide.                                                                                                                                                                                                                                                                  |
+| P\_<POS>-em_gen_max        | [kW]      | Maximum power the electric machine can generate. This already considers the maximum charge power the battery can handle.                                                                                                                                                                                                                                                                                       |
+| P\_<POS>-em_mech           | [kW]      | Power at the shaft of the electric motor at position *POS*                                                                                                                                                                                                                                                                                                                                                     |
+| P\_<POS>-em_mech_map       | [kW]      | Mechanical powerthe electric motor at position *POS* applies for driving or recuperation, including the electric motor's inertia                                                                                                                                                                                                                                                                               |
+| P\_<POS>-em_el             | [kW]      | Electric power generated or consumed by the elctric machine                                                                                                                                                                                                                                                                                                                                                    |
+| P\_<POS>-em_loss           | [kW]      | Losses in the electric machine due to converting electric power to mechanical power                                                                                                                                                                                                                                                                                                                            |
+| P\_<POS>-em_inertia_loss   | [kW]      | Inertia loses of the electric machine                                                                                                                                                                                                                                                                                                                                                                          |
+| P\_<POS>\_in               | [kW]      | Power at the electric machine's input shaft (drivetrain)                                                                                                                                                                                                                                                                                                                                                       |
+| P\_<POS>\_out              | [kW]      | Power at the electric machine's output shaft (drivetrain)                                                                                                                                                                                                                                                                                                                                                      |
+| P\_<POS>\_mech             | [kW]      | Mechanical power the electric machine applies to the drivetrain. Positive values mean that electric energy is generated while negative values mean that the electric machine drives the vehicle.                                                                                                                                                                                                               |
+| P\_<POS>\_loss             | [kW]      | The total sum of losses of the electric motor at position *POS*. Calcualted as the difference of mecanical power applied at the drivetrain and the electrical power drawn from the REESS.                                                                                                                                                                                                                      |
+| P\_<POS>\_transm_loss      | [kW]      | Losses of the transmission stage inside the electric motor component                                                                                                                                                                                                                                                                                                                                           |
+| EM_OVL-<POS>-em            | [%]       | Used capacity of the thermal overload buffer of the thermal derating model                                                                                                                                                                                                                                                                                                                                     |
+| EM_<POS>_off               | [-]       | Indicates if the electric motor at position *POS* is energized or not.                                                                                                                                                                                                                                                                                                                                         |
 | P_bat_T                    | [kW]      | Electric power provided at the battery's connector                                                                                                                                                                                                                                                                                                                                                             |
 | P_bat_int                  | [kW]      | Internal battery power                                                                                                                                                                                                                                                                                                                                                                                         |
 | P_bat_loss                 | [kW]      | Losses of the battery due to its internal resistance.                                                                                                                                                                                                                                                                                                                                                          |
diff --git a/Documentation/User Manual/5-input-and-output-files/VSUM.md b/Documentation/User Manual/5-input-and-output-files/VSUM.md
index cb0b2366ad..bb5ceeccc2 100644
--- a/Documentation/User Manual/5-input-and-output-files/VSUM.md	
+++ b/Documentation/User Manual/5-input-and-output-files/VSUM.md	
@@ -79,12 +79,19 @@ The .vsum file includes total / average results for each calculation run in one
 | DecelerationTimeShare                  | [%]                                                | Time share of deceleration phases (a~3s~ \< 0.125 \[m/s^2^\], a~3s~ = 3-seconds-averaged acceleration)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
 | CruiseTimeShare                        | [%]                                                | Time share of cruise phases (-0.125 ≤ a~3s~ ≤ 0.125 \[m/s^2^\])                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
 | StopTimeShare                          | [%]                                                | Time share of stop phases (v \< 0.1 \[m/s\])                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
-| E_EM_<\_POS>\_drive                    | [kWh]                                              | Mechanical energy applied by the electric machine at position *POS* to drive the vehicle                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
-| E_EM_<\_POS>\_gen                      | [kWh]                                              | Mechanical energy recuperated by the electric machine at position *POS*                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
-| n_EM_<\_POS>\_avg                      | [rpm]                                              | Average angular speed of the electric machine                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
-| η_EM_<\_POS>\_mot                      | [-]                                                | Average efficiency of the electric machine when the electric machine drives the vehicle                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
-| η_EM_<\_POS>\_gen                      | [-]                                                | Average efficiency of the electric machine when the electric machine generates electric energy                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
-| E_EM_<\_POS>\_off_loss                 | [kWh]                                              | Total losses added by the electric machine when the electric machine is not energized (i.e., the electric machine's drag losses)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
+| E_EM_<POS>\_drive                      | [kWh]                                              | Mechanical energy applied at the drivetrain by the electric machine at position *POS* to drive the vehicle                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
+| E_EM_<POS>\_gen                        | [kWh]                                              | Mechanical energy at the drivetrain recuperated by the electric machine at position *POS*                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
+| η_EM_<POS>\_drive                      | [-]                                                | Average efficiency at the drivetrain of the electric machine when the electric machine drives the vehicle. Based on the mechanical energy at the drivetrain and the electric power.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
+| η_EM_<POS>\_gen                        | [-]                                                | Average efficiency at the drivetrain of the electric machine when the electric machine generates electric energy. Based on the mechanical energy at the drivetrain and the electric power                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
+| E_EM_<POS>-em_drive                    | [kWh]                                              | Mechanical energy at the electric motor shaft applied by the electric machine at position *POS* to drive the vehicle                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
+| E_EM_<POS>-em_gen                      | [kWh]                                              | Mechanical energy at the electric motor shaft recuperated by the electric machine at position *POS*                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
+| η_EM_<POS>-em_drive                    | [-]                                                | Average efficiency of the electric machine when the electric machine drives the vehicle. Based on the mechanical energy at the electric motor shaft and the electric energy.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+| η_EM_<POS>-em_gen                      | [-]                                                | Average efficiency of the electric machine when the electric machine generates electric energy. Based on the mechanical energy at the electric motor shaft and the electric energy.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
+| n_EM_<POS>\_avg                        | [rpm]                                              | Average angular speed of the electric machine                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
+| E_EM_<POS>\_off_loss                   | [kWh]                                              | Total losses added by the electric machine when the electric machine is not energized (i.e., the electric machine's drag losses)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
+| E_EM_<POS>\_transm_loss                | [kWh]                                              | Losses of the transmission stage in the electric motor component.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
+| E_EM_<POS>-em_loss                     | [kWh]                                              | Total losses of the electric motor component. Calculated from P_<POS>-em_loss                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
+| E_EM_<POS>\_loss                       | [kWh]                                              | Losses of the electric machine. Calculated from P_<POS>_loss                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
 | Battery Start SoC                      | [%]                                                | Battery state of charge at the beginning of the simulation run                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
 | Battery End SoC                        | [%]                                                | Battery state of charge at the end of the simulation run                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
 | Battery Delta SoC                      | [kWh]                                              | Difference of the energy stored in the battery between the beginning and end of the simulation run                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
-- 
GitLab