Merge pull request #1190 from lbl-srg/issue1189_release_5_1_0

Issue1189 release 5 1 0
lbl-srg · Jun 14, 2018 · daa95e7 · daa95e7
2 parents 204fb8a + 635b2a2
commit daa95e7
Show file tree

Hide file tree

Showing 16 changed files with 70 additions and 83 deletions.
diff --git a/Buildings/Fluid/FixedResistances/Validation/PlugFlowPipes/Data/BaseClasses/PipeDataULg.mo b/Buildings/Fluid/FixedResistances/Validation/PlugFlowPipes/Data/BaseClasses/PipeDataULg.mo
@@ -25,16 +25,16 @@ carried out at the University of Liège.
 <p>
 Before to perform a test, the water city network is pushed inside
 the approximately 39 meter long studied pipe during about 10 minutes
-to be sure that it is at the same temperature. 
+to be sure that it is at the same temperature.
 During this time period, valves V3 and V1 are opened, the boiler is off and
 the valve V2 is closed.
 </p>
 <p>
-Then, the valve V1 is closed and the valve V2 and V3 are opened. 
-The boiler is started to reach the setpoint hot water temperature. 
+Then, the valve V1 is closed and the valve V2 and V3 are opened.
+The boiler is started to reach the setpoint hot water temperature.
 When the temperature setpoint is achieved, data starts to be recorded,
 the valve V1 is opened and the valve V2 is closed at the same time
-to supply the studied pipe in hot water. 
+to supply the studied pipe in hot water.
 After the outlet pipe temperature is stabilized, the boiler is shut off.
 </p>
 <p>
@@ -58,9 +58,9 @@ src=\"modelica://Buildings/Resources/Images/Experimental/ULgTestBench.png\" bord
 to the initial temperature of the water (cooling before test)
 </li>
 <li>Heat transfer coefficient between the pipe and the ambient is assumed
-at 5 W/m<sup>2</sup>K (from internal model) due to insulation.  
+at 5 W/m<sup>2</sup>K (from internal model) due to insulation.
 The pipe is insulated by Tubolit 60/13 (13mm of thickness) whose
-nominal thermal coefficient is inferior 0.04. 
+nominal thermal coefficient is inferior 0.04.
 Notice the insulation is quite aged therefore
 the nominal thermal coefficient could be higher
 </li>

diff --git a/Buildings/Fluid/FixedResistances/Validation/PlugFlowPipes/Data/BaseClasses/package.mo b/Buildings/Fluid/FixedResistances/Validation/PlugFlowPipes/Data/BaseClasses/package.mo
@@ -2,4 +2,11 @@ within Buildings.Fluid.FixedResistances.Validation.PlugFlowPipes.Data;
 package BaseClasses "BaseClasses for data records"
 extends Modelica.Icons.BasesPackage;
 
+annotation (Documentation(info="<html>
+<p>
+This package contains base classes that are used to construct the models in
+<a href=\"modelica://Buildings.Fluid.FixedResistances.Validation.PlugFlowPipes.Data\">
+Buildings.Fluid.FixedResistances.Validation.PlugFlowPipes.Data</a>.
+</p>
+</html>"));
 end BaseClasses;
diff --git a/Buildings/Fluid/FixedResistances/Validation/PlugFlowPipes/Data/PipeDataULg160104_2.mo b/Buildings/Fluid/FixedResistances/Validation/PlugFlowPipes/Data/PipeDataULg160104_2.mo
@@ -1004,7 +1004,6 @@ record PipeDataULg160104_2 "Experimental data from ULg's pipe test bench from 4
         21.2; 10145.1,0.2494,22.2,22.3,21.3,21.2; 10152.7,0.2494,22.1,22.3,21.2,
         21.2; 10161.2,0.2494,22.1,22.3,21.2,21.1; 10169,0.2494,22.1,22.2,21.2,
         21.1; 10176.5,0.2494,22.1,22.2,21.2,21.1]);
-                         // TODO adapt this value
   annotation (Documentation(revisions="<html>
 <ul>
 <li>

diff --git a/Buildings/Fluid/FixedResistances/Validation/PlugFlowPipes/MSLAIT.mo b/Buildings/Fluid/FixedResistances/Validation/PlugFlowPipes/MSLAIT.mo
@@ -438,9 +438,10 @@ equation
             220,200}})),
     experiment(
       StopTime=603900,
-      Tolerance=1e-006,
-      __Dymola_Algorithm="Dassl"),
-    __Dymola_experimentSetupOutput(events=false),
+      Tolerance=1e-006),
+       __Dymola_Commands(file=
+          "Resources/Scripts/Dymola/Fluid/FixedResistances/Validation/PlugFlowPipes/MSLAIT.mos"
+        "Simulate and plot"),
     Documentation(info="<html>
 <p>
 The example contains
@@ -514,8 +515,5 @@ influence of allowFlowReversal and the presence of explicit volumes in the pipe.
 </li>
 <li>January 26, 2016 by Carles Ribas:<br/>First implementation. </li>
 </ul>
-</html>"),
-    __Dymola_Commands(file=
-          "Resources/Scripts/Dymola/Fluid/FixedResistances/Validation/PlugFlowPipes/MSLAIT.mos"
-        "Simulate and plot"));
+</html>"));
 end MSLAIT;
