Doc update

Author: shachindra1980

.github/workflows/ci.yml

@@ -0,0 +1,55 @@
+# GitHub Actions Workflow with MATLAB Actions
+#
+# For a general overview of GitHub Actions, see
+# https://docs.github.com/en/actions
+#
+# For using MathWorks products in GitHub Actions, see
+# https://github.com/matlab-actions/overview
+#
+# For details about the syntax of this file, see
+# https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions
+
+# Copyright 2024 The MathWorks, Inc.
+
+name: CI using MATLAB
+
+on:
+  push:
+    paths-ignore:
+      - 'docs/**'
+      - '**.md'
+      - '**.png'
+      - '**.svg'
+      - '**.txt'
+      - '**.xml'
+
+  pull_request:
+    paths-ignore:
+      - 'docs/**'
+      - '**.md'
+      - '**.png'
+      - '**.svg'
+      - '**.txt'
+      - '**.xml'
+
+  schedule:
+    - cron:  '55/61 20/25 1/6 * *' # schedule a weekly-ish build
+
+jobs:
+
+  job-check-project:
+    runs-on: ubuntu-latest
+    steps:
+
+      - name: Check out repository
+        uses: actions/checkout@v3
+
+      - name: Setup MATLAB
+        uses: matlab-actions/setup-matlab@v1
+        with:
+          release: R2023a
+
+      - name: Run tests
+        uses: matlab-actions/run-command@v1
+        with:
+          command: openProject(pwd);SandBatteryTestRunner;

Overview/ResidentialBuildingTESandPVcell.m

@@ -1,6 +1,5 @@
 %% Residential Building Heating with TES and PV 
-
-
+%
 % Copyright 2023 - 2024 The MathWorks, Inc.
 
 %% Model Overview
@@ -32,7 +31,7 @@
 % This picture shows equivalent circuit of MPPT.
 %
 % 
-% <<MPPTcircuit.PNG>>
+% <<MPPTcircuit.png>>
 %
 %
 % The MPPT Converter subsystem receives two inputs:
@@ -65,12 +64,10 @@
 %
 % To model the sand battery, the Thermal energy storage subsystem uses a
 % Sand TES custom block.
-% To learn more about the custom block, see <blockDescriptionTES.html Sand 
+% To learn more about the custom block, see <matlab:web('blockDescriptionTES.html') Sand 
 % Battery>
 %
-
 %% Set Model Parameters
 % * <matlab:open('ThermalBatterySetParam.m') Set Thermal Battery Parameters>
 % * <matlab:open('residentialUnitSetParam.m') Set Residential Unit Parameters>
- 
-    
+%

Overview/blockDescriptionTES.m

@@ -1,13 +1,9 @@
 %% Sand Battery 
-%%
 % 
-% <<maskIcon.PNG>>
+% <<maskIcon.png>>
 % 
-
- 
 % Copyright 2023 - 2024 The MathWorks, Inc.
 
-
 %% Description 
 % The Sand Battery block models a thermal energy storage by using sand as the energy storage medium. 
 % The block stores the energy in form of sensible heat of the sand. 
@@ -26,15 +22,14 @@
 % parallel-connected cells. To ensure the accuracy of the energy
 % calculation, the Biot number criterion internally constraints the mass of
 % the sand associated with the heating coil or moist air pipe.
-
    %%
    % 
-   % <<TESnetwork.PNG>>
+   % <<TESnetwork.png>>
    % 
 % This figure shows the sand battery configuration when you set the |Number of coil rows| and |Number of coils in each row| parameters to 2. 
  %%
    % 
-   % <<sandBattery.PNG>>
+   % <<sandBattery.png>>
    % 
 %% Ports 
 %%
@@ -51,12 +46,10 @@
 %%%
 % * *tH* — Thermal conserving port associated with the heat leakage from the thermal energy storage (TES).
 %
-
-
 %% Parameters
 %
 % 
-% <<blockMaskTES.PNG>>
+% <<blockMaskTES.png>>
 % 
 % 
 %
@@ -114,8 +107,4 @@
 % * *Specific heat of sand* — Specific heat of the sand, specified as a positive scalar.
 %
 % * *Initial sand mass temperature* — Initial temperature of the sand at the beginning of the simulation, specified as a positive scalar.
-%
-
-
-
-
+%

Overview/html/ResidentialBuildingTESandPVcell.html

@@ -6,7 +6,7 @@
    <!--
 This HTML was auto-generated from MATLAB code.
 To make changes, update the MATLAB code and republish this document.
-      --><title>Residential Building Heating with TES and PV</title><meta name="generator" content="MATLAB 9.14"><link rel="schema.DC" href="http://purl.org/dc/elements/1.1/"><meta name="DC.date" content="2024-06-19"><meta name="DC.source" content="ResidentialBuildingTESandPVcell.m"><style type="text/css">
+      --><title>Residential Building Heating with TES and PV</title><meta name="generator" content="MATLAB 9.14"><link rel="schema.DC" href="http://purl.org/dc/elements/1.1/"><meta name="DC.date" content="2024-11-26"><meta name="DC.source" content="ResidentialBuildingTESandPVcell.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}
 
 html { min-height:100%; margin-bottom:1px; }
@@ -67,11 +67,10 @@
 
 
 
-  </style></head><body><div class="content"><h1>Residential Building Heating with TES and PV</h1><!--introduction--><!--/introduction--><h2>Contents</h2><div><ul><li><a href="#1">Model Overview</a></li><li><a href="#4">Model Subsystems</a></li><li><a href="#8">Set Model Parameters</a></li></ul></div><h2 id="1">Model Overview</h2><p>The residential heating model comprises a rooftop photovoltaic (PV) panel for charging the thermal battery, a thermal energy storage for storing renewable energy, a hot water tank for storing hot water, a heat exchanger (HEX) for heating the water, a pump for supplying hot water to the house, and an air blower for taking out the stored heat from the thermal battery.</p><p>To increase the efficiency of the system PV panels, the model recovers the heat by circulating the water through the channels below the PV panels. The Control subsystem controls the water pump and air blower pressure to achieve the set temperature of the hot water tank. The subsystem also operates the flow control valve. The flow control valve allows the water to flow towards the PV panels that are hotter than the tank temperature.</p><p><img vspace="5" hspace="5" src="thermalEnergyStorageDesignOverview_01.png" alt=""> </p><h2 id="4">Model Subsystems</h2><p><b>Photovoltaic Panel Subsystem</b></p><p>The Photovoltaic panel subsystem models the solar battery that converts the sunlight into electricity. The subsystem uses a Solar Cell block that allows you to choose a pre-parameterized PV component.</p><p><b>MPPT Converter Subsystem</b></p><p>The PV panel produces a power as a function of the load resistance that connects to the panel. To maximize the power that the PV panels produce when they connect to the heating coil network of a given resistance, you require an MPPT converter. This picture shows equivalent circuit of MPPT.</p><p><img vspace="5" hspace="5" src="MPPTcircuit.PNG" alt=""> </p><p>The MPPT Converter subsystem receives two inputs:</p><div><ul><li>The net heating coil resistance that connects to the PV panel <img src="ResidentialBuildingTESandPVcell_eq08783089781685090913.png" alt="$R_L$" style="width:17px;height:13px;"></li><li>The Voltage <img src="ResidentialBuildingTESandPVcell_eq10400070808277276123.png" alt="$V_m$" style="width:17px;height:13px;"> at which the PV panel produces the maximum power.</li></ul></div><p>PV panel suppliers provide the value of <img src="ResidentialBuildingTESandPVcell_eq10400070808277276123.png" alt="$V_m$" style="width:17px;height:13px;"> in the product datasheet. To maximize the PV power, the MPPT sets the voltage across the panel to <img src="ResidentialBuildingTESandPVcell_eq10400070808277276123.png" alt="$V_m$" style="width:17px;height:13px;">. If the current from the PV panel is <img src="ResidentialBuildingTESandPVcell_eq04234782492993571773.png" alt="$I_m$" style="width:15px;height:13px;">, then the power that the PV panel produces is equal to <img src="ResidentialBuildingTESandPVcell_eq14958545416380561496.png" alt="$V_m*I_m$" style="width:47px;height:13px;">.</p><p>The heater coil dissipates a power equal to <img src="ResidentialBuildingTESandPVcell_eq14440076464137941470.png" alt="$V_L^2/R_L$" style="width:43px;height:17px;">.</p><p>To calculate the MPPT terminal voltage, the MPPT Converter subsystem equates the two powers and solve for <img src="ResidentialBuildingTESandPVcell_eq13778725294678372914.png" alt="$V_L$" style="width:12px;height:11px;">:</p><p><img src="ResidentialBuildingTESandPVcell_eq05957124644736009177.png" alt="$V_L \ =\ \sqrt{V_m \times I_m \times R_L }$" style="width:147px;height:15px;">.</p><p><b>Residential Unit Subsystem</b></p><p>The Residential Unit subsystem comprises an electrical resistor to model the household power consumption and a thermal network to model the temperature variation of the rooms. Hot water radiators heat the rooms when the outside atmosphere temperature drops below the room set point temperature. The roof of the rooms thermally connects to the PV panel. The floor of the rooms thermally connects to the TES by using a Conductive Heat Transfer block.</p><p><b>Thermal Energy Storage Subsystem</b></p><p>To model the sand battery, the Thermal energy storage subsystem uses a Sand TES custom block. To learn more about the custom block, see <a href="blockDescriptionTES.html">Sand Battery</a></p><h2 id="8">Set Model Parameters</h2><div><ul><li><a href="matlab:open('ThermalBatterySetParam.m')">Set Thermal Battery Parameters</a></li><li><a href="matlab:open('residentialUnitSetParam.m')">Set Residential Unit Parameters</a></li></ul></div><p class="footer">Copyright 2023 - 2024 The MathWorks, Inc.<br><a href="https://www.mathworks.com/products/matlab/">Published with MATLAB&reg; R2023a</a><br></p></div><!--
+  </style></head><body><div class="content"><h1>Residential Building Heating with TES and PV</h1><!--introduction--><!--/introduction--><h2>Contents</h2><div><ul><li><a href="#1">Model Overview</a></li><li><a href="#4">Model Subsystems</a></li><li><a href="#8">Set Model Parameters</a></li></ul></div><h2 id="1">Model Overview</h2><p>The residential heating model comprises a rooftop photovoltaic (PV) panel for charging the thermal battery, a thermal energy storage for storing renewable energy, a hot water tank for storing hot water, a heat exchanger (HEX) for heating the water, a pump for supplying hot water to the house, and an air blower for taking out the stored heat from the thermal battery.</p><p>To increase the efficiency of the system PV panels, the model recovers the heat by circulating the water through the channels below the PV panels. The Control subsystem controls the water pump and air blower pressure to achieve the set temperature of the hot water tank. The subsystem also operates the flow control valve. The flow control valve allows the water to flow towards the PV panels that are hotter than the tank temperature.</p><p><img vspace="5" hspace="5" src="thermalEnergyStorageDesignOverview_01.png" alt=""> </p><h2 id="4">Model Subsystems</h2><p><b>Photovoltaic Panel Subsystem</b></p><p>The Photovoltaic panel subsystem models the solar battery that converts the sunlight into electricity. The subsystem uses a Solar Cell block that allows you to choose a pre-parameterized PV component.</p><p><b>MPPT Converter Subsystem</b></p><p>The PV panel produces a power as a function of the load resistance that connects to the panel. To maximize the power that the PV panels produce when they connect to the heating coil network of a given resistance, you require an MPPT converter. This picture shows equivalent circuit of MPPT.</p><p><img vspace="5" hspace="5" src="MPPTcircuit.png" alt=""> </p><p>The MPPT Converter subsystem receives two inputs:</p><div><ul><li>The net heating coil resistance that connects to the PV panel <img src="ResidentialBuildingTESandPVcell_eq08783089781685090913.png" alt="$R_L$" style="width:17px;height:13px;"></li><li>The Voltage <img src="ResidentialBuildingTESandPVcell_eq10400070808277276123.png" alt="$V_m$" style="width:17px;height:13px;"> at which the PV panel produces the maximum power.</li></ul></div><p>PV panel suppliers provide the value of <img src="ResidentialBuildingTESandPVcell_eq10400070808277276123.png" alt="$V_m$" style="width:17px;height:13px;"> in the product datasheet. To maximize the PV power, the MPPT sets the voltage across the panel to <img src="ResidentialBuildingTESandPVcell_eq10400070808277276123.png" alt="$V_m$" style="width:17px;height:13px;">. If the current from the PV panel is <img src="ResidentialBuildingTESandPVcell_eq04234782492993571773.png" alt="$I_m$" style="width:15px;height:13px;">, then the power that the PV panel produces is equal to <img src="ResidentialBuildingTESandPVcell_eq14958545416380561496.png" alt="$V_m*I_m$" style="width:47px;height:13px;">.</p><p>The heater coil dissipates a power equal to <img src="ResidentialBuildingTESandPVcell_eq14440076464137941470.png" alt="$V_L^2/R_L$" style="width:43px;height:17px;">.</p><p>To calculate the MPPT terminal voltage, the MPPT Converter subsystem equates the two powers and solve for <img src="ResidentialBuildingTESandPVcell_eq13778725294678372914.png" alt="$V_L$" style="width:12px;height:11px;">:</p><p><img src="ResidentialBuildingTESandPVcell_eq05957124644736009177.png" alt="$V_L \ =\ \sqrt{V_m \times I_m \times R_L }$" style="width:147px;height:15px;">.</p><p><b>Residential Unit Subsystem</b></p><p>The Residential Unit subsystem comprises an electrical resistor to model the household power consumption and a thermal network to model the temperature variation of the rooms. Hot water radiators heat the rooms when the outside atmosphere temperature drops below the room set point temperature. The roof of the rooms thermally connects to the PV panel. The floor of the rooms thermally connects to the TES by using a Conductive Heat Transfer block.</p><p><b>Thermal Energy Storage Subsystem</b></p><p>To model the sand battery, the Thermal energy storage subsystem uses a Sand TES custom block. To learn more about the custom block, see <a href="matlab:web('blockDescriptionTES.html')">Sand Battery</a></p><h2 id="8">Set Model Parameters</h2><div><ul><li><a href="matlab:open('ThermalBatterySetParam.m')">Set Thermal Battery Parameters</a></li><li><a href="matlab:open('residentialUnitSetParam.m')">Set Residential Unit Parameters</a></li></ul></div><p class="footer">Copyright 2023 - 2024 The MathWorks, Inc.<br><a href="https://www.mathworks.com/products/matlab/">Published with MATLAB&reg; R2023a</a><br></p></div><!--
 ##### SOURCE BEGIN #####
 %% Residential Building Heating with TES and PV 
-
-
+%
 % Copyright 2023 - 2024 The MathWorks, Inc.
 
 %% Model Overview
@@ -103,7 +102,7 @@
 % This picture shows equivalent circuit of MPPT.
 %
 % 
-% <<MPPTcircuit.PNG>>
+% <<MPPTcircuit.png>>
 %
 %
 % The MPPT Converter subsystem receives two inputs:
@@ -136,14 +135,12 @@
 %
 % To model the sand battery, the Thermal energy storage subsystem uses a
 % Sand TES custom block.
-% To learn more about the custom block, see <blockDescriptionTES.html Sand 
+% To learn more about the custom block, see <matlab:web('blockDescriptionTES.html') Sand 
 % Battery>
 %
-
 %% Set Model Parameters
 % * <matlab:open('ThermalBatterySetParam.m') Set Thermal Battery Parameters>
 % * <matlab:open('residentialUnitSetParam.m') Set Residential Unit Parameters>
- 
-    
+%
 ##### SOURCE END #####
 --></body></html>