/
package.mo
4584 lines (4413 loc) · 207 KB
/
package.mo
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
within ;
package Buildings "Library with models for building energy and control systems"
extends Modelica.Icons.Package;
package UsersGuide "User's Guide"
extends Modelica.Icons.Information;
class Conventions "Conventions"
extends Modelica.Icons.Information;
annotation (preferredView="info",
Documentation(info="<html>
<p>
This library follows the conventions of the
<a href=\"modelica://Modelica.UsersGuide.Conventions\">
Modelica Standard Library</a>, which are as follows:
</p>
<p>
Note, in the html documentation of any Modelica library,
the headings \"h1, h2, h3\" should not be used,
because they are utilized from the automatically generated
documentation and headings.
Additional headings in the html documentation should start with \"h4\".
</p>
<p>
In the Modelica package the following conventions are used:
</p>
<ol>
<li> Class and instance names are written in upper and lower case
letters, e.g., \"ElectricCurrent\". An underscore is only used
at the end of a name to characterize a lower or upper index,
e.g., \"pin_a\".</li>
<li> <b>Class names</b> start always with an upper case letter.</li>
<li> <b>Instance names</b>, i.e., names of component instances and
of variables (with the exception of constants),
start usually with a lower case letter with only
a few exceptions if this is common sense
(such as \"T\" for a temperature variable).</li>
<li> <b>Constant names</b>, i.e., names of variables declared with the
\"constant\" prefix, follow the usual naming conventions
(= upper and lower case letters) and start usually with an
upper case letter, e.g. UniformGravity, SteadyState.</li>
<li> The two connectors of a domain that have identical declarations
and different icons are usually distinguished by \"_a\", \"_b\"
or \"_p\", \"_n\", e.g., Flange_a/Flange_b, HeatPort_a, HeatPort_b.</li>
<li> The <b>instance name</b> of a component is always displayed in its icon
(= text string \"%name\") in <b>blue color</b>. A connector class has the instance
name definition in the diagram layer and not in the icon layer.
<b>Parameter</b> values, e.g., resistance, mass, gear ratio, are displayed
in the icon in <b>black color</b> in a smaller font size as the instance name.
</li>
<li> A main package has usually the following subpackages:
<ul>
<li><b>UsersGuide</b> containing an overall description of the library
and how to use it.</li>
<li><b>Examples</b> containing models demonstrating the
usage of the library.</li>
<li><b>Interfaces</b> containing connectors and partial
models.</li>
<li><b>Types</b> containing type, enumeration and choice
definitions.</li>
</ul>
</li>
</ol>
<p>
The <code>Buildings</code> library uses the following conventions
in addition to the ones of the Modelica Standard Library:
</p>
<ol>
<li>
The nomenclature used in the package
<a href=\"modelica://Buildings.Utilities.Psychrometrics\">
Buildings.Utilities.Psychrometrics</a>
is as follows,
<ul>
<li>
Uppercase <code>X</code> denotes mass fraction per total mass.
</li>
<li>
Lowercase <code>x</code> denotes mass fraction per mass of dry air.
</li>
<li>
The notation <code>z_xy</code> denotes that the function or block has output
<code>z</code> and inputs <code>x</code> and <code>y</code>.
</li>
<li>
The symbol <code>pW</code> denotes water vapor pressure, <code>TDewPoi</code>
denotes dew point temperature, <code>TWetBul</code> denotes wet bulb temperature,
and <code>TDryBul</code> (or simply <code>T</code>) denotes dry bulb temperature.
</li>
</ul>
<li>
Names of models, blocks and packages should start with an upper-case letter and be a
noun or a noun with a combination of adjectives and nouns.
Use camel-case notation to combine multiple words, such as <code>HeatTransfer</code>.
</li>
<li>
Parameter and variables names are usually a character, such as <code>T</code>
for temperature and <code>p</code> for pressure, or a combination of the first three
characters of a word, such as <code>higPreSetPoi</code> for high pressure set point.
</li>
<li>
Comments should be added to each class (package, model, function etc.).
The first character should be upper case.
For one-line comments of parameters, variables and classes, no period should be used at the end of the comment.
</li>
<li>
Where applicable, all variable must have units, also if the variable is protected.
</li>
<li>
To indicate that a class (i.e., a package, model, block etc.) has not been extensively tested or validated,
its class name ends with the string <code>Beta</code>.
</li>
</ol>
</html>
"));
end Conventions;
package ReleaseNotes "Release notes"
extends Modelica.Icons.ReleaseNotes;
class Version_1_7_build1 "Version 1.7 build 1"
extends Modelica.Icons.ReleaseNotes;
annotation (Documentation(info="<html>
<p>
Version 1.7 build 1 is ... xxx
</p>
<!-- New libraries -->
<p>
The following <b style=\"color:blue\">new libraries</b> have been added:
</p>
<table class=\"releaseTable\" summary=\"summary\" border=\"1\" cellspacing=0 cellpadding=2>
<tr><td valign=\"top\">xxx
</td>
<td valign=\"top\">xxx.
</td>
</tr>
</table>
<!-- New components for existing libraries -->
<p>
The following <b style=\"color:blue\">new components</b> have been added
to <b style=\"color:blue\">existing</b> libraries:
</p>
<table class=\"releaseTable\" summary=\"summary\" border=\"1\" cellspacing=0 cellpadding=2 style=\"border-collapse:collapse;\">
<tr><td colspan=\"2\"><b>xxx</b>
</td>
</tr>
<tr><td valign=\"top\">xxx
</td>
<td valign=\"top\">xxx.
</td>
</tr>
</table>
<!-- Backward compatible changes -->
<p>
The following <b style=\"color:blue\">existing components</b>
have been <b style=\"color:blue\">improved</b> in a
<b style=\"color:blue\">backward compatible</b> way:
</p>
<table class=\"releaseTable\" summary=\"summary\" border=\"1\" cellspacing=0 cellpadding=2 style=\"border-collapse:collapse;\">
<tr><td colspan=\"2\"><b>Buildings.BoundaryConditions</b>
</td>
</tr>
<tr><td valign=\"top\">Buildings.BoundaryConditions.WeatherData.ReaderTMY3
</td>
<td valign=\"top\">Removed redundant connection
<code>connect(conHorRad.HOut, cheHorRad.HIn);</code>.
</td>
</tr>
<tr><td colspan=\"2\"><b>Buildings.Fluid</b>
</td>
</tr>
<tr><td valign=\"top\">Buildings.Fluid.HeatExchangers.DryCoilCounterFlow
</td>
<td valign=\"top\">Changed assignment of <code>T_m</code> to avoid using the conditionally
enabled model <code>ele[:].mas.T</code>, which is only
valid in a connect statement.
Moved assignments of
<code>Q1_flow</code>, <code>Q2_flow</code>, <code>T1</code>,
<code>T2</code> and <code>T_m</code> outside of equation section
to avoid mixing graphical and textual modeling within the same model.
</td>
</tr>
<tr><td valign=\"top\">Buildings.Fluid.HeatExchangers.DryCoilDiscretized
</td>
<td valign=\"top\">Removed parameter <code>m1_flow_nominal</code>, as this parameter is already
declared in its base class
<a href=\"modelica://Buildings.Fluid.Interfaces.PartialFourPortInterface\">
Buildings.Fluid.Interfaces.PartialFourPortInterface</a>.
This change avoids an error in OpenModelica as the two declarations
had a different value for the <code>min</code> attribute, which is not valid
in Modelica.
</td>
</tr>
<tr>
<td valign=\"top\">Buildings.Fluid.HeatExchangers.BaseClasses.CoilRegister<br/>
Buildings.Fluid.HeatExchangers.BaseClasses.DuctManifoldDistributor
</td>
<td valign=\"top\">Reformulated the multiple iterators in the <code>sum</code> function
as this language construct is not supported in OpenModelica.
</td>
</tr>
<tr>
<td valign=\"top\">Buildings.Fluid.HeatExchangers.RadiantSlabs.SingleCircuitSlab
</td>
<td valign=\"top\">Set start value for <code>hPip(fluid(T))</code> to avoid
a warning about conflicting start values.
</td>
</tr>
<tr>
<td valign=\"top\">Buildings.Fluid.SolarCollectors.ASHRAE93<br/>
Buildings.Fluid.SolarCollectors.EN12975
</td>
<td valign=\"top\">Reformulated the model to avoid an translation error
if glycol is used..
</td>
</tr>
<tr>
<td valign=\"top\">Buildings.Fluid.Storage.StratifiedEnhancedInternalHex
</td>
<td valign=\"top\">Replaced the <code>abs()</code> function in the assignment of the parameter
<code>nSegHexTan</code> as the return value of <code>abs()</code>
is a <code>Real</code> which causes a type error during model check.
</td>
</tr>
<tr><td colspan=\"2\"><b>Buildings.HeatTransfer</b>
</td>
</tr>
<tr><td valign=\"top\">Buildings.HeatTransfer.Conduction.MultiLayer
</td>
<td valign=\"top\">Changed the assignment of <code>_T_a_start</code>,
<code>_T_b_start</code> and <code>RTot</code> to be
in the initial equation section as opposed to
the parameter declaration.
This is needed to avoid an error during model check
and translation in Dymola 2015 FD01 beta1.
</td>
</tr>
<tr><td colspan=\"2\"><b>Buildings.Media</b>
</td>
</tr>
<tr><td valign=\"top\">Buildings.Media.Interfaces.PartialSimpleIdealGasMedium<br/>
Buildings.Media.Interfaces.PartialSimpleMedium
</td>
<td valign=\"top\">Set <code>T(start=T_default)</code> and
<code>p(start=p_default)</code> in the
<code>ThermodynamicState</code> record. Setting the start value for
<code>T</code> is required to avoid an error due to
conflicting start values when translating
<a href=\"modelica://Buildings.Examples.VAVReheat.ClosedLoop\">
Buildings.Examples.VAVReheat.ClosedLoop</a> in pedantic mode.
</td>
</tr>
<tr><td colspan=\"2\"><b>xxx</b>
</td>
</tr>
<tr><td valign=\"top\">xxx
</td>
<td valign=\"top\">xxx.
</td>
</tr>
</table>
<!-- Non-backward compatible changes to existing components -->
<p>
The following <b style=\"color:blue\">existing components</b>
have been <b style=\"color:blue\">improved</b> in a
<b style=\"color:blue\">non-backward compatible</b> way:
</p>
<table class=\"releaseTable\" summary=\"summary\" border=\"1\" cellspacing=0 cellpadding=2 style=\"border-collapse:collapse;\">
<tr><td colspan=\"2\"><b>Buildings.Airflow</b>
</td>
</tr>
<tr><td valign=\"top\">Buildings.Airflow.Multizone.ZonalFlow_ACS<br/>
Buildings.Airflow.Multizone.ZonalFlow_m_flow
</td>
<td valign=\"top\">Removed parameter <code>forceErrorControlOnFlow</code> as it was not used.
For Dymola, the conversion script will automatically
update existing models.
</td>
</tr>
<tr><td colspan=\"2\"><b>Buildings.Examples</b>
</td>
</tr>
<tr><td valign=\"top\">Buildings.Examples.VAVReheat.Controls.IntegerSum
</td>
<td valign=\"top\">Removed block as it is not used in any model.
Models that require an integer sum can use
<code>Modelica.Blocks.MathInteger.Sum</code>.
</td>
</tr>
<tr><td valign=\"top\">Buildings.Examples.VAVReheat.Controls.UnoccupiedOn
</td>
<td valign=\"top\">Removed block as it is not used in any model.
</td>
</tr>
<tr><td colspan=\"2\"><b>Buildings.HeatTransfer</b>
</td>
</tr>
<tr><td valign=\"top\">Buildings.HeatTransfer.Conduction.BaseClasses.der_temperature_u
</td>
<td valign=\"top\">Changed the input argument for this function from type
<code>Buildings.HeatTransfer.Data.BaseClasses.Material</code>
to the elements of this type as OpenModelica fails to translate the
model if the input to this function is a record.
</td>
</tr>
<tr><td colspan=\"2\"><b>Buildings.Fluid</b>
</td>
</tr>
<tr><td valign=\"top\">Buildings.Fluid.HeatExchangers.DryCoilDiscretized<br/>
Buildings.Fluid.HeatExchangers.WetCoilDiscretized
</td>
<td valign=\"top\">Reformulated flow splitter in the model to reduce
the dimension of the coupled linear or nonlinear
system of equations. With this revision, the optional
control volume in the duct inlet has been removed
as it is no longer needed. Therefore, the parameter
<code>dl</code> has also been removed.
Replaced the parameters <code>energyDynamics1</code>
and <code>energyDynamics2</code> with
<code>energyDynamics</code>.
Removed the parameter <code>ductConnectionDynamics</code>.<br/>
For Dymola, the conversion script will automatically
update existing models.
</td>
</tr>
<tr><td valign=\"top\">Buildings.Fluid.HeatExchangers.RadiantSlabs.SingleCircuitSlab<br/>
Buildings.Fluid.HeatExchangers.RadiantSlabs.ParallelCircuitsSlab
</td>
<td valign=\"top\">Changed the models to use by default an <i>ε-NTU</i>
approach for the heat transfer between the fluid and the slab
rather than a finite difference scheme along the
flow path.
Optionally, the finite difference scheme can also be used
as this is needed for some control design applications.<br/>
The new <i>ε-NTU</i> formulation has shown to lead to
about five times faster
computation on several test cases including the models in
<a href=\"modelica://Buildings.Rooms.FLEXLAB.Rooms.Examples\">
Buildings.Rooms.FLEXLAB.Rooms.Examples</a>.<br/>
For Dymola, the conversion script will automatically
update existing models.
</td>
</tr>
<tr><td valign=\"top\">Buildings.Fluid.HeatExchangers.BaseClasses.DuctManifoldFixedResistance
</td>
<td valign=\"top\">Reformulated flow splitter in the model to reduce
the dimension of the coupled linear or nonlinear
system of equations. With this revision, the optional
control volume in the duct inlet has been removed
as it is no longer needed. Therefore, the parameters
<code>dl</code> and <code>energyDynamics</code> have
also been removed.<br/>
For Dymola, the conversion script will automatically
update existing models.
</td>
<tr><td valign=\"top\">Buildings.Fluid.HeatExchangers.BaseClasses.CoilRegister
</td>
<td valign=\"top\">Replaced the parameters <code>energyDynamics1</code>
and <code>energyDynamics2</code> with
the new parameter <code>energyDynamics</code>.
Removed the parameters <code>steadyState_1</code>
and <code>steadyState_2</code> as this information
is already contained in <code>energyDynamics</code>.<br/>
For Dymola, the conversion script will automatically
update existing models.
</td>
</tr>
<tr><td valign=\"top\">Buildings.Media.ConstantPropertyLiquidWater<br/>
Buildings.Media.Interfaces.PartialSimpleMedium
</td>
<td valign=\"top\">Removed option to model water as a compressible medium as
this option was not useful.
</td>
</tr>
</table>
<!-- Errors that have been fixed -->
<p>
The following <b style=\"color:red\">critical errors</b> have been fixed (i.e., errors
that can lead to wrong simulation results):
</p>
<table class=\"releaseTable\" summary=\"summary\" border=\"1\" cellspacing=0 cellpadding=2 style=\"border-collapse:collapse;\">
<tr><td colspan=\"2\"><b>Buildings.BoundaryConditions</b>
</td>
</tr>
<tr><td valign=\"top\">Buildings.BoundaryConditions.WeatherData.ReaderTMY3
</td>
<td valign=\"top\">Corrected error that led the total and opaque sky cover to be ten times
too low if its value was obtained from the parameter or the input connector.
For the standard configuration in which the sky cover is obtained from
the weather data file, the model was correct. This error only affected
the other two possible configurations.
</td>
</tr><tr><td colspan=\"2\"><b>Buildings.Fluid</b>
</td>
</tr>
<tr><td valign=\"top\">Buildings.Fluid.Data.Pipes
</td>
<td valign=\"top\">Corrected wrong entries for inner and outer diameter
of PEX pipes.
</td>
</tr>
<tr><td valign=\"top\">Buildings.Fluid.Storage.Stratified<br/>
Buildings.Fluid.Storage.StratifiedEnhanced<br/>
Buildings.Fluid.Storage.StratifiedEnhancedInternalHex
</td>
<td valign=\"top\">Replaced the use of <code>Medium.lambda_const</code> with
<code>Medium.thermalConductivity(sta_default)</code> as
<code>lambda_const</code> is not declared for all media.
This avoids a translation error if certain media are used.
</td>
</tr><tr><td valign=\"top\">Buildings.Fluid.Storage.StratifiedEnhancedInternalHex
</td>
<td valign=\"top\">Corrected issue
<a href=\"https://github.com/lbl-srg/modelica-buildings/issues/271\">#271</a>
which led to a compilation error if the heat exchanger
and the tank had different media.
</td>
</tr>
<tr><td colspan=\"2\"><b>Buildings.Rooms</b>
</td>
</tr>
<tr><td valign=\"top\">Buildings.Rooms.FLEXLAB.Rooms.Examples.TestBedX3WithRadiantFloor<br/>
Buildings.Rooms.FLEXLAB.Rooms.Examples.X3AWithRadiantFloor<br/>
Buildings.Rooms.FLEXLAB.Rooms.Examples.X3BWithRadiantFloor
</td>
<td valign=\"top\">Corrected wrong entries for inner and outer diameter
of PEX pipes.
</td>
</tr>
</table>
<!-- Uncritical errors -->
<p>
The following <b style=\"color:red\">uncritical errors</b> have been fixed (i.e., errors
that do <b style=\"color:red\">not</b> lead to wrong simulation results, e.g.,
units are wrong or errors in documentation):
</p>
<table class=\"releaseTable\" summary=\"summary\" border=\"1\" cellspacing=0 cellpadding=2 style=\"border-collapse:collapse;\">
<tr><td colspan=\"2\"><b>Buildings.Fluid</b>
</td>
</tr>
<tr><td valign=\"top\">Buildings.Fluid.FixedResistances.FixedResistanceDpM
</td>
<td valign=\"top\">Corrected error in documentation of computation of <code>k</code>.
</td>
</tr>
<tr><td colspan=\"2\"><b>Buildings.HeatTransfer</b>
</td>
</tr>
<tr><td valign=\"top\">Buildings.HeatTransfer.Windows.BaseClasses.GlassLayer
</td>
<td valign=\"top\">Changed type of <code>tauIR</code> from
<code>Modelica.SIunits.Emissivity</code> to
<code>Modelica.SIunits.TransmissionCoefficient</code>.
This avoids a type error in OpenModelica.
</td>
</tr>
</table>
<!-- Github issues -->
<p>
The following
<a href=\"https://github.com/lbl-srg/modelica-buildings/issues\">issues</a>
have been fixed:
</p>
<table border=\"1\" summary=\"github issues\" cellspacing=0 cellpadding=2 style=\"border-collapse:collapse;\">
<tr><td colspan=\"2\"><b>xxx</b>
</td>
</tr>
<tr><td valign=\"top\"><a href=\"https://github.com/lbl-srg/modelica-buildings/issues/xxx\">#xxx</a>
</td>
<td valign=\"top\">xxx.
</td>
</tr>
</table>
<p>
Note:
</p>
<ul>
<li>
xxx
</li>
</ul>
</html>"));
end Version_1_7_build1;
class Version_1_6_build1 "Version 1.6 build 1"
extends Modelica.Icons.ReleaseNotes;
annotation (Documentation(info="<html>
<p>
Version 1.6 build 1 updates the <code>Buildings</code> library to the
Modelica Standard Library 3.2.1 and to <code>Modelica_StateGraph2</code> 2.0.2.
</p>
<p>
This is the first version of the <code>Buildings</code> library
that contains models from the
<a href=\"https://github.com/iea-annex60/modelica-annex60\">
IEA EBC Annex 60 library</a>,
a Modelica library for building and community energy systems that is
collaboratively developed within the project
<a href=\"http://www.iea-annex60.org\">
\"New generation computational tools for building and community energy systems
based on the Modelica and Functional Mockup Interface standards\"</a>,
a project that is conducted under the
Energy in Buildings and Communities Programme (EBC) of the
International Energy Agency (IEA).
</p>
<!-- New libraries -->
<!-- New components for existing libraries -->
<p>
The following <b style=\"color:blue\">new components</b> have been added
to <b style=\"color:blue\">existing</b> libraries:
</p>
<table class=\"releaseTable\" summary=\"summary\" border=\"1\" cellspacing=0 cellpadding=2 style=\"border-collapse:collapse;\">
<tr><td colspan=\"2\"><b>Buildings.Fluid</b>
</td>
</tr>
<tr><td valign=\"top\">Buildings.Fluid.Actuators.Valves.TwoWayTable
</td>
<td valign=\"top\">Two way valve for which the opening characteristics
is specified by a table.
</td>
</tr>
<tr><td colspan=\"2\"><b>Buildings.Utilities.Math</b>
</td>
</tr>
<tr><td valign=\"top\">Buildings.Utilities.Math.Examples.Average
Buildings.Utilities.Math.Examples.InverseXRegularized
Buildings.Utilities.Math.Examples.Polynominal
Buildings.Utilities.Math.Examples.PowerLinearized
Buildings.Utilities.Math.Examples.QuadraticLinear
Buildings.Utilities.Math.Examples.RegNonZeroPower
Buildings.Utilities.Math.Examples.SmoothExponential
Buildings.Utilities.Math.Functions.average
Buildings.Utilities.Math.Functions.booleanReplicator
Buildings.Utilities.Math.Functions.Examples.IsMonotonic
Buildings.Utilities.Math.Functions.Examples.TrapezoidalIntegration
Buildings.Utilities.Math.Functions.integerReplicator
Buildings.Utilities.Math.InverseXRegularized
Buildings.Utilities.Math.Polynominal
Buildings.Utilities.Math.PowerLinearized
Buildings.Utilities.Math.QuadraticLinear
Buildings.Utilities.Math.RegNonZeroPower
Buildings.Utilities.Math.SmoothExponential
Buildings.Utilities.Math.TrapezoidalIntegration
</td>
<td valign=\"top\">Various functions and blocks for mathematical operations.
</td>
</tr>
<tr><td colspan=\"2\"><b>Buildings.Utilities.Psychrometrics</b>
</td>
</tr>
<tr><td valign=\"top\">Buildings.Utilities.Psychrometrics.Examples.SaturationPressureLiquid
Buildings.Utilities.Psychrometrics.Examples.SaturationPressure
Buildings.Utilities.Psychrometrics.Examples.SublimationPressureIce
Buildings.Utilities.Psychrometrics.Functions.BaseClasses.der_saturationPressureLiquid
Buildings.Utilities.Psychrometrics.Functions.BaseClasses.der_sublimationPressureIce
Buildings.Utilities.Psychrometrics.Functions.BaseClasses.Examples.SaturationPressureDerivativeCheck
Buildings.Utilities.Psychrometrics.Functions.Examples.SaturationPressure
Buildings.Utilities.Psychrometrics.Functions.saturationPressureLiquid
Buildings.Utilities.Psychrometrics.Functions.saturationPressure
Buildings.Utilities.Psychrometrics.Functions.sublimationPressureIce
Buildings.Utilities.Psychrometrics.SaturationPressureLiquid
Buildings.Utilities.Psychrometrics.SaturationPressure
Buildings.Utilities.Psychrometrics.SublimationPressureIce
</td>
<td valign=\"top\">Various functions and blocks for psychrometric calculations.
</td>
</tr>
</table>
<!-- Backward compatible changes -->
<p>
The following <b style=\"color:blue\">existing components</b>
have been <b style=\"color:blue\">improved</b> in a
<b style=\"color:blue\">backward compatible</b> way:
</p>
<table class=\"releaseTable\" summary=\"summary\" border=\"1\" cellspacing=0 cellpadding=2 style=\"border-collapse:collapse;\">
<tr><td colspan=\"2\"><b>Buildings.Fluid</b>
</td>
</tr>
<tr><td valign=\"top\">Buildings.Fluid.Interfaces.PartialTwoPortInterface<br/>
Buildings.Fluid.Interfaces.PartialFourPortInterface
</td>
<td valign=\"top\">Removed call to homotopy function
in the computation of the connector variables as
these are conditionally enabled variables and
therefore must not be used in any equation. They
are only for output reporting.
</td>
</tr>
<tr><td valign=\"top\">Buildings.Fluid.Actuators.Dampers.Exponential
</td>
<td valign=\"top\">Improved documentation of the flow resistance.
</td>
</tr>
<tr><td colspan=\"2\"><b>Buildings.BoundaryConditions</b>
</td>
</tr>
<tr><td valign=\"top\">Buildings.BoundaryConditions.WeatherData.ReaderTMY3<br/>
</td>
<td valign=\"top\">Added the option to use a constant, an input signal or the weather file as the source
for the ceiling height, the total sky cover, the opaque sky cover, the dew point temperature,
and the infrared horizontal radiation <code>HInfHor</code>.
</td>
</tr>
</table>
<!-- Non-backward compatible changes to existing components -->
<p>
The following <b style=\"color:blue\">existing components</b>
have been <b style=\"color:blue\">improved</b> in a
<b style=\"color:blue\">non-backward compatible</b> way:
</p>
<table class=\"releaseTable\" summary=\"summary\" border=\"1\" cellspacing=0 cellpadding=2 style=\"border-collapse:collapse;\">
<tr><td colspan=\"2\"><b>Buildings.Fluid</b>
</td>
</tr>
<tr><td valign=\"top\">Buildings.Fluid.Movers.FlowMachinePolynomial
</td>
<td valign=\"top\">Moved the model to the package
<code>Buildings.Obsolete</code>,
as this model is planned to be removed in future versions.
The conversion script should update old instances of
this model automatically in Dymola.
Users should change their models to use a flow machine from
the package <code>Buildings.Fluid.Movers</code>.
</td>
</tr>
<tr><td valign=\"top\">Buildings.Fluid.Storage.ExpansionVessel
</td>
<td valign=\"top\">Simplified the model to have a constant pressure.
The following non-backward compatible changes
have been made.
<ol>
<li>The parameter <code>VTot</code> was renamed to <code>V_start</code>.</li>
<li>The following parameters were removed: <code>VGas0</code>,
<code>pMax</code>, <code>energyDynamics</code> and <code>massDynamics</code>.</li>
</ol>
The conversion script should update old instances of
this model automatically in Dymola.
</td>
</tr>
<tr><td valign=\"top\">Buildings.Fluid.Storage.StratifiedEnhancedInternalHex
</td>
<td valign=\"top\">Revised the model as the old version required the port<sub>a</sub>
of the heat exchanger to be located higher than port<sub>b</sub>.
This makes sense if the heat exchanger is used to heat up the tank,
but not if it is used to cool down a tank, such as in a cooling plant.
The following parameters were changed:
<ol>
<li>Changed <code>hexTopHeight</code> to <code>hHex_a</code>.</li>
<li>Changed <code>hexBotHeight</code> to <code>hHex_b</code>.</li>
<li>Changed <code>topHexSeg</code> to <code>segHex_a</code>,
and made it protected as this is deduced from <code>hHex_a</code>.</li>
<li>Changed <code>botHexSeg</code> to <code>segHex_b</code>,
and made it protected as this is deduced from <code>hHex_b</code>.</li>
</ol>
The names of the following ports have been changed:
<ol>
<li>Changed <code>port_a1</code> to <code>portHex_a</code>.</li>
<li>Changed <code>port_b1</code> to <code>portHex_b</code>.</li>
</ol>
The conversion script should update old instances of
this model automatically in Dymola for all of the above changes.
</td>
</tr>
</table>
<!-- Errors that have been fixed -->
<p>
The following <b style=\"color:red\">critical errors</b> have been fixed (i.e., errors
that can lead to wrong simulation results):
</p>
<table class=\"releaseTable\" summary=\"summary\" border=\"1\" cellspacing=0 cellpadding=2 style=\"border-collapse:collapse;\">
<tr><td colspan=\"2\"><b>Buildings.Fluid</b>
</td>
</tr>
<tr><td valign=\"top\">Buildings.Fluid.HeatExchangers.Boreholes.UTube
</td>
<td valign=\"top\">Reimplemented the resistor network inside the borehole
as the old implementation led to too slow a transient
response. This change also led to the removal of the
parameters <code>B0</code> and <code>B1</code>
as the new implementation does not require them.
</td>
</tr>
</table>
<!-- Uncritical errors -->
<p>
The following <b style=\"color:red\">uncritical errors</b> have been fixed (i.e., errors
that do <b style=\"color:red\">not</b> lead to wrong simulation results, e.g.,
units are wrong or errors in documentation):
</p>
<table class=\"releaseTable\" summary=\"summary\" border=\"1\" cellspacing=0 cellpadding=2 style=\"border-collapse:collapse;\">
<tr><td colspan=\"2\"><b>Buildings.Fluid</b>
</td>
</tr>
<tr><td valign=\"top\">Buildings.Fluid.HeatExchangers.Boreholes.BaseClasses.HexInternalElement
</td>
<td valign=\"top\">Corrected error in documentation which stated a wrong default value
for the pipe spacing.
</td>
</tr>
<tr><td valign=\"top\">Buildings.Fluid.HeatExchangers.BaseClasses.ntu_epsilonZ()
</td>
<td valign=\"top\">Added dummy argument to function call of <code>Internal.solve</code>
to avoid a warning during model check in Dymola 2015.
</td>
<tr><td valign=\"top\">Buildings.Fluid.HeatExchangers.DryEffectivenessNTU
</td>
<td valign=\"top\">Changed <code>assert</code> statement to avoid comparing
enumeration with an integer, which triggers a warning
in Dymola 2015.
</td>
</tr> <tr><td valign=\"top\">Buildings.Rooms.Constructions.Examples.ExteriorWall<br/>
Buildings.Rooms.Constructions.Examples.ExteriorWallWithWindow<br/>
Buildings.Rooms.Constructions.Examples.ExteriorWallTwoWindows
</td>
<td valign=\"top\">Corrected wrong assignment of parameter in instance <code>bouConExt(conMod=...)</code>
which was set to an interior instead of an exterior convection model.
</td>
</tr>
<tr><td valign=\"top\">Buildings.Utilities.Psychrometrics.Functions.TDewPoi_pW()
</td>
<td valign=\"top\">Added dummy argument to function call of <code>Internal.solve</code>
to avoid a warning during model check in Dymola 2015.
</td>
</table>
<!-- Github issues -->
<p>
The following
<a href=\"https://github.com/lbl-srg/modelica-buildings/issues\">issues</a>
have been fixed:
</p>
<table border=\"1\" summary=\"github issues\" cellspacing=0 cellpadding=2 style=\"border-collapse:collapse;\">
<tr><td colspan=\"2\"><b>Buildings.Fluid</b>
</td>
</tr>
<tr><td valign=\"top\"><a href=\"https://github.com/lbl-srg/modelica-buildings/issues/196\">#196</a>
</td>
<td valign=\"top\">Change capacity location in borehole grout.
</td>
</tr>
</table>
</html>"));
end Version_1_6_build1;
class Version_1_5_build3 "Version 1.5 build 3"
extends Modelica.Icons.ReleaseNotes;
annotation (preferredView="info",
Documentation(info="<html>
<p>
Version 1.5 build 3 is a maintenance release that corrects an error in
<a href=\"modelica://Buildings.Fluid.MassExchangers.HumidifierPrescribed\">
Buildings.Fluid.MassExchangers.HumidifierPrescribed</a>.
It is fully compatible with version 1.5 build 2.
</p>
<!-- Errors that have been fixed -->
<p>
The following <b style=\"color:red\">critical errors</b> have been fixed (i.e., errors
that can lead to wrong simulation results):
<table summary=\"summary\" border=\"1\" cellspacing=0 cellpadding=2 style=\"border-collapse:collapse;\">
<tr><td colspan=\"2\"><b>Buildings.Fluid</b>
</td>
</tr>
<tr><td valign=\"top\">Buildings.Fluid.MassExchangers.HumidifierPrescribed
</td>
<td valign=\"top\">
Corrected the enthalpy balance, which caused the latent heat flow rate to be added
twice to the fluid stream.
This closes issue <a href=\"https://github.com/lbl-srg/modelica-buildings/issues/197\">#197</a>.
</td>
</tr>
</table>
<!-- Github issues -->
<p>
The following
<a href=\"https://github.com/lbl-srg/modelica-buildings/issues\">issues</a>
have been fixed:
</p>
<table summary=\"summary\" border=\"1\" cellspacing=0 cellpadding=2 style=\"border-collapse:collapse;\">
<tr><td colspan=\"2\"><b>HumidifierPrescribed accounts twice for latent heat gain</b>
</td>
</tr>
<tr><td valign=\"top\"><a href=\"https://github.com/lbl-srg/modelica-buildings/issues/197\">#197</a>
</td>
<td valign=\"top\">This issue has been addressed by correcting the latent heat added to the
fluid stream.
</td>
</tr>
</table>
</html>"));
end Version_1_5_build3;
class Version_1_5_build2 "Version 1.5 build 2"
extends Modelica.Icons.ReleaseNotes;
annotation (preferredView="info",
Documentation(info="<html>
<p>
Version 1.5 build 2 is a maintenance release that corrects an error in
<a href=\"modelica://Buildings.Fluid.HeatExchangers.DryCoilDiscretized\">
Buildings.Fluid.HeatExchangers.DryCoilDiscretized</a> and in
<a href=\"modelica://Buildings.Fluid.HeatExchangers.WetCoilDiscretized\">
Buildings.Fluid.HeatExchangers.WetCoilDiscretized</a>.
It is fully compatible with version 1.5 build 1.
<!-- Errors that have been fixed -->
<p>
The following <b style=\"color:red\">critical errors</b> have been fixed (i.e., errors
that can lead to wrong simulation results):
</p>
<table summary=\"summary\" border=\"1\" cellspacing=0 cellpadding=2 style=\"border-collapse:collapse;\">
<tr><td colspan=\"2\"><b>Buildings.Fluid</b>
</td>
</tr>
<tr><td valign=\"top\">Buildings.Fluid.HeatExchangers.DryCoilDiscretized<br/>
Buildings.Fluid.HeatExchangers.WetCoilDiscretized
</td>
<td valign=\"top\">
Corrected wrong connect statements that caused the last register to have
no liquid flow.
This closes issue <a href=\"https://github.com/lbl-srg/modelica-buildings/issues/194\">#194</a>.
</td>
</tr>
</table>
<!-- Github issues -->
<p>
The following
<a href=\"https://github.com/lbl-srg/modelica-buildings/issues\">issues</a>
have been fixed:
</p>
<table summary=\"summary\" border=\"1\" cellspacing=0 cellpadding=2 style=\"border-collapse:collapse;\">
<tr><td colspan=\"2\"><b>DryCoilDiscretized model not using last register, liquid flow path</b>
</td>
</tr>
<tr><td valign=\"top\"><a href=\"https://github.com/lbl-srg/modelica-buildings/issues/194\">#194</a>
</td>
<td valign=\"top\">This issue has been addressed by correcting the connect statements.
</td>
</tr>
</table>
</html>"));
end Version_1_5_build2;
class Version_1_5_build1 "Version 1.5 build 1"
extends Modelica.Icons.ReleaseNotes;
annotation (preferredView="info",
Documentation(info="<html>
<p>
Version 1.5 build 1 is a major release that contains new packages with models for
solar collectors and for the Facility for Low Energy Experiments (FLEXLAB)
at the Lawrence Berkeley National Laboratory.
</p>
<p>
This release also contains a major revision of all info sections to correct invalid html syntax.
The package <code>Buildings.HeatTransfer.Radiosity</code> has been revised to comply
with the Modelica language specification.
The package <code>Buildings.Rooms</code> has been revised to aid implementation of
non-uniformly mixed room air models.
This release also contains various corrections that avoid warnings during translation
when used with Modelica 3.2.1.
Various models have been revised to increase compatibility with OpenModelica.
However, currently only a subset of the models work with OpenModelica.
</p>
<!-- New libraries -->
<p>
The following <b style=\"color:blue\">new libraries</b> have been added:
</p>
<table class=\"releaseTable\" summary=\"summary\" border=\"1\" cellspacing=0 cellpadding=2>
<tr><td valign=\"top\">Buildings.Fluid.SolarCollectors
</td>
<td valign=\"top\">Library with solar collectors.
</td>
</tr>
<tr><td valign=\"top\">Buildings.Rooms.FLEXLAB
</td>
<td valign=\"top\">Package with models for test cells of LBNL's FLEXLAB
(Facility for Low Energy Experiments in Buildings).
</td>
</tr>
<tr><td valign=\"top\">Buildings.Utilities.IO.FLEXLAB
</td>
<td valign=\"top\">Package that demonstrates two-way data exchange
between Modelica and LBNL's FLEXLAB (Facility for
Low Energy Experiments in Buildings).
</td>
</tr>
</table>
<!-- New components for existing libraries -->
<p>
The following <b style=\"color:blue\">new components</b> have been added
to <b style=\"color:blue\">existing</b> libraries:
</p>
<table class=\"releaseTable\" summary=\"summary\" border=\"1\" cellspacing=0 cellpadding=2 style=\"border-collapse:collapse;\">
<tr><td colspan=\"2\"><b>Buildings.Fluid.Storage</b>
</td>
</tr>
<tr><td valign=\"top\">Buildings.Fluid.Storage.StratifiedEnhancedInternalHex
</td>
<td valign=\"top\">Added a model of a tank with built-in heat exchanger.
This model may be used together with solar thermal plants.
</td>
</tr>
<tr><td colspan=\"2\"><b>Buildings.Resources</b>
</td>
</tr>
<tr><td valign=\"top\">Buildings.Resources.Include
</td>
<td valign=\"top\">Added an <code>Include</code> folder and the <code>bcvtb.h</code>
header file to it to fix compilation errors in BCVTB example files.
</td>
</tr>
</table>
<!-- Backward compatible changes -->
<p>
The following <b style=\"color:blue\">existing components</b>
have been <b style=\"color:blue\">improved</b> in a
<b style=\"color:blue\">backward compatible</b> way:
</p>
<table class=\"releaseTable\" summary=\"summary\" border=\"1\" cellspacing=0 cellpadding=2 style=\"border-collapse:collapse;\">
<tr><td colspan=\"2\"><b>Buildings.BoundaryConditions</b>
</td>
</tr>
<tr><td valign=\"top\">Buildings.BoundaryConditions.WeatherData.ReaderTMY3<br/>
Buildings.BoundaryConditions.WeatherData.BaseClasses.getAbsolutePath
</td>
<td valign=\"top\">Improved the algorithm that determines the absolute path of the file.
Now weather files are searched in the path specified, and if not found, the urls
<code>file://</code>, <code>modelica://</code> and <code>modelica://Buildings</code>
are added in this order to search for the weather file.
This allows using the data reader without having to specify an absolute path,
as long as the <code>Buildings</code> library
is on the <code>MODELICAPATH</code>.
</td>
</tr>
<tr><td colspan=\"2\"><b>Buildings.Fluid</b>
</td>
</tr>
<tr><td valign=\"top\">Buildings.Fluid.Interfaces.StaticTwoPortConservationEquation
</td>
<td valign=\"top\">Reformulated computation of outlet properties to avoid an event at zero mass flow rate.
</td>
</tr>
<tr><td valign=\"top\">Buildings.Fluid.HeatExchangers.CoolingTowers.YorkCalc
</td>
<td valign=\"top\">Simplified the implementation for the situation if
<code>allowReverseFlow=false</code>.
Avoided the use of the conditionally enabled variables <code>sta_a</code> and
<code>sta_b</code> as this was not proper use of the Modelica syntax.
</td>
</tr>
<tr><td valign=\"top\">Buildings.Fluid.Interfaces.Examples.ReverseFlowHumidifier
</td>
<td valign=\"top\">Changed one instance of <code>Modelica.Fluid.Sources.MassFlowSource_T</code>,
that was connected to the two fluid streams,
to two instances, each having half the mass flow rate.
This is required for the model to work with Modelica 3.2.1 due to the
change introduced in
ticket <a href=\"https://trac.modelica.org/Modelica/ticket/739\">#739</a>.
</td>
</tr>
<tr><td valign=\"top\">Buildings.Fluid.Sensors.EnthalpyFlowRate<br/>
Buildings.Fluid.Sensors.SensibleEnthalpyFlowRate<br/>
Buildings.Fluid.Sensors.LatentEnthalpyFlowRate<br/>
Buildings.Fluid.Sensors.VolumeFlowRate
</td>
<td valign=\"top\">Removed default value <code>tau=0</code> as the base class
already sets <code>tau=1</code>.
This change was made so that all sensors use the same default value.
</td>
</tr>
<tr><td valign=\"top\">Buildings.Fluid.Sensors.TraceSubstancesTwoPort
</td>
<td valign=\"top\">Added default value <code>C_start=0</code>.
</td>