diff --git a/Buildings/Fluid/FixedResistances/Validation/PlugFlowPipes/MSLAIT2Nodes.mo b/Buildings/Fluid/FixedResistances/Validation/PlugFlowPipes/MSLAIT2Nodes.mo
@@ -431,9 +431,10 @@ equation
   annotation (
     Diagram(coordinateSystem(preserveAspectRatio=false, extent={{-160,-160},{
             220,200}})),
-    experiment(StopTime=603900, Tolerance=1e-006,
-    __Dymola_Algorithm="Dassl"),
-    __Dymola_experimentSetupOutput(events=false),
+    experiment(StopTime=603900, Tolerance=1e-006),
+    __Dymola_Commands(file=
+          "Resources/Scripts/Dymola/Fluid/FixedResistances/Validation/PlugFlowPipes/MSLAIT2Nodes.mos"
+        "Simulate and plot"),
     Documentation(info="<html>
 <p>The example contains
 <a href=\"modelica://Buildings.Fluid.FixedResistances.Validation.PlugFlowPipes.Data.PipeDataAIT151218\">
@@ -504,8 +505,5 @@ influence of allowFlowReversal and the presence of explicit volumes in the pipe.
 </li>
 <li>January 26, 2016 by Carles Ribas:<br/>First implementation. </li>
 </ul>
-</html>"),
-    __Dymola_Commands(file=
-          "Resources/Scripts/Dymola/Fluid/FixedResistances/Validation/PlugFlowPipes/MSLAIT2Nodes.mos"
-        "Simulate and plot"));
+</html>"));
 end MSLAIT2Nodes;
diff --git a/Buildings/Fluid/FixedResistances/Validation/PlugFlowPipes/PlugFlowAIT.mo b/Buildings/Fluid/FixedResistances/Validation/PlugFlowPipes/PlugFlowAIT.mo
@@ -348,8 +348,11 @@ equation
     experiment(
       StopTime=603900,
       Interval=900,
-      Tolerance=1e-006,
-      __Dymola_Algorithm="Dassl"),
+      Tolerance=1e-006),
+    __Dymola_Commands(file=
+          "Resources/Scripts/Dymola/Fluid/FixedResistances/Validation/PlugFlowPipes/PlugFlowAIT.mos"
+        "Simulate and plot"),
+    Diagram(coordinateSystem(extent={{-120,-160},{160,160}})),
     Documentation(info="<html>
 <p>
 The example contains
@@ -408,9 +411,5 @@ influence of allowFlowReversal and the presence of explicit volumes in the pipe.
 </li>
 <li>January 26, 2016 by Carles Ribas:<br/>First implementation. </li>
 </ul>
-</html>"),
-    __Dymola_Commands(file=
-          "Resources/Scripts/Dymola/Fluid/FixedResistances/Validation/PlugFlowPipes/PlugFlowAIT.mos"
-        "Simulate and plot"),
-    Diagram(coordinateSystem(extent={{-120,-160},{160,160}})));
+</html>"));
 end PlugFlowAIT;
diff --git a/Buildings/Fluid/MassExchangers/Validation/package.mo b/Buildings/Fluid/MassExchangers/Validation/package.mo
@@ -2,4 +2,19 @@ within Buildings.Fluid.MassExchangers;
 package Validation "Validation examples"
   extends Modelica.Icons.ExamplesPackage;
 
+annotation (Documentation(info="<html>
+<p>
+This package contains validation models for the classes in
+<a href=\"modelica://Buildings.Fluid.MassExchangers\">
+Buildings.Fluid.MassExchangers</a>.
+</p>
+<p>
+Note that most validation models contain simple input data
+which may not be realistic, but for which the correct
+output can be obtained through an analytic solution.
+The examples plot various outputs, which have been verified against these
+solutions. These model outputs are stored as reference data and
+used for continuous validation whenever models in the library change.
+</p>
+</html>"));
 end Validation;
diff --git a/Buildings/Fluid/MassExchangers/package.mo b/Buildings/Fluid/MassExchangers/package.mo
@@ -3,9 +3,11 @@ package MassExchangers "Package with mass exchanger models"
   extends Modelica.Icons.VariantsPackage;
 
 annotation (preferredView="info", Documentation(info="<html>
+<p>
 This package contains models for mass exchangers.
 For heat exchanger models without humidity transfer, see the package
 <a href=\"modelica://Buildings.Fluid.HeatExchangers\">
 Buildings.Fluid.HeatExchangers</a>.
+</p>
 </html>"));
 end MassExchangers;
diff --git a/Buildings/Fluid/MixingVolumes/Validation/CoupledVolumesWater.mo b/Buildings/Fluid/MixingVolumes/Validation/CoupledVolumesWater.mo
@@ -1,7 +1,6 @@
 within Buildings.Fluid.MixingVolumes.Validation;
 model CoupledVolumesWater
   "Validation model for two coupled volumes with water"
-  import Buildings;
   extends Modelica.Icons.Example;
 
   replaceable package Medium = Buildings.Media.Water

diff --git a/Buildings/Fluid/Storage/Examples/StratifiedUnloadAtMinimumTemperature.mo b/Buildings/Fluid/Storage/Examples/StratifiedUnloadAtMinimumTemperature.mo
@@ -175,8 +175,7 @@ equation
         "Simulate and plot"),
     experiment(
       StopTime=21600,
-      Tolerance=1e-06,
-      __Dymola_Algorithm="Cvode"),
+      Tolerance=1e-06),
     Documentation(info="<html>
 <p>
 Example for tank model that has three outlets, each with a valve.

diff --git a/...dings/Resources/Documentation/userGuide/build/html/_sources/development.rst.txt b/...dings/Resources/Documentation/userGuide/build/html/_sources/development.rst.txt
@@ -42,7 +42,7 @@ Alternatively, simple models such as the models below may be used as a starting
 `Buildings.Fluid.HeatExchangers.HeaterCooler_u <http://simulationresearch.lbl.gov/modelica/releases/latest/help/Buildings_Fluid_HeatExchangers.html#Buildings.Fluid.HeatExchangers.HeaterCooler_u>`_
   For a device that adds heat to a fluid stream.
 
-`Buildings.Fluid.MassExchangers.Humidifier_u <http://simulationresearch.lbl.gov/modelica/releases/latest/help/Buildings_Fluid_MassExchangers.html#Buildings.Fluid.MassExchangers.Humidifier_u>`_
+`Buildings.Fluid.Humidifiers.Humidifier_u <http://simulationresearch.lbl.gov/modelica/releases/latest/help/Buildings_Fluid_Humidifiers.html#Buildings.Fluid.Humidifiers.Humidifier_u>`_
   For a device that adds humidity to a fluid stream.
 
 `Buildings.Fluid.Chillers.Carnot_y <http://simulationresearch.lbl.gov/modelica/releases/latest/help/Buildings_Fluid_Chillers.html#Buildings.Fluid.Chillers.Carnot_y>`_

diff --git a/Buildings/Resources/Documentation/userGuide/build/html/development.html b/Buildings/Resources/Documentation/userGuide/build/html/development.html
@@ -224,7 +224,7 @@ <h3>5.2.1. Thermofluid flow device<a class="headerlink" href="#thermofluid-flow-
 <dl class="docutils">
 <dt><a class="reference external" href="http://simulationresearch.lbl.gov/modelica/releases/latest/help/Buildings_Fluid_HeatExchangers.html#Buildings.Fluid.HeatExchangers.HeaterCooler_u">Buildings.Fluid.HeatExchangers.HeaterCooler_u</a></dt>
 <dd>For a device that adds heat to a fluid stream.</dd>
-<dt><a class="reference external" href="http://simulationresearch.lbl.gov/modelica/releases/latest/help/Buildings_Fluid_MassExchangers.html#Buildings.Fluid.MassExchangers.Humidifier_u">Buildings.Fluid.MassExchangers.Humidifier_u</a></dt>
+<dt><a class="reference external" href="http://simulationresearch.lbl.gov/modelica/releases/latest/help/Buildings_Fluid_Humidifiers.html#Buildings.Fluid.Humidifiers.Humidifier_u">Buildings.Fluid.Humidifiers.Humidifier_u</a></dt>
 <dd>For a device that adds humidity to a fluid stream.</dd>
 <dt><a class="reference external" href="http://simulationresearch.lbl.gov/modelica/releases/latest/help/Buildings_Fluid_Chillers.html#Buildings.Fluid.Chillers.Carnot_y">Buildings.Fluid.Chillers.Carnot_y</a></dt>
 <dd>For a device that exchanges heat between two fluid streams.</dd>