New Workflow

Author: vikrants

.github/workflows/ci.yml

@@ -38,18 +38,24 @@ on:
 jobs:
 
   job-check-project:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     steps:
 
       - name: Check out repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup MATLAB
-        uses: matlab-actions/setup-matlab@v1
+        uses: matlab-actions/setup-matlab@v2
         with:
           release: R2024a
+          cache: true
+          products: | 
+            Simscape_Fluids
+            Simulink
+            Simscape
+            MATLAB_Test
 
       - name: Run tests
-        uses: matlab-actions/run-command@v1
+        uses: matlab-actions/run-command@v2
         with:
           command: openProject(pwd); BuildingEnergyManagementTestRunner;

Components/Ambient/EnvModel.png

@@ -23,6 +23,7 @@ component (Propagation = blocks) BuildingHVACOperation
     end
 
     parameters
+        roomModelOption = roomPhysicsOptions.basicroom; % Select room modelling option
         heatPerOccupant = {5, 'W'}; % Heat per occupant
         opsParamBldg = zeros(400,7);% Building operational parameter matrix
         % Row size 400 represents: 
@@ -49,14 +50,14 @@ component (Propagation = blocks) BuildingHVACOperation
         Qr = {zeros(nApts,nRooms), 'W'}; % S
     end
 
-    for i = 1:nApts
-        for j = 1:nRooms
-            connections
-                connect(HPA,BldgA(i,j));
-                connect(HPB,BldgB(i,j));
-            end
-        end
-    end
+    % for i = 1:nApts
+    %     for j = 1:nRooms
+    %         connections
+    %             connect(HPA,BldgA(i,j));
+    %             connect(HPB,BldgB(i,j));
+    %         end
+    %     end
+    % end
 
     annotations
         HPA   : Side=Left;
@@ -65,7 +66,7 @@ component (Propagation = blocks) BuildingHVACOperation
         Qr    : Side=Top;
         BldgA : Side=Right;
         BldgB : Side=Right;
