open-ideas · annadellisola · Jul 8, 2025 · Dec 23, 2024 · Dec 23, 2024 · Dec 23, 2024
diff --git a/IDEAS/Examples/Tutorial/Example1.mo → .../Tutorial/DetailedHouse/DetailedHouse1.mo b/IDEAS/Examples/Tutorial/Example1.mo → .../Tutorial/DetailedHouse/DetailedHouse1.mo
@@ -1,13 +1,12 @@
-within IDEAS.Examples.Tutorial;
-model Example1 "First example model containing one zone"
+within IDEAS.Examples.Tutorial.DetailedHouse;
+model DetailedHouse1 "First example model containing one zone"
   extends Modelica.Icons.Example;
   package Medium = IDEAS.Media.Air "Air medium";
 
   parameter Modelica.Units.SI.Length l=8 "Zone length";
   parameter Modelica.Units.SI.Length w=4 "Zone width";
   parameter Modelica.Units.SI.Length h=2.7 "Zone height";
 
-
   //SimInfoManager must be 'inner' at the top level
   inner IDEAS.BoundaryConditions.SimInfoManager sim
     annotation (Placement(transformation(extent={{-100,80},{-80,100}})));
@@ -117,8 +116,34 @@ equation
         "Simulate and plot"),
     Documentation(info="<html>
 <p>
-This first example file instantiates a simple building model.
+This first example file instantiates a simple building model that consists of one zone, four walls,
+a window, a floor and a ceiling.  The zone dimensions are 8 m (with walls oriented 
+north and south) by 4 m, and the window measures 3 m by 1.4 m. Use the default 
+zone height of 2.8 m. Apply double glazing and a heavy wall, which provide high thermal mass.
 </p>
+<h4>Required models</h4>
+<ul>
+<li>
+<a href=\"modelica://IDEAS.BoundaryConditions.SimInfoManager\">
+IDEAS.BoundaryConditions.SimInfoManager</a>
+</li>
+<li>
+<a href=\"modelica://IDEAS.Buildings.Components.Zone\">
+ IDEAS.Buildings.Components.Zone</a>
+</li>
+<li>
+<a href=\"modelica://IDEAS.Buildings.Components.OuterWall\">
+IDEAS.Buildings.Components.OuterWall</a>
+</li>
+<li>
+<a href=\"modelica://IDEAS.Buildings.Components.Window\">
+IDEAS.Buildings.Components.Window</a>
+</li>
+<li>
+<a href=\"modelica://IDEAS.Buildings.Components.SlabOnGround\">
+IDEAS.Buildings.Components.SlabOnGround</a>
+</li>
+</ul>
 </html>", revisions="<html>
 <ul>
 <li>
@@ -127,4 +152,4 @@ First implementation for the IDEAS crash course.
 </li>
 </ul>
 </html>"));
-end Example1;
+end DetailedHouse1;
diff --git a/IDEAS/Examples/Tutorial/Example10.mo → ...Tutorial/DetailedHouse/DetailedHouse10.mo b/IDEAS/Examples/Tutorial/Example10.mo → ...Tutorial/DetailedHouse/DetailedHouse10.mo
@@ -1,6 +1,6 @@
-within IDEAS.Examples.Tutorial;
-model Example10 "Speeding up the code"
-  extends Example9(
+within IDEAS.Examples.Tutorial.DetailedHouse;
+model DetailedHouse10 "Speeding up the code"
+  extends DetailedHouse9(
     fanRet(
       energyDynamics=Modelica.Fluid.Types.Dynamics.SteadyState, use_riseTime=
           false),
@@ -84,4 +84,4 @@ Tuning model and solver for computation time
     __Dymola_Commands(file=
           "Resources/Scripts/Dymola/Examples/Tutorial/Example10.mos"
         "Simulate and plot"));
-end Example10;
+end DetailedHouse10;
diff --git a/IDEAS/Examples/Tutorial/Example2.mo → .../Tutorial/DetailedHouse/DetailedHouse2.mo b/IDEAS/Examples/Tutorial/Example2.mo → .../Tutorial/DetailedHouse/DetailedHouse2.mo
@@ -1,6 +1,7 @@
-within IDEAS.Examples.Tutorial;
-model Example2 "Adding closed screens"
-  extends Example1(window(redeclare Buildings.Components.Shading.Screen shaType));
+within IDEAS.Examples.Tutorial.DetailedHouse;
+model DetailedHouse2 "Adding closed screens"
+  extends DetailedHouse1(
+                   window(redeclare Buildings.Components.Shading.Screen shaType));
   Modelica.Blocks.Sources.Constant const(k=1)
     annotation (Placement(transformation(extent={{-100,-60},{-80,-40}})));
 equation
@@ -12,6 +13,17 @@ equation
 This second example file extends the first example and adds a solar shading screen to the window model. 
 Compare the simulation outputs to see the impact on the zone temperature.
 </p>
+<h4>Required models</h4>
+<ul>
+<li>
+<a href=\"modelica://Modelica.Blocks.Sources.Constant\">
+Modelica.Blocks.Sources.Constant</a>
+</li>
+<li>
+<a href=\"modelica://IDEAS.Buildings.Components.Shading.Screen\">
+IDEAS.Buildings.Components.Shading.Screen</a>
+</li>
+</ul>
 </html>", revisions="<html>
 <ul>
 <li>
@@ -29,4 +41,4 @@ First implementation for the IDEAS crash course.
       __Dymola_NumberOfIntervals=5000,
       Tolerance=1e-06,
       __Dymola_Algorithm="Lsodar"));
-end Example2;
+end DetailedHouse2;
diff --git a/IDEAS/Examples/Tutorial/Example3.mo → .../Tutorial/DetailedHouse/DetailedHouse3.mo b/IDEAS/Examples/Tutorial/Example3.mo → .../Tutorial/DetailedHouse/DetailedHouse3.mo
@@ -1,6 +1,7 @@
-within IDEAS.Examples.Tutorial;
-model Example3 "Adding occupant and lighting"
-  extends Example2(zone(
+within IDEAS.Examples.Tutorial.DetailedHouse;
+model DetailedHouse3 "Adding occupant and lighting"
+  extends DetailedHouse2(
+                   zone(
       redeclare replaceable Buildings.Components.Occupants.Fixed occNum(nOccFix=1),
       redeclare Buildings.Components.OccupancyType.OfficeWork occTyp,
       redeclare Buildings.Components.RoomType.Office rooTyp,
@@ -17,7 +18,25 @@ First implementation for the IDEAS crash course.
 </html>", info="<html>
 <p>
 This example extends the second example by adding an occupant and lighting model.
+Based on the selected options, the system automatically calculates zone heat gains, 
+relative humidity, and CO2 concentration. The model implements a continuous occupancy 
+of one person and LED lighting for the zone. The lighting operates when occupants are present.
 </p>
+<h4>Required models</h4>
+<ul>
+<li>
+<a href=\"modelica://IDEAS.Buildings.Components.Occupants.Fixed\">
+IDEAS.Buildings.Components.Occupants.Fixed</a>
+</li>
+<li>
+<a href=\"modelica://IDEAS.Buildings.Components.LightingType.LED\">
+IDEAS.Buildings.Components.LightingType.LED</a>
+</li>
+<li>
+<a href=\"modelica://IDEAS.Buildings.Components.LightingControl.OccupancyBased\">
+IDEAS.Buildings.Components.LightingControl.OccupancyBased</a>
+</li>
+</ul>
 </html>"),
     __Dymola_Commands(file=
           "Resources/Scripts/Dymola/Examples/Tutorial/Example3.mos"
@@ -28,4 +47,4 @@ This example extends the second example by adding an occupant and lighting model
       __Dymola_NumberOfIntervals=5000,
       Tolerance=1e-06,
       __Dymola_Algorithm="Lsodar"));
-end Example3;
+end DetailedHouse3;
diff --git a/IDEAS/Examples/Tutorial/Example4.mo → .../Tutorial/DetailedHouse/DetailedHouse4.mo b/IDEAS/Examples/Tutorial/Example4.mo → .../Tutorial/DetailedHouse/DetailedHouse4.mo
@@ -1,6 +1,7 @@
-within IDEAS.Examples.Tutorial;
-model Example4 "Including custom occupant schedule"
-  extends Example3(zone(redeclare OccSched occNum(k=2)));
+within IDEAS.Examples.Tutorial.DetailedHouse;
+model DetailedHouse4 "Including custom occupant schedule"
+  extends DetailedHouse3(
+                   zone(redeclare OccSched occNum(k=2)));
 
 protected
   model OccSched "Simple occupancy schedule"
@@ -28,8 +29,24 @@ First implementation for the IDEAS crash course.
 </html>", info="<html>
 <p>
 This example extends the third example by adding a
-custom occupancy model that uses an occupancy schedule.
+custom occupancy model that uses an occupancy schedule e that returns an
+occupancy of two during office hours and zero otherwise.
 </p>
+<h4>Required models</h4>
+<ul>
+<li>
+<a href=\"modelica://IDEAS.Buildings.Components.Occupants.BaseClasses.PartialOccupants\">
+IDEAS.Buildings.Components.Occupants.BaseClasses.PartialOccupants</a>
+</li>
+<li>
+<a href=\"modelica://IDEAS.Utilities.Time.CalendarTime\">
+IDEAS.Utilities.Time.CalendarTime</a>
+</li>
+<li>
+<a href=\"modelica://Modelica.Blocks.Sources.RealExpression\">
+Modelica.Blocks.Sources.RealExpression</a>
+</li>
+</ul>
 </html>"),
     __Dymola_Commands(file="Resources/Scripts/Dymola/Examples/Tutorial/Example4.mos"
         "Simulate and plot"),
@@ -39,4 +56,4 @@ custom occupancy model that uses an occupancy schedule.
       __Dymola_NumberOfIntervals=5000,
       Tolerance=1e-06,
       __Dymola_Algorithm="Lsodar"));
-end Example4;
+end DetailedHouse4;
diff --git a/IDEAS/Examples/Tutorial/Example5.mo → .../Tutorial/DetailedHouse/DetailedHouse5.mo b/IDEAS/Examples/Tutorial/Example5.mo → .../Tutorial/DetailedHouse/DetailedHouse5.mo
@@ -1,5 +1,5 @@
-within IDEAS.Examples.Tutorial;
-model Example5 "New model with 2 coupled zones"
+within IDEAS.Examples.Tutorial.DetailedHouse;
+model DetailedHouse5 "New model with 2 coupled zones"
   extends Modelica.Icons.Example;
   replaceable package Medium = IDEAS.Media.Air "Air medium";
 
@@ -78,14 +78,30 @@ First implementation for the IDEAS crash course.
 </html>", info="<html>
 <p>
 This example demonstrates the use of the RectangularZoneTemplate.
-The one-zone implementation with one window of example 1 is repeated here as 
+The one-zone implementation with one window of <a href=\"modelica://IDEAS.Examples.Tutorial.DetailedHouse.DetailedHouse1\">
+IDEAS.Examples.Tutorial.DetailedHouse.DetailedHouse1</a> is repeated here as 
 a two-zone implementation with two windows that are north and south oriented.
 Note the different temperature responses of the zones. 
 </p>
+<h4>Required models</h4>
+<ul>
+<li>
+<a href=\"modelica://IDEAS.BoundaryConditions.SimInfoManager\">
+IDEAS.BoundaryConditions.SimInfoManager</a>
+</li>
+<li>
+<a href=\"modelica://IDEAS.Buildings.Components.RectangularZoneTemplate\">
+IDEAS.Buildings.Components.RectangularZoneTemplate</a>
+</li>
+<li>
+Construction and glazing records from <a href=\"modelica://IDEAS.Examples.Tutorial.DetailedHouse.DetailedHouse1\">
+IDEAS.Examples.Tutorial.DetailedHouse.DetailedHouse1</a>
+</li>
+</ul>
 </html>"), experiment(
       StartTime=10000000,
       StopTime=11000000,
       __Dymola_NumberOfIntervals=5000,
       Tolerance=1e-06,
       __Dymola_Algorithm="Lsodar"));
-end Example5;
+end DetailedHouse5;
diff --git a/IDEAS/Examples/Tutorial/Example6.mo → .../Tutorial/DetailedHouse/DetailedHouse6.mo b/IDEAS/Examples/Tutorial/Example6.mo → .../Tutorial/DetailedHouse/DetailedHouse6.mo
@@ -1,6 +1,7 @@
-within IDEAS.Examples.Tutorial;
-model Example6 "Extension of example 5 that adds a heating system"
-  extends Example5;
+within IDEAS.Examples.Tutorial.DetailedHouse;
+model DetailedHouse6
+  "Extension of example 5 that adds a heating system"
+  extends DetailedHouse5;
   package MediumWater = IDEAS.Media.Water "Water Medium";
 
   Fluid.HeatPumps.ScrollWaterToWater heaPum(
@@ -153,13 +154,13 @@ equation
           -30},{184,-30},{184,0}}, color={0,127,255}));
   connect(rad.port_b, heaPum.port_a1) annotation (Line(points={{50,-20},{50,-30},
           {184,-30},{184,0}}, color={0,127,255}));
-  annotation (Diagram(coordinateSystem(extent={{-100,-100},{300,100}},
+  annotation (Diagram(coordinateSystem(extent={{-100,-100},{100,100}},
           initialScale=0.1), graphics={Text(
           extent={{138,98},{224,90}},
           lineColor={28,108,200},
           textString="This sets the absolute pressure only"), Line(points={{126,
               86},{134,92}}, color={28,108,200})}), Icon(coordinateSystem(
-          extent={{-100,-100},{300,100}}, initialScale=0.1)),
+          extent={{-100,-100},{100,100}}, initialScale=0.1)),
     experiment(
       StartTime=10000000,
       StopTime=11000000,
@@ -173,8 +174,51 @@ September 18, 2019 by Filip Jorissen:<br/>
 First implementation for the IDEAS crash course.
 </li>
 </ul>
+</html>",
+info="<html>
+<p>
+This model extends <a href=\"modelica://IDEAS.Examples.Tutorial.DetailedHouse.DetailedHouse5\">
+IDEAS.Examples.Tutorial.DetailedHouse.DetailedHouse5</a> by adding a HVAC system.
+The system consists of a water-water heat pump, radiators, a storage tank, circulation
+pumps and a low temperature heat source for the heat pump.
+</p>
+<h4>Required models</h4>
+<ul>
+<li>
+<a href=\"modelica://IDEAS.Fluid.HeatPumps.ScrollWaterToWater\">
+IDEAS.Fluid.HeatPumps.ScrollWaterToWater</a>
+</li>
+<li>
+<a href=\"modelica://IDEAS.Fluid.HeatExchangers.Radiators.RadiatorEN442_2\">
+IDEAS.Fluid.HeatExchangers.Radiators.RadiatorEN442_2</a>
+</li>
+<li>
+<a href=\"modelica://IDEAS.Fluid.Actuators.Valves.TwoWayTRV\">
+IDEAS.Fluid.Actuators.Valves.TwoWayTRV</a>
+</li>
+<li>
+<a href=\"modelica://IDEAS.Fluid.Movers.FlowControlled_dp\">
+IDEAS.Fluid.Movers.FlowControlled_dp</a>
+</li>
+<li>
+<a href=\"modelica://IDEAS.Fluid.Sources.Boundary_pT\">
+IDEAS.Fluid.Sources.Boundary_pT</a>
+</li>
+<li>
+<a href=\"modelica://IDEAS.Fluid.Storage.Stratified\">
+IDEAS.Fluid.Storage.Stratified</a>
+</li>
+<li>
+<a href=\"modelica://Modelica.Blocks.Sources.IntegerConstant\">
+Modelica.Blocks.Sources.IntegerConstant</a>
+</li>
+<li>
+<a href=\"modelica://Modelica.Blocks.Continuous.Integrator\">
+Modelica.Blocks.Continuous.Integrator</a>
+</li>
+</ul>
 </html>"),
     __Dymola_Commands(file=
           "Resources/Scripts/Dymola/Examples/Tutorial/Example6.mos"
         "Simulate and plot"));
-end Example6;
+end DetailedHouse6;
diff --git a/IDEAS/Examples/Tutorial/Example7.mo → .../Tutorial/DetailedHouse/DetailedHouse7.mo b/IDEAS/Examples/Tutorial/Example7.mo → .../Tutorial/DetailedHouse/DetailedHouse7.mo
@@ -1,6 +1,7 @@
-within IDEAS.Examples.Tutorial;
-model Example7 "Adding a controller"
-  extends Example6(heaPum(enable_variable_speed=true));
+within IDEAS.Examples.Tutorial.DetailedHouse;
+model DetailedHouse7 "Adding a controller"
+  extends DetailedHouse6(
+                   heaPum(enable_variable_speed=true));
   Modelica.Blocks.Logical.Hysteresis hys(uLow=273.15 + 40, uHigh=273.15 + 45)
     "Hysteresis controller"
     annotation (Placement(transformation(extent={{60,-80},{80,-60}})));
@@ -25,8 +26,24 @@ First implementation for the IDEAS crash course.
 </ul>
 </html>", info="<html>
 <p>
-The simple controller has a large impact on the heat pump COP.
+This step adds a controller that disables the heat pump when the supply water
+temperature exceeds 45◦C. The simple controller has a large impact on the heat pump COP.
 </p>
+<h4>Required models</h4>
+<ul>
+<li>
+<a href=\"modelica://IDEAS.Fluid.Sensors.TemperatureTwoPort\">
+IDEAS.Fluid.Sensors.TemperatureTwoPort</a>
+</li>
+<li>
+<a href=\"modelica://Modelica.Blocks.Logical.Hysteresis\">
+Modelica.Blocks.Logical.Hysteresis</a>
+</li>
+<li>
+<a href=\"modelica://Modelica.Blocks.Math.BooleanToReal\">
+Modelica.Blocks.Math.BooleanToReal</a>
+</li>
+</ul>
 </html>"),
     __Dymola_Commands(file=
           "Resources/Scripts/Dymola/Examples/Tutorial/Example7.mos"
@@ -38,4 +55,4 @@ The simple controller has a large impact on the heat pump COP.
       Tolerance=1e-06,
       __Dymola_fixedstepsize=20,
       __Dymola_Algorithm="Lsodar"));
-end Example7;
+end DetailedHouse7;
diff --git a/IDEAS/Examples/Tutorial/Example8.mo → .../Tutorial/DetailedHouse/DetailedHouse8.mo b/IDEAS/Examples/Tutorial/Example8.mo → .../Tutorial/DetailedHouse/DetailedHouse8.mo
@@ -1,6 +1,6 @@
-within IDEAS.Examples.Tutorial;
-model Example8 "JSOn writer"
-  extends Example7;
+within IDEAS.Examples.Tutorial.DetailedHouse;
+model DetailedHouse8 "JSOn writer"
+  extends DetailedHouse7;
   Utilities.IO.Files.JSONWriter jsonWri(
     nin=1,
     fileName="EEl.json",
@@ -21,11 +21,18 @@ First implementation for the IDEAS crash course.
 <p>
 This model outputs the main model result to a json file.
 </p>
+<h4>Required models</h4>
+<ul>
+<li>
+<a href=\"modelica://IDEAS.Utilities.IO.Files.JSONWriter\">
+IDEAS.Utilities.IO.Files.JSONWriter</a>
+</li>
+</ul>
 </html>"), experiment(
       StartTime=10000000,
       StopTime=11000000,
       __Dymola_NumberOfIntervals=5000,
       Tolerance=1e-06,
       __Dymola_fixedstepsize=20,
       __Dymola_Algorithm="Lsodar"));
-end Example8;
+end DetailedHouse8;