updating user manual

Documentation/User Manual/1-user-interface/L_ElectricMotor.md

@@ -22,6 +22,18 @@ Make and Model
 Inertia \[kgm²\]
 :   Rotational inertia of the gearbox (constant for all gears). (Engineering mode only)
 
+Continuous Power \[W\]
+:    The nominal power the electric machine can provide continuously
+
+Rated Speed (cont. Pwr) \[rpm\]
+:    Speed applied when determining the continuous power. Used for determining the continuous losses in the overload model
+
+Peak Performance Time \[s\]
+:    The time interval the electric machine can operate at its peak performance
+
+Thermal Overload Recovery Factor
+:    The accumulated overload energy has to be below the max. overload capacity multiplied by this factor so that the peak power is available again.
+
 Max. Drive and Max. Generation Torque Curve
 :   Torque over engine speed the electric motor can apply on its output shaft. (see [Electric Motor Max Torque File (.vemp)](#electric-motor-max-torque-file-.vemp))
 
@@ -35,7 +47,7 @@ Electric Power Consumption Map
 
 ###Chart Area
 
-The Chart Area displays the electric machine's max. drive curve and max. generation curve (blue), the drag curve (green) and the entries provided in the electric power consumption map.
+The Chart Area displays the electric machine's max. drive curve and max. generation curve (blue), the drag curve (green) and the entries provided in the electric power consumption map (red).
 
 
 ###Controls

Documentation/User Manual/1-user-interface/M_BatteryPackEditor.md

-##Electric Energy Storage Editor
+##Rechargeable Electric Energy Storage Editor
 
-![](pics/VECTO_Battery.png)
+Two types of rechargeable electric energy storage can be configured in VECTO: either a battery pack or a super capacitor.
+
+###Battery Pack
 
+![](pics/VECTO_Battery.png)
 
-###Description
+####Description
 
 The electric energy storage editor allows to edit all model parameters relevant for the electric energy storage.
 
-###Relative File Paths
+####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. 
 
 VECTO automatically uses relative paths if the input file (e.g. SoC) is in the same directory as the Battery file. (The Battery File must be saved before browsing for input files.)
 
 
-###Main Parameters
+####Main Parameters
 
 Make and Model
-:   Free text defining the gearbox model, type, etc.
+:   Free text defining the model, type, etc.
 
 Capacity \[Ah\]
 :   Nominal capacity of the battery
@@ -38,11 +41,33 @@ Internal Resistance Curve
 :   Defines the battery's internal resistance depending on its state of charge. The file must cover the SOC range from 0 to 100%! (see [Battery Internal Resistance File (.vbatr)](#battery-internal-resistance-file-.vbatv))
 
 
-###Chart Area
+####Chart Area
 
 The Chart Area displays the battery's internal voltage (blue) and the internal resistance (red) over its state of charge.
 
 
+###SuperCap
+
+![](pics/VECTO_SuperCap.png)
+
+####Main Parameters
+
+Make and Model
+:   Free text defining the model, type, etc.
+
+Capacity \[F\]
+:   Nominal capacity of the capacitor
+
+Min Voltage \[V\]
+:   Minimum allowed state of charge
+
+Max Voltage \[v\]
+:   Maximum allowed state of charge
+
+Internal Resistance
+:   Defines the capacitor's internal resistance 
+
+
 ###Controls
 
 

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

@@ -4,7 +4,10 @@ The electric motor is modeled by basically 4 map files:
  - Maximum drive torque over motor speed
  - Maximum generation torque over motor speed
  - Drag curve (i.e., the motor is not energized) over motor speed
- - Electric power map
+ - Electric power map ($P_\textrm{map,el}$)
+ - Continuous power ($P_textrm{cont}$)
+ - Engine speed for continuous power ($n_\textrm{P,cont}$)
+ - Maximum overload time ($t_\textrm{ovl}$)
 
 The first two curves are read from a single .vemp file (see [Electric Motor Max Torque File (.vemp)](#electric-motor-max-torque-file-.vemp)). The drag curve is provided in a .vemd file (see [Electric Motor Drag Curve File (.vemd)](#electric-motor-drag-curve-file-.vemd)) and the electric power map in a .vemo file (see [Electric Motor Map (.vemo)](#electric-motor-map-.vemo)).
 
@@ -13,3 +16,22 @@ The convention for all input files is that positive torque values drive the vehi
 
 ![](pics/electric_motor_map.png)
 
+
+###Thermal De-Rating
+
+The electric machine can be overloaded for a certain period. In addition to the maximum drive and generation torque (which already is in overload condition) the mechanical power the electric machine can generate is required.
+
+The basic principal of the thermal de-rating is as follows: based on the continuous power and the angular velocity for the continuous power as well as the maximum overload time a thermal energy buffer is calculated. During the simulation the difference between the current losses in the electric machine and the losses at the continuous power operating point are integrated over time. If this value reaches the capacity of the thermal energy buffer the electric machine can only deliver the specified continuous power until the thermal energy buffer goes below a certain.
+
+
+$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}$
+
+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$
+
+$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.
\ No newline at end of file

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

 ##RESS
 
-The rechargable electrictric energy storage system uses the following model parameters:
+###Battery
+
+The battery model uses the following model parameters:
 
 - Capacity of the battery pack
 - C-Factor (limits the max. current for charging/discharging)
@@ -21,3 +23,16 @@ The maximum discharge current is further limited by the battery's internal resis
 
 $I_\textrm{disch,max} = \frac{U(\textrm{SoC})}{4 * R_i(\textrm{SoC})}$
 
+
+###Super Capacitor
+
+The super capacitor model uses the following model parameters:
+
+- Capacity of the SuperCap in Farad
+- Internal resistance
+- Minimum voltage
+- Maximum voltage
+- Maximum current charging
+- Maximum current discharging
+
+The values of maximum charging current and maximum discharging current need to be positive!
\ No newline at end of file