Merge pull request #2 from simscape/master

Hyperlink and doc update

Author: JiteshJhaIN

Components/MotorDrive/MotorMultiPhysics/PMSMdetailTestbench.slx

@@ -3,7 +3,7 @@
 % This repository contains model and code to help engineers design battery electric
 % vehicle (BEV), including range estimation and battery sizing workflows.
 %
-% Copyright 2022 - 2023 The MathWorks, Inc.
+% Copyright 2022 - 2025 The MathWorks, Inc.
 
 
 
@@ -32,14 +32,14 @@
 %
 % * <matlab:open('BEVRangeEstimationMain.mlx') Range Estimation for Battery Electric Vehicles>
 % * <matlab:open('BEVBatterySizingMain.mlx') Sizing Battery for Electric Vehicles>
-% * <matlab:open('BatteryNeuralNetModel.mlx') Battery Neural Network Model for Temperature Prediction>
-% * <matlab:open('PMSMmotorTestBench.mlx') PMSM Thermal Test Bench for Battery Electric Vehicle (BEV)>
+% * <matlab:open('VirtualSensorNeuralNetModel.mlx') Battery Neural Network Model for Temperature Prediction>
+% * <matlab:open('generateDULossMap.mlx') Generate loss map for PMSM (BEV)>
 %
 
 %% Documentation
 % 
 % * <matlab:web('BatteryElectricVehicleModelOverview.html') Battery Electric Vehicle Model>
-% * <matlab:open('PMSMmotorTestBenchDescription.mlx') PMSM Thermal Model>
+% * <matlab:open('MotorDriveThermalTestBenchDescription.mlx') PMSM Thermal Model>
 % 
 
 %% Models

Model/BEVsystemModel.slx

@@ -7,9 +7,9 @@
 To make changes, update the MATLAB code and republish this document.
       -->
 <title>Electric Vehicle Design with Simscape&trade;</title>
-<meta name="generator" content="MATLAB 23.2">
+<meta name="generator" content="MATLAB 24.2">
 <link rel="schema.DC" href="http://purl.org/dc/elements/1.1/">
-<meta name="DC.date" content="2024-07-18">
+<meta name="DC.date" content="2026-01-05">
 <meta name="DC.source" content="ElectricVehicleDesignOverview.m">
 <style type="text/css">
 html,body,div,span,applet,object,iframe,h1,h2,h3,h4,h5,h6,p,blockquote,pre,a,abbr,acronym,address,big,cite,code,del,dfn,em,font,img,ins,kbd,q,s,samp,small,strike,strong,tt,var,b,u,i,center,dl,dt,dd,ol,ul,li,fieldset,form,label,legend,table,caption,tbody,tfoot,thead,tr,th,td{margin:0;padding:0;border:0;outline:0;font-size:100%;vertical-align:baseline;background:transparent}body{line-height:1}ol,ul{list-style:none}blockquote,q{quotes:none}blockquote:before,blockquote:after,q:before,q:after{content:'';content:none}:focus{outine:0}ins{text-decoration:none}del{text-decoration:line-through}table{border-collapse:collapse;border-spacing:0}
@@ -112,10 +112,10 @@ <h2 id="1">Overview</h2>
 <a href="matlab:open('BEVBatterySizingMain.mlx')">Sizing Battery for Electric Vehicles</a>
 </li>
 <li>
-<a href="matlab:open('BatteryNeuralNetModel.mlx')">Battery Neural Network Model for Temperature Prediction</a>
+<a href="matlab:open('VirtualSensorNeuralNetModel.mlx')">Battery Neural Network Model for Temperature Prediction</a>
 </li>
 <li>
-<a href="matlab:open('PMSMmotorTestBench.mlx')">PMSM Thermal Test Bench for Battery Electric Vehicle (BEV)</a>
+<a href="matlab:open('generateDULossMap.mlx')">Generate loss map for PMSM (BEV)</a>
 </li>
 </ul>
 </div>
@@ -126,7 +126,7 @@ <h2 id="5">Documentation</h2>
 <a href="matlab:web('BatteryElectricVehicleModelOverview.html')">Battery Electric Vehicle Model</a>
 </li>
 <li>
-<a href="matlab:open('PMSMmotorTestBenchDescription.mlx')">PMSM Thermal Model</a>
+<a href="matlab:open('MotorDriveThermalTestBenchDescription.mlx')">PMSM Thermal Model</a>
 </li>
 </ul>
 </div>
@@ -147,8 +147,8 @@ <h2 id="8">Acronyms</h2>
 <li>FWD : Forward Wheel Drive</li>
 </ul>
 </div>
-<p class="footer">Copyright 2022 - 2023 The MathWorks, Inc.<br>
-<a href="https://www.mathworks.com/products/matlab/">Published with MATLAB&reg; R2023b</a>
+<p class="footer">Copyright 2022 - 2025 The MathWorks, Inc.<br>
+<a href="https://www.mathworks.com/products/matlab/">Published with MATLAB&reg; R2024b</a>
 <br>
 </p>
 </div>
@@ -159,7 +159,7 @@ <h2 id="8">Acronyms</h2>
 % This repository contains model and code to help engineers design battery electric
 % vehicle (BEV), including range estimation and battery sizing workflows.
 %
-% Copyright 2022 - 2023 The MathWorks, Inc.
+% Copyright 2022 - 2025 The MathWorks, Inc.
 
 
 
@@ -188,14 +188,14 @@ <h2 id="8">Acronyms</h2>
 %
 % * <matlab:open('BEVRangeEstimationMain.mlx') Range Estimation for Battery Electric Vehicles>
 % * <matlab:open('BEVBatterySizingMain.mlx') Sizing Battery for Electric Vehicles>
-% * <matlab:open('BatteryNeuralNetModel.mlx') Battery Neural Network Model for Temperature Prediction>
-% * <matlab:open('PMSMmotorTestBench.mlx') PMSM Thermal Test Bench for Battery Electric Vehicle (BEV)>
+% * <matlab:open('VirtualSensorNeuralNetModel.mlx') Battery Neural Network Model for Temperature Prediction>
+% * <matlab:open('generateDULossMap.mlx') Generate loss map for PMSM (BEV)>
 %
 
 %% Documentation
 % 
 % * <matlab:web('BatteryElectricVehicleModelOverview.html') Battery Electric Vehicle Model>
-% * <matlab:open('PMSMmotorTestBenchDescription.mlx') PMSM Thermal Model>
+% * <matlab:open('MotorDriveThermalTestBenchDescription.mlx') PMSM Thermal Model>
 % 
 
 %% Models

Overview/ElectricVehicleDesignOverview.m

@@ -150,7 +150,7 @@
 % Simscape Bus. 
 %
 % The electric motor loss map is generated using the PMSM test bench, as described
-% in <matlab:open('PMSMmotorTestBench.mlx'); PMSM Thermal Test Bench for Battery Electric Vehicle.>
+% in <matlab:open('generateDULossMap.mlx'); PMSM Thermal Test Bench for Battery Electric Vehicle.>
 %
 % <matlab:open_system("BEVsystemModel");open_system('BEVsystemModel/Vehicle/Front%20Motor%20(EM1)'); Open Front Motor Subsystem>
 
@@ -203,7 +203,7 @@
 %%
 % The chiller extracts a fixed amount of heat from the coolant.
 %
-% <matlab:load_system("VehicleElectroThermal");open_system('VehicleElectroThermal/Vehicle/Chiller'); Open Chiller Subsystem>
+% <matlab:load_system("VehicleElectroThermal");open_system('VehicleElectroThermal/Chiller'); Open Chiller Subsystem>
 %
 load_system('VehicleElectroThermal.slx')
 open_system('VehicleElectroThermal/Chiller');
@@ -229,10 +229,10 @@
 % temperature is high, the heater is switched off as the battery can
 % sustain the temperature. 
 % 
-% <matlab:load_system("Controller_HVAC");open_system('Controller_HVAC/Cabin%20Control/Cabin%20Air%20Control'); Open Thermal Control Subsystem>
+% <matlab:load_system("Controller");open_system('Controller/Cabin%20Control/Cabin%20Air%20Control'); Open Thermal Control Subsystem>
 %
-load_system('Controller_HVAC');
-open_system('Controller_HVAC/Cabin Control/Cabin Air Control');
+load_system('Controller');
+open_system('Controller/Cabin Control/Cabin Air Control');
 
 %% Cabin HVAC
 %
@@ -244,9 +244,9 @@
 % blower circulates the air from the vent through the cabin to heat or cool
 % the cabin. 
 %
-% <matlab:load_system("VehicleElectroThermal");open_system('VehicleElectroThermal/HVAC/Cabin/Cabin%20Plant'); Open Cabin Subsystem>
+% <matlab:load_system("VehicleElectroThermal");open_system('VehicleElectroThermal/HVAC/Cabin%20Plant'); Open Cabin Subsystem>
 %
-open_system('VehicleElectroThermal/HVAC/Cabin/Cabin Plant');
+open_system('VehicleElectroThermal/HVAC/Cabin Plant');
 
 %%
 % The cabin loses heat to the environment through the vehicle door, windows, and roof.

Overview/html/ElectricVehicleDesignOverview.html

@@ -1,3 +1,3 @@
 % Copyright 2022 - 2023 The MathWorks, Inc.
 
-edit('PMSMmotorTestBench.mlx');
+edit('MotorDriveThermalTestBenchDescription.mlx');

Overview/html/ElectricVehicleDesignOverview.png

@@ -7,9 +7,9 @@
 To make changes, update the MATLAB code and republish this document.
       -->
 <title>Battery Electric Vehicle Model</title>
-<meta name="generator" content="MATLAB 23.2">
+<meta name="generator" content="MATLAB 24.2">
 <link rel="schema.DC" href="http://purl.org/dc/elements/1.1/">
-<meta name="DC.date" content="2024-11-15">
+<meta name="DC.date" content="2026-01-05">
 <meta name="DC.source" content="BatteryElectricVehicleModelOverview.m">
 <style type="text/css">
 html,body,div,span,applet,object,iframe,h1,h2,h3,h4,h5,h6,p,blockquote,pre,a,abbr,acronym,address,big,cite,code,del,dfn,em,font,img,ins,kbd,q,s,samp,small,strike,strong,tt,var,b,u,i,center,dl,dt,dd,ol,ul,li,fieldset,form,label,legend,table,caption,tbody,tfoot,thead,tr,th,td{margin:0;padding:0;border:0;outline:0;font-size:100%;vertical-align:baseline;background:transparent}body{line-height:1}ol,ul{list-style:none}blockquote,q{quotes:none}blockquote:before,blockquote:after,q:before,q:after{content:'';content:none}:focus{outine:0}ins{text-decoration:none}del{text-decoration:line-through}table{border-collapse:collapse;border-spacing:0}
@@ -140,7 +140,7 @@ <h2 id="1">Model Overview</h2>
 <img vspace="5" hspace="5" src="BatteryElectricVehicleModelOverview_04.png" alt=""> <p><h3>Table based battery</h3></p>
 <p>The table based battery model tabulates battery characteristics as functions of state of charge (SOC) and temperature and scales the characteristics upto the capacity of the pack. For quick deployment the Battery block has a selection of predefined battery characteristics.</p>
 <p>
-<a href="matlab:open_system(%22BatteryPlantModel_Table%22)">Open Battery table Subsystem</a>
+<a href="matlab:open_system(%22BatteryTableBased%22)">Open Battery table Subsystem</a>
 </p>
 <img vspace="5" hspace="5" src="BatteryElectricVehicleModelOverview_05.png" alt=""> <p><h3>Battery Management System</h3></p>
 <p>The battery management system (BMS) manages all the battery operations and keeps the battery within operational limits. The BMS maintains the current, voltage, and temperature of the pack within safe limits during the charging and discharging operations. In this example, the BMS controls the circuit breakers to protect the battery pack based on the pack sensor data and on estimated parameters such as the state of charge (SOC) and the current limits for charging and discharging.</p>
@@ -191,7 +191,7 @@ <h2 id="9">Electric Drivetrain (E-Axle)</h2>
 <a href="matlab:open_system(%22BEVsystemModel%22);open_system('BEVsystemModel/Vehicle/Rear%20Motor%20(EM2)');">Open Rear Motor Subsystem</a>
 </p>
 <img vspace="5" hspace="5" src="BatteryElectricVehicleModelOverview_07.png" alt=""> <p>The electric motors are connected to the battery high voltage bus. The Emotors are connected or disconnected from the battery based on relay signal from the BMS which is connected to the fault port of the Motor &amp; Drive block. The plant model tracks a torque demand generated by the vehicle controller in close loop to reach a speed setpoint. You can load tabulated data of the speed and time to track a speed profile. This tabulated profile can be a standard drive cycle in the Drive Cycle Source block or a real drive cycle data from test runs. Output from the Emotor block goes to a gearbox and then to the wheel. The signals are passed to other components via Simscape Bus.</p>
-<p>The electric motor loss map is generated using the PMSM test bench, as described in <a href="matlab:open('PMSMmotorTestBench.mlx');">PMSM Thermal Test Bench for Battery Electric Vehicle.</a>
+<p>The electric motor loss map is generated using the PMSM test bench, as described in <a href="matlab:open('generateDULossMap.mlx');">PMSM Thermal Test Bench for Battery Electric Vehicle.</a>
 </p>
 <p>
 <a href="matlab:open_system(%22BEVsystemModel%22);open_system('BEVsystemModel/Vehicle/Front%20Motor%20(EM1)');">Open Front Motor Subsystem</a>
@@ -220,21 +220,21 @@ <h2 id="9">Electric Drivetrain (E-Axle)</h2>
 <img vspace="5" hspace="5" src="BatteryElectricVehicleModelOverviewThermalDiagram.png" alt=""> </p>
 <p>The chiller extracts a fixed amount of heat from the coolant.</p>
 <p>
-<a href="matlab:load_system(%22VehicleElectroThermal%22);open_system('VehicleElectroThermal/Vehicle/Chiller');">Open Chiller Subsystem</a>
+<a href="matlab:load_system(%22VehicleElectroThermal%22);open_system('VehicleElectroThermal/Chiller');">Open Chiller Subsystem</a>
 </p>
 <img vspace="5" hspace="5" src="BatteryElectricVehicleModelOverview_11.png" alt=""> <p>The heater adds a fixed amount of heat to the coolant in the circuit.</p>
 <p>
 <a href="matlab:load_system(%22VehicleElectroThermal%22);open_system('VehicleElectroThermal/Heater');">Open Heater Subsytem</a>
 </p>
 <img vspace="5" hspace="5" src="BatteryElectricVehicleModelOverview_12.png" alt=""> <p>The pump and the valves are actuated based on the coolant temperature and whether battery requires cooling or heating. When the temperature of the coolant in the Emotor is low, then the coolant bypasses the radiator and keeps recirculating to increase the temperature. If the temperature is above a threshold value, coolant passes through the radiator. Similarly, when the battery temperature is above a threshold value the coolant passes through the chiller to cool the battery quickly. A positive temperature coefficient (PTC) heater increases the temperature of the battery in low ambient temperature conditions. Once the battery temperature is high, the heater is switched off as the battery can sustain the temperature.</p>
 <p>
-<a href="matlab:load_system(%22Controller_HVAC%22);open_system('Controller_HVAC/Cabin%20Control/Cabin%20Air%20Control');">Open Thermal Control Subsystem</a>
+<a href="matlab:load_system(%22Controller%22);open_system('Controller/Cabin%20Control/Cabin%20Air%20Control');">Open Thermal Control Subsystem</a>
 </p>
 <img vspace="5" hspace="5" src="BatteryElectricVehicleModelOverview_13.png" alt=""> <h2 id="17">Cabin HVAC</h2>
 <p><h3>Abstract Refrigeration</h3></p>
 <p>The battery powers the cooling or heating of the cabin. In near zero ambient temperature conditions, heating the cabin consumes 10-15% of the battery capacity. The PTC heater, cooler, and the blower are in loop. The blower circulates the air from the vent through the cabin to heat or cool the cabin.</p>
 <p>
-<a href="matlab:load_system(%22VehicleElectroThermal%22);open_system('VehicleElectroThermal/HVAC/Cabin/Cabin%20Plant');">Open Cabin Subsystem</a>
+<a href="matlab:load_system(%22VehicleElectroThermal%22);open_system('VehicleElectroThermal/HVAC/Cabin%20Plant');">Open Cabin Subsystem</a>
 </p>
 <img vspace="5" hspace="5" src="BatteryElectricVehicleModelOverview_14.png" alt=""> <p>The cabin loses heat to the environment through the vehicle door, windows, and roof.</p>
 <p>The Scenarios subsystem sets the cabin setpoint temperature and the AC on/off control. The HVAC controller modulates the air flow in the cabin through the vent. The heater and cooler draw the required power from the main battery high voltage bus.</p>
@@ -248,7 +248,7 @@ <h2 id="9">Electric Drivetrain (E-Axle)</h2>
 <a href="matlab:web('ElectricVehicleDesignOverview.html');">Electric Vehicle Design with Simscape</a>
 </p>
 <p class="footer">Copyright 2022-2023 The MathWorks, Inc.<br>
-<a href="https://www.mathworks.com/products/matlab/">Published with MATLAB&reg; R2023b</a>
+<a href="https://www.mathworks.com/products/matlab/">Published with MATLAB&reg; R2024b</a>
 <br>
 </p>
 </div>
@@ -324,8 +324,8 @@ <h2 id="9">Electric Drivetrain (E-Axle)</h2>
 % upto the capacity of the pack. For quick deployment the Battery block has a selection of
 % predefined battery characteristics.
 %
-% <matlab:open_system("BatteryPlantModel_Table") Open Battery table Subsystem>
-open_system('BatteryPlantModel_Table')
+% <matlab:open_system("BatteryTableBased") Open Battery table Subsystem>
+open_system('BatteryTableBased')
 
 %%
 % 
@@ -406,7 +406,7 @@ <h2 id="9">Electric Drivetrain (E-Axle)</h2>
 % Simscape Bus. 
 %
 % The electric motor loss map is generated using the PMSM test bench, as described
-% in <matlab:open('PMSMmotorTestBench.mlx'); PMSM Thermal Test Bench for Battery Electric Vehicle.>
+% in <matlab:open('generateDULossMap.mlx'); PMSM Thermal Test Bench for Battery Electric Vehicle.>
 %
 % <matlab:open_system("BEVsystemModel");open_system('BEVsystemModel/Vehicle/Front%20Motor%20(EM1)'); Open Front Motor Subsystem>
 
@@ -459,7 +459,7 @@ <h2 id="9">Electric Drivetrain (E-Axle)</h2>
 %%
 % The chiller extracts a fixed amount of heat from the coolant.
 %
-% <matlab:load_system("VehicleElectroThermal");open_system('VehicleElectroThermal/Vehicle/Chiller'); Open Chiller Subsystem>
+% <matlab:load_system("VehicleElectroThermal");open_system('VehicleElectroThermal/Chiller'); Open Chiller Subsystem>
 %
 load_system('VehicleElectroThermal.slx')
 open_system('VehicleElectroThermal/Chiller');
@@ -485,10 +485,10 @@ <h2 id="9">Electric Drivetrain (E-Axle)</h2>
 % temperature is high, the heater is switched off as the battery can
 % sustain the temperature. 
 % 
-% <matlab:load_system("Controller_HVAC");open_system('Controller_HVAC/Cabin%20Control/Cabin%20Air%20Control'); Open Thermal Control Subsystem>
+% <matlab:load_system("Controller");open_system('Controller/Cabin%20Control/Cabin%20Air%20Control'); Open Thermal Control Subsystem>
 %
-load_system('Controller_HVAC');
-open_system('Controller_HVAC/Cabin Control/Cabin Air Control');
+load_system('Controller');
+open_system('Controller/Cabin Control/Cabin Air Control');
 
 %% Cabin HVAC
 %
@@ -500,9 +500,9 @@ <h2 id="9">Electric Drivetrain (E-Axle)</h2>
 % blower circulates the air from the vent through the cabin to heat or cool
 % the cabin. 
 %
-% <matlab:load_system("VehicleElectroThermal");open_system('VehicleElectroThermal/HVAC/Cabin/Cabin%20Plant'); Open Cabin Subsystem>
+% <matlab:load_system("VehicleElectroThermal");open_system('VehicleElectroThermal/HVAC/Cabin%20Plant'); Open Cabin Subsystem>
 %
-open_system('VehicleElectroThermal/HVAC/Cabin/Cabin Plant');
+open_system('VehicleElectroThermal/HVAC/Cabin Plant');
 
 %%
 % The cabin loses heat to the environment through the vehicle door, windows, and roof.