-        UILayout = [UIGroup("Operational Data",opsParamBldg) ... 
+        UILayout = [UIGroup("Operational Data",roomModelOption,opsParamBldg) ... 
                     UIGroup("Other Variables",heatPerOccupant)];
     end
 
@@ -92,4 +93,35 @@ component (Propagation = blocks) BuildingHVACOperation
         end
     end
 
+    if roomModelOption == roomPhysicsOptions.basicroom || roomModelOption == roomPhysicsOptions.requirements
+        for i = 1:nApts
+            for j = 1:nRooms
+                % Closing TL domain nodes as they are not needed; put dummy param. values
+                equations
+                    BldgA(i,j).T == {300, 'K'};
+                    BldgA(i,j).p == {0.1, 'MPa'};
+                    BldgB(i,j).T == {300, 'K'};
+                    BldgB(i,j).p == {0.1, 'MPa'};
+                end
+            end
+        end
+        equations
+            HPA.T == {300, 'K'};
+            HPA.p == {0.1, 'MPa'};
+            HPB.T == {300, 'K'};
+            HPB.p == {0.1, 'MPa'};
+        end
+        annotations
+            [HPA,HPB,BldgA,BldgB]: ExternalAccess=none;
+        end
+    else
+        for i = 1:nApts
+            for j = 1:nRooms
+                connections
+                    connect(HPA,BldgA(i,j));
+                    connect(HPB,BldgB(i,j));
+                end
+            end
+        end 
+    end
 end

Components/Building/BuildingModel.png

@@ -5,7 +5,7 @@
 % for building energy managmement systems, BEMS.
 %
 
-% Copyright 2024 The MathWorks, Inc.
+% Copyright 2024 - 2025 The MathWorks, Inc.
 
 %%
 % Building energy management is an important step when addressing energy 
@@ -21,50 +21,53 @@
 % based workflows are used to parameterize Simscape Custom components for 
 % building energy simulations.
 %
-%% Create Building Model with Solar Loads
+%% Create Building Models Quickly and Analyze Solar Loading
 % 
-% * To learn how to create buildings quickly and define solar loading on
+% To learn how to create buildings quickly and define solar loading on
 % them, see <matlab:open('CreateBuildingModelWithSolarLoad.mlx') Create 
-% Building Model with Solar Loads>. 
+% Building Model with Solar Loads>. In this workflow, you will learn how to 
+% define rooms, create apartments, and construct a 3D building. At the end 
+% of the workflow, you will be able to save your building definition in a 
+% XML part and use it later or share with others.
 % 
-% In this workflow, you will learn how to define rooms, create apartments, 
-% and construct a 3D building. At the end of the workflow, you will be able 
-% to save your building definition in a XML part and use it later or share 
-% with others.
+%
+% <<../Images/createBuildingREADME.gif>>
+% 
+%
+%% Analyze Building HVAC Requirements Across Different Seasons, Geography
 % 
-%% Run Building Model for HVAC Requirement Analysis
+% There are two workflows in this section that leverage the same model
+% SLX file, |BuildingModelWithSolarLoad|. This model uses two different 
+% custom Simscape blocks - the *Building* and the *Ambient* block to
+% simulate energy requirements or building heat load.
 % 
-% * To learn how to evaluate HVAC requirements for a building, see 
-% <matlab:open('BuildingManagementSystemRequirementAnalysis.mlx') Simulate 
-% Building Model for HVAC Requirement Analysis> to open and run the live 
-% script. 
+% * In the first workflow, <matlab:open('BuildingManagementSystemRequirementAnalysis.mlx') 
+% Simulate Building Model for HVAC Requirement Analysis>, you will learn how to 
+% evaluate the building system for HVAC requirements over a period of one
+% week.
+% * In the second workflow, <matlab:open('BuildingHeatLoadEstimation.mlx') 
+% Building Heat Load Estimation>, you will learn how to compare a house
+% heat loading and HVAC requriements in several different cities, over a
+% period of one year.
 % 
-% The live script opens the Simscape Model which you can run and analyze 
-% the results. To enable the post-processing functions to work in the live 
-% script, you must run the model programatically, as shown in code example. 
-% This model uses two different custom Simscape blocks - the *Building* and 
-% the *Ambient* block. To learn more about each custom block, open the block 
-% mask and see the documentation link.
 % 
-%% Setup Building Model for BEMS Design
+% <<../Images/houseHeatLoadREADME.gif>>
 % 
-% * To learn how to evaluate actual energy consumption and design
+% 
+%% Model Heat Pump, Detailed HVAC, and Building Energy Management System
+% 
+% To learn how to evaluate actual energy consumption and design
 % controllers, see <matlab:open('SimulateBuildingEnergyManagement.mlx') 
 % Simulate Building Model for BEMS Design>. This will open a live script 
-% which sets up the model, parameterizes it, and opens the model to run.
-% 
+% which sets up the model, parameterizes it, and opens the model to run. 
 % This is a detailed model that uses four different custom Simscape blocks -
 % the *Building* , the *Heat Pump* , the *Ambient* , and the *Operational 
 % Data* blocks. To learn more about each custom block, open the block mask and 
-% see the documentation link.
-% 
-% In this example, you will also learn how to use a air-water heat pump 
-% (AWHP) to maintain a desired set-point temperature within the building 
-% rooms. You will be able to specify different conditions for different 
-% rooms by using a physics table data. You will learn how to specify 
-% different heating or cooling options within a room: radiator, under-floor 
-% piping, or both. 
-
+% see the documentation link. You will also learn how to specify and
+% evaluate different heating and/or cooling options for a building room: 
+% radiator, under-floor piping, or both. 
+%
+%
 %% Appendix A: Custom Component Documentation
 % To learn more about the different custom components used in the simulation: 
 % 
@@ -80,6 +83,30 @@
 % Operational Data Documentation> to learn more about the block.
 %
 %% Appendix B: Overall Workflow Pictorial
+% There are 2 SLX models that are used in different analysis. Both these models 
+% use one or more of the above specified custom components. The two SLX
+% models are:
+%
+% * |BuildingModelWithSolarLoad.slx| - used for HVAC requirement analysis.
+% * |BuildingModelWithSolarLoadAndHVAC.slx| - used for BEMS analysis.
+%
+% The picture below shows the composition of these two models. The first
+% SLX model, |BuildingModelWithSolarLoad|, makes use of two custom
+% component - |Building| and |Ambient|. The second SLX model,
+% |BuildingModelWithSolarLoadAndHVAC|, makes use of all four custom
+% components - |Building|, |Ambient|, |Operational Data|, and |Heat Pump|.
+% The room model options vary between the rooms defined in |Building| block
+% for |BuildingModelWithSolarLoad.slx| and
+% |BuildingModelWithSolarLoadAndHVAC.slx|. In the
+% |BuildingModelWithSolarLoad| SLX model, the |Building| has rooms defined
+% as thermal mass and connected to the |Wall| (wall, roof, floor) custom
+% components. In the |BuildingModelWithSolarLoadAndHVAC| SLX model, the
+% |Building| has rooms defined as thermal mass and connected to |Wall| 
+% (wall, roof, floor) and HVAC components like |Radiator| and 
+% |Underfloor Piping|. The room fidelity is controlled through a drop-down
+% list within the |Building| block mask.
+% 
+% <<../Images/overallProjectSummary.png>>
 % 
 % <<../Images/overallSummaryBuildingSim.png>>
 % 

Components/Building/BuildingTestHarness.slx

@@ -20,6 +20,15 @@
 %
 %% Operational Data
 %
+% * *Select room modelling option*, |roomModelOption|, is a drop down list
+% that enables you to switch between different room modelling and analysis 
+% options. You can chose from 5 different options: |Thermal Load|, |Thermal 
+% Requirements|, |HVAC: Room Radiator Only|, |HVAC: Room Underfloor 
+% Heating/Cooling Only|, and |HVAC: Room Radiator with Underfloor 
+% Heating/Cooling|. This must be of same value as set in the Building custom 
+% component. To learn more about the room modelling options, see 
+% <matlab:open('DocumentationRoomModellingOptions.html') Room Modelling 
+% Options in Building Custom Component>.
 % * *Building Operational Parameter Matrix*, |opsParamBldg|, specified as
 % a matrix, defines the different operational parameter states in the 
 % building. The matix has 7 columns and rows equal to total number of hours