Finish adding links and documentations.

terrancelu92 · Aug 18, 2023 · 74049d8 · 74049d8
1 parent 63826f3
commit 74049d8
Show file tree

Hide file tree

Showing 8 changed files with 159 additions and 122 deletions.
diff --git a/...ffice_complex_air/models/MultizoneOfficeComplexAir/BaseClasses/BuildingControlEmulator.mo b/...ffice_complex_air/models/MultizoneOfficeComplexAir/BaseClasses/BuildingControlEmulator.mo
diff --git a/...ultizone_office_complex_air/models/MultizoneOfficeComplexAir/BaseClasses/HVACSide/HVAC.mo b/...ultizone_office_complex_air/models/MultizoneOfficeComplexAir/BaseClasses/HVACSide/HVAC.mo
@@ -162,8 +162,8 @@ equation
       color={0,127,225},
       thickness=1));
   connect(floor1.port_a_CooWat, chiWatNet.ports_b[1]) annotation (Line(
-      points={{134.313,20},{134.313,0},{112,0},{112,-102},{72,-102},{72,
-          -101.933},{40,-101.933}},
+      points={{134.313,20},{134.313,0},{112,0},{112,-102},{72,-102},{72,-101.933},
+          {40,-101.933}},
       color={0,127,225},
       thickness=1));
 
@@ -194,15 +194,14 @@ equation
       points={{20,-104},{16,-104},{16,-106},{10,-106}},
       color={0,127,255},
       thickness=1));
-  connect(chiWatNet.p, chiWatPla.dP) annotation (Line(points={{41,-100},{54,
-          -100},{54,-120},{-16,-120},{-16,-94},{-11.6,-94}},
+  connect(chiWatNet.p, chiWatPla.dP) annotation (Line(points={{41,-100},{54,-100},
+          {54,-120},{-16,-120},{-16,-94},{-11.6,-94}},
                                                     color={0,0,127}));
   connect(chiWatPla.TCWSet, TCWSupSet.y) annotation (Line(points={{-11.6,-106},
           {-20,-106},{-20,-50},{-59,-50}},
                                       color={0,0,127}));
-  connect(chiWatPla.TWetBul, TWetBul) annotation (Line(points={{-11.6,-110},{
-          -92,-110},{-92,-68},{-114,-68}},
-                                       color={0,0,127}));
+  connect(chiWatPla.TWetBul, TWetBul) annotation (Line(points={{-11.6,-110},{-92,
+          -110},{-92,-68},{-114,-68}}, color={0,0,127}));
   connect(boiWatPla.port_a, boiWatNet.port_b) annotation (Line(
       points={{140,-96},{140,-96},{156,-96}},
       color={238,46,47},

diff --git a/...izone_office_complex_air/models/MultizoneOfficeComplexAir/BaseClasses/HVACSide/package.mo b/...izone_office_complex_air/models/MultizoneOfficeComplexAir/BaseClasses/HVACSide/package.mo
@@ -1,4 +1,7 @@
 within MultizoneOfficeComplexAir.BaseClasses;
-package HVACSide
+package HVACSide "Package with base classes for the HVAC side"
 
+annotation (Documentation(info="<html>
+<p>This package contains base classes that are used to construct the HVAC side models. </p>
+</html>"));
 end HVACSide;
diff --git a/...e_office_complex_air/models/MultizoneOfficeComplexAir/BaseClasses/LoadSide/LoadWrapper.mo b/...e_office_complex_air/models/MultizoneOfficeComplexAir/BaseClasses/LoadSide/LoadWrapper.mo
@@ -1,5 +1,5 @@
 within MultizoneOfficeComplexAir.BaseClasses.LoadSide;
-model LoadWrapper
+model LoadWrapper "Load calculation in EnergyPlus using Spawn"
   MultizoneOfficeComplexAir.BaseClasses.LoadSide.BaseClasses.WholeBuildingEnergyPlus
     whoBui annotation (Placement(transformation(extent={{-60,-10},{-40,10}})));
   Modelica.Blocks.Interfaces.RealInput Tem[15] "temperature vector"

diff --git a/...izone_office_complex_air/models/MultizoneOfficeComplexAir/BaseClasses/LoadSide/package.mo b/...izone_office_complex_air/models/MultizoneOfficeComplexAir/BaseClasses/LoadSide/package.mo
@@ -1,4 +1,7 @@
 within MultizoneOfficeComplexAir.BaseClasses;
-package LoadSide
+package LoadSide "Package with base classes for the loadside"
 
+annotation (Documentation(info="<html>
+<p>This package contains base classes that are used to construct the loadside models. </p>
+</html>"));
 end LoadSide;
diff --git a/..._office_complex_air/models/MultizoneOfficeComplexAir/BaseClasses/ReadOverwrite/package.mo b/..._office_complex_air/models/MultizoneOfficeComplexAir/BaseClasses/ReadOverwrite/package.mo
@@ -1,4 +1,7 @@
 within MultizoneOfficeComplexAir.BaseClasses;
 package ReadOverwrite "Contains overwrite base classes for the test case"
 
+annotation (Documentation(info="<html>
+<p>This package contains overwrite base classes for the test case.</p>
+</html>"));
 end ReadOverwrite;
diff --git a/...ases/multizone_office_complex_air/models/MultizoneOfficeComplexAir/BaseClasses/package.mo b/...ases/multizone_office_complex_air/models/MultizoneOfficeComplexAir/BaseClasses/package.mo
@@ -1,4 +1,8 @@
 within MultizoneOfficeComplexAir;
-package BaseClasses "Contains base classes for the test case"
+package BaseClasses "Package with base classes for the testcase"
     extends Modelica.Icons.BasesPackage;
+
+annotation (Documentation(info="<html>
+<p>This package contains base classes that are used to construct the models in the testcase. </p>
+</html>"));
 end BaseClasses;
diff --git a/testcases/multizone_office_complex_air/models/MultizoneOfficeComplexAir/TestCases/package.mo b/testcases/multizone_office_complex_air/models/MultizoneOfficeComplexAir/TestCases/package.mo
@@ -1,4 +1,8 @@
 within MultizoneOfficeComplexAir;
 package TestCases "Contains models for test cases"
 extends Modelica.Icons.ExamplesPackage;
+
+annotation (Documentation(info="<html>
+<p>This package contains models of the testcase. </p>
+</html>"));
 end TestCases;