Buildings.UsersGuide.ReleaseNotes

Release notes

Information

This section summarizes the changes that have been performed on the Buildings library.

Version 10.0.0 (September 5, 2023)
Version 9.1.1 (September 5, 2023)
Version 9.1.0 (December 6, 2022)
Version 9.0.0 (May 31, 2022)
Version 8.1.3 (May 31, 2022)
Version 8.1.2 (May 26, 2022)
Version 8.1.1 (May 12, 2022)
Version 8.1.0 (December 9, 2021)
Version 8.0.0 (June 8, 2021)
Version 7.0.2 (December 9, 2021)
Version 7.0.1 (June 4, 2021)
Version 7.0.0 (May 28, 2020)
Version 6.0.0 (July 15, 2019)
Version 5.1.0 (June 14, 2018)
Version 5.0.1 (November 22, 2017)
Version 5.0.0 (November 17, 2017)
Version 4.0.0 (March 29, 2017)
Version 3.0.0 (March 29, 2016)
Version 2.1.0 (July 13, 2015)
Version 2.0.0 (May 4, 2015)
Version 1.6 build1 (June 19, 2014)
Version 1.5 build3 (February 12, 2014)
Version 1.5 build2 (December 13, 2013)
Version 1.5 build1 (October 24, 2013)
Version 1.4 build1 (May 15, 2013)
Version 1.3 build1 (January 8, 2013)
Version 1.2 build1 (July 26, 2012)
Version 1.1 build1 (February 29, 2012)
Version 1.0 build2 (December 8, 2011)
Version 1.0 build1 (November 4, 2011)
Version 0.12.0 (May 6, 2011)
Version 0.11.0 (March 17, 2011)
Version 0.10.0 (July 30, 2010)
Version 0.9.1 (June 24, 2010)
Version 0.9.0 (June 11, 2010)
Version 0.8.0 (February 6, 2010)
Version 0.7.0 (September 29, 2009)
Version 0.6.0 (May 15, 2009)
Version 0.5.0 (February 19, 2009)
Version 0.4.0 (October 31, 2008)
Version 0.3.0 (September 30, 2008)
Version 0.2.0 (June 17, 2008)
Version 0.1.0 (May 27, 2008)

Extends from Modelica.Icons.ReleaseNotes (Icon for release notes in documentation).

Package Content

Name	Description
Version_10_0_0	Version 10.0.0
Version_9_1_1	Version 9.1.1
Version_9_1_0	Version 9.1.0
Version_9_0_0	Version 9.0.0
Version_8_1_3	Version 8.1.3
Version_8_1_2	Version 8.1.2
Version_8_1_1	Version 8.1.1
Version_8_1_0	Version 8.1.0
Version_8_0_0	Version 8.0.0
Version_7_0_2	Version 7.0.2
Version_7_0_1	Version 7.0.1
Version_7_0_0	Version 7.0.0
Version_6_0_0	Version 6.0.0
Version_5_1_0	Version 5.1.0
Version_5_0_1	Version 5.0.1
Version_5_0_0	Version 5.0.0
Version_4_0_0	Version 4.0.0
Version_3_0_0	Version 3.0.0
Version_2_1_0	Version 2.1.0
Version_2_0_0	Version 2.0.0
Version_1_6_build1	Version 1.6 build 1
Version_1_5_build3	Version 1.5 build 3
Version_1_5_build2	Version 1.5 build 2
Version_1_5_build1	Version 1.5 build 1
Version_1_4_build1	Version 1.4 build 1
Version_1_3_build1	Version 1.3 build 1
Version_1_2_build1	Version 1.2 build 1
Version_1_1_build1	Version 1.1 build 1
Version_1_0_build2	Version 1.0 build 2
Version_1_0_build1	Version 1.0 build 1
Version_0_12_0	Version 0.12.0
Version_0_11_0	Version 0.11.0
Version_0_10_0	Version 0.10.0
Version_0_9_1	Version 0.9.1
Version_0_9_0	Version 0.9.0
Version_0_8_0	Version 0.8.0
Version_0_7_0	Version 0.7.0
Version_0_6_0	Version 0.6.0
Version_0_5_0	Version 0.5.0
Version_0_4_0	Version 0.4.0
Version_0_3_0	Version 0.3.0
Version_0_2_0	Version 0.2.0
Version_0_1_0	Version 0.1.0

Buildings.UsersGuide.ReleaseNotes.Version_10_0_0

Version 10.0.0

Information

Version 10.0.0 is a major release that adds various new packages and models.

The library has been tested with Dymola 2023x, OpenModelica 1.22.0-dev (41-g8a5b18f-1), OPTIMICA 1.43.4 and recent versions of Impact.

The following major changes have been done compared to release 9.1.1:

A package with configurable template models for variable air volume flow systems with control based on ASHRAE Guideline 36 has been added to Buildings.Template.
Reduced order building envelope models based on the ISO 13790:2008 Standard have been added. This allows modeling of building envelope heat transfer either with a detailed Modelica multizone model (Buildings.ThermalZones.Detailed), with EnergyPlus via the Spawn coupling (Buildings.ThermalZones.EnergyPlus_9_6_0), or with reduced order models based on ISO 13790 (Buildings.ThermalZones.ISO13790) or based on VDI 6007 (Buildings.ThermalZones.ReducedOrder).
Various models for district energy systems have been added to the package Buildings.Experimental. This package includes models for
- combined heating and cooling district energy systems that operate near ambient temperature (sometimes called 5th generation district energy systems),
- Energy Transfer Stations (ETS) with all electric plants with heat recovery chillers,
- ETS with multiple heat pumps (heat recovery as well as air-source heat pumps) and storage, i.e., the so-called Time-Independent Energy Recovery (TIER) plant in (Buildings.Experimental.DHC.Plants.Combined.AllElectricCWStorage),
- direct and indirect ETS for heating or for cooling, and
- district steam systems.
A package with all major hydronic configurations that are encountered in heating and cooling systems has been added in Buildings.Fluid.HydronicConfigurations. This package also includes automatic sizing of control valves to obtain suitable valve authority.
The fan and pump models have been revised, and can now be configured to compute the part load efficiency based on the Euler number.
Various new elementary control blocks have been added to the Buildings.Controls.OBC.CDL package to provide a reference implementation of the ASHRAE Standard 231P Control Description Language that is currently being developed. See also obc.lbl.gov.

The following new libraries have been added:

Buildings.Templates	Package that contains templates for HVAC systems with control sequences based on ASHRAE Guideline 36. Currently limited to VAV systems, the package is under active development and will be further expanded with templates for primary systems and various types of zone equipment.
Buildings.ThermalZones.ISO13790	Package that contains models for reduced building physics of thermal zones based on a thermal network consisting of five resistances and one capacity. The models are inspired by the ISO 13790:2008 Standard.
Buildings.Experimental.DHC.EnergyTransferStations.Heating	Package containing models for energy transfer stations used in district heating systems.
Buildings.Experimental.DHC.Loads.Combined.Examples	Package that contains example models of a building with loads provided as time series for heat pump space heating, heat pump domestic hot water heating, and free cooling in an ambient district network.
Buildings.Experimental.DHC.Loads.Heating	Package containing models for loads in district heating systems.
Buildings.Experimental.DHC.Plants.Combined	Package of models for central plants that provide heating and cooling.
Buildings.Experimental.DHC.BaseClasses.Steam	Package for steam systems using the split-medium approach..
Buildings.Experimental.DHC.Examples.Steam	Package of example models for steam district heating systems.
Buildings.Experimental.DHC.Loads.Steam	Package with models for loads involving steam systems.
Buildings.Experimental.DHC.Networks.Steam	Package of models for distribution networks involving steam.
Buildings.Experimental.DHC.Plants.Steam	Package with models for steam plants.
Buildings.Fluid.HydronicConfigurations	Package that contains models for standard connection configurations used in hydronic circuits for heating or cooling applications.

The following new components have been added to existing libraries:

Buildings.Controls.OBC.CDL
Buildings.Controls.OBC.CDL.Logical.Proof	Added new CDL blocks as suggested by ASHRAE 231p committee. This is for issue 3256.
Buildings.Controls.OBC.CDL.Logical.VariablePulse	Added new CDL blocks as suggested by ASHRAE 231p committee. This is for issue 3042.
Buildings.Controls.OBC.CDL.Reals.Ramp	Added new CDL blocks as suggested by ASHRAE 231p committee. This is for issue 3141.
Buildings.Controls.OBC.CDL.Integers.Stage	Added new CDL blocks as suggested by ASHRAE 231P committee. This is for issue 3103.
Buildings.Experimental.DHC.Plants.Cooling
Buildings.Experimental.DHC.Plants.Cooling.StoragePlant Buildings.Experimental.DHC.Plants.Cooling.Controls.FlowControl Buildings.Experimental.DHC.Plants.Cooling.Controls.SelectMin Buildings.Experimental.DHC.Plants.Cooling.Controls.TankStatus Buildings.Experimental.DHC.Plants.Cooling.Controls.Validation.TankStatus Buildings.Experimental.DHC.Plants.Cooling.Examples.StoragePlantDualSource Buildings.Experimental.DHC.Plants.Cooling.BaseClasses.IdealUser Buildings.Experimental.DHC.Plants.Cooling.BaseClasses.ParallelJunctions Buildings.Experimental.DHC.Plants.Cooling.BaseClasses.ParallelPipes Buildings.Experimental.DHC.Plants.Cooling.BaseClasses.ReversibleConnection Buildings.Experimental.DHC.Plants.Cooling.BaseClasses.TankBranch Buildings.Experimental.DHC.Plants.Cooling.BaseClasses.Validation.IdealUser	Added models for a district CHW system with two plants, where one of them has a storage tank that can be charged remotely by the other plant. This is for issue 2859.
Buildings.Fluid.Movers
Buildings.Fluid.Movers.Examples.Data.EnglanderNorford1992 Buildings.Fluid.Movers.Data.Fans.Greenheck.BIDW12 Buildings.Fluid.Movers.Data.Fans.Greenheck.BIDW13 Buildings.Fluid.Movers.Data.Fans.Greenheck.BIDW15 Buildings.Fluid.Movers.Data.Fans.Greenheck.BIDW16 Buildings.Fluid.Movers.Data.Fans.Greenheck.BIDW18 Buildings.Fluid.Movers.Examples.StaticReset Buildings.Fluid.Movers.Validation.PowerEuler Buildings.Fluid.Movers.BaseClasses.Euler.computeTables Buildings.Fluid.Movers.BaseClasses.Euler.correlation Buildings.Fluid.Movers.BaseClasses.Euler.getPeak Buildings.Fluid.Movers.BaseClasses.Euler.lookupTables Buildings.Fluid.Movers.BaseClasses.Euler.peak Buildings.Fluid.Movers.BaseClasses.Validation.EulerComparison Buildings.Fluid.Movers.BaseClasses.Validation.EulerCurve Buildings.Fluid.Movers.BaseClasses.Validation.EulerReducedSpeed Buildings.Fluid.Movers.BaseClasses.Validation.HydraulicEfficiencyMethods Buildings.Fluid.Movers.BaseClasses.Validation.TotalEfficiencyMethods	Added package that enables the Euler number method for efficiency computation, as well as example models, validation models, and data records to support it. This is for #2668.
Buildings.Fluid.Movers.BaseClasses.Characteristics.efficiency_yMot Buildings.Fluid.Movers.BaseClasses.Characteristics.efficiencyParameters_yMot Buildings.Fluid.Movers.BaseClasses.Characteristics.motorEfficiencyCurve Buildings.Fluid.Movers.BaseClasses.Validation.MotorEfficiencyMethods	Added functions and data records that allow the motor efficiency to be provided as a function of part load ratio, and its validation model. This is for #2668.
Buildings.Fluid.Movers.Preconfigured.FlowControlled_dp Buildings.Fluid.Movers.Preconfigured.FlowControlled_m_flow Buildings.Fluid.Movers.Preconfigured.SpeedControlled_y Buildings.Fluid.Movers.Preconfigured.Validation.ControlledFlowMachinePreconfigured	Added preconfigured versions for the mover models that only require the user to provide nominal conditions. This is for #2668.
Buildings.Fluid.Movers.Validation.PressureCurve	Added a validation model that displays the pressure curve. This is for #3371.
Buildings.Fluid.Sources
Buildings.Fluid.Sources.BaseClasses.PartialAirSource	Added new base class that only provides moist air as a medium selection. This is for IBPSA, #1681.
Buildings.Utilities.IO.Files
Buildings.Utilities.IO.Files.WeeklySchedule	Added model to read weekly time schedules from a file. This is for IBPSA, #1601.

The following existing components have been improved in a backward compatible way:

Buildings.Controls.OBC.ASHRAE.G36.TerminalUnits
Buildings.Controls.OBC.ASHRAE.G36.TerminalUnits.CoolingOnly.Subsequences.Alarms Buildings.Controls.OBC.ASHRAE.G36.TerminalUnits.DualDuctColdDuctMin.Subsequences.Alarms Buildings.Controls.OBC.ASHRAE.G36.TerminalUnits.DualDuctMixConDischargeSensor.Subsequences.Alarms Buildings.Controls.OBC.ASHRAE.G36.TerminalUnits.DualDuctMixConInletSensor.Subsequences.Alarms Buildings.Controls.OBC.ASHRAE.G36.TerminalUnits.DualDuctSnapActing.Subsequences.Alarms Buildings.Controls.OBC.ASHRAE.G36.TerminalUnits.ParallelFanCVF.Subsequences.Alarms Buildings.Controls.OBC.ASHRAE.G36.TerminalUnits.ParallelFanVVF.Subsequences.Alarms Buildings.Controls.OBC.ASHRAE.G36.TerminalUnits.Reheat.Subsequences.Alarms Buildings.Controls.OBC.ASHRAE.G36.TerminalUnits.SeriesFanCVF.Subsequences.Alarms Buildings.Controls.OBC.ASHRAE.G36.TerminalUnits.SeriesFanVVF.Subsequences.Alarms	Added delay triggering alarms after enabling AHU supply fan, to allow the system becoming stablized. This is for issue 3257.
Buildings.Experimental.DHC.Plants.Cooling
Buildings.Experimental.DHC.Plants.Cooling.Controls.ChilledWaterPumpSpeed	Set `final totPum.nin = numPum` so that this block is restricted to a two-pump configuration as intended. Also corrected the "up to two pumps" language in documentation. This is for issue 3470.
Buildings.ThermalZones.Detailed.Validation.BESTEST
Buildings.ThermalZones.Detailed.Validation.BESTEST.UsersGuide Buildings.ThermalZones.Detailed.Validation.BESTEST.Cases6xx Buildings.ThermalZones.Detailed.Validation.BESTEST.Cases9xx	Added test acceptance criteria limits. This is for issue 3396.
Buildings.Controls.OBC.Utilities
Buildings.Controls.OBC.Utilities.PIDWithInputGains	Correted the instance `antWinGai2` to be conditional. This is for #3423.
Buildings.BoundaryConditions.WeatherData
Buildings.BoundaryConditions.WeatherData.ReaderTMY3	Improved error message in Java application that converts weather file. This is for #3380.
Buildings.Controls.OBC.ASHRAE.G36.AHUs
Buildings.Controls.OBC.ASHRAE.G36.AHUs.MultiZone.VAV.SetPoints.FreezeProtection Buildings.Controls.OBC.ASHRAE.G36.AHUs.SingleZone.VAV.SetPoints.FreezeProtection	Added flag to disable freeze protection. This is for #3139.
Buildings.Controls.OBC.CDL
Buildings.Controls.OBC.CDL.Reals.Switch	Added `smoothOrder(0, ...)` as this is required for some solvers that assume otherwise the output of the block to be differentiable.
Buildings.Controls.OBC.CDL.Routing.RealExtractSignal	Added assertion when the extract index is out of range. This is for #3125.
Buildings.Electrical
Buildings.Electrical.Interfaces.PartialTwoPort	Added constraining clause for terminal as models that extend from this model access a component that is not in the base class, and Optimica 1.40 issues a warning for this. This is for #3236.
Buildings.Examples.ScalableBenchmarks
Buildings.Examples.ScalableBenchmarks.BuildingVAV.Examples.OneFloor_OneZone	Changed `fan[].m_flow_nominal` from 10 to 0.1. This is for #3067
Buildings.Examples.VAVReheat
Buildings.Examples.VAVReheat.BaseClasses.Guideline36	Changed the indication of the status when window is closed. In default, it should be true (closed dry contact) rather than false. This is for #3257.
Buildings.Examples.VAVReheat.BaseClasses.PartialHVAC	Added junction to mix the return and outdoor air. Set the value of parameter `transferHeat` to true for the mixed air temperature sensor. This is for #3230.
Buildings.Examples.VAVReheat.BaseClasses.VAVReheatBox	Changed the pressure independent damper to exponential damper. This is for #3139.
Buildings.Examples.VAVReheat.BaseClasses.Controls.RoomVAV	Added flag to choose different damper type and added control for the boxes with the exponential damper. This is for #3139.
Buildings.Experimental
Buildings.Experimental.DHC.Loads.BaseClasses.Examples.BaseClasses.BuildingTimeSeries	Compute the scaling parameters based on the peak loads and revise documentation. This is for #2302.
Buildings.Experimental.DHC.Networks.Connection2Pipe	Removed renamed model redeclare to solve error and allow separate pipe declarations on sup/ret of DHC networks. This is for #2905.
Buildings.Experimental.DHC.Networks.Connection2PipePlugFlow	Fix redeclare of dis pipe models in connections. This is for #2905.
Buildings.Fluid.Actuators
Buildings.Fluid.Actuators.BaseClasses.PartialThreeWayValve	Removed start value for `dp`. This is for #3231.
Buildings.Fluid.BaseClasses
Buildings.Fluid.BaseClasses.MassFlowRateMultiplier	Added option to use input connector as multiplier factor. This is for IBPSA, #1684.
Buildings.Fluid.Interfaces.ConservationEquation Buildings.Fluid.Interfaces.StaticTwoPortConservationEquation Buildings.Fluid.MixingVolumes.MixingVolume Buildings.Fluid.MixingVolumes.MixingVolume.MoistAir Buildings.Fluid.Sensors.TemperatureWetBulbTwoPort	Improved implementation so that models also work with certain media from the Modelica Standard Library that may be used to model combustion gases. This is for IBPSA, #1650.
Buildings.Fluid.Chillers
Buildings.Fluid.Chillers.BaseClasses.PartialElectric	Added optional switchover mode for heat recovery chillers. This is for #3211.
Buildings.Fluid.Chillers.BaseClasses.Carnot	Changed parameter binding `etaCarnot_nominal(unit="1") = COP_nominal/(TUseAct_nominal/(TCon_nominal+TAppCon_nominal - (TEva_nominal-TAppEva_nominal)))` to `etaCarnot_nominal(unit="1") = 0.3` to avoid a circular assignment. Improved documentation. This is for #3226.
Buildings.Fluid.Geothermal
Buildings.Fluid.Geothermal.Borefields.OneUTube Buildings.Fluid.Geothermal.Borefields.TwoUTubes	Enabled calculation of bore fields with hundreds of bore holes. This is accomplished by updating the calculation of the ground temperature response in the model `Buildings.Fluid.Geothermal.Borefields.BaseClasses.HeatTransfer.GroundTemperatureResponse` using clustering of bore holes as described in doi:10.1080/19401493.2021.1968953. This is for IBPSA, #1577.
Buildings.Fluid.HeatExchangers
Buildings.Fluid.HeatExchangers.WetCoilEffectivenessNTU Buildings.Fluid.HeatExchangers.BaseClasses.PartialEffectivenessNTU	Set `flowRegime` to be equal to `flowRegime_nominal` by default. Added an assertion warning to inform the user about how to change this behaviour if the flow direction does need to change. This is for IBPSA, #1682.
Buildings.Fluid.Movers
Buildings.Fluid.Movers.FlowControlled_dp Buildings.Fluid.Movers.FlowControlled_m_flow Buildings.Fluid.Movers.SpeedControlled_y	Avoided negative flow work if the flow or pressure is forced in a way that the flow work would be negative. This is for IBPSA, #1621.
Buildings.Fluid.Movers.FlowControlled_dp Buildings.Fluid.Movers.FlowControlled_m_flow Buildings.Fluid.Movers.SpeedControlled_y Buildings.Fluid.Movers.Preconfigured.SpeedControlled_y Buildings.Fluid.Movers.BaseClasses.PartialFlowMachine	Changed the way the nominal flow rate is declared so that it can be modified in `PartialFlowMachine` by a higher-level model, but not the other way around. This is for IBPSA, #1705.
Buildings.Fluid.Sources
Buildings.Controls.OBC.ASHRAE.G36_PR1.AHUs.MultiZone.VAV.SetPoints.OutdoorAirFlow.AHU	Replaced hysteresis with `max` function to avoid chattering when the fan switches on. This is for #3106.
Buildings.HeatTransfer.Windows
Buildings.Controls.OBC.ASHRAE.G36_PR1.AHUs.MultiZone.VAV.SetPoints.OutdoorAirFlow.AHU	Replaced hysteresis with `max` function to avoid chattering when the fan switches on. This is for #3106.
Buildings.HeatTransfer.Windows
Buildings.Fluid.Sources.BaseClasses.Outside Buildings.Fluid.Sources.MassFlowSource_WeatherData	Changed base class to constrain medium to moist air. This is for IBPSA, #1681.
Buildings.HeatTransfer.Windows
Buildings.HeatTransfer.Windows.Functions.glassTRExteriorIrradiationNoShading Buildings.HeatTransfer.Windows.Functions.glassTRInteriorIrradiationNoShading	Added default value for output variables. This is for #3111.
Buildings.Media
Buildings.Media.Examples.BaseClasses.PartialProperties	Removed a self-dependent default binding of a function input. This is for #3384.
Buildings.Media.Steam	Changed the variable type definition of `pHat` and `THat` from absolute to `Modelica.Units.SI.PressureDifference` and `Modelica.Units.SI.TemperatureDifference` to prevent min/max assertion erros during initilization. This is for #2905. In function `rho_pT`, created and used new function extending `Modelica.Media.Water.IF97_Utilities.BaseIF97.Basic.g2` with an annotation `smoothOrder=2`. This is to specifcally pass on the `smoothOrder=2` annotion placed on `rho_pT` to the `g2` function. This is for #2905.
Buildings.Obsolete.Controls.OBC.ASHRAE.G36_PR1
Buildings.Obsolete.Controls.OBC.ASHRAE.G36_PR1.AHUs.MultiZone.VAV.SetPoints.OutdoorAirFlow.AHU	Replaced hysteresis with `max` function to avoid chattering when the fan switches on. This is for #3106.
Buildings.ThermalZones.EnergyPlus_9_6_0.Examples.SingleFamilyHouse
Buildings.ThermalZones.EnergyPlus_9_6_0.Examples.SingleFamilyHouse.RadiantHeatingCooling_TRoom Buildings.ThermalZones.EnergyPlus_9_6_0.Examples.SingleFamilyHouse.RadiantHeatingCooling_TSurface Buildings.ThermalZones.EnergyPlus_9_6_0.Examples.SingleFamilyHouse.HeatPumpRadiantHeatingGroundHeatTransfer	Changed pipe spacing and insulation of radiant slab.
Buildings.ThermalZones.ReducedOrder
Buildings.ThermalZones.ReducedOrder.SolarGain.CorrectionGDoublePane	Corrected units of protected variables to avoid warning during model check. This is for IBPSA, issue #1644.
Buildings.Utilities.Math
Buildings.Utilities.Math.Functions.regNonZeroPower	Improved documentation and assertion. This is for Buildings, issue #3135.
Buildings.Utilities.Math.Functions.spliceFunction Buildings.Utilities.Math.Functions.BaseClasses.der_spliceFunction	Improved implementation of transition limits. This is for IBPSA, issue #1640.

The following existing components have been improved in a non-backward compatible way:

Buildings.Controls.OBC.ASHRAE.G36.TerminalUnits
Buildings.Controls.OBC.ASHRAE.G36.TerminalUnits.CoolingOnly.Subsequences.Alarms Buildings.Controls.OBC.ASHRAE.G36.TerminalUnits.DualDuctColdDuctMin.Subsequences.Alarms Buildings.Controls.OBC.ASHRAE.G36.TerminalUnits.DualDuctMixConDischargeSensor.Subsequences.Alarms Buildings.Controls.OBC.ASHRAE.G36.TerminalUnits.DualDuctMixConInletSensor.Subsequences.Alarms Buildings.Controls.OBC.ASHRAE.G36.TerminalUnits.DualDuctSnapActing.Subsequences.Alarms Buildings.Controls.OBC.ASHRAE.G36.TerminalUnits.ParallelFanCVF.Subsequences.Alarms Buildings.Controls.OBC.ASHRAE.G36.TerminalUnits.ParallelFanVVF.Subsequences.Alarms Buildings.Controls.OBC.ASHRAE.G36.TerminalUnits.Reheat.Subsequences.Alarms Buildings.Controls.OBC.ASHRAE.G36.TerminalUnits.SeriesFanCVF.Subsequences.Alarms Buildings.Controls.OBC.ASHRAE.G36.TerminalUnits.SeriesFanVVF.Subsequences.Alarms	Added zone operation mode input to limit triggering alarms only in occupied mode. This is for issue 3257.
Buildings.Controls.OBC.ASHRAE.G36.TerminalUnits.CoolingOnly.Subsequences.Dampers Buildings.Controls.OBC.ASHRAE.G36.TerminalUnits.ParallelFanCVF.Subsequences.DamperValves Buildings.Controls.OBC.ASHRAE.G36.TerminalUnits.ParallelFanVVF.Subsequences.DamperValves Buildings.Controls.OBC.ASHRAE.G36.TerminalUnits.Reheat.Subsequences.DamperValves Buildings.Controls.OBC.ASHRAE.G36.TerminalUnits.SeriesFanCVF.Subsequences.DamperValves Buildings.Controls.OBC.ASHRAE.G36.TerminalUnits.SeriesFanVVF.Subsequences.DamperValves	Added AHU supply fan status input for damper position reset. This is for issue 3257.
Buildings.Air
Buildings.Air.Systems.SingleZone.VAV.ChillerDXHeatingEconomizer	Refactored the model for issue 2668.
Buildings.Controls.OBC.ASHRAE.G36.AHUs
Buildings.Controls.OBC.ASHRAE.G36.AHUs.MultiZone.VAV.Economizers.Subsequences.Limits.SeparateWithDP Buildings.Controls.OBC.ASHRAE.G36.AHUs.SingleZone.VAV.Economizers.Subsequences.Enable Buildings.Controls.OBC.ASHRAE.G36.AHUs.SingleZone.VAV.Economizers.Subsequences.Limits	Because of the removal of `Logical.And3` based on ASHRAE 231P, replaced it with a stack of two `Logical.And` blocks. This is for #2465.
Buildings.Controls.OBC.ASHRAE.G36.TerminalUnits
Buildings.Controls.OBC.ASHRAE.G36.TerminalUnits.CoolingOnly.Subsequences.Alarms Buildings.Controls.OBC.ASHRAE.G36.TerminalUnits.DualDuctColdDuctMin.Subsequences.Alarms Buildings.Controls.OBC.ASHRAE.G36.TerminalUnits.DualDuctMixConDischargeSensor.Subsequences.Alarms Buildings.Controls.OBC.ASHRAE.G36.TerminalUnits.DualDuctMixConInletSensor.Subsequences.Alarms Buildings.Controls.OBC.ASHRAE.G36.TerminalUnits.DualDuctSnapActing.Subsequences.Alarms Buildings.Controls.OBC.ASHRAE.G36.TerminalUnits.ParallelFanCVF.Subsequences.Alarms Buildings.Controls.OBC.ASHRAE.G36.TerminalUnits.ParallelFanVVF.Subsequences.Alarms Buildings.Controls.OBC.ASHRAE.G36.TerminalUnits.Reheat.Subsequences.Alarms Buildings.Controls.OBC.ASHRAE.G36.TerminalUnits.SeriesFanCVF.Subsequences.Alarms Buildings.Controls.OBC.ASHRAE.G36.TerminalUnits.SeriesFanVVF.Subsequences.Alarms	Because of the removal of `Logical.And3` based on ASHRAE 231P, replaced it with a stack of two `Logical.And` blocks. This is for #2465.
Buildings.Controls.OBC.ASHRAE.G36.TerminalUnits.CoolingOnly.Subsequences.Dampers Buildings.Controls.OBC.ASHRAE.G36.TerminalUnits.DualDuctColdDuctMin.Subsequences.Dampers Buildings.Controls.OBC.ASHRAE.G36.TerminalUnits.DualDuctMixConDischargeSensor.Subsequences.Dampers Buildings.Controls.OBC.ASHRAE.G36.TerminalUnits.DualDuctMixConInletSensor.Subsequences.Dampers Buildings.Controls.OBC.ASHRAE.G36.TerminalUnits.DualDuctSnapActing.Subsequences.DampersDualSensors Buildings.Controls.OBC.ASHRAE.G36.TerminalUnits.DualDuctSnapActing.Subsequences.DampersSingleSensors Buildings.Controls.OBC.ASHRAE.G36.TerminalUnits.ParallelFanCVF.Subsequences.DamperValves Buildings.Controls.OBC.ASHRAE.G36.TerminalUnits.ParallelFanVVF.Subsequences.DamperValves Buildings.Controls.OBC.ASHRAE.G36.TerminalUnits.Reheat.Subsequences.DamperValves Buildings.Controls.OBC.ASHRAE.G36.TerminalUnits.SeriesFanCVF.Subsequences.DamperValves Buildings.Controls.OBC.ASHRAE.G36.TerminalUnits.SeriesFanVVF.Subsequences.DamperValves	Removed the parameter `have_preIndDam` to exclude the option of using pressure independant damper. This is for #3139.
Buildings.Controls.OBC.ASHRAE.G36.Types
Buildings.Controls.OBC.ASHRAE.G36.Types.BuildingPressureControlTypes	Removed the option of using return fan with tracking calculated supply and return airflow. This is for #3139.
Buildings.Controls.OBC.ASHRAE.G36.Types.OutdoorAirSection	Removed the no-economizer option. This is for #3139.
Buildings.Controls.OBC.CDL
Buildings.Controls.OBC.CDL.Continuous	Renamed package `Continuous` to `Reals` due to changes in ASHRAE Standard 231P. This is for #3483. This change is supported in the conversion script.
Buildings.Controls.OBC.CDL.Logical.And3 Buildings.Controls.OBC.CDL.Logical.Validation.And3	Moved to the `Obsolete` package based on ASHRAE 231P. This is for #2465.
Buildings.Controls.OBC.CDL.Reals.Acos Buildings.Controls.OBC.CDL.Reals.Asin Buildings.Controls.OBC.CDL.Reals.Atan Buildings.Controls.OBC.CDL.Reals.Atan2	Added unit `rad` to the output. This is for #3277.
Buildings.Controls.OBC.CDL.Reals.Cos Buildings.Controls.OBC.CDL.Reals.Sin Buildings.Controls.OBC.CDL.Reals.Tan	Added unit `rad` to the input. This is for #3277.
Buildings.Controls.OBC.CDL.Routing.RealExtractor	Removed parameter `allowOutOfRange` and `outOfRangeValue` and output the element with the nearest valid index when the index input is out of range. This is for #3125. This change is supported in the conversion script.
Buildings.Examples
Buildings.Examples.DualFanDualDuct.ClosedLoop Buildings.Examples.HydronicHeating.TwoRoomsWithStorage Buildings.Examples.ScalableBenchmarks.BuildingVAV.Examples.OneFloor_OneZone Buildings.Examples.VAVReheat.BaseClasses.PartialHVAC	Replaced fan and pump models that have simple two-point pressure curve assignments with preconfigured models. This is for #2668.
Buildings.Examples.HydronicHeating.TwoRoomsWithStorage	Changed control that enables the heating system.
Buildings.Experimental.DHC.Plants
Buildings.Experimental.DHC.Plants.Combined.Controls.BaseClasses.ModeCondenserLoop	Because of the removal of `Logical.And3` based on ASHRAE 231P, replaced it with a stack of two `Logical.And` blocks. This is for #2465.
Buildings.Experimental.DHC.Loads
Buildings.Experimental.DHC.Loads.BaseClasses.FlowDistribution Buildings.Experimental.DHC.Loads.BaseClasses.Validation.FlowDistributionPumpControl	Swapped the pump models for preconfigured versions. This is for #3099.
Buildings.Fluid.DXCoils
Buildings.Fluid.DXCoils.AirCooled Buildings.Fluid.DXCoils.WaterCooled	Renamed packages to `AirSource` and `WaterSource` as DX coils for heating are added, and hence cooled is not an appropriate package name. This is for issue 3288.
Buildings.Fluid.Examples
Buildings.Fluid.Examples.SimpleHouse	Changed `conDam.yMin` from 0.1 to 0.25. This is for IBPSA, #1624.
Buildings.Fluid.Movers
Buildings.Fluid.Movers.BaseClasses.PartialFlowMachine	Removed the block that was used to support fan or pump models with an rpm input. This is for IBPSA, issue 1704.
Buildings.Fluid.Movers.BaseClasses.PartialFlowMachine Buildings.Fluid.Movers.Data.Generic Buildings.Fluid.Movers.Data.Fans.Greenheck.BIDW12 Buildings.Fluid.Movers.Data.Fans.Greenheck.BIDW13 Buildings.Fluid.Movers.Data.Fans.Greenheck.BIDW15 Buildings.Fluid.Movers.Data.Fans.Greenheck.BIDW16 Buildings.Fluid.Movers.Data.Fans.Greenheck.BIDW18 Buildings.Fluid.Movers.Data.Pumps.Wilo.CronolineIL80slash220dash4slash4 Buildings.Fluid.Movers.Data.Pumps.Wilo.Stratos25slash1to4 Buildings.Fluid.Movers.Data.Pumps.Wilo.Stratos25slash1to6 Buildings.Fluid.Movers.Data.Pumps.Wilo.Stratos25slash1to8 Buildings.Fluid.Movers.Data.Pumps.Wilo.Stratos30slash1to4 Buildings.Fluid.Movers.Data.Pumps.Wilo.Stratos30slash1to8 Buildings.Fluid.Movers.Data.Pumps.Wilo.Stratos32slash1to12 Buildings.Fluid.Movers.Data.Pumps.Wilo.Stratos40slash1to12 Buildings.Fluid.Movers.Data.Pumps.Wilo.Stratos40slash1to8 Buildings.Fluid.Movers.Data.Pumps.Wilo.Stratos50slash1to12 Buildings.Fluid.Movers.Data.Pumps.Wilo.Stratos80slash1to12 Buildings.Fluid.Movers.Data.Pumps.Wilo.TopS25slash10 Buildings.Fluid.Movers.Data.Pumps.Wilo.TopS30slash10 Buildings.Fluid.Movers.Data.Pumps.Wilo.TopS30slash5 Buildings.Fluid.Movers.Data.Pumps.Wilo.TopS40slash10 Buildings.Fluid.Movers.Data.Pumps.Wilo.TopS40slash7 Buildings.Fluid.Movers.Data.Pumps.Wilo.VeroLine50slash150dash4slash2 Buildings.Fluid.Movers.Data.Pumps.Wilo.VeroLine80slash115dash2comma2slash2 Buildings.Fluid.Movers.Examples.MoverContinuous Buildings.Fluid.Movers.Examples.MoverParameter Buildings.Fluid.Movers.Examples.MoverStages Buildings.Fluid.Movers.Preconfigured.Validation.ControlledFlowMachinePreconfigured Buildings.Fluid.Movers.SpeedControlled_y Buildings.Fluid.Movers.Validation.BaseClasses.ControlledFlowMachine Buildings.Fluid.Movers.Validation.BaseClasses.FlowMachine_ZeroFlow Buildings.Fluid.Movers.Validation.ControlledFlowMachine Buildings.Fluid.Movers.Validation.ControlledFlowMachineDynamic Buildings.Fluid.Movers.Validation.PowerSimplified Buildings.Fluid.Movers.Validation.PumpCurveDerivatives Buildings.Fluid.Movers.Validation.Pump_stratos Buildings.Fluid.Movers.Validation.Pump_y_stratos	Removed or replaced parameters, blocks, and components that were used to support fan or pump models with an rpm input. This is for IBPSA, issue 1704.
Buildings.Fluid.Movers.Preconfigured.SpeedControlled_Nrpm Buildings.Fluid.Movers.SpeedControlled_Nrpm Buildings.Fluid.Movers.Validation.SpeedControlled_Nrpm	Moved to the `Obsolete` package. This is for IBPSA, issue 1704.
Buildings.Fluid.Movers.BaseClasses.FlowMachineInterface Buildings.Fluid.Movers.BaseClasses.PowerInterface Buildings.Fluid.Movers.BaseClasses.Types	Added computation paths for power and efficiency variables for the Euler number or as a function of part load ratio. This is for issue 2668.
Buildings.Fluid.Movers.BaseClasses.Validation.NegativePressureOrFlow	Remade this model with Buildings.Fluid.Movers.BaseClasses.FlowMachineInterface instead of using a full mover model so that forcing a flow rate and a pressure rise is more straightforward. This is for issue 2668.
Buildings.Fluid.Movers.Data.Generic Buildings.Fluid.Movers.BaseClasses.FlowMachineInterface Buildings.Fluid.Movers.BaseClasses.PartialFlowMachine Buildings.Fluid.Movers.BaseClasses.Validation.FlowMachineInterface	Moved the assignment of `V_flow_max` and `haveVMax` from `Buildings.Fluid.Movers.BaseClasses.PartialFlowMachine` to lower-level models. This is for issue 2668.
Buildings.Fluid.Movers.FlowControlled_dp Buildings.Fluid.Movers.FlowControlled_m_flow Buildings.Fluid.Movers.SpeedControlled_y Buildings.Fluid.Movers.Data.Generic Buildings.Fluid.Movers.Data.Pumps.Wilo.CronolineIL80slash220dash4slash4 Buildings.Fluid.Movers.Data.Pumps.Wilo.Stratos25slash1to4 Buildings.Fluid.Movers.Data.Pumps.Wilo.Stratos25slash1to6 Buildings.Fluid.Movers.Data.Pumps.Wilo.Stratos25slash1to8 Buildings.Fluid.Movers.Data.Pumps.Wilo.Stratos30slash1to4 Buildings.Fluid.Movers.Data.Pumps.Wilo.Stratos30slash1to8 Buildings.Fluid.Movers.Data.Pumps.Wilo.Stratos32slash1to12 Buildings.Fluid.Movers.Data.Pumps.Wilo.Stratos40slash1to12 Buildings.Fluid.Movers.Data.Pumps.Wilo.Stratos40slash1to8 Buildings.Fluid.Movers.Data.Pumps.Wilo.Stratos50slash1to12 Buildings.Fluid.Movers.Data.Pumps.Wilo.Stratos80slash1to12 Buildings.Fluid.Movers.Data.Pumps.Wilo.TopS25slash10 Buildings.Fluid.Movers.Data.Pumps.Wilo.TopS30slash10 Buildings.Fluid.Movers.Data.Pumps.Wilo.TopS30slash5 Buildings.Fluid.Movers.Data.Pumps.Wilo.TopS40slash10 Buildings.Fluid.Movers.Data.Pumps.Wilo.TopS40slash7 Buildings.Fluid.Movers.Data.Pumps.Wilo.VeroLine50slash150dash4slash2 Buildings.Fluid.Movers.Data.Pumps.Wilo.VeroLine80slash115dash2comma2slash2 Buildings.Fluid.Movers.Validation.PowerSimplified Buildings.Fluid.Movers.BaseClasses.FlowMachineInterface	Refactored the models and data recoreds for issue 2668.
Buildings.Fluid.Movers.FlowControlled_m_flow	Added assertion to avoid using the model with a head that is significantly higher than the head specified by its performance curve. This is for IBPSA, #1659.
Buildings.Fluid.SolarCollectors
Buildings.Fluid.SolarCollectors.Controls.CollectorPump	Corrected implementation to make comparison based on total irradiation on tilted surface rather than the direct normal irradiation. This required adding parameters for the azimuth, tilt and ground reflectance. Added hysteresis to the controller, and changed output signal to be boolean-valued on/off rather than a continuous signal. Moved the old implementation to `Buildings.Obsolete.Fluid.SolarCollectors.Controls`. This is for #3074.
Buildings.ThermalZones.EnergyPlus_9_6_0.Examples.SingleFamilyHouse
Buildings.ThermalZones.EnergyPlus_9_6_0.Examples.SingleFamilyHouse.HeatPumpRadiantHeatingGroundHeatTransfer	Replaced ideal heater with a geothermal heat pump.
Buildings.Obsolete
Buildings.Obsolete.DistrictHeatingCooling	Removed package which is no longer supported.
Buildings.Utilities.Plotters
Buildings.Utilities.Plotters.Examples.BaseClasses.CoolingCoilValve	Because of the removal of `Logical.And3` based on ASHRAE 231P, replaced it with a stack of two `Logical.And` blocks. This is for #2465.

The following critical errors have been fixed (i.e., errors that can lead to wrong simulation results):

Buildings.Controls.OBC
Buildings.Controls.OBC.ASHRAE.G36_PR1.Generic.SetPoints.OperationMode	Corrected input for enabling freeze protection setback mode. This is for issue 3084.
Buildings.Controls.OBC.CDL
Buildings.Controls.OBC.CDL.Reals.Sources.CalendarTime	Refactored implementation to avoid wrong day number due to rounding errors that caused simultaneous events to not be triggered at the same time. This is for issue 3199.
Buildings.Electrical.DC
Buildings.Electrical.DC.Storage.BaseClasses.Charge	Corrected calculation of power taken from the battery when it is discharged. This is for issue 3095.
Buildings.Examples
Buildings.Examples.HydronicHeating.TwoRoomsWithStorage	Corrected outdoor temperature in instance `TOutSwi` at which system switches on and off. This is for issue 3059.
Buildings.Experimental
Buildings.Experimental.DHC.EnergyTransferStations.Combined.HeatPumpHeatExchanger	Assigned dp_nominal to `pum1HexChi`. Corrected calculation of heat pump evaporator mass flow control. This is for issue 3379.
Buildings.Experimental.DHC.EnergyTransferStations.Combined.Subsystems.HeatPump	Assigned dp_nominal to condenser pump. This is for issue 3379.
Buildings.Experimental.DHC.EnergyTransferStations.Cooling.Indirect	Fixed building supply temperature controller parameter `reverseActing` by changing from `true` to `false`. This is for issue 3299.
Buildings.Experimental.DHC.EnergyTransferStations.Cooling.Direct	Removed assignment of check valve `allowFlowReversal=false`. This is for #3389.
Buildings.Experimental.DHC.Loads.BaseClasses.Examples.BaseClasses.BuildingTimeSeries	Applied `facMul` to domestic hot water load. This is for issue 3379.
Buildings.Fluid.HeatExchangers
Buildings.Fluid.HeatExchangers.BaseClasses.PartialEffectivenessNTU	Corrected wrong temperature in assignment of `sta2_default`. For `Buildings.Media.Air` and `Buildings.Media.Water` this error does not affect the results. This is for Buildings, issue 3151
Buildings.Fluid.DXSystems.AirCooled.MultiStage Buildings.Fluid.DXSystems.AirCooled.SingleStage Buildings.Fluid.DXSystems.AirCooled.VariableSpeed Buildings.Fluid.DXSystems.WaterCooled.MultiStage Buildings.Fluid.DXSystems.WaterCooled.SingleStage Buildings.Fluid.DXSystems.WaterCooled.VariableSpeed Buildings.Fluid.DXSystems.Cooling.BaseClasses.CapacityWaterCooled Buildings.Fluid.DXSystems.BaseClasses.PartialCoolingCapacity	Corrected performance calculation as a function of mass flow rates. This is for #3146.
Buildings.Fluid.HeatExchangers.WetCoilCounterFlow Buildings.Fluid.HeatExchangers.WetCoilDiscretized	Reverted the correction on latent heat from component. This is for #3065.
Buildings.Fluid.HeatExchangers.Validation.WetCoilCounterFlowLowWaterFlowRate	Modify air source boundary condition so air enters coil at 99.5% relative humidity. This is for #3065.
Buildings.Utilities.Time
Buildings.Utilities.Time.CalendarTime	Refactored implementation to avoid wrong day number due to rounding errors that caused simultaneous events to not be triggered at the same time. This is for issue 3199.

The following uncritical errors have been fixed (i.e., errors that do not lead to wrong simulation results, e.g., units are wrong or errors in documentation):

Buildings.Fluid.HeatExchangers
Buildings.Fluid.DXSystems.Cooling.BaseClasses.Evaporation	Corrected assertion for the condition `dX_nominal<0` and the documentation. This is for issue 3322.

Extends from Modelica.Icons.ReleaseNotes (Icon for release notes in documentation).

Modelica definition

class Version_10_0_0 "Version 10.0.0" extends Modelica.Icons.ReleaseNotes; end Version_10_0_0;

Buildings.UsersGuide.ReleaseNotes.Version_9_1_1

Version 9.1.1

Information

Version 9.1.1 is backward compatible with 9.1.0, except that the Spawn binaries need to be updated as described in Buildings.ThermalZones.EnergyPlus_9_6_0.UsersGuide.Installation.

The library has been tested with Dymola 2023x, OpenModelica 1.22.0-dev (41-g8a5b18f-1), OPTIMICA 1.43.4 and recent versions of Impact.

The Spawn binaries have been updated from version 0.3.0 to 0.4.3. Both use the same EnergyPlus input data files from EnergyPlus 9.6.0. The update corrects a bug that caused EnergyPlus to always send a heat capacitance multiplier of 1 to Modelica (see #3481).

The following new components have been added to existing libraries:

Buildings.BoundaryConditions.WeatherData
Buildings.BoundaryConditions.WeatherData.BaseClasses.PartialConvertTime	Added model to be extended in solar models that need calendar year for calculation. See IBPSA, #1716.

The following existing components have been improved in a backward compatible way:

Buildings.Controls.OBC.Utilities
Buildings.Controls.OBC.Utilities.PIDWithInputGains	Corrected the instance `antWinGai2` to be conditional. This is for #3423.
Buildings.BoundaryConditions
Buildings/BoundaryConditions/SolarGeometry/BaseClasses/Declination.mo Buildings/BoundaryConditions/SolarIrradiation/BaseClasses/SkyClearness.mo Buildings/BoundaryConditions/WeatherData/BaseClasses/ConvertTime.mo Buildings/BoundaryConditions/WeatherData/BaseClasses/EquationOfTime.mo Buildings/BoundaryConditions/WeatherData/BaseClasses/LocalCivilTime.mo	Updated radiation models to use calendar time instead of simulation time. See IBPSA, #1716.
Buildings.Controls.OBC.CDL
Buildings.Controls.OBC.CDL.Psychrometrics.WetBulb_TDryBulPhi	Added a constant in order for unit check to pass. See IBPSA, #1711.
Buildings.Controls.OBC.CDL.Continuous.Validation.MovingAverage Buildings.Controls.OBC.CDL.Utilities.Validation.SunRiseSet Buildings.Controls.OBC.CDL.Utilities.Validation.SunRiseSetNegativeStartTime Buildings.Controls.OBC.CDL.Utilities.Validation.SunRiseSetPositiveStartTime	Changed models to comply with CDL specifications. This is for #3301.
Buildings.Electrical
Buildings.Electrical.Interfaces.PartialTwoPort	Added constraining clause for terminal as models that extend from this model access a component that is not in the base class, and Optimica 1.40 issues a warning for this. This is for #3236.
Buildings.Fluid
Buildings.Fluid.Examples.Performance.Example5 Buildings.Fluid.Examples.Performance.Example6 Buildings.Fluid.Examples.Performance.Example7 Buildings.Fluid.Examples.Performance.Example8	Added a constant in order for unit check to pass. See IBPSA, #1711.
Buildings.Fluid.Geothermal.Borefields.BaseClasses.Boreholes.BaseClasses.Functions.convectionResistanceCircularPipe Buildings.Fluid.Geothermal.Borefields.BaseClasses.Boreholes.BaseClasses.Functions.partialInternalResistances	Corrected variability of assignment to comply with the Modelica Language Definition. See IBPSA, #1762.
Buildings.Fluid.HeatExchangers.BaseClasses.Examples.EpsilonNTUZ	Added a constant in order for unit check to pass. See IBPSA, #1711.
Buildings.Media
Buildings.Media.Examples.BaseClasses.PartialProperties	Removed a self-dependent default binding of a function input. This is for #3384.
Buildings.Utilities
Buildings.Utilities.Plotters.Examples.Scatter Buildings.Utilities.Plotters.Examples.TimeSeries Buildings.Utilities.Psychrometrics.TWetBul_TDryBulPhi Buildings.Utilities.Psychrometrics.TWetBul_TDryBulXi	Added a constant in order for unit check to pass. See IBPSA, #1711.

The following critical errors have been fixed (i.e., errors that can lead to wrong simulation results):

Buildings.Controls.OBC.CDL
Buildings.Controls.OBC.CDL.Continuous.Sources.CalendarTime	Refactored implementation to avoid wrong day number due to rounding errors that caused simultaneous events to not be triggered at the same time. This is for issue 3199.
Buildings.Fluid.HeatExchangers
Buildings.Fluid.HeatExchangers.DryCoilDiscretized	Corrected the modification of `hexReg[nReg].m2_flow_nominal`. This is for #3441.
Buildings.ThermalZones.EnergyPlus_9_6_0
Buildings.ThermalZones.EnergyPlus_9_6_0.ThermalZone	Corrected bug that caused EnergyPlus to always send 1 for the heat capacitance multiplier. This is for #3481.
Buildings.Utilities.Time
Buildings.Utilities.Time.CalendarTime	Refactored implementation to avoid wrong day number due to rounding errors that caused simultaneous events to not be triggered at the same time. This is for issue 3199.

The following uncritical errors have been fixed (i.e., errors that do not lead to wrong simulation results, e.g., units are wrong or errors in documentation):

Buildings.Fluid.FMI
Buildings.Fluid.FMI.Adaptors.Outlet	Corrected dimension of `X` in function call, which caused the model to not translate with some tools if the media has only one component such as water. IBPSA, #1768.
Buildings.Fluid.HeatExchangers
Buildings.Fluid.HeatExchangers.DXCoils.BaseClasses.Evaporation	Corrected assertion for the condition `dX_nominal<0` and the documentation. This is for issue 3322.

Extends from Modelica.Icons.ReleaseNotes (Icon for release notes in documentation).

Modelica definition

class Version_9_1_1 "Version 9.1.1" extends Modelica.Icons.ReleaseNotes; end Version_9_1_1;

Buildings.UsersGuide.ReleaseNotes.Version_9_1_0

Version 9.1.0

Information

Version 9.1.0 is backward compatible with 9.0.0.

The library has been tested with Dymola 2023x, OpenModelica 1.20.0-dev (314-g3033f43-1), OPTIMICA (revision 2022-05-09-master-4b0cd2bf71) and recent versions of Impact.

The following major changes have been done:

The ASHRAE Guideline 36 air-side sequences have been updated to the official release. They are in the package Buildings.Controls.OBC.ASHRAE.G36. The previous public release draft is still distributed with this version.
Various new blocks for the Control Description Language have been added to the package Buildings.Controls.OBC.CDL.
The flow rate control in various examples has been improved to avoid large pump or fan heads if the mass flow rate is prescribed rather than computed based on the pump or fan curve.
Various models have been improved for robustness, for compatibility with the Modelica.Media library, and to correct errors.

The following new libraries have been added:

Buildings.Controls.OBC
Buildings.Controls.OBC.ASHRAE.G36	Package with sequences implemented according to ASHRAE Guideline 36 official release, May 2020.

The following new components have been added to existing libraries:

Buildings.BoundaryConditions
Buildings.BoundaryConditions.SolarIrradiation.Examples.GlobalPerezTiltedSurface	Added model that outputs the global solar irradiation on a tilted surface. This is for IBPSA, #1654.
Buildings.Controls.OBC.CDL
Buildings.Controls.OBC.CDL.Routing.BooleanExtractSignal Buildings.Controls.OBC.CDL.Routing.BooleanExtractor Buildings.Controls.OBC.CDL.Routing.IntegerExtractSignal Buildings.Controls.OBC.CDL.Routing.IntegerExtractor	Added boolean and integer extract signals. This is for #3125.
Buildings.Experimental.DHC.Networks.Combined.BaseClasses
Buildings.Experimental.DHC.Networks.Combined.BaseClasses.Validation.Pipe	Test for comparing `Buildings.Experimental.DHC.Networks.Combined.BaseClasses.PipeAutosize` initialization of `dh` to `Buildings.Experimental.DHC.Networks.Combined.BaseClasses.PipeStandard`. This is for issue #2510.

The following existing components have been improved in a backward compatible way:

Buildings.Applications.DataCenter
Buildings.Applications.BaseClasses.Equipment.FlowMachine_m Buildings.Applications.BaseClasses.Equipment.FlowMachine_y Buildings.Applications.DataCenters.ChillerCooled.Equipment.BaseClasses.PartialCoolingCoilHumidifyingHeating Buildings.Applications.DataCenters.ChillerCooled.Equipment.BaseClasses.PartialHeatExchanger Buildings.Applications.DataCenters.ChillerCooled.Equipment.BaseClasses.PartialPumpParallel Buildings.Applications.DataCenters.ChillerCooled.Equipment.BaseClasses.SignalFilterParameters Buildings.Applications.DataCenters.ChillerCooled.Equipment.Validation.IntegratedPrimarySecondary Buildings.Applications.DataCenters.ChillerCooled.Examples.BaseClasses.PartialDataCenter Buildings.Applications.DataCenters.ChillerCooled.Examples.IntegratedPrimaryLoadSideEconomizer Buildings.Applications.DataCenters.ChillerCooled.Examples.IntegratedPrimarySecondaryEconomizer Buildings.Applications.DataCenters.ChillerCooled.Examples.NonIntegratedPrimarySecondaryEconomizer	Improved implementation to avoid high pressures due to pump with forced mass flow rate. This is for IBPSA, #1659.
Buildings.Controls.OBC.ASHRAE.G36_PR1
Buildings.Controls.OBC.ASHRAE.G36_PR1.AHUs.MultiZone.VAV.SetPoints.OutdoorAirFlow.AHU	Replaced hysteresis with `max` function to avoid chattering when the fan switches on. This is for #3106.
Buildings.Experimental.DHC
Buildings.Experimental.DHC.EnergyTransferStations.BaseClasses.Validation.CollectorDistributor Buildings.Experimental.DHC.EnergyTransferStations.Combined.Subsystems.HeatPump Buildings.Experimental.DHC.Examples.Combined.BaseClasses.PartialSeries Buildings.Experimental.DHC.Plants.Cooling.ElectricChillerParallel Buildings.Experimental.DHC.Plants.Cooling.Examples.ElectricChillerParallel Buildings.Experimental.DHC.Plants.Cooling.Subsystems.CoolingTowersParallel Buildings.Experimental.DHC.Plants.Cooling.Subsystems.CoolingTowersWithBypass Buildings.Experimental.DHC.Plants.Cooling.Subsystems.Examples.BaseClasses.PartialCoolingTowersSubsystem Buildings.Experimental.DHC.Plants.Cooling.Subsystems.Examples.CoolingTowersParallel	Improved implementation to avoid high pressures due to pump with forced mass flow rate. This is for IBPSA, #1659.
Buildings.Fluid
Buildings.Fluid.Actuators.BaseClasses.PartialThreeWayValve	Propagated parameter `riseTime` to valves. The value is not used as the filter is disabled, but it will show in the result file. Having a consistent value for all these parameters in the result filter helps during debugging. This is for IBPSA, #1663.
Buildings.Fluid.Geothermal.Borefields.BaseClasses.HeatTransfer.ThermalResponseFactors.gFunction	Initialized variable which otherwise lead to the simulation to fail in OpenModelica. This is for IBPSA, #1664.
Buildings.Fluid.Interfaces.ConservationEquation Buildings.Fluid.Interfaces.StaticTwoPortConservationEquation Buildings.Fluid.MixingVolumes.MixingVolume Buildings.Fluid.MixingVolumes.MixingVolume.MoistAir Buildings.Fluid.Sensors.TemperatureWetBulbTwoPort	Improved implementation so that models also work with certain media from the Modelica Standard Library that may be used to model combustion gases. This is for IBPSA, #1650.
Buildings.Fluid.Movers.FlowControlled_dp Buildings.Fluid.Movers.FlowControlled_m_flow Buildings.Fluid.Movers.SpeedControlled_Nrpm Buildings.Fluid.Movers.SpeedControlled_y	Avoided negative flow work if the flow or pressure is forced in a way that the flow work would be negative. This is for IBPSA, #1621.
Buildings.HeatTransfer.Windows
Buildings.HeatTransfer.Windows.Functions.glassTRExteriorIrradiationNoShading Buildings.HeatTransfer.Windows.Functions.glassTRInteriorIrradiationNoShading	Added default value for output variables. This is for #3111.
Buildings.Utilities.Math.Functions.regNonZeroPower	Improved documentation and assertion. This is for Buildings, issue #3135.
Buildings.ThermalZones.ReducedOrder
Buildings.ThermalZones.ReducedOrder.SolarGain.CorrectionGDoublePane	Corrected units of protected variables to avoid warning during model check. This is for IBPSA, issue #1644.
Buildings.Utilities.Math
Buildings.Utilities.Math.Functions.spliceFunction Buildings.Utilities.Math.Functions.BaseClasses.der_spliceFunction	Improved implementation of transition limits. This is for IBPSA, issue #1640.
Buildings.Experimental.DHC.Networks.Combined.BaseClasses
Buildings.Experimental.DHC.Networks.Combined.BaseClasses.PipeAutosize	`start` attribute for parameter `dh` changed to 0.01. `min` attribute for parameter `dh` changed to 0.001. This is for issue #2510.

The following existing components have been improved in a non-backward compatible way:

Buildings.Fluid.Examples
Buildings.Fluid.Examples.SimpleHouse	Changed `conDam.yMin` from 0.1 to 0.25. This is for IBPSA, #1624.
Buildings.Examples.ScalableBenchmarks
Buildings.Examples.ScalableBenchmarks.BuildingVAV.Examples.OneFloor_OneZone	Changed `fan[].m_flow_nominal` from 10 to 0.1. This is for #3067

The following critical errors have been fixed (i.e., errors that can lead to wrong simulation results):

Buildings.Electrical.DC
Buildings.Electrical.DC.Storage.BaseClasses.Charge	Corrected calculation of power taken from the battery when it is discharged. This is for issue 3095.
Buildings.Experimental.DHC.Plants.Cooling
Buildings.Experimental.DHC.Plants.Cooling.ElectricChillerParallel	Corrected wrong assignments for chiller system `mulChiSys` which assigned chilled water to condenser water parameters and vice versa.
Buildings.Controls.OBC
Buildings.Controls.OBC.ASHRAE.G36_PR1.Generic.SetPoints.OperationMode	Corrected input for enabling freeze protection setback mode. This is for issue 3084.
Buildings.Examples
Buildings.Examples.HydronicHeating.TwoRoomsWithStorage	Corrected outdoor temperature in instance `TOutSwi` at which system switches on and off. This is for issue 3059.
Buildings.Fluid.HeatExchangers
Buildings.Fluid.HeatExchangers.BaseClasses.PartialEffectivenessNTU	Corrected wrong temperature in assignment of `sta2_default`. For `Buildings.Media.Air` and `Buildings.Media.Water` this error does not affect the results. This is for Buildings, issue 3151
Buildings.Fluid.DXSystems.AirCooled.MultiStage Buildings.Fluid.DXSystems.AirCooled.SingleStage Buildings.Fluid.DXSystems.AirCooled.VariableSpeed Buildings.Fluid.DXSystems.WaterCooled.MultiStage Buildings.Fluid.DXSystems.WaterCooled.SingleStage Buildings.Fluid.DXSystems.WaterCooled.VariableSpeed Buildings.Fluid.DXSystems.Cooling.BaseClasses.CapacityWaterCooled Buildings.Fluid.DXSystems.BaseClasses.PartialCoolingCapacity	Corrected performance calculation as a function of mass flow rates. This is for #3146.
Buildings.Fluid.HeatExchangers.WetCoilCounterFlow Buildings.Fluid.HeatExchangers.WetCoilDiscretized	Reverted the correction on latent heat from component. This is for #3065.
Buildings.Fluid.HeatExchangers.Validation.WetCoilCounterFlowLowWaterFlowRate	Modify air source boundary condition so air enters coil at 99.5% relative humidity. This is for #3065.

Extends from Modelica.Icons.ReleaseNotes (Icon for release notes in documentation).

Modelica definition

class Version_9_1_0 "Version 9.1.0" extends Modelica.Icons.ReleaseNotes; end Version_9_1_0;

Buildings.UsersGuide.ReleaseNotes.Version_9_0_0

Version 9.0.0

Information

Version 9.0.0 is a major release that updates the Modelica version from 3.2.3 to 4.0.0.

The library has been tested with Dymola 2022x, OpenModelica 1.19.0-dev (613-gd6e04c0-1), OPTIMICA (revision 2022-05-09-master-4b0cd2bf71) and recent versions of Impact.

The following major changes have been done:

The Modelica version has been updated from version 3.2.3 to 4.0.0.
Most fluid component models have been updated to remove the parameter massDynamics, which is now set to the same value as the parameter energyDynamics.
The models for coupling with EnergyPlus have been moved to the package Buildings.ThermalZones.EnergyPlus_9_6_0 to allow support for more than one EnergyPlus version in future releases.
The BESTEST validation in the package Buildings.ThermalZones.Detailed.Validation.BESTEST has been updated to the latest BESTEST version, and new tests have been added.
The package Buildings.Fluid.Geothermal.BuriedPipes has been added to model heat transfer between buried pipes and the ground, such as for district energy systems.
The package Buildings.Media.Steam for modeling steam has been added.
Various new models have been added to the package Buildings.Airflow.Multizone for modeling multizone air exchange.
Models for ice tanks have been added to the package Buildings.Fluid.Storage.Ice.
Various models, such as for PV, solar collectors and thermal zones have been improved to obtain the latitude of the building from the weather data bus, rather than requiring the user to specify it.
The run-time coupling with Python has been updated to Python version 3.8, and it has been renamed to Buildings.Utilities.IO.Python_3_8.
Various other models have been improved or added, in particular for modeling of control sequences using the Control Description Language that has been developed in the OpenBuildingControl project at https://obc.lbl.gov.

The following new libraries have been added:

Buildings.Fluid.Geothermal
Buildings.Fluid.Geothermal.BuriedPipes	Package with models for modeling thermal coupling between buried pipes and ground.
Buildings.Media
Buildings.Media.Steam	Package with medium model for steam heating applications.

The following new components have been added to existing libraries:

Buildings.ThermalZones.Detailed.Validation.BESTEST
Buildings.ThermalZones.Detailed.Validation.BESTEST.Case660 Buildings.ThermalZones.Detailed.Validation.BESTEST.Case670 Buildings.ThermalZones.Detailed.Validation.BESTEST.Case680 Buildings.ThermalZones.Detailed.Validation.BESTEST.Case680FF Buildings.ThermalZones.Detailed.Validation.BESTEST.Case685 Buildings.ThermalZones.Detailed.Validation.BESTEST.Case695 Buildings.ThermalZones.Detailed.Validation.BESTEST.Case910 Buildings.ThermalZones.Detailed.Validation.BESTEST.Case930 Buildings.ThermalZones.Detailed.Validation.BESTEST.Case980 Buildings.ThermalZones.Detailed.Validation.BESTEST.Case980FF Buildings.ThermalZones.Detailed.Validation.BESTEST.Case985 Buildings.ThermalZones.Detailed.Validation.BESTEST.Case995	Added new test cases based on the ASHRAE 140-2020. This is for #3005.
Buildings.Air
Buildings.Air.Systems.SingleZone.VAV.Examples.OptimalStart	Added example models for the use of the block optimal start controller. This is for #2126.
Buildings.Airflow.Multizone
Buildings.Airflow.Multizone.Coefficient_V_flow Buildings.Airflow.Multizone.Coefficient_m_flow Buildings.Airflow.Multizone.Point_m_flow Buildings.Airflow.Multizone.Points_m_flow Buildings.Airflow.Multizone.Table_V_flow Buildings.Airflow.Multizone.Table_m_flow	Added new component models for multizone air exchange. This is for IBPSA, #1436.
Buildings.Fluid
Buildings.Fluid.FixedResistances.PlugFlowPipeDiscretized	Added model for multiple plug flow pipes in series, which can be used to vary boundary conditions over the length of a pipe.
Buildings.Fluid.Sources.Outside_CpData	Added new component model that allows specifying a wind pressure profile for an exterior construction. This is for IBPSA, #1436.
Buildings.Controls.OBC
Buildings.Controls.OBC.ASHRAE.G36_PR1.Generic.SetPoints.ZoneStatusDuplicator	Block that duplicates the zone status to be connected to all zone groups. This is for issue 2544.
Buildings.Controls.OBC.CDL.Routing.BooleanVectorFilter Buildings.Controls.OBC.CDL.Routing.BooleanVectorReplicator Buildings.Controls.OBC.CDL.Routing.IntegerVectorFilter Buildings.Controls.OBC.CDL.Routing.IntegerVectorReplicator Buildings.Controls.OBC.CDL.Routing.RealVectorFilter Buildings.Controls.OBC.CDL.Routing.RealVectorReplicator	Blocks for filtering and replicating vectors of signals. This is for issue 2544.
Buildings.Controls.OBC.CDL
Buildings.Controls.OBC.CDL.Continuous.Asin Buildings.Controls.OBC.CDL.Continuous.Acos Buildings.Controls.OBC.CDL.Continuous.Subtract Buildings.Controls.OBC.CDL.Integers.Subtract	Created new blocks based on the discussion from ASHRAE Standard 231P Committee. This is for #2865.
Buildings.Controls.OBC.CDL.Continuous.Derivative	Created new block which is required for PID controller with gain scheduling. This is for #3022.
Buildings.Controls.OBC.CDL.Integers.AddParameter	Created new block based on the discussion from ASHRAE Standard 231P Committee. This is for #2876.
Buildings.Controls.OBC.RadiantSystems
Buildings.Controls.OBC.RadiantSystems.Cooling.HighMassSupplyTemperature_TSurRelHum	Added controller for radiant cooling that controls the surface temperature using constant mass flow and variable supply temperature. This is for #2823.
Buildings.Controls.OBC.Utilities
Buildings.Controls.OBC.Utilities.PIDWithInputGains	Added PID controller with anti-windup and control gains exposed as inputs. This is for #2993.
Buildings.Fluid.Storage.Ice
Buildings.Fluid.Storage.Ice.ControlledTank Buildings.Fluid.Storage.Ice.Tank	Added models for ice storage tank whose performance is characterized by performance curves. This is for #2820.

The following existing components have been improved in a backward compatible way:

Buildings.HeatTransfer
Buildings.HeatTransfer.Windows.BaseClasses.CenterOfGlass	Changed the gas layer to be conditional. This is for #3026.
Buildings.ThermalZones.Detailed.Validation.BESTEST
Buildings.ThermalZones.Detailed.Validation.BESTEST.Case600FF Buildings.ThermalZones.Detailed.Validation.BESTEST.Case640 Buildings.ThermalZones.Detailed.Validation.BESTEST.Case650 Buildings.ThermalZones.Detailed.Validation.BESTEST.Case650FF Buildings.ThermalZones.Detailed.Validation.BESTEST.Case950 Buildings.ThermalZones.Detailed.Validation.BESTEST.Case950FF	Updated the test cases based on the ASHRAE 140-2020. This is for #3005.
Buildings.Applications.DataCenters
Buildings.Applications.DataCenters.ChillerCooled.Equipment.BaseClasses.AHUParameters Buildings.Applications.DataCenters.ChillerCooled.Equipment.BaseClasses.PartialCoolingCoilHumidifyingHeating	Changed cooling coil model and removed unused parameters. This is for #2549.
Buildings.BoundaryConditions
Buildings.BoundaryConditions.WeatherData.ReaderTMY3	The weather data reader is now reading the altitude above sea level from the weather data file. This new version also outputs this altitude and the latitude of the location on the weather data bus. This is for IBPSA, #1477.
Buildings.Controls.Continuous
Buildings.Controls.Continuous.SignalRanker	Changed implementation to use sort function from Modelica Standard Library, and updated its example to avoid simultaneous state and time events. This is for IBPSA, #1534.
Buildings.Controls.OBC.ASHRAE
Buildings.Controls.OBC.ASHRAE.G36_PR1.Generic.SetPoints.GroupStatus	Added filters to select which zones are used in group. This is for # 2544.
Buildings.Controls.OBC.CDL
Buildings.Controls.OBC.CDL.Continuous.Sources.CalendarTime	Increased number of years that block will output the calendar time. This is for issue 2942.
Buildings.Controls.OBC.CDL.Conversions.BooleanToInteger Buildings.Controls.OBC.CDL.Conversions.BooleanToReal	Corrected documentation texts where the variables were described with wrong types. This is for issue 3016.
Buildings.Controls.OBC.CDL.Discrete.TriggeredMovingMean	Added missing `discrete` keyword to sampled variable. This is for issue 2942.
Buildings.Controls.OBC.CDL.Utilities.SunRiseSet	Changed implementation to avoid NaN in OpenModelica. This is for issue 2835.
Buildings.Electrical.AC.ThreePhasesUnbalanced
Buildings.Electrical.AC.ThreePhasesUnbalanced.Lines.Line Buildings.Electrical.AC.ThreePhasesUnbalanced.Lines.Line_N Buildings.Electrical.AC.ThreePhasesUnbalanced.Lines.TwoPortMatrixRLC Buildings.Electrical.AC.ThreePhasesUnbalanced.Lines.TwoPortMatrixRLC_N Buildings.Electrical.AC.ThreePhasesUnbalanced.Lines.TwoPortMatrixRL_N Buildings.Electrical.AC.ThreePhasesUnbalanced.Lines.TwoPortRLC Buildings.Electrical.AC.ThreePhasesUnbalanced.Lines.TwoPortRLC_N	Set nominal attribute for voltage at terminal. This change enables Dymola 2023 beta3 to solve `Buildings.Electrical.AC.ThreePhasesUnbalanced.Validation.IEEETests.Test4NodesFeeder.UnbalancedStepDown.DY` and `Buildings.Electrical.AC.ThreePhasesUnbalanced.Validation.IEEETests.Test4NodesFeeder.UnbalancedStepUp.DD` which otherwise fail during the initialization as the homotopy steps obtain unreasonable values for the voltages.
Buildings.Fluid.Boilers
Buildings.Fluid.Boilers.Data.Lochinvar	Added annotation `defaultComponentPrefixes = "parameter"`.
Buildings.Fluid.Boilers.Polynomial	Moved part of the code to `Buildings.Fluid.Boilers.BaseClasses.PartialBoiler` to support the new model `Buildings.Fluid.Boilers.BoilerTable`. This is for # 2651.
Buildings.Fluid.HeatExchangers
Buildings.Fluid.HeatExchangers.PlateHeatExchangerEffectivenessNTU	Exposed ratio of convection coefficients, set its default values based on fluid properties and flow rates, and exposed exponents for convective heat transfer coefficients. This is for #2918.
Buildings.Fluid.HeatPumps
Buildings.Fluid.HeatPumps.Data.EquationFitReversible.Generic	Removed `protected` declaration inside the record as the Modelica Language Specification only allows public sections in a record. This is for #3009.
Buildings.Examples
Buildings.Examples.VAVReheat.Controls.DuctStaticPressureSetpoint	Removed hysteresis that disabled duct static pressure reset based on outdoor air temperature. This is for #2545.
Buildings.Examples.VAVReheat.Validation.BaseClasses.Floor	Update CO2 generation expressions. This is for #2781.
Buildings.Examples.VAVReheat.BaseClasses.Controls.FreezeStat	Added hysteresis. Without it, models can stall due to state events. This is for #2975.
Buildings.Examples.DualFanDualDuct.ClosedLoop Buildings.Examples.ScalableBenchmarks.BuildingVAV.Examples.OneFloor_OneZone Buildings.Examples.VAVReheat.BaseClasses.PartialOpenLoop	Changed cooling coil model. This is for #2549.
Buildings.Examples.Tutorial.Boiler.System7	Changed block downstream of `greThrTRoo` from `and` to `or` block. This ensures that the system is off when the outdoor air or room air is sufficiently warm.
Buildings.Examples.Tutorial.SpaceCooling.System2 Buildings.Examples.Tutorial.SpaceCooling.System3	Correct supply and return water parameterization. Use design conditions for UA parameterization in cooling coil. Use explicit calculation of sensible and latent load to determine design load on cooling coil. This is for #2624.
Buildings.Examples.ChillerPlant.BaseClasses.DataCenter	Set `nominalValuesDefaultPressureCurve=true` to avoid warnings. This is for Buildings, #2761.
Buildings.Experimental.DHC
Buildings.Experimental.DHC.Plants.Cooling	Revised the model for extensibility. This is for #2749.
Buildings.Fluid.Actuators
Buildings.Fluid.Movers.FlowControlled_dp Buildings.Fluid.Movers.FlowControlled_m_flow Buildings.Fluid.Movers.SpeedControlled_Nrpm Buildings.Fluid.Movers.SpeedControlled_y	Changed implementation of the filter. The new implementation uses a simpler model. This is for IBPSA #1498.
Buildings.Fluid.FMI
Buildings.Fluid.FMI.ExportContainers.HVACZone Buildings.Fluid.FMI.ExportContainers.HVACZones	Correct supply and return water parameterization. Use explicit calculation of sensible and latent load to determine design load on cooling coil. This is for #2624.
Buildings.Fluid.FMI.ExportContainers.Validation.RoomHVAC	Changed cooling coil model. This is for #2549. Correct supply and return water parameterization. Use explicit calculation of sensible and latent load to determine design load on cooling coil. This is for #2624.
Buildings.Fluid.HeatExchangers
Buildings.Fluid.HeatExchangers.CoolingTowers.Examples.BaseClasses.PartialStaticTwoPortCoolingTower	Added a temperature sensor for better measurement of the entering water temperature. This is for #2866.
Buildings.Media
Buildings.Media.Air	Made the `BaseProperties` replaceable. This is for IBPSA #1516.
Buildings.ThermalZones.ReducedOrder
Buildings.ThermalZones.ReducedOrder.Validation.VDI6007.BaseClasses.VerifyDifferenceThreePeriods	Improved model to guard against approximation errors of event handling. With this change, the models in `Buildings.ThermalZones.ReducedOrder.Validation.VDI6007` all simulate with OpenModelica. This is for Buidings, #2713.
Buildings.Utilities.IO
Buildings.Utilities.IO.Files.Examples.CSVReader	Updated example so it works with future versions of the Modelica Standard Library which supports reading csv files. This is for IBPSA #1572.
Buildings.Utilities.Math
Buildings.Utilities.Math.Functions.BaseClasses.der_spliceFunction	Reimplemented function to avoid a potential overflow caused by the `cosh` function. This is for IBPSA #1531.
Buildings.Experimental.DHC
Buildings.Experimental.DHC.Plants.Cooling.Subsystems.Examples.BaseClasses.PartialCoolingTowersSubsystem	Added a temperature sensor for better measurement of the entering water temperature. This is for #2866.

The following existing components have been improved in a non-backward compatible way:

Buildings.Applications
Buildings.Applications.DataCenters.ChillerCooled.Equipment.FlowMachine_y Buildings.Applications.DataCenters.ChillerCooled.Equipment.FlowMachine_m Buildings.Applications.DataCenters.ChillerCooled.Equipment.ElectricChillerParallel Buildings.Applications.DataCenters.ChillerCooled.Controls.VariableSpeedPumpStage	Moved to `Buildings.Applications.BaseClasses`. This is for # 2264. This change is supported in the conversion script.
Buildings.BoundaryConditions
Buildings.BoundaryConditions.SolarGeometry.IncidenceAngle Buildings.BoundaryConditions.SolarGeometry.BaseClasses.IncidenceAngle Buildings.BoundaryConditions.SolarGeometry.ZenithAngle Buildings.BoundaryConditions.SolarIrradiation.DiffusePerez Buildings.BoundaryConditions.SolarIrradiation.DirectTiltedSurface Buildings.BoundaryConditions.SolarGeometry.BaseClasses.SolarAzimuth	Removed parameter `lat` for the latitude as this is now obtained from the weather data bus. This is for IBPSA, #1477. This change is supported in the conversion script.
Buildings.BoundaryConditions.SolarIrradiation.BaseClasses.RelativeAirMass	Introduced altitude attenuation for relative air mass calculation. This required adding a new input. This is for IBPSA, #1477.
Buildings.BoundaryConditions.SolarIrradiation.BaseClasses.SkyClearness	Changed input connector `HGloHor` to `HDirHor`. This is for IBPSA, #1477.
Buildings.Controls.Continuous
Buildings.Controls.Continuous.PIDHysteresisTimer Buildings.Controls.Continuous.PIDHysteresis	Moved blocks to `Buildings.Obsolete.Controls.Continuous`. This is for IBPSA, #1522. This change is supported in the conversion script.
Buildings.Controls.OBC.CDL
Buildings.Controls.OBC.CDL.Continuous.Add Buildings.Controls.OBC.CDL.Integers.Add Buildings.Controls.OBC.CDL.Continuous.AddParameter	Moved classes to `Obsolete` package and created new blocks to avoid using input gain factor. This is for #2865 and #2876. This change is supported in the conversion script.
Buildings.Controls.OBC.CDL.Continuous.Feedback	Moved the class to `Obsolete` package. This is for #2865. This change is supported in the conversion script.
Buildings.Controls.OBC.CDL.Continuous.Division Buildings.Controls.OBC.CDL.Continuous.Gain Buildings.Controls.OBC.CDL.Continuous.MovingMean Buildings.Controls.OBC.CDL.Continuous.Product Buildings.Controls.OBC.CDL.Integers.Product Buildings.Controls.OBC.CDL.Continuous.SlewRateLimiter	Renamed the blocks to `Divide`, `MultiplyByParameter`, `MovingAverage`, `Multiply`, `LimitSlewRate`. This is for #2865. This change is supported in the conversion script.
Buildings.Controls.OBC.CDL.Interfaces.DayTypeInput Buildings.Controls.OBC.CDL.Interfaces.DayTypeOutput Buildings.Controls.OBC.CDL.Discrete.DayType Buildings.Controls.OBC.CDL.Conversions.IsHoliday Buildings.Controls.OBC.CDL.Conversions.IsWorkingDay Buildings.Controls.OBC.CDL.Conversions.IsNonWorkingDay Buildings.Controls.OBC.CDL.Discrete.Examples.DayType Buildings.Controls.OBC.CDL.Conversions.Validation.DayTypeCheck Buildings.Controls.OBC.CDL.Types.Day	Moved classes to `Obsolete` package. This is for #2839. This change is supported in the conversion script.
Buildings.Controls.OBC.CDL.Logical.MultiAnd Buildings.Controls.OBC.CDL.Logical.MultiOr	Renamed parameter `nu` to `nin`. This is for #2580. This change is supported in the conversion script.
Buildings.Controls.OBC.CDL.Routing.BooleanReplicator Buildings.Controls.OBC.CDL.Routing.IntegerReplicator Buildings.Controls.OBC.CDL.Routing.RealReplicator	Renamed to include `BooleanScalarReplicator`, `IntegerScalarReplicator`, and `RealScalarReplicator`. This is for #2544. This change is supported in the conversion script.
Buildings.Controls.OBC.CDL.Logical.IntegerSwitch Buildings.Controls.OBC.CDL.Logical.LogicalSwitch Buildings.Controls.OBC.CDL.Logical.Switch	Moved the blocks to `CDL.Integers.Switch`, `CDL.Logical.Switch`, and `CDL.Continuous.Switch`. This is for #2650. This change is supported in the conversion script.
Buildings.Controls.OBC.CDL.Integers.Change	Renamed parameter for start value from `y_start` to `pre_u_start` for consistency with `Buildings.Controls.OBC.CDL.Logical.Change`. This is for #2990. This change is supported in the conversion script.
Buildings.Electrical
Buildings.Electrical.AC.ThreePhasesUnbalanced.Sources.PVsimpleOriented Buildings.Electrical.AC.ThreePhasesUnbalanced.Sources.PVsimpleOriented_N Buildings.Electrical.DC.Sources.PVSimpleOriented Buildings.Electrical.AC.OnePhase.Sources.PVSimpleOriented Buildings.Electrical.AC.ThreePhasesBalanced.Sources.PVSimpleOriented Buildings.Electrical.DC.Sources.PVSimpleOriented Buildings.Electrical.Interfaces.PartialPVOriented	Removed parameter `lat` for the latitude as this is now obtained from the weather data bus. This is for IBPSA, #1477. This change is supported in the conversion script.
Buildings.Examples.VAVReheat
Buildings.Examples.VAVReheat.ASHRAE2006 Buildings.Examples.VAVReheat.Guideline36 Buildings.Examples.VAVReheat.BaseClasses.PartialOpenLoop	Changed models to include the hydraulic configurations of the cooling coil, heating coil and VAV terminal box. Changed heating supply water temperature at design condition to 45°C. Corrected implementation of freeze protection for ASHRAE 2006 models. This is for #2594. Changed model structure to separate building and HVAC system. This is for #2652. Changed parameter declarations and added to Guideline 36 models the optimal start up calculation. This is for issue #2829.
Buildings.Examples.ScalableBenchmarks
Buildings.Examples.ScalableBenchmarks.BuildingVAV.ThermalZones.ThermalZone	Reimplemented computation of energy provided by HVAC system to also include the latent load. The new implementation uses the enthalpy sensor, and therefore the mass flow rate and temperature sensors have been removed. Also, rather than load in Watts, it outputs the energy in Joules. This version also improves the infiltration. Now, exactly the same amount of air in infiltrated and exfiltrated. This was not the case previously because the infiltration was a prescribed air flow rate, and the exfiltration was based on pressure difference. This caused an inbalance in the HVAC supply and return air flow rate.
Buildings.Fluid.Actuators
Buildings.Fluid.Actuators.Dampers.Exponential Buildings.Fluid.Actuators.Dampers.MixingBox Buildings.Fluid.Actuators.Dampers.MixingBoxMinimumFlow Buildings.Fluid.Actuators.Dampers.PressureIndependent Buildings.Fluid.Actuators.Valves.ThreeWayEqualPercentageLinear Buildings.Fluid.Actuators.Valves.ThreeWayLinear Buildings.Fluid.Actuators.Valves.ThreeWayTable Buildings.Fluid.Actuators.Valves.TwoWayEqualPercentage Buildings.Fluid.Actuators.Valves.TwoWayLinear Buildings.Fluid.Actuators.Valves.TwoWayPolynomial Buildings.Fluid.Actuators.Valves.TwoWayPressureIndependent Buildings.Fluid.Actuators.Valves.TwoWayQuickOpening Buildings.Fluid.Actuators.Valves.TwoWayTable	Changed implementation of the filter and changed the parameter `order` to be a constant because typical users have no need to change this value. The new implementation uses a simpler model. This is for IBPSA #1498. This change is only backwards incompatible if a user propagated the value of `order` to a high-level parameter.
Buildings.Fluid.FixedResistances
Buildings.Fluid.FixedResistances.PlugFlowPipe Buildings.Fluid.FixedResistances.BaseClasses.PlugFlowCore	In `Buildings.Fluid.FixedResistances.PlugFlowPipe`, changed `ports_b`, which was a vectorized port, to `port_b` which is a scalar port. This has been done in order for the model to have the same connectors as are used for other pipe models. Refactored implementation and made various classes in this model protected. This is for IBPSA #1494. For Dymola, a conversion script renames existing models to `Buildings.Obsolete.Fluid.FixedResistances.PlugFlowPipe` and `Buildings.Obsolete.Fluid.FixedResistances.BaseClasses.PlugFlowCore`.
Buildings.Fluid.SolarCollectors
Buildings.Fluid.SolarCollectors.EN12975 Buildings.Fluid.SolarCollectors.ASHRAE93	Removed parameter `lat` for the latitude as this is now obtained from the weather data bus. This is for IBPSA, #1477. This change is supported in the conversion script.
Buildings.Fluid.Storage
Buildings.Fluid.Storage.ExpansionVessel	Removed parameter `p` which was not used. This is for IBPSA, #1614. This change is supported in the conversion script.
Buildings.HeatTransfer.Windows
Buildings.HeatTransfer.Windows.FixedShade Buildings.HeatTransfer.Windows.Overhang Buildings.HeatTransfer.Windows.BaseClasses.Overhang	Removed parameter `lat` for the latitude as this is now obtained from the weather data bus. This is for IBPSA, #1477. This change is supported in the conversion script.
Buildings.Obsolete
Buildings.Obsolete.Utilities.IO.Python27	Removed support for Python 27. Use instead `Buildings.Utilities.IO.Python36`.
Buildings.ThermalZones.Detailed
Buildings.ThermalZones.Detailed.MixedAir Buildings.ThermalZones.Detailed.CFD Buildings.ThermalZones.Detailed.BaseClasses.ExteriorBoundaryConditions Buildings.ThermalZones.Detailed.BaseClasses.ExteriorBoundaryConditionsWithWindow Buildings.ThermalZones.Detailed.Validation.BaseClasses.SingleZoneFloor	Removed parameter `lat` for the latitude as this is now obtained from the weather data bus. This is for IBPSA, #1477. This change is supported in the conversion script.
Buildings.ThermalZones.Detailed.MixedAir	Set `final massDynamics=energyDynamic`. This is for IBPSA, #1542. This change is supported in the conversion script.
Buildings.ThermalZones.EnergyPlus_9_6_0
Buildings.ThermalZones.EnergyPlus_9_6_0	Renamed package to add the version number for EnergyPlus. This will allow supporting more than one version of EnergyPlus. This is for #2851.
Buildings.ThermalZones.EnergyPlus_9_6_0.Building	This model, which needs to be part of every model that uses EnergyPlus, now requires the specification of the EnergyPlus weather data file (`.epw` file) through the parameter `epwName`. This is for #2443. Removed the parameters `showWeatherData` and `generatePortableFMU`. Now, the weather data bus is always enabled as it is used in almost all simulations. This change is supported in the conversion script. Converted `usePrecompiledFMU` and the associated `fmuName` from parameter to a constant as these are only used for debugging by developers. This is for #2759.
Buildings.ThermalZones.EnergyPlus_9_6_0.Examples.SmallOffice.ASHRAE2006Spring Buildings.ThermalZones.EnergyPlus_9_6_0.Examples.SmallOffice.ASHRAE2006Summer Buildings.ThermalZones.EnergyPlus_9_6_0.Examples.SmallOffice.ASHRAE2006Winter Buildings.ThermalZones.EnergyPlus_9_6_0.Examples.SmallOffice.Guideline36Spring Buildings.ThermalZones.EnergyPlus_9_6_0.Examples.SmallOffice.Guideline36Summer Buildings.ThermalZones.EnergyPlus_9_6_0.Examples.SmallOffice.Guideline36Winter	Changed models to include the hydraulic configurations of the cooling coil, heating coil and VAV terminal box. This is for #2594. Changed model structure to separate building and HVAC system. This is for #2652. Changed parameter declarations and added to Guideline 36 models the optimal start up calculation. This is for issue #2829.
Buildings.Utilities.IO
Buildings.Utilities.IO.Python36	Replaced package with `Buildings.Utilities.IO.Python_3_8` and moved the old package to `Buildings.Obsolete.Utilities.IO.Python36`. This is for #2599. For Dymola, a conversion script will rename models that use `Python36` to use `Python_3_8`.
Buildings.Utilities.Math
Buildings.Utilities.Math.Polynominal Buildings.Utilities.Math.Examples.Polynominal	Corrected name to `Polynomial`. This is for IBPSA, #1524. This change is supported in the conversion script.

The following critical errors have been fixed (i.e., errors that can lead to wrong simulation results):

Buildings.Controls.OBC.CDL
Buildings.Controls.OBC.CDL.Continuous.Greater Buildings.Controls.OBC.CDL.Continuous.GreaterThreshold Buildings.Controls.OBC.CDL.Continuous.Less Buildings.Controls.OBC.CDL.Continuous.LessThreshold	Corrected the condition of switching true back to false. It is caused by the wrong inequality check. This is for #2981.
Buildings.Experimental.DHC
Buildings.Experimental.DHC.Examples.Combined.ParallelConstantFlow	Removed the model that represented an incorrect hydronic configuration. This is for #2967.
Buildings.Fluid.Chillers
Buildings.Fluid.Chillers.BaseClasses.PartialElectric	Corrected calculation of entering condenser temperature when using a moist air media model. This is important for modeling air-cooled chillers using the model `Buildings.Fluid.Chillers.ElectricEIR` This is for #2770.
Buildings.Fluid.HeatExchangers
Buildings.Fluid.HeatExchangers.WetCoilCounterFlow Buildings.Fluid.HeatExchangers.WetCoilDiscretized	Corrected removal of latent heat from component. This is for #3027.
Buildings.Occupants
Buildings.Occupants.Office.Occupancy.Wang2005Occupancy	Reformulated model so it works also if the simulation does not start at 0. To improve efficiency, this reformulation also changes the event triggering function so that it leads to time events rather than state events. This is for #2590.

The following uncritical errors have been fixed (i.e., errors that do not lead to wrong simulation results, e.g., units are wrong or errors in documentation):

Buildings.Airflow
Buildings.Airflow.Multizone.DoorOperable	Removed duplicate declaration of `VABp_flow`. This is for Buildings, #1496.
Buildings.Applications.DataCenters
Buildings.Applications.DataCenters.ChillerCooled.Equipment.Validation.IntegratedPrimaryLoadSide	Removed duplicate instances of blocks that generate control signals. This is for Buildings, issue 2963.
Buildings.Applications.DataCenters.ChillerCooled.Examples.IntegratedPrimaryLoadSideEconomizer Buildings.Applications.DataCenters.ChillerCooled.Examples.IntegratedPrimarySecondaryEconomizer Buildings.Applications.DataCenters.ChillerCooled.Examples.NonIntegratedPrimarySecondaryEconomizer	Corrected weather data bus connection which was structurally incorrect and did not parse in OpenModelica. This is for Buildings, issue 2706.
Buildings.Controls.OBC.CDL
Buildings.Controls.OBC.CDL.PID Buildings.Controls.OBC.CDL.PIDWithReset	Corrected wrong documentation in how the derivative of the control error is approximated. This is for Buildings, issue 2994.
Buildings.Electrical
Buildings.Electrical.AC.OnePhase.Sources.PVSimple Buildings.Electrical.AC.OnePhase.Sources.PVSimpleOriented Buildings.Electrical.AC.ThreePhasesBalanced.Sources.PVSimple Buildings.Electrical.AC.ThreePhasesBalanced.Sources.PVSimpleOriented Buildings.Electrical.AC.ThreePhasesUnbalanced.Sources.PVsimple Buildings.Electrical.AC.ThreePhasesUnbalanced.Sources.PVsimple Buildings.Electrical.AC.ThreePhasesUnbalanced.Sources.PVsimpleOriented Buildings.Electrical.AC.ThreePhasesUnbalanced.Sources.PVsimpleOriented_N Buildings.Electrical.DC.Sources.PVSimple Buildings.Electrical.DC.Sources.PVSimpleOriented Buildings.Electrical.Interfaces.PartialPvBase	Corrected wrong documentation string for surface area which should be gross rather than net area.
Buildings.Experimental
Buildings.Experimental.DHC.Plants.Cooling.Controls.ChillerStage	Corrected parameter value for `twoOn.nOut`. This correction is required to simulate the model in Dymola 2022 if the model has been updated to MSL 4.0.0. With MSL 3.2.3, the simulation works without this correction. This is for Buildings, #1563.
Buildings.Media
Buildings.Media.Specialized.Water.TemperatureDependentDensity	Corrected assignment of gas constant which lead to a unit error. This change does not affect the results as the value is not used for this liquid medium. This is for IBPSA, #1603.
Buildings.ThermalZones.Detailed
Buildings.ThermalZones.Detailed.BaseClasses.RadiationTemperature	Corrected annotation. This is for Buildings, #2550.
Buildings.ThermalZones.Detailed.Constructions.Examples.ExteriorWallTwoWindows Buildings.ThermalZones.Detailed.Constructions.Examples.ExteriorWallWithWindow Buildings.ThermalZones.Detailed.FLEXLAB.Rooms.X3B.Electrical Buildings.ThermalZones.Detailed.Validation.BESTEST.Cases6xx.Case600FF	Added missing parameter declaration. This is for Buildings, #2556.
Buildings.Utilities.IO.Python_3_8
Buildings.Utilities.IO.Python_3_8.Functions.Examples.Exchange	Removed call to impure function `removeFile`. This removal is required for MSL 4.0.0. This is for Buildings, #1563.

Extends from Modelica.Icons.ReleaseNotes (Icon for release notes in documentation).

Modelica definition

class Version_9_0_0 "Version 9.0.0" extends Modelica.Icons.ReleaseNotes; end Version_9_0_0;

Buildings.UsersGuide.ReleaseNotes.Version_8_1_3

Version 8.1.3

Information

Version 8.1.3 is a patch that has backward compatible bug fixes. It is backwards compatible with versions 8.0.0, 8.1.0, 8.1.1 and 8.1.2.

The library has been tested with Dymola 2022, JModelica (revision 14023), OpenModelica 1.19.0-dev (449+g4f16e6af22), OPTIMICA (revision OCT-dev-r26446_JM-r14295) and recent versions of Impact.

The following critical errors have been fixed (i.e., errors that can lead to wrong simulation results):

Buildings.Fluid.HeatExchangers
Buildings.Fluid.HeatExchangers.WetCoilCounterFlow Buildings.Fluid.HeatExchangers.WetCoilDiscretized	Corrected removal of latent heat from component. This is for #3027.

Extends from Modelica.Icons.ReleaseNotes (Icon for release notes in documentation).

Modelica definition

class Version_8_1_3 "Version 8.1.3" extends Modelica.Icons.ReleaseNotes; end Version_8_1_3;

Buildings.UsersGuide.ReleaseNotes.Version_8_1_2

Version 8.1.2

Information

Version 8.1.2 is a patch that has backward compatible bug fixes. It is backwards compatible with versions 8.0.0, 8.1.0 and 8.1.1.

The library has been tested with Dymola 2022, JModelica (revision 14023), OpenModelica 1.19.0-dev (449+g4f16e6af22), OPTIMICA (revision OCT-dev-r26446_JM-r14295) and recent versions of Impact.

The following existing components have been improved in a backward compatible way:

Buildings.HeatTransfer
Buildings.HeatTransfer.Windows.BaseClasses.CenterOfGlass	Changed the gas layer to be conditional. This is for #3026.
Buildings.Fluid
Buildings.Fluid.Boilers.Data.Lochinvar	Added annotation `defaultComponentPrefixes = "parameter"`.
Buildings.Fluid.HeatPumps.Data.EquationFitReversible.Generic	Removed `protected` declaration inside the record as the Modelica Language Specification only allows public sections in a record. This is for #3009.

The following uncritical errors have been fixed (i.e., errors that do not lead to wrong simulation results, e.g., units are wrong or errors in documentation):

Buildings.Controls
Buildings.Controls.OBC.CDL.Conversions.BooleanToInteger Buildings.Controls.OBC.CDL.Conversions.BooleanToReal	Corrected documentation texts where the variables were described with wrong types. This is for #3016.

Extends from Modelica.Icons.ReleaseNotes (Icon for release notes in documentation).

Modelica definition

class Version_8_1_2 "Version 8.1.2" extends Modelica.Icons.ReleaseNotes; end Version_8_1_2;

Buildings.UsersGuide.ReleaseNotes.Version_8_1_1

Version 8.1.1

Information

Version 8.1.1 is a patch that has backward compatible bug fixes. It is backwards compatible with version 8.0.0 and 8.1.0.

The library has been tested with Dymola 2022, JModelica (revision 14023), OpenModelica 1.19.0-dev (449+g4f16e6af22), OPTIMICA (revision OCT-dev-r26446_JM-r14295) and recent versions of Impact.

The following existing components have been improved in a backward compatible way:

Buildings.Examples.VAVReheat
Buildings.Examples.VAVReheat.BaseClasses.Controls.FreezeStat	Added hysteresis. Without it, models can stall due to state events. This is for #2975.
Buildings.Controls.OBC
Buildings.Controls.OBC.Utilities.SunRiseSet	Changed implementation to avoid NaN in OpenModelica. This is for issue 2835.
Buildings.Electrical.AC.ThreePhasesUnbalanced.Lines.Line Buildings.Electrical.AC.ThreePhasesUnbalanced.Lines.Line_N Buildings.Electrical.AC.ThreePhasesUnbalanced.Lines.TwoPortMatrixRLC Buildings.Electrical.AC.ThreePhasesUnbalanced.Lines.TwoPortMatrixRLC_N Buildings.Electrical.AC.ThreePhasesUnbalanced.Lines.TwoPortMatrixRL_N Buildings.Electrical.AC.ThreePhasesUnbalanced.Lines.TwoPortRLC Buildings.Electrical.AC.ThreePhasesUnbalanced.Lines.TwoPortRLC_N	Set nominal attribute for voltage at terminal. This change enables Dymola 2023 beta3 to solve `Buildings.Electrical.AC.ThreePhasesUnbalanced.Validation.IEEETests.Test4NodesFeeder.UnbalancedStepDown.DY` and `Buildings.Electrical.AC.ThreePhasesUnbalanced.Validation.IEEETests.Test4NodesFeeder.UnbalancedStepUp.DD` which otherwise fail during the initialization as the homotopy steps obtain unreasonable values for the voltages.
Buildings.ThermalZones.EnergyPlus
Buildings.ThermalZones.EnergyPlus	Changed handling of forward and backward slashes on Windows. Now models in this package also work with OpenModelica on Windows.

The following critical errors have been fixed (i.e., errors that can lead to wrong simulation results):

Buildings.Experimental.DHC
Buildings.Experimental.DHC.Examples.Combined.ParallelConstantFlow	Removed the model that represented an incorrect hydronic configuration. This is for #2967.

The following uncritical errors have been fixed (i.e., errors that do not lead to wrong simulation results, e.g., units are wrong or errors in documentation):

Buildings.Applications
Buildings.Applications.DataCenters.ChillerCooled.Equipment.Validation.IntegratedPrimaryLoadSide	Removed duplicate instances of blocks that generate control signals. This is for Buildings, issue 2963.
Buildings.Controls.OBC.CDL
Buildings.Controls.OBC.CDL.PID Buildings.Controls.OBC.CDL.PIDWithReset	Corrected wrong documentation in how the derivative of the control error is approximated. This is for Buildings, issue 2994.
Buildings.Experimental
Buildings.Experimental.DHC.CentralPlants.Cooling.Controls.ChillerStage	Corrected parameter value for `twoOn.nOut`. This correction is required to simulate the model in Dymola 2022 if the model has been updated to MSL 4.0.0. With MSL 3.2.3, the simulation works without this correction. This is for Buildings, #1563.
Buildings.Media
Buildings.Media.Specialized.Water.TemperatureDependentDensity	Corrected assignment of gas constant which lead to a unit error. This change does not affect the results as the value is not used for this liquid medium. This is for IBPSA, #1603.
Buildings.Utilities.IO.Python36
Buildings.Utilities.IO.Python36.Functions.Examples.Exchange	Removed call to impure function `removeFile`. This removal is required for MSL 4.0.0. This is for Buildings, #1563.

Extends from Modelica.Icons.ReleaseNotes (Icon for release notes in documentation).

Modelica definition

class Version_8_1_1 "Version 8.1.1" extends Modelica.Icons.ReleaseNotes; end Version_8_1_1;

Buildings.UsersGuide.ReleaseNotes.Version_8_1_0

Version 8.1.0

Information

Version 8.1.0 is a minor release that is backwards compatible with version 8.0.0. The library has been tested with Dymola 2022, JModelica (revision 14023), OpenModelica 1.19.0-dev (449+g4f16e6af22), and OPTIMICA (revision OCT-stable-r19089_JM-r14295).

The following changes have been done:

Added a package to compute undisturbed ground temperatures.
Added controller for radiant cooling and heating systems.
Added a package for district cooling applications.
Added a new boiler model that is suitable for condensing boilers.
Corrected various errors and improved compliance with Modelica Language Standard.

The following new libraries have been added:

Buildings.BoundaryConditions
Buildings.BoundaryConditions.GroundTemperature	Package with models and climatic data for computing ground temperature.
Buildings.Controls
Buildings.Controls.OBC.RadiantSystems	Package with controllers for radiant cooling and heating systems such for pipes embedded in the concrete slab.
Buildings.Experimental.DHC
Buildings.Experimental.DHC.Plants.Cooling	Package with models for a chilled water plant adapted to district cooling applications. This is for issue 2264

The following new components have been added to existing libraries:

Buildings.Controls.OBC
Buildings.Controls.OBC.ASHRAE.G36_PR1.Generic.SetPoints.ZoneStatusDuplicator	Block that duplicates the zone status to be connected to all zone groups. This is for issue 2544.
Buildings.Controls.OBC.CDL.Routing.BooleanVectorFilter Buildings.Controls.OBC.CDL.Routing.BooleanVectorReplicator Buildings.Controls.OBC.CDL.Routing.IntegerVectorFilter Buildings.Controls.OBC.CDL.Routing.IntegerVectorReplicator Buildings.Controls.OBC.CDL.Routing.RealVectorFilter Buildings.Controls.OBC.CDL.Routing.RealVectorReplicator	Blocks for filtering and replicating vectors of signals. This is for issue 2544.
Buildings.Fluid.Boilers
Buildings.Fluid.Boilers.BoilerTable Buildings.Fluid.Boilers.Examples.BoilerTable Buildings.Fluid.Boilers.Validation.BoilerTableEfficiencyCurves Buildings.Fluid.Boilers.BaseClasses.PartialBoiler Buildings.Fluid.Boilers.Data.Generic Buildings.Fluid.Boilers.Data.Lochinvar.Crest.FBdash2501 Buildings.Fluid.Boilers.Data.Lochinvar.Crest.FBdash3001 Buildings.Fluid.Boilers.Data.Lochinvar.Crest.FBdash3501 Buildings.Fluid.Boilers.Data.Lochinvar.Crest.FBdash4001 Buildings.Fluid.Boilers.Data.Lochinvar.Crest.FBdash5001 Buildings.Fluid.Boilers.Data.Lochinvar.Crest.FBdash6001 Buildings.Fluid.Boilers.Data.Lochinvar.FTXL.FTX400 Buildings.Fluid.Boilers.Data.Lochinvar.FTXL.FTX500 Buildings.Fluid.Boilers.Data.Lochinvar.FTXL.FTX600 Buildings.Fluid.Boilers.Data.Lochinvar.FTXL.FTX725 Buildings.Fluid.Boilers.Data.Lochinvar.FTXL.FTX850 Buildings.Fluid.Boilers.Data.Lochinvar.KnightXL.KBXdash0400 Buildings.Fluid.Boilers.Data.Lochinvar.KnightXL.KBXdash0500 Buildings.Fluid.Boilers.Data.Lochinvar.KnightXL.KBXdash0650 Buildings.Fluid.Boilers.Data.Lochinvar.KnightXL.KBXdash0800 Buildings.Fluid.Boilers.Data.Lochinvar.KnightXL.KBXdash1000	Classes for modeling boilers whose efficiency curves are provided as a table. Part of the code from the old `Buildings.Fluid.Boilers.BoilerPolynomial` has been moved to `Buildings.Fluid.Boilers.BaseClasses.PartialBoiler` to support the new model `Buildings.Fluid.Boilers.BoilerTable`. This is for issue 2651. In the moved code, the boiler's heating power output is now corrected by its loss to the ambient. This is for #2725.
Buildings.Fluid.Chillers
Buildings.Fluid.Chillers.Data.ElectricEIR.ElectricEIRChiller_York_YCAL0033EE_101kW_3_1COP_AirCooled	Data for air cooled chiller. This is for issue #2770.

The following existing components have been improved in a backward compatible way:

Buildings.Controls.Continuous
Buildings.Controls.Continuous.SignalRanker	Changed implementation to use sort function from Modelica Standard Library, and updated its example to avoid simultaneous state and time events. This is for IBPSA, #1534.
Buildings.Examples.ChillerPlant
Buildings.Examples.ChillerPlant.BaseClasses.DataCenter	Set `nominalValuesDefaultPressureCurve=true` to avoid warnings. This is for Buildings, issue #2761. Changed initialization from steady state initial to fixed initial for some components. This is for Buildings, issue #2798.
Buildings.ThermalZones.ReducedOrder
Buildings.ThermalZones.ReducedOrder.Validation.VDI6007.BaseClasses.VerifyDifferenceThreePeriods	Improved model to guard against approximation errors of event handling. With this change, the models in `Buildings.ThermalZones.ReducedOrder.Validation.VDI6007` all simulate with OpenModelica. This is for Buildings, issue #2713.
Buildings.Utilities.Math
Buildings.Utilities.Math.Functions.BaseClasses.der_spliceFunction	Reimplemented function to avoid a potential overflow caused by the `cosh` function. This is for IBPSA #1531.

The following critical errors have been fixed (i.e., errors that can lead to wrong simulation results):

Buildings.Fluid.Chillers
Buildings.Fluid.Chillers.BaseClasses.PartialElectric	Corrected calculation of entering condenser temperature when using a moist air media model. This is important for modeling air-cooled chillers using the model `Buildings.Fluid.Chillers.ElectricEIR`. This is for issue #2770.
Buildings.Occupants
Buildings.Occupants.Office.Occupancy.Wang2005Occupancy	Reformulated model so it works also if the simulation does not start at 0. To improve efficiency, this reformulation also changes the event triggering function so that it leads to time events rather than state events. This is for Buildings, #2590.

The following uncritical errors have been fixed (i.e., errors that do not lead to wrong simulation results, e.g., units are wrong or errors in documentation):

Buildings.Airflow
Buildings.Airflow.Multizone.DoorOperable	Removed duplicate declaration of `VABp_flow`. This is for Buildings, issue #1496.
Buildings.Applications.DataCenters
Buildings.Applications.DataCenters.ChillerCooled.Examples.IntegratedPrimaryLoadSideEconomizer Buildings.Applications.DataCenters.ChillerCooled.Examples.IntegratedPrimarySecondaryEconomizer Buildings.Applications.DataCenters.ChillerCooled.Examples.NonIntegratedPrimarySecondaryEconomizer	Corrected weather data bus connection which was structurally incorrect and did not parse in OpenModelica. This is for Buildings, issue 2706.
Buildings.Electrical
Buildings.Electrical.AC.OnePhase.Storage.Battery Buildings.Electrical.DC.Storage.BaseClasses.Charge Buildings.Electrical.DC.Storage.Battery	Corrected unit string. This is for Buildings, issue #2798.
Buildings.ThermalZones.Detailed
Buildings.ThermalZones.Detailed.BaseClasses.RadiationTemperature	Corrected annotation. This is for Buildings, issue #2550.
Buildings.ThermalZones.Detailed.Constructions.Examples.ExteriorWallTwoWindows Buildings.ThermalZones.Detailed.Constructions.Examples.ExteriorWallWithWindow Buildings.ThermalZones.Detailed.FLEXLAB.Rooms.X3B.Electrical Buildings.ThermalZones.Detailed.Validation.BESTEST.Cases6xx.Case600FF	Added missing parameter declaration. This is for Buildings, issue #2556.
Buildings.ThermalZones.ReducedOrder
Buildings.ThermalZones.ReducedOrder.Validation.VDI6007.BaseClasses.VerifyDifferenceThreePeriods	Improved model to guard against approximation errors of event handling. With this change, the models in `Buildings.ThermalZones.ReducedOrder.Validation.VDI6007` all simulate with OpenModelica. This is for Buildings, issue #2713.

Extends from Modelica.Icons.ReleaseNotes (Icon for release notes in documentation).

Modelica definition

class Version_8_1_0 "Version 8.1.0" extends Modelica.Icons.ReleaseNotes; end Version_8_1_0;

Buildings.UsersGuide.ReleaseNotes.Version_8_0_0

Version 8.0.0

Information

Version 8.0.0 is a major release that contains the first version of the Spawn of EnergyPlus coupling. The library has been tested with Dymola 2021, JModelica (revision 14023), and OPTIMICA (revision OCT-stable-r19089_JM-r14295).

The following major changes have been done:

The package Buildings.ThermalZones.EnergyPlus contains the first version of the Spawn of EnergyPlus coupling that is being developed at https://lbl-srg.github.io/soep. The Spawn coupling allows to model HVAC and controls in Modelica, and graphically connect to EnergyPlus models for thermal zones, schedules, EMS actuators and output variables. This allows for example to model HVAC systems, HVAC controls and controls for active facade systems in Modelica, and use the EnergyPlus envelope model to simulate heat transfer through the building envelope, including the heat and light transmission through the windows for the current control signal of the active shade.
The package Buildings.Experimental.DHC contains models for district heating and cooling systems that are being developed for the URBANopt District Energy System software.
The new media Buildings.Media.Antifreeze.PropyleneGlycolWater allows modeling of propylene-glycol water mixtures.
A new cooling coil model Buildings.Fluid.HeatExchangers.WetCoilEffectivenessNTU has been added. This model is applicable for fully-dry, partially-wet, and fully-wet regimes. In contrast to Buildings.Fluid.HeatExchangers.WetCoilCounterFlow and to Buildings.Fluid.HeatExchangers.WetCoilDiscretized, this model uses the epsilon-NTU relationship rather than a spatial discretization of the coil. This leads to fewer state variables and generally to a faster simulation.
New simplified door models for bi-directional air exchange between thermal zones are implemented in Buildings.Airflow.Multizone.
Various other models have been improved or added, in particular for modeling of control sequences using the Control Description Language that has been developed in the OpenBuildingControl project at https://obc.lbl.gov.

For more details, please see the release notes below.

The following new libraries have been added:

Buildings.BoundaryConditions
Buildings.BoundaryConditions.Validation.BESTEST	Packages with validation models for the weather data BESTEST. This is for IBPSA, issue 1314.
Buildings.Experimental
Buildings.Experimental.DHC	Packages for modeling district heating and cooling systems. These packages contain components supporting the integration within the URBANopt SDK. The development is in progress.
Buildings.Media
Buildings.Media.Antifreeze.PropyleneGlycolWater	Package with medium model for propylene glycol water mixtures. This is for IBPSA, issue 1410.
Buildings.ThermalZones
Buildings.ThermalZones.EnergyPlus	Package for Spawn of EnergyPlus that couples Modelica directly to the EnergyPlus envelope model. The models in this package allow simulating the envelope heat transfer of one or several buildings in EnergyPlus, and simulating HVAC and controls in Modelica. EnergyPlus objects are represented graphically as any other Modelica models, and the coupling and co-simulation is done automatically based on these models.

The following new components have been added to existing libraries:

Buildings.Airflow.Multizone
Buildings.Airflow.Multizone.DoorOpen Buildings.Airflow.Multizone.DoorOperable	Simplified model for large openings with bi-directional, buoyancy-induced air flow, such as open doors. This is for IBPSA, issue 1353.
Buildings.Controls.OBC
Buildings.Controls.OBC.ASHRAE.G36_PR1.Generic.SetPoints.GroupStatus	Find minimum and maximum values regarding the status of zones in one group. This is needed for specifying the group operating mode according to ASHRAE Guideline 36, May 2020 version. This is for # 1893.
Buildings.Controls.OBC.ASHRAE.G36_PR1.AHUs.SingleZone.VAV.SetPoints.ModeAndSetPoints	Moved from Buildings.Controls.OBC.ASHRAE.G36_PR1.TerminalUnits.ModeAndSetPoints, reimplemented to use the operating mode specified according to ASHRAE G36 official release and changed the heating and cooling demand limit level to be inputs. This is for # 1893.
Buildings.Controls.OBC.CDL.Continuous.PID	New implementation of the PID controller. This is for # 2056 and for # 2182.
Buildings.Controls.OBC.CDL.Continuous.PIDWithReset	New implementation of the PID controller with output reset based on a boolean trigger. This implementation allows to reset the output of the controller to a parameter value. (Resetting it to an input was never used and is now removed for simplicity.) This is for # 2056 and for # 2182.
Buildings.Controls.OBC.CDL.Logical.TimerAccumulating	New timer that accumulates time. The output will be reset to zero when the reset input becomes `true`. This is for # 2101.
Buildings.Controls.OBC.CDL.Integers.Sources.Pulse	`Integer` pulse source signal. This is for # 2125 and # 2282.
Buildings.Controls.OBC.CDL.Integers.Sources.TimeTable	Time table for `Integer` outputs. Each output is held constant between two consecutive entries in each column of the `table` parameters. This is for # 2125.
Buildings.Controls.OBC.CDL.Logical.Sources.TimeTable	Time table for `Boolean` outputs. This is for # 2125.
Buildings.Examples
Buildings.Examples.VAVReheat.Controls.SupplyAirTemperature	Control block for tracking the supply air temperature set point. This is for # 2024.
Buildings.Examples.VAVReheat.Controls.SupplyAirTemperatureSetpoint	Computation of the supply air temperature set point based on the operation mode. This is for # 2024.
Buildings.Fluid
Buildings.Fluid.Actuators.Valves.TwoWayButterfly	Two way valve with the flow characteristic of a butterfly valve. This is for IBPSA, issue 975.
Buildings.Fluid.HeatExchangers.WetCoilEffectivenessNTU	Cooling coil model applicable for fully-dry, partially-wet, and fully-wet regimes. In contrast to `Buildings.Fluid.HeatExchangers.WetCoilCounterFlow` and to `Buildings.Fluid.HeatExchangers.WetCoilDiscretized`, this model uses the epsilon-NTU relationship rather than a spatial discretization of the coil. This leads to fewer state variables and generally to a faster simulation. This is for # 622.

The following existing components have been improved in a backward compatible way:

Buildings.Air
Buildings.Air.Systems.SingleZone.VAV.Examples.Guideline36	Updated AHU controller which applies the sequence of specifying operating mode according to G36 official release. This is for # 1893.
Buildings.Controls.OBC.ASHRAE
Buildings.Controls.OBC.ASHRAE.G36_PR1.TerminalUnits.Controller	Changed the default heating maximum airflow setpoint to 30% of the zone nominal airflow. This is for # 2172.
Buildings.Controls.OBC.CDL
Buildings.Controls.OBC.CDL.Continuous.MovingMean Buildings.Controls.OBC.CDL.Continuous.PID Buildings.Controls.OBC.CDL.Continuous.PIDWithReset Buildings.Controls.OBC.CDL.Continuous.SlewRateLimiter Buildings.Controls.OBC.CDL.Continuous.Sources.CalendarTime Buildings.Controls.OBC.CDL.Continuous.Sources.Pulse Buildings.Controls.OBC.CDL.Continuous.Sources.Ramp Buildings.Controls.OBC.CDL.Continuous.Sources.Sin Buildings.Controls.OBC.CDL.Continuous.Sources.TimeTable Buildings.Controls.OBC.CDL.Discrete.DayType Buildings.Controls.OBC.CDL.Discrete.FirstOrderHold Buildings.Controls.OBC.CDL.Discrete.Sampler Buildings.Controls.OBC.CDL.Discrete.UnitDelay Buildings.Controls.OBC.CDL.Discrete.ZeroOrderHold Buildings.Controls.OBC.CDL.Logical.Sources.Pulse Buildings.Controls.OBC.CDL.Logical.Sources.SampleTrigger Buildings.Controls.OBC.CDL.Logical.Timer Buildings.Controls.OBC.CDL.Logical.TimerAccumulating Buildings.Controls.OBC.CDL.Logical.TriggeredTrapezoid Buildings.Controls.OBC.CDL.Logical.TrueDelay Buildings.Controls.OBC.CDL.Logical.TrueFalseHold Buildings.Controls.OBC.CDL.Logical.TrueHoldWithReset Buildings.Controls.OBC.CDL.Psychrometrics.DewPoint_TDryBulPhi Buildings.Controls.OBC.CDL.Psychrometrics.SpecificEnthalpy_TDryBulPhi Buildings.Controls.OBC.CDL.Psychrometrics.WetBulb_TDryBulPhi Buildings.Controls.OBC.Utilities.SetPoints.SupplyReturnTemperatureReset Buildings.Controls.OBC.CDL.Utilities.SunRiseSet	Reformulated to remove dependency to `Modelica.Units.SI`. This is for issue 2243.
Buildings.Controls.OBC.CDL.Continuous.Greater Buildings.Controls.OBC.CDL.Continuous.GreaterThreshold Buildings.Controls.OBC.CDL.Continuous.Less Buildings.Controls.OBC.CDL.Continuous.LessThreshold	Added option to specify a hysteresis, which by default is set to 0.
Buildings.Controls.OBC.Utilities
Buildings.Controls.OBC.Utilities.OptimalStart	Refactored sampling of history of temperature slope to only sample when control error requires optimal start up. This is for #2345.
Buildings.Examples
Buildings.Examples.HydronicHeating.TwoRoomsWithStorage	Changed `dpVal_nominal` to 6 kPa. This is for issue 2378.
Buildings.Examples.VAVReheat.BaseClasses.Floor	Refactored model to extend from the newly added `Buildings.Examples.VAVReheat.BaseClasses.PartialFloor` model. This is for issue 1502.
Buildings.Examples.VAVReheat.BaseClasses.PartialOpenLoop	Declared the rooms in a new model `Buildings.Examples.VAVReheat.BaseClasses.Floor` to allow use of the model with the Modelica or the Spawn envelope model.
Buildings.Examples.DualFanDualDuct.ClosedLoop Buildings.Examples.ScalableBenchmarks.BuildingVAV.Examples.OneFloor_OneZone Buildings.Examples.ScalableBenchmarks.BuildingVAV.Examples.TwoFloor_TwoZone Buildings.Examples.VAVReheat.ASHRAE2006 Buildings.Examples.VAVReheat.Guideline36	Adapted the model to the updated control of supply air temperature. This is for issue 2024.
Buildings.Examples.VAVReheat.Guideline36	Upgraded sequence of specifying operating mode according to G36 official release. This is for issue 1893.
Buildings.Examples.VAVReheat.Guideline36	Change component name `yOutDam` to `yExhDam` and update documentation graphic to include relief damper. This is for #2399.
Buildings.Examples.VAVReheat.ASHRAE2006	Update documentation graphic to include relief damper. This is for #2399.
Buildings.Fluid
Buildings.Fluid.FixedResistances.PlugFlowPipe	Improved calculation of time constant to avoid negative values in some special cases. This is for IBPSA, issue 1427.
Buildings.Fluid.HeatExchangers.DryCoilEffectivenessNTU Buildings.Fluid.HeatExchangers.PlateHeatExchangerEffectivenessNTU Buildings.Fluid.HeatExchangers.PartialEffectivenessNTU	Added a warning for when `Q_flow_nominal` is specified with the wrong sign.
Buildings.Fluid.HeatExchangers.RadiantSlabs Buildings.Fluid.HeatExchangers.RadiantSlabs.BaseClasses.Functions.AverageResistance	Corrected inequality test on `alpha`, and changed print statement to an assertion with assertion level set to warning. This is for issue 2009.
Buildings.Fluid.HeatExchangers.DryCoilEffectivenessNTU Buildings.Fluid.HeatExchangers.PlateHeatExchangerEffectivenessNTU Buildings.Fluid.HeatExchangers.PartialEffectivenessNTU	Added a warning for when `Q_flow_nominal` is specified with the wrong sign.
Buildings.Fluid.HeatExchangers.RadiantSlabs Buildings.Fluid.HeatExchangers.RadiantSlabs.BaseClasses.Functions.AverageResistance	Corrected inequality test on `alpha`, and changed print statement to an assertion with assertion level set to warning. This is for issue 2009.
Buildings.Fluid.Sensors.EnthalpyFlowRate Buildings.Fluid.Sensors.EntropyFlowRate Buildings.Fluid.Sensors.LatentEnthalpyFlowRate Buildings.Fluid.Sensors.SensibleEnthalpyFlowRate Buildings.Fluid.Sensors.VolumeFlowRate	Changed parameter values to use as default a steady-state sensor signal. This is for IBPSA, issue 1406.
Buildings.Media
Buildings.Media.Refrigerants.R410A	Improved implementation, which now works with OpenModelica. This is for IBPSA, issue 1414.
Buildings.Utilities
Buildings.Utilities.Cryptographics.sha	Corrected memory leak.

The following existing components have been improved in a non-backward compatible way:

Buildings.Air
Buildings.Air.Systems.SingleZone.VAV	Updated parameters of the two HVAC controllers such as PI gains, damper positions, and supply air temperature limits to make example models comparable. Added CO2 monitoring. This is for issue 1608.
Buildings.Air.Systems.SingleZone.VAV.ChillerDXHeatingEconomizerController	Moved and renamed to `Buildings.Air.Systems.SingleZone.VAV.BaseClasses.ControllerChillerDXHeatingEconomizer`. Also a bug fix was implemented that enables the fan when cooling needed during unoccupied hours. This is for issue 2265. For Dymola, a conversion script makes this change.
Buildings.Controls.Continuous
Buildings.Controls.Continuous.LimPID Buildings.Controls.Continuous.PIDHysteresis Buildings.Controls.Continuous.PIDHysteresisTimer	Corrected wrong convention of reverse and direct action. The previous parameter `reverseAction` with a default of `false` has been removed, and a new parameter `reverseActing` with a default of `true` has been added. This was done because the previous implementation wrongly interpreted reverse action as the control output changing in reverse to the change in control error, but the industry convention is that reverse action means that the control output changes in reverse to the measurement signal. This is for IBPSA, #1365. For Dymola, a conversion script makes this change.
Buildings.Controls.OBC.ASHRAE.G36_PR1
Buildings.Controls.OBC.ASHRAE.G36_PR1.AHUs.MultiZone.VAV.Economizers.Subsequences.Modulation	Removed parameter `samplePeriod` and removed delay on actuator signal to avoid a large delay in this feedback loop. This is for issue 2454.
Buildings.Controls.OBC.ASHRAE.G36_PR1.AHUs.SingleZone.VAV.Controller	Updated the block of specifying operating mode and setpoints. This is for issue 1893.
Buildings.Controls.OBC.ASHRAE.G36_PR1.Generic.SetPoints.OperationMode	Upgraded the sequence according to ASHRAE Guideline 36, May 2020 version. This is for issue 1893.
Buildings.Controls.OBC.CDL.Continuous
Buildings.Controls.OBC.CDL.Continuous.ChangeSign Buildings.Controls.OBC.CDL.Continuous.HysteresisWithHold	Moved blocks to `Obsolete` package because they can be implemented with other blocks and have only rarely been used. This is for issue 2134. For Dymola, a conversion script makes this change.
Buildings.Controls.OBC.CDL.Continuous.LimPID	Corrected wrong convention of reverse and direct action. The previous parameter `reverseAction` with a default of `false` has been removed, and a new parameter `reverseActing` with a default of `true` has been added. This was done because the previous implementation wrongly interpreted reverse action as the control output changing in reverse to the change in control error, but the industry convention is that reverse action means that the control output changes in reverse to the measurement signal. This is for IBPSA, #1365. For Dymola, a conversion script makes this change.
Buildings.Controls.OBC.CDL.Continuous.LimPID	Moved model to `Building.Obsolete.Controls.OBC.CDL.Continuous`. Instead of this model, use the new model `Buildings.Controls.Continuous.PID` or `Buildings.Controls.Continuous.PIDWithReset`. This is for issue 2056.
Buildings.Controls.OBC.CDL.Continuous.GreaterEqualThreshold Buildings.Controls.OBC.CDL.Continuous.GreaterEqual Buildings.Controls.OBC.CDL.Continuous.LessEqualThreshold Buildings.Controls.OBC.CDL.Continuous.LessEqual	Moved blocks to obsolete package. Instead of these blocks, use the ones that do not contain the word `Equal` in their name. This was done because for real-valued, measured quantities, there is no reason to distinguish between weak and strict inequality (due to sensor noise, or within a simulation, due to solver noise or rounding errors). This is for #2076. For Dymola, a conversion script makes this change.
Buildings.Controls.OBC.CDL.Continuous.GreaterThreshold Buildings.Controls.OBC.CDL.Continuous.LessThreshold Buildings.Controls.OBC.CDL.Continuous.NumberOfRequests	Renamed parameter `threshold` to `t`. This is for #2076. For Dymola, a conversion script makes this change.
Buildings.Controls.OBC.CDL.Continuous.NumberOfRequests	Moved block to obsolete package because this block is not needed, and it would need to be refactored to add hysteresis. This is for #2124. For Dymola, a conversion script makes this change.
Buildings.Controls.OBC.CDL.Continuous.Sources.Pulse	Removed `startTime` parameter. Introduced `shift` parameter. This is for issue 2170 and issue 2282. For Dymola, a conversion script makes this change.
Buildings.Controls.OBC.CDL.Continuous.Sources.Pulse	Removed parameter `nperiod`. This is for issue 2170.
Buildings.Controls.OBC.CDL.Logical
Buildings.Controls.OBC.CDL.Logical.Latch Buildings.Controls.OBC.CDL.Logical.Toggle	Removed the parameter `pre_y_start`, and made the initial output to be equal to latch or toggle input when the clear input is `false`. This is for #2177. For Dymola, a conversion script makes this change.
Buildings.Controls.OBC.CDL.Logical.Timer	Removed `reset` boolean input and added boolean output `passed` to show if the time becomes greater than threshold time. This is for #2101.
Buildings.Controls.OBC.CDL.Logical.Sources.SampleTrigger Buildings.Controls.OBC.CDL.Logical.Sources.Pulse	Removed `startTime` parameter. Introduced `shift` parameter. This is for issue 2170 and issue 2282. For Dymola, a conversion script makes this change.
Buildings.Controls.OBC.CDL.Integers
Buildings.Controls.OBC.CDL.Integers.GreaterEqualThreshold Buildings.Controls.OBC.CDL.Integers.LessEqualThreshold Buildings.Controls.OBC.CDL.Integers.GreaterThreshold Buildings.Controls.OBC.CDL.Integers.LessThreshold	Renamed parameter `threshold` to `t`. This is for #2076. For Dymola, a conversion script makes this change.
Buildings.Controls.OBC.CDL.Psychrometrics
Buildings.Controls.OBC.CDL.Psychrometrics.TDewPoi_TDryBulPhi Buildings.Controls.OBC.CDL.Psychrometrics.TWetBul_TDryBulPhi Buildings.Controls.OBC.CDL.Psychrometrics.h_TDryBulPhi	Renamed blocks and removed input connector for pressure. This is for #2139. For Dymola, a conversion script will rename existing instance to use the old versions which have been moved to the `Buildings.Obsolete` package.
Buildings.Controls.OBC.Utilities
Buildings.Controls.OBC.Utilities.SetPoints	Moved package from `Buildings.Controls.OBC.CDL.SetPoints`. This is for #2355.
Buildings.Controls.OBC.UnitConversions
Buildings.Controls.OBC.UnitConversions.From_Btu Buildings.Controls.OBC.UnitConversions.From_quad Buildings.Controls.OBC.UnitConversions.To_Btu Buildings.Controls.OBC.UnitConversions.To_quad	Corrected quantity from `Work` to `Energy`. This is for #2245.
Buildings.Examples.VAVReheat
Buildings.Examples.VAVReheat.ASHRAE2006 Buildings.Examples.VAVReheat.Guideline36 Buildings.Examples.VAVReheat.BaseClasses.PartialOpenLoop	Refactored model to implement the economizer dampers directly in `Buildings.Examples.VAVReheat.BaseClasses.PartialOpenLoop` rather than through the model of a mixing box. Since the version of the Guideline 36 model has no exhaust air damper, this leads to simpler equations. This is for issue #2454.
Buildings.Examples.VAVReheat.BaseClasses.VAVBranch	Moved to `Buildings.Obsolete.Examples.VAVReheat.BaseClasses.VAVBranch` and replaced by `Buildings.Examples.VAVReheat.BaseClasses.VAVReheatBox`. This is for issue #2059. For Dymola, a conversion script makes this change.
Buildings.Examples.VAVReheat.Controls.Economizer	Updated the block with an input for enabling outdoor air damper opening and an input for economizer cooling signal. This is for issue 2024.
Buildings.Examples.VAVReheat.Controls.EconomizerTemperatureControl	This block is now retired. This is for issue 2024.
Buildings.Experimental
Buildings.Experimental.DistrictHeatingCooling	Moved package to `Buildings.Obsolete.DistrictHeatingCooling`. Generic components for DHC system modeling are now developed under `Buildings.Experimental.DHC`.

The following critical errors have been fixed (i.e., errors that can lead to wrong simulation results):

Buildings.Applications.DataCenters.ChillerCooled.Equipment
Buildings.Applications.DataCenters.ChillerCooled.Equipment.BaseClasses.FourPortResistanceChillerWSE Buildings.Applications.DataCenters.ChillerCooled.Equipment.BaseClasses.PartialChillerWSE Buildings.Applications.DataCenters.ChillerCooled.Equipment.BaseClasses.PartialCoolingCoilHumidifyingHeating Buildings.Applications.DataCenters.ChillerCooled.Equipment.BaseClasses.PartialHeatExchanger Buildings.Applications.DataCenters.ChillerCooled.Equipment.BaseClasses.PartialIntegratedPrimary Buildings.Applications.DataCenters.ChillerCooled.Equipment.BaseClasses.PartialPlantParallel Buildings.Applications.DataCenters.ChillerCooled.Equipment.BaseClasses.PartialPumpParallel Buildings.Applications.DataCenters.ChillerCooled.Equipment.BaseClasses.ThreeWayValveParameters Buildings.Applications.DataCenters.ChillerCooled.Equipment.IntegratedPrimaryLoadSide Buildings.Applications.DataCenters.ChillerCooled.Equipment.IntegratedPrimaryPlantSide Buildings.Applications.DataCenters.ChillerCooled.Equipment.IntegratedPrimarySecondary Buildings.Applications.DataCenters.ChillerCooled.Equipment.NonIntegrated Buildings.Applications.DataCenters.ChillerCooled.Equipment.WatersideEconomizer	Corrected fixed flow resistance settings and added ideal mixing junctions. This is for issue 2446.
Buildings.Controls.OBC.CDL.Integers
Buildings.Controls.OBC.CDL.Integers.Change	Corrected initialization of previous value of input to use the current input rather than `0`. This is for issue 2294.

The following uncritical errors have been fixed (i.e., errors that do not lead to wrong simulation results, e.g., units are wrong or errors in documentation):

Buildings.Controls.OBC.CDL.Continuous
Buildings.Controls.OBC.CDL.Continuous.Greater Buildings.Controls.OBC.CDL.Continuous.GreaterThreshold Buildings.Controls.OBC.CDL.Continuous.Less Buildings.Controls.OBC.CDL.Continuous.LessThreshold	Corrected documentation. This is for issue 2246.

Note:

This version also corrects a possible memory violation when reading weather data files that have very long lines, as reported in IBPSA, #1432.

Extends from Modelica.Icons.ReleaseNotes (Icon for release notes in documentation).

Modelica definition

class Version_8_0_0 "Version 8.0.0" extends Modelica.Icons.ReleaseNotes; end Version_8_0_0;

Buildings.UsersGuide.ReleaseNotes.Version_7_0_2

Version 7.0.2

Information

Version 7.0.2 is a bug fix release. The library has been tested with Dymola 2022, JModelica (revision 14023), OpenModelica 1.19.0-dev (449+g4f16e6af22) and OPTIMICA (revision OCT-stable-r19089_JM-r14295).

The following changes have been done:

Improved models to comply with Modelica Language Standard. Now all models translate with OpenModelica.
Corrected chiller models for situation where condenser is air cooled.
Corrected occupancy models for simulations that do not start at time equal to zero.
Implemtend various other improvements.

The following new components have been added to existing libraries:

Buildings.Fluid.Chillers
Buildings.Fluid.Chillers.Data.ElectricEIR.ElectricEIRChiller_York_YCAL0033EE_101kW_3_1COP_AirCooled	Data for air cooled chiller. This is for Buildings, issue #2770.

The following existing components have been improved in a backward compatible way:

Buildings.Controls.Continuous
Buildings.Controls.Continuous.SignalRanker	Changed implementation to use sort function from Modelica Standard Library, and updated its example to avoid simultaneous state and time events. This is for IBPSA, #1534.
Buildings.Examples.ChillerPlant
Buildings.Examples.ChillerPlant.BaseClasses.DataCenter	Set `nominalValuesDefaultPressureCurve=true` to avoid warnings. This is for Buildings, issue #2761. Changed initialization from steady state initial to fixed initial for some components. This is for Buildings, issue #2798.
Buildings.ThermalZones.ReducedOrder
Buildings.ThermalZones.ReducedOrder.Validation.VDI6007.BaseClasses.VerifyDifferenceThreePeriods	Improved model to guard against approximation errors of event handling. With this change, the models in `Buildings.ThermalZones.ReducedOrder.Validation.VDI6007` all simulate with OpenModelica. This is for Buildings, issue #2713.
Buildings.Utilities.Math
Buildings.Utilities.Math.Functions.BaseClasses.der_spliceFunction	Reimplemented function to avoid a potential overflow caused by the `cosh` function. This is for IBPSA #1531.

The following critical errors have been fixed (i.e., errors that can lead to wrong simulation results):

Buildings.Fluid.Chillers
Buildings.Fluid.Chillers.BaseClasses.PartialElectric	Corrected calculation of entering condenser temperature when using a moist air media model. This is important for modeling air-cooled chillers using the model `Buildings.Fluid.Chillers.ElectricEIR`. This is for Buildings, issue #2770.
Buildings.Occupants
Buildings.Occupants.Office.Occupancy.Wang2005Occupancy	Reformulated model so it works also if the simulation does not start at 0. To improve efficiency, this reformulation also changes the event triggering function so that it leads to time events rather than state events. This is for Buildings, #2590.

The following uncritical errors have been fixed (i.e., errors that do not lead to wrong simulation results, e.g., units are wrong or errors in documentation):

Buildings.Airflow
Buildings.Airflow.Multizone.DoorOperable	Removed duplicate declaration of `VABp_flow`. This is for Buildings, issue #1496.
Buildings.Electrical
Buildings.Electrical.AC.OnePhase.Storage.Battery Buildings.Electrical.DC.Storage.BaseClasses.Charge Buildings.Electrical.DC.Storage.Battery	Corrected unit string. This is for Buildings, issue #2798.
Buildings.Applications.DataCenters
Buildings.Applications.DataCenters.ChillerCooled.Examples.IntegratedPrimaryLoadSideEconomizer Buildings.Applications.DataCenters.ChillerCooled.Examples.IntegratedPrimarySecondaryEconomizer Buildings.Applications.DataCenters.ChillerCooled.Examples.NonIntegratedPrimarySecondaryEconomizer	Corrected weather data bus connection which was structurally incorrect and did not parse in OpenModelica. This is for Buildings, issue 2706.
Buildings.ThermalZones.Detailed
Buildings.ThermalZones.Detailed.BaseClasses.RadiationTemperature	Corrected annotation. This is for Buildings, issue #2550.
Buildings.ThermalZones.Detailed.Constructions.Examples.ExteriorWallTwoWindows Buildings.ThermalZones.Detailed.Constructions.Examples.ExteriorWallWithWindow Buildings.ThermalZones.Detailed.FLEXLAB.Rooms.X3B.Electrical Buildings.ThermalZones.Detailed.Validation.BESTEST.Cases6xx.Case600FF	Added missing parameter declaration. This is for Buildings, issue #2556.

Extends from Modelica.Icons.ReleaseNotes (Icon for release notes in documentation).

Modelica definition

class Version_7_0_2 "Version 7.0.2" extends Modelica.Icons.ReleaseNotes; end Version_7_0_2;

Buildings.UsersGuide.ReleaseNotes.Version_7_0_1

Version 7.0.1

Information

Version 7.0.1 is a bug fix release. The library has been tested with Dymola 2021 and 2022, JModelica (revision 14023), and OPTIMICA (revision OCT-stable-r12473_JM-r14295).

The following changes have been done:

Corrected memory violation on Windows for weather data file with long header lines.
Corrected various misplaced or missing each declarations.
Corrected access to protected classes.
Reformulated replaceable class to avoid access of components that are not in the constraining type.
Added missing parameter declarations for records.

The following existing components have been improved in a backward compatible way:

Buildings.Applications
Buildings.Applications.DataCenters.ChillerCooled.Equipment.Validation	Changed boundary condition model to prescribed pressure rather than prescribed mass flow rate. Prescribing the mass flow rate caused unreasonably large pressure drop because the mass flow rate was forced through a closed valve. This is for #2488.
Buildings.Electrical
Buildings.Electrical.AC.ThreePhasesUnbalanced.Validation.IEEETests.Test4NodesFeeder.BalancedStepUp.YD	Set better start values for algebraic variables. This is for #2432.

The following uncritical errors have been fixed (i.e., errors that do not lead to wrong simulation results, e.g., units are wrong or errors in documentation):

Buildings.Fluid
Buildings.Fluid.CHPs.BaseClasses.EnergyConversionNormal Buildings.Fluid.CHPs.ThermalElectricalFollowing	Reformulated replaceable class to avoid access of components that are not in the constraining type. This is for issue #2471.
Buildings.Fluid.Geothermal.Borefields.BaseClasses.PartialBorefield	Corrected placement of `each` keyword. See Buildings, #2440. Switched port connections for `masFloDiv`. See IBPSA, #41. Propagated flowReversal into `masFloDiv` and `masFloMul`.
Buildings.Fluid.Geothermal.Borefields.Examples.Borefields Buildings.Fluid.Geothermal.Borefields.Validation.ConstantHeatInjection_100Boreholes Buildings.Fluid.Geothermal.Borefields.Validation.Sandbox	Added missing parameter keyword for data records.
Buildings.Fluid.HeatExchangers.BaseClasses.CoilRegister Buildings.Fluid.HeatExchangers.BaseClasses.HexElementLatent	Changed constant `simplify_mWat_flow` from protected to public because it is assigned by Buildings.Fluid.HeatExchangers.WetCoilCounterFlow. This is for #2387.
Buildings.Fluid.HeatExchangers.BaseClasses.PartialPrescribedOutlet	Removed duplicate declaration of `m_flow_nominal` which is already declared in the base class.
Buildings.Fluid.DXSystems.AirCooled.Examples.MultiStage Buildings.Fluid.DXSystems.AirCooled.Examples.PerformanceCurves.Curve_I Buildings.Fluid.DXSystems.AirCooled.Examples.PerformanceCurves.Curve_II Buildings.Fluid.DXSystems.AirCooled.Examples.PerformanceCurves.Curve_III Buildings.Fluid.DXSystems.AirCooled.Examples.SingleSpeed Buildings.Fluid.DXSystems.AirCooled.Examples.SpaceCooling Buildings.Fluid.DXSystems.AirCooled.Examples.VariableSpeed Buildings.Fluid.DXSystems.AirCooled.Validation.SingleSpeedEnergyPlus Buildings.Fluid.DXSystems.AirCooled.Validation.SingleSpeedPLREnergyPlus Buildings.Fluid.DXSystems.Cooling.BaseClasses.Examples.WetCoil Buildings.Fluid.DXSystems.WaterCooled.Examples.MultiStage Buildings.Fluid.DXSystems.WaterCooled.Examples.SingleSpeed Buildings.Fluid.DXSystems.WaterCooled.Examples.VariableSpeed Buildings.Fluid.DXSystems.WaterCooled.Validation.VariableSpeedEnergyPlus Buildings.Fluid.DXSystems.WaterCooled.Validation.VariableSpeedEnergyPlusPartLoad	Corrected placement of `each` keyword. See Buildings, PR #2440. Added missing parameter declaration for data record.
Buildings.Fluid.HeatExchangers.WetCoilCounterFlow	Removed `final` declaration in redeclaration. This is for #2392.
Buildings.Fluid.Interfaces.PrescribedOutlet	Removed duplicate declaration of `m_flow_nominal` which is already declared in the base class.
Buildings.Fluid.Sources.BaseClasses.PartialSource Buildings.Fluid.Storage.BaseClasses.IndirectTankHeatExchanger	Corrected misplaced `each` and added missing instance comment. This is for IBPSA, #1462.
Buildings.BoundaryConditions.WeatherData.BaseClasses.getTimeSpanTMY3	Corrected memory access violation on Windows for files with long header. This is for IBPSA, #1432.
Buildings.BoundaryConditions.WeatherData.BaseClasses.getTimeSpanTMY3 Buildings.Utilities.Cryptographics.sha	Corrected memory leak in C function.
Buildings.Utilities.IO.BCVTB.BaseClasses.FluidInterface	Corrected missing `each` keyword.

Extends from Modelica.Icons.ReleaseNotes (Icon for release notes in documentation).

Modelica definition

class Version_7_0_1 "Version 7.0.1" extends Modelica.Icons.ReleaseNotes; end Version_7_0_1;

Buildings.UsersGuide.ReleaseNotes.Version_7_0_0

Version 7.0.0

Information

Version 7.0.0 is a major release that contains various new packages, new models and improvements to existing models. The library has been tested with Dymola 2020x and 2021, JModelica (revision 14023), and OPTIMICA (revision OCT-stable-r12473_JM-r14295).

The following major changes have been done:

New packages have been added to model building controls (Buildings.Controls.OBC.Utilities) and to support the creation of emulators that compare the performance of building control sequences in the Building Optimization Performance Tests framework BOPTEST.
Various new control blocks have been added to Buildings.Controls.OBC.CDL.
Various new equipment models have been added, such as models of absorption chillers, CHP equipment and heat pumps.
The reduced order building models now also allow modeling air moisture and air contaminant balance.
A tutorial has been added to explain how to implement control sequences using the Control Description Language that is being developed in the OpenBuildingControl project.
The icons of many components have been updated so that they visualize temperatures, flow rates or control signals while the simulation is running.
Results of the ANSI/ASHRAE Standard 14 validation (BESTEST) are now integrated in the user's guide Buildings.ThermalZones.Detailed.Validation.BESTEST.UsersGuide.

The following new libraries have been added:

Buildings.Controls.OBC.Utilities	Package with utility blocks, base classes and validation models for the OpenBuildingControl (OBC) library.
Buildings.Utilities.IO.SignalExchange	Package with blocks that can be used to identify and activate control signal overwrites, and to identify and read sensor signals. This package is used by the Building Optimization Performance Test software BOPTEST.
Buildings.Utilities.IO.Python36	Upgraded from `Buildings.Utilities.IO.Python27` since Python2.7 has been deprecated. This is for issue #1760.

The following new components have been added to existing libraries:

Buildings.Controls
Buildings.Controls.OBC.ASHRAE.G36_PR1.AHUs.MultiZone.VAV.SetPoints.OutdoorAirFlow	Package of sequences for specifying the minimum outdoor airflow rate. This replaces `Buildings.Controls.OBC.ASHRAE.G36_PR1.AHUs.MultiZone.VAV.SetPoints.OutsideAirFlow`. The new implemented sequences separate zone level calculation from the system level calculation. It avoids vector-valued calculations. This is for #1829.
Buildings.Controls.OBC.ASHRAE.G36_PR1.Generic.SetPoints.ZoneStatus	Block that outputs zone temperature status by comparing it with setpoint temperatures, with the maximum and minimum temperature of the group which the zone is in. This allows separating the vector-valued calculations from control sequences. This is for #1709.
Buildings.Controls.OBC.CDL.Discrete.TriggeredMovingMean	Block that outputs the triggered discrete moving mean of an input signal. This replaces `Buildings.Controls.OBC.CDL.Discrete.MovingMean`, which has been moved to `Buildings.Obsolete`. This is for #1588.
Buildings.Controls.OBC.Utilities.OptimalStart	Block that outputs optimal start time for an HVAC system prior to the occupancy. This is for #1589.
Buildings.Fluid
Buildings.Fluid.Actuators.Valves.ThreeWayTable	Three way valves with opening characteristics based on a user-provided table.
Buildings.Fluid.CHPs	Package with model for combined heat and power device.
Buildings.Fluid.Chillers.AbsorptionIndirectSteam	Indirect steam heated absorption chiller based on performance curves.
Buildings.Fluid.FixedResistances.CheckValve	Check valve that prevents backflow, except for a small leakage flow rate. This is for IBPSA, #1198
Buildings.Fluid.HeatPumps.EquationFitReversible	Heat pump model that can be reversed between heating and cooling mode, that takes as a set point the leaving fluid temperature, and that computes its performance based on an equation fit.
Buildings.Examples.Tutorial
Buildings.Examples.Tutorial.CDL	Tutorial that explains how to implement control sequences using the Control Description Language.

The following existing components have been improved in a backward compatible way:

Buildings.BoundaryConditions.WeatherData
Buildings.BoundaryConditions.WeatherData.ReaderTMY3	Refactored weather data reader and changed implementation to allow exactly zero radiation rather than a small positive value. This was required to allow simulating buildings at steady-state, which is needed for some controls design. For examples in which buildings are simulated at steady-state, see `Buildings.ThermalZones.Detailed.Validation.MixedAirFreeResponseSteadyState`, `Buildings.Examples.VAVReheat.Validation.Guideline36SteadyState` and `Buildings.ThermalZones.ReducedOrder.Validation.RoomSteadyState`. This is for IBPSA, #1340.
Buildings.Controls.Continuous
Buildings.Controls.Continuous.LimPID	Removed homotopy that may be used during initialization to ensure that outputs are bounded. This is for IBPSA, #1221.
Buildings.Controls.OBC.CDL
Buildings.Controls.OBC.CDL.Continuous.Derivative	Removed parameter `initType` and `x_start`. This is for IBPSA, #1887. For Dymola, a conversion script makes this change.
Buildings.Controls.OBC.CDL.Continuous.IntegratorWithReset	Removed parameter `initType`. This is for IBPSA, #1887. For Dymola, a conversion script makes this change.
Buildings.Controls.OBC.CDL.Continuous.LimPID	Removed homotopy that may be used during initialization to ensure that outputs are bounded. This is for IBPSA, #1221.
Buildings.Controls.OBC.CDL.Continuous.Sources.CalendarTime Buildings.Controls.OBC.CDL.Types.ZeroTime	Revised implementation such that the meaning of `time` is better explained and unix time stamps are correctly defined with respect to GMT. Added option unix time stamp GMT. This is for IBPSA, #1232.
Buildings.Controls.OBC.CDL.Continuous.Sources.CalendarTime Buildings.Controls.OBC.CDL.Types.ZeroTime	Revised implementation such that the meaning of `time` is better explained and unix time stamps are correctly defined with respect to GMT. Added option unix time stamp GMT. This is for IBPSA, #1232.
Buildings.Controls.OBC.CDL.Logical.Latch Buildings.Controls.OBC.CDL.Logical.Toggle	Simplified implementation, which makes them work with OpenModelica. This is for #1823.
Buildings.Controls.OBC.CDL.Logical.Timer	Added a boolean input to reset the accumulated timer. This is for #1221.
Buildings.Controls.OBC.CDL.Types.Init	Removed this enumeration because it is no longer used. This is for #1887.
Buildings.Controls.OBC.ASHRAE.G36_PR1
Buildings.Controls.OBC.ASHRAE.G36_PR1.Generic.SetPoints.TrimAndRespond	Corrected to delay the true initial device status. This is for #1876
Buildings.Controls.OBC.ASHRAE.G36_PR1.TerminalUnits.Reheat.DamperValves	Replaced multisum block with add blocks, replaced gain block used for normalization with division block. This is for #1830
Buildings.Controls.OBC.ASHRAE.G36_PR1.AHUs.SingleZone.VAV.Controller	Replaced the mode and setpoint calculation block with `Buildings.Controls.OBC.ASHRAE.G36_PR1.TerminalUnits.ModeAndSetPoints`. This is for #1709
Buildings.Controls.OBC.ASHRAE.G36_PR1.TerminalUnits.Reheat.SetPoints.ActiveAirFlow	Used hysteresis to check occupancy. This is for #1788.
Buildings.Controls.OBC.ASHRAE.G36_PR1.AHUs.MultiZone.VAV.SetPoints.OutsideAirFlow	Applied hysteresis for checking ventilation efficiency. This is for #1787.
Buildings.Controls.OBC.ASHRAE.G36_PR1.Generic.SetPoints.TrimAndRespond	Added assertions and corrected implementation when respond amount is negative. This is for #1503.
Buildings.Examples.Tutorial
Buildings.Examples.Tutorial.Boiler Buildings.Examples.Tutorial.SpaceCooling	Updated examples to use the control blocks from the Control Description Language package `Buildings.Controls.OBC.CDL`.
Buildings.Examples.VAVReheat
Buildings.Examples.VAVReheat.BaseClasses.VAVBranch	Added output connector for returned damper position.
Buildings.Fluid
Buildings.Fluid.Actuators.BaseClasses.ActuatorSignal Buildings.Fluid.Actuators.Dampers.PressureIndependent	Added the computation of the damper opening.
Buildings.Fluid.Actuators.BaseClasses.PartialTwoWayValve Buildings.Fluid.Actuators.Valves.TwoWayEqualPercentage Buildings.Fluid.Actuators.Valves.TwoWayLinear Buildings.Fluid.Actuators.Valves.TwoWayPolynomial Buildings.Fluid.Actuators.Valves.TwoWayPressureIndependent Buildings.Fluid.Actuators.Valves.TwoWayQuickOpening Buildings.Fluid.Actuators.Valves.TwoWayTable	Improved implementation to guard against control input that is negative. The new implementation constrains the input to be bigger than 0. This is for IBPSA, #1233.
Buildings.Fluid.Geothermal.Borefields.BaseClasses.HeatTransfer.ThermalResponseFactors.shaGFunction	Declared string as a constant due to JModelica's tigther type checking. This is for IBPSA, #1230.
Buildings.Fluid.DXSystems.AirCooled.MultiStage Buildings.Fluid.DXSystems.AirCooled.SingleSpeed Buildings.Fluid.DXSystems.AirCooled.VariableSpeed Buildings.Fluid.DXSystems.WaterCooled.MultiStage Buildings.Fluid.DXSystems.WaterCooled.SingleSpeed Buildings.Fluid.DXSystems.WaterCooled.VariableSpeed	Corrected wrong `min` and `max` attribute for change in humidity. This is for #1933.
Buildings.Fluid.Storage.Stratified Buildings.Fluid.Storage.StratifiedEnhanced Buildings.Fluid.Storage.StratifiedEnhancedInternalHex	Provided option to initialize the tank temperature at different values across the height of the tank. This is for IBPSA, #1246.
Buildings.Fluid.SolarCollectors.BaseClasses.PartialSolarCollector	In volume, set `prescribedHeatFlowRate=false`. This is for #1636.
Buildings.HeatTransfer
Buildings.HeatTransfer.Convection.Exterior	Set wind direction modifier to a constant as wind speed approaches zero. This is for #1923.
Buildings.ThermalZones.Detailed.Validation.BESTEST.Cases6xx
Buildings.ThermalZones.Detailed.Validation.BESTEST.Cases6xx.Case600 Buildings.ThermalZones.Detailed.Validation.BESTEST.Cases6xx.Case600FF	Changed computation of time averaged values to avoid a time event every hour. This is for #1714.
Buildings.ThermalZones.ReducedOrder
Buildings.ThermalZones.ReducedOrder.RC.OneElement Buildings.ThermalZones.ReducedOrder.RC.TwoElements Buildings.ThermalZones.ReducedOrder.RC.ThreeElements Buildings.ThermalZones.ReducedOrder.RC.FourElements	Added option to also simulate moisture balance in room air volume. This can be enabled by setting the parameter `use_moisture_balance = true`. This is for IBPSA, #1209.
Buildings.Utilities
Buildings.Utilities.IO.Files.CSVWriter Buildings.Utilities.IO.Files.CombiTimeTableWriter Buildings.Utilities.IO.Files.CombiTimeTableWriter	Revised to avoid overflow of string buffer in Dymola. This is for IBPSA, #1219.
Buildings.Utilities.Math.SmoothHeaviside Buildings.Utilities.Math.Functions.SmoothHeaviside	This function is now twice instead of only once Lipschitz continuously differentiable. This is for IBPSA, #1202.
Buildings.Utilities.Time.CalendarTime Buildings.Utilities.Time.Types.ZeroTime	Revised implementation such that the meaning of `time` is better explained and unix time stamps are correctly defined with respect to GMT. Added option unix time stamp GMT. This is for IBPSA, #1192.
Buildings.Utilities.Comfort.Fanger	Updated the model from ASHRAE 1997 to ANSI/ASHRAE 55-2017 and added a validation model which compares the PMV with an implementation from the University of California at Berkeley. This is for #1936.
Buildings.Examples
Buildings.Examples.VAVReheat.BaseClasses.Floor Buildings.Examples.VAVReheat.ASHRAE2006 Buildings.Examples.VAVReheat.Guideline36 Buildings.Examples.DualFanDualDuct	Updated core zone geometry parameters related to room heat and mass balance. This change was done in `Buildings.Examples.VAVReheat.BaseClasses.Floor`. This is for #1719.

The following existing components have been improved in a non-backward compatible way:

Buildings.Airflow
Buildings.Airflow.Multizone	Set parameters `m_flow_small`, `m1_flow_small` and `m2_flow_small` to `final` so that they do no longer appear on the GUI. These parameters are not used by models in this package. This is for IBPSA, #1362. For Dymola, a conversion script makes this change.
Buildings.Controls.OBC.CDL
Buildings.Controls.OBC.CDL.Continuous.LimPID	Refactored model so that it is itself a CDL conformant composite block. This refactoring removes the no longer use parameters `xd_start` that was used to initialize the state of the derivative term. This state is now initialized based on the requested initial output `yd_start` which is a new parameter with a default of `0`. Also, removed the parameters `y_start` and `initType` because the initial output of the controller can be set by using `xi_start` and `yd_start`. This refactoring also removes the parameter `strict` that was used in the output limiter. The new implementation enforces a strict check by default. This is for #1878. For Dymola, a conversion script makes this change.
Buildings.Controls.OBC.CDL.Continuous.LimPID	Changed the default values for the output limiter from `yMin=-yMax` to `yMin=0` and from `yMax` being unspecified to `yMax=1`. This is for #1888. For Dymola, a conversion script makes this change.
Buildings.Controls.OBC.CDL.Discrete.MovingMean	This block became obsolete, use `Buildings.Controls.OBC.CDL.Discrete.TriggeredMovingMean` instead. For Dymola, a conversion script makes this change.
Buildings.Controls.OBC.Utilities.SetPoints.SupplyReturnTemperatureReset	Changed name from `HotWaterTemperatureReset` to `SupplyReturnTemperatureReset`. This is for #860. For Dymola, a conversion script makes this change.
Buildings.Controls.OBC.ASHRAE.G36_PR1
Buildings.Controls.OBC.ASHRAE.G36_PR1.AHUs.MultiZone.VAV.Controller	Reimplemented to add new block for specifying the minimum outdoor airfow setpoint. The new block avoids vector-valued calculations. The reimplemented controller needs to work with `Buildings.Controls.OBC.ASHRAE.G36_PR1.AHUs.MultiZone.VAV.SetPoints.OutdoorAirFlow.Zone` and `Buildings.Controls.OBC.ASHRAE.G36_PR1.AHUs.MultiZone.VAV.SetPoints.OutdoorAirFlow.SumZone`, to calculate the zone level minimum outdoor airflow setpoints and then find the sum, the minimum and the maximum of these setpoints. See `Buildings.Examples.VAVReheat.Guideline36`. This is for #1829.
Buildings.Controls.OBC.ASHRAE.G36_PR1.Generic.SetPoints.OperationMode	Reimplemented to remove the vector-valued calculations. This is for #1709
Buildings.Controls.OBC.ASHRAE.G36_PR1.AHUs.SingleZone.VAV.ModeAndSetPoints	Removed from the library as it can be replaced by `Buildings.Controls.OBC.ASHRAE.G36_PR1.TerminalUnits.ModeAndSetPoints`. This is for #1709
Buildings.Controls.OBC.ASHRAE.G36_PR1.AHUs.SingleZone.VAV.Controller	Added cooling coil control and the controller validation model. This is for #1265
Buildings.Controls.OBC.ASHRAE.G36_PR1.AHUs.SingleZone.VAV.Economizers.Subsequences.Enable	Added the option to allow fixed plus differential dry bulb temperature cutoff.
Buildings.Controls.OBC.ASHRAE.G36_PR1.AHUs.SingleZone.VAV.Economizers.Subsequences.Modulation	Added heating coil control sequences.
Buildings.Controls.OBC.ASHRAE.G36_PR1.AHUs.SingleZone.VAV.SetPoints.Supply	Added a switch for fan control.
Buildings.Controls.OBC.ASHRAE.G36_PR1.AHUs.SingleZone.VAV.ZoneState	Improved the implementation to avoid issues when heating and cooling controls occur at the same time.
Buildings.Controls.OBC.ASHRAE.G36_PR1.TerminalUnits.Reheat.SystemRequests	Changed the actual damper position name from `uDam` to `yDam_actual`. This is for #1873
Buildings.Controls.OBC.ASHRAE.G36_PR1.TerminalUnits.Controller	Added actual VAV damper position as the input for generating system request. This is for #1873
Buildings.Controls.OBC.ASHRAE.G36_PR1.TerminalUnits.Reheat.DamperValves	Added option to check if the VAV damper is pressure independent. This is for #1873
Buildings.Controls.SetPoints
Buildings.Controls.SetPoints.SupplyReturnTemperatureReset	Changed name from `HotWaterTemperatureReset` to `SupplyReturnTemperatureReset`. This is for #860. For Dymola, a conversion script makes this change.
Buildings.Fluid.Actuators
Buildings.Fluid.Actuators.BaseClasses.PartialDamperExponential Buildings.Fluid.Actuators.Dampers.Exponential Buildings.Fluid.Actuators.Dampers.MixingBox Buildings.Fluid.Actuators.Dampers.MixingBoxMinimumFlow Buildings.Fluid.Actuators.Dampers.PressureIndependent Buildings.Fluid.Actuators.Dampers.VAVBoxExponential	Merged `VAVBoxExponential` into `Exponential`. `Exponential` now provides all modeling capabilities previously implemented in `VAVBoxExponential` which is no more needed and has been removed from the library. New parameters `dpDamper_nominal` and `dpFixed_nominal` have been introduced in `Exponential`, consistent with the valve models. Parameter `k0` has been replaced by a leakage coefficient. For Dymola, a conversion script makes this change. However the script will not make the `each` keyword persist in array declarations. The keyword will have to be manually reintroduced after applying the script. This is for IBPSA, #1188.
Buildings.ThermalZones.ReducedOrder
Buildings.ThermalZones.ReducedOrder.RC.OneElement Buildings.ThermalZones.ReducedOrder.RC.OneElement Buildings.ThermalZones.ReducedOrder.RC.OneElement Buildings.ThermalZones.ReducedOrder.RC.OneElement Buildings.ThermalZones.ReducedOrder.RC.ThreeElements Buildings.ThermalZones.ReducedOrder.RC.ThreeElements Buildings.ThermalZones.ReducedOrder.RC.TwoElements Buildings.ThermalZones.ReducedOrder.RC.TwoElements Buildings.ThermalZones.ReducedOrder.RC.FourElements Buildings.ThermalZones.ReducedOrder.RC.FourElements Buildings.ThermalZones.ReducedOrder.RC.OneElement Buildings.ThermalZones.ReducedOrder.EquivalentAirTemperature.BaseClasses.PartialVDI6007 Buildings.ThermalZones.ReducedOrder.EquivalentAirTemperature.BaseClasses.PartialVDI6007 Buildings.ThermalZones.ReducedOrder.EquivalentAirTemperature.VDI6007WithWindow	Renamed convection coefficient from `alpha` to `hCon`. For Dymola, a conversion script makes this change. This is for IBPSA, #1168.

The following critical errors have been fixed (i.e., errors that can lead to wrong simulation results):

Buildings.Controls.OBC.CDL
Buildings.Controls.OBC.CDL.Continuous.Sources.TimeTable	Corrected implementation so that it gives the correct periodicity of the table if the simulation starts at a negative time. This is for 1834.
Buildings.Electrical
Buildings.Electrical.AC.OnePhase.Sources.PVSimple Buildings.Electrical.AC.OnePhase.Sources.PVSimpleOriented Buildings.Electrical.AC.ThreePhasesBalanced.Sources.PVSimple Buildings.Electrical.AC.ThreePhasesBalanced.Sources.PVSimpleOriented Buildings.Electrical.AC.ThreePhasesUnbalanced.Sources.PVsimple Buildings.Electrical.AC.ThreePhasesUnbalanced.Sources.PVsimpleOriented Buildings.Electrical.AC.ThreePhasesUnbalanced.Sources.PVsimpleOriented_N Buildings.Electrical.AC.ThreePhasesUnbalanced.Sources.PVsimple_N Buildings.Electrical.Interfaces.PartialPV	Corrected model so that reported power `P` also includes the DCAC conversion. Note that the power added to the elecrical system was correct, but the power reported in the output connector `P` did not include this conversion factor. This is for 1577.
Buildings.Electrical.AC.OnePhase.Storage.Battery Buildings.Electrical.AC.ThreePhasesBalanced.Storage.Battery	Corrected model and improved the documentation. The previous model extracted from the AC connector the input power `P` plus the AC/DC conversion losses, but `P` should be the power exchanged at the AC connector. Conversion losses are now only accounted for in the energy exchange at the battery. This is for 1865.
Buildings.Examples.VAVReheat
Buildings.Examples.VAVReheat.ASHRAE2006 Buildings.Examples.VAVReheat.Guideline36	Connected actual VAV damper position as the measured input data for defining duct static pressure setpoint. This is for #1873.
Buildings.Examples.VAVReheat.Controls.DuctStaticPressureSetpoint	Reverse action changed to `true` for the pressure set-point controller.
Buildings.Examples.VAVReheat.Controls.RoomVAV	Refactored the model to implement a single maximum control logic. The previous implementation led to a maximum air flow rate in heating demand. The input connector `TDis` is removed. This is non backward compatible. This is for #1873.
Buildings.Fluid
Buildings.Fluid.HeatExchangers.CoolingTowers.YorkCalc Buildings.Fluid.HeatExchangers.CoolingTowers.BaseClasses.Characteristics.normalizedPower	Corrected error in computing the cooling tower fan power consumption. This is for 1691.
Buildings.Utilities
Buildings/Resources/Python-Sources/KalmanFilter.py Buildings.Utilities.IO.Python27.Examples.KalmanFilter	Changed the temporary file format from `pickle` to `json` as the former can trigger a segfault with JModelica simulation run in a subprocess. This is for Buildings, #1587.

The following uncritical errors have been fixed (i.e., errors that do not lead to wrong simulation results, e.g., units are wrong or errors in documentation):

Buildings.Controls.OBC.CDL
Buildings.Controls.OBC.CDL.Continuous.LimPID	Removed wrong unit declaration for gain `k`. This is for Buildings, #1821.
Buildings.Fluid.Sources
Buildings.Fluid.Sources.Boundary_pT Buildings.Fluid.Sources.Boundary_ph Buildings.Fluid.Sources.MassFlowSource_T Buildings.Fluid.Sources.MassFlowSource_h	Refactored handling of mass fractions which was needed to handle media such as `Modelica.Media.IdealGases.MixtureGases.FlueGasSixComponents` and `Modelica.Media.IdealGases.MixtureGases.SimpleNaturalGas`. Prior to this change, use of these media led to a translation error. This is for IBPSA, #1205.
Buildings.ThermalZones.Detailed
Buildings.ThermalZones.Detailed.Constructions.Examples.ExteriorWallTwoWindows Buildings.ThermalZones.Detailed.Constructions.Examples.ExteriorWallWithWindow	Corrected wrong assignment of a parameter. This is for IBPSA, #1766.
Buildings/Resources
Buildings/Resources/C-Sources/cryptographicsHash.c	Add a `#ifndef` clause. This is for IBPSA, #1278.

The following components have become obsolete:

Buildings.Obsolete
Buildings.Obsolete.Controls.OBC.CDL.Discrete.MovingMean	The block `Buildings.Controls.OBC.CDL.Discrete.TriggeredMovingMean` replaced the original `MovingMean` block. For Dymola, a conversion script makes this change. This is for #1588.
Buildings.Obsolete.Utilities.IO.Python27	The package `Buildings.Utilities.IO.Python27` has been upgraded to `Buildings.Utilities.IO.Python36`. For Dymola, a conversion script moves the Python27 package to here. This is for issue #1760.

Extends from Modelica.Icons.ReleaseNotes (Icon for release notes in documentation).

Modelica definition

class Version_7_0_0 "Version 7.0.0" extends Modelica.Icons.ReleaseNotes; end Version_7_0_0;

Buildings.UsersGuide.ReleaseNotes.Version_6_0_0

Version 6.0.0

Information

Version 6.0.0 is a major new release that contains various new packages, new models and improvements to existing models. The library has been tested with Dymola 2019FD01 and with JModelica (revision 12903).

The following major changes have been done:

Various new packages have been added, such as:
- A package for simulating occupancy and occupancy that resulted from IEA EBC Annex 66.
- A package with models for geothermal borefields.
- A package with blocks for control of shades and of outdoor lights.
- A package with blocks that allow generating time series and scatter plots, and writing these plots to one or several html files.
- A package with blocks for unit conversion.
Various new control blocks have been added to Buildings.Controls.OBC.CDL.

The following new libraries have been added:

Buildings.Controls.OBC.OutdoorLights	Package with outdoor lighting controllers.
Buildings.Controls.OBC.Shade	Package with shade controllers.
Buildings.Controls.OBC.UnitConversions	Package with blocks for unit conversion. Blocks in this package are meant to use when reading data from a building automation system, or writing data to a building automation system, that uses units that are different from the units used by Modelica.
Buildings.Fluid.Geothermal	Package with models for geothermal heat exchangers. This package has models for borefields with vertical boreholes, and for a single vertical borehole with a U-tube heat exchanger. The borefield models can have any geometrical configuration, and either one or two U-tube heat exchangers.
Buildings.Occupants	Package with occupant behavior models and functions to simulate the occupancy and the interaction of occupants with air-conditioning and heating systems, windows, blinds, and lighting in residential and office buildings.
Buildings.Utilities.Cryptographics	Package with a function to compute a SHA1 encrypted string.
Buildings.Utilities.IO.Files	Package with blocks to write CSV files, JSON files or combi time table files.
Buildings.Utilities.Plotters	Package with blocks that allow generating time series and scatter plots, and writing these plots to one or several html files. The plots can be deactivated based on an input signal and a time delay, for example, to plot data only while the HVAC system operates for at least 30 minutes.

The following new components have been added to existing libraries:

Buildings.Controls.OBC.CDL
Buildings.Controls.OBC.CDL.Continuous.MultiOr	Block that outputs true boolean signal if and only if any element of the boolean input vector is true.
Buildings.Controls.OBC.CDL.Continuous.MatrixMin	Block that outputs vector of row- or column-wise minimum values.
Buildings.Controls.OBC.CDL.Continuous.MatrixMax	Block that outputs vector of row- or column-wise maximum values.
Buildings.Controls.OBC.CDL.Continuous.MatrixGain	Block that outputs the product of a gain matrix with the input signal vector.
Buildings.Controls.OBC.CDL.Discrete.MovingMean	Block that outputs the discrete moving mean of a sampled input signal.
Buildings.Controls.OBC.CDL.Integers.Change	Block that outputs whether its Integer input changed its value, and whether it increased or decreased.
Buildings.Controls.OBC.CDL.Logical.IntegerSwitch	Block that outputs one of two integer input signals based on a boolean input signal.
Buildings.Controls.OBC.CDL.Routing.RealExtractor	Block that extracts a scalar signal from a signal vector dependent on an Integer-valued input.
Buildings.Controls.OBC.CDL.Utilities.SunRiseSet	Block that outputs sunrise and sunset time for each day.
Buildings.Fluid
Buildings.Fluid.HeatExchangers	Added `Buildings.Fluid.HeatExchangers.PlateHeatExchangerEffectivenessNTU` which computes the effectiveness of a plate heat exchanger based on design conditions and current mass flow rates.
Buildings.Utilities
Buildings.Utilities.Math	Added Bessel, exponential integral, factorial, falling factorial and binomial functions.
Buildings.Utilities.Psychrometrics.Functions.X_pTphi	Added function to compute humidity mass fraction for given pressure, temperature and relative humidity.

The following existing components have been improved in a backward compatible way:

Buildings.BoundaryConditions
Buildings.BoundaryConditions.WeatherData.ReaderTMY3	Updated implementation to allow for weather data file that span less than a year and cross New Year, and for weather data files that span more than a year. This is for IBPSA, #842.
Buildings.Controls.OBC.CDL
Buildings.Controls.OBC.CDL.Logical.Timer	Updated implementation to output accumulated time when input is `true`. This is for issue 1212.
Buildings.Controls.OBC.CDL.Logical.TrueDelay	Added parameter `delayOnInit` to optionally delay the initial `true` input. This is for issue 1346.
Buildings.Controls.OBC.ASHRAE.G36_PR1
Buildings.Controls.OBC.ASHRAE.G36_PR1/AHUs.SingleZone.VAV.SetPoints.OutsideAirFlow	Made input connector for occupancy conditionally removable to avoid having to set the number of occupants as an input if there is no occupancy sensor. This is for issue 1270.
Buildings.Fluid
Buildings.Fluid.Interfaces.ConservationEquation Buildings.Fluid.MixingVolumes.MixingVolume Buildings.Fluid.MixingVolumes.MixingVolumeMoistAir	Changed model so that the volume is no longer fixed at compilation time. This is for issue 1411.
Buildings.Media
Buildings.Media.Air Buildings.Media.Water Buildings.Media.Antifreeze.PropyleneGlycolWater Buildings.Media.Specialized.Air.PerfectGas	Improved error message when temperature or mass fraction is outside the allowed range. This is for IBPSA, issue 1045.
Buildings.Utilities.IO.Python27
Buildings.Utilities.IO.Python27.Functions.exchange	Refactored setting the `PYTHONPATH` environment variable. This is for issue 1421.

The following existing components have been improved in a non-backward compatible way:

Buildings.Airflow.Multizone
Buildings.Airflow.Multizone.DoorDiscretizedOperable	Removed parameter `CD`. For Dymola, a conversion script makes this change. This is for IBPSA, #971.
Buildings.Airflow.Multizone.EffectiveAirLeakageArea	Removed parameters `A`, `CD` and `lWet`. For Dymola, a conversion script makes this change. This is for IBPSA, #932.
Buildings.Airflow.Multizone.MediumColumnDynamic	Removed parameter `m_flow_nominal`. For Dymola, a conversion script makes this change. This is for IBPSA, #970.
Buildings.Airflow.Multizone.Orifice	Removed parameter `lWet`. For Dymola, a conversion script makes this change. This is for IBPSA, #932.
Buildings.Airflow.Multizone.MediumColumnDynamic Buildings.Airflow.Multizone.MediumColumn Buildings.Airflow.Multizone.EffectiveAirLeakageArea Buildings.Airflow.Multizone.Orifice	Removed parameter `allowFlowReversal` as this is not meaningful for these models. For Dymola, a conversion script makes this change. This is for IBPSA, #877.
Buildings.BoundaryConditions
Buildings.BoundaryConditions.WeatherData.BaseClasses.ConvertTime	Added new parameters needed for weather data files that span multiple years. Models of users are not likely to be affected by this change as this model is part of the weather data file reader that implements all required changes. This is for IBPSA, #842.
Buildings.Controls.OBC.ASHRAE
Buildings.Controls.OBC.ASHRAE.G36_PR1.AHUs.SingleZone Buildings.Controls.OBC.ASHRAE.G36_PR1.AHUs.MultiZone	Renamed packages to `Buildings.Controls.OBC.ASHRAE.G36_PR1.AHUs.SingleZone.VAV` and `Buildings.Controls.OBC.ASHRAE.G36_PR1.AHUs.MultiZone.VAV`, and renamed various signals and parameters for consistency. For Dymola, a conversion script makes this change.
Buildings.Controls.OBC.CDL
Buildings.Controls.OBC.CDL.RealExtractSignal	Changed block name from `ExtractSignal`. For Dymola, a conversion script makes this change.
Buildings.Controls.OBC.CDL.Continuous.MultiMax	Changed output variable name from `yMax` to `y`. For Dymola, a conversion script makes this change. This is for issue 1252.
Buildings.Controls.OBC.CDL.Continuous.MultiMin	Changed output variable name from `yMin` to `y`. For Dymola, a conversion script makes this change. This is for issue 1252.
Buildings.Fluid
Buildings.Fluid.HeatExchangers.DryEffectivenessNTU	Renamed model to `Buildings.Fluid.HeatExchangers.DryCoilEffectivenessNTU` because the convective heat transfer coefficients are for air. For Dymola, a conversion script makes this change. Removed variable `Z` as it is not used.
Buildings.Fluid.HeatExchangers.PlateHeatExchangerEffectivenessNTU	Removed variable `Z` as it is not used.
Buildings.Fluid.HeatExchangers.Ground.Boreholes.BaseClasses.factorial	Renamed function to `Buildings.Utilities.Math.Functions.factorial` because it is also used by the new Geothermal package. For Dymola, a conversion script makes this change.
Buildings.Fluid.HeatExchangers.Ground.Boreholes	Renamed package to `Buildings.Fluid.Geothermal.Boreholes` due to the introduction of the new Geothermal package. For Dymola, a conversion script makes this change.
Buildings.Fluid.HeatExchangers.RadiantSlabs.BaseClasses.MassFlowRateMultiplier	Renamed model to `Buildings.Fluid.BaseClasses.MassFlowRateMultiplier` because it is also used by the new Geothermal package. For Dymola, a conversion script makes this change.
Buildings.Fluid.Sources.FixedBoundary	This model is now obsolete and will be removed in future releases. The model has been renamed model to `Buildings.Obsolete.Fluid.Sources.FixedBoundary`. Use `Buildings.Fluid.Sources.Boundary_pT` instead. For Dymola, a conversion script makes this change.
Buildings.Media
Buildings.Media.Refrigerants.R410A	Removed the function `pressureSatLiq_T` as it was not used. This is for IBPSA, #995.
Buildings.Utilities.Reports
Buildings.Utilities.Reports.Printer Buildings.Utilities.Reports.printRealArray	Moved `Buildings.Utilities.Reports.Printer` to `Buildings.Utilities.IO.Files.Printer` and moved `Buildings.Utilities.Reports.printRealArray` to `Buildings.Utilities.IO.Files.BaseClasses.printRealArray`. For Dymola, a conversion script makes this change. This is due to the newly introduced package `Buildings.Utilities.IO.Files`.

The following critical errors have been fixed (i.e., errors that can lead to wrong simulation results):

Buildings.Controls.OBC.CDL
Buildings.Controls.OBC.CDL.Logical.Latch	Corrected implementation that causes wrong output at initial stage. This is for issue 1402.
Buildings.Controls.OBC.CDL.Logical.Toggle	Corrected implementation that causes wrong output at initial stage. This is for issue 1402.
Buildings.Fluid.Geothermal
Buildings.Fluid.Geothermal.Borefields.Data.Soil.SandStone	Corrected wrong thermal properties. This is for IBPSA, #1062.
Buildings.Fluid.HeatExchangers
Buildings.Fluid.HeatExchangers.Heater_T Buildings.Fluid.HeatExchangers.SensibleCooler_T	Corrected missing propagation of initial conditions. This is for IBPSA, #1016.
Buildings.ThermalZones.Detailed
Buildings.ThermalZones.Detailed.MixedAir	Propagated parameter `mSenFac` which increased the thermal capacity of the room air, such as to account for furniture. This is for issue 1405.
Buildings.ThermalZones.ReducedOrder
Buildings.ThermalZones.ReducedOrder.RC.ThreeElements Buildings.ThermalZones.ReducedOrder.RC.FourElements	The RC element of the roof `roofRC` was flipped to have its `port_b` on the outside. The resistances `RRem` and `R` of the roof and floor have been switched in the documentation. This is for IBPSA, #997.

The following uncritical errors have been fixed (i.e., errors that do not lead to wrong simulation results, e.g., units are wrong or errors in documentation):

Buildings.Controls.OBC.ASHRAE
Buildings.Controls.OBC.ASHRAE.G36_PR1.Generic.SetPoints.OperationMode	Corrected wrong time in the documentation of the parameters. This is for issue 1409.

Extends from Modelica.Icons.ReleaseNotes (Icon for release notes in documentation).

Modelica definition

class Version_6_0_0 "Version 6.0.0" extends Modelica.Icons.ReleaseNotes; end Version_6_0_0;

Buildings.UsersGuide.ReleaseNotes.Version_5_1_0

Version 5.1.0

Information

Version 5.1.0 adds new libraries, new components and improves various existing components. Version 5.1.0 updates the license to a 3-clause BSD license. It is backward compatible with versions 5.0.0 and 5.0.1.

This release adds a model for propylene glycol - water mixtures, a model for long pipes suited for district heating and cooling simulations, a new valve model whose opening characteristics can be fit to measured data, and idealized models that allow to prescribe the temperature and humidity in any part of a fluid flow system.

The following new libraries have been added:

Buildings.Media.Antifreeze.PropyleneGlycolWater

Package with medium model for propylene glycol - water mixture. The concentration and the medium temperature for which the properties are evaluated can be set when instantiating the medium.

The following new components have been added to existing libraries:

Buildings.Fluid
Buildings.Fluid.Actuators.Valves.TwoWayPolynomial	Two-way valve with opening characteristics specified by a polynomial. This model may be used if a valve characteristics needs to be matched to measured data.
Buildings.Fluid.FixedResistances.PlugFlowPipe	Pipe with heat loss and transport of the fluid using a plug flow model. This model is applicable for simulation of long pipes such as in district heating and cooling systems.
Buildings.Fluid.Sources.PropertySource_T Buildings.Fluid.Sources.PropertySource_h	Model that changes the fluid properties of the medium that flows through it based on input signals. These idealized models can be used to force a certain temperature, enthalpy or humidity in a fluid flow system.

The following existing components have been improved in a backward compatible way:

Buildings.Airflow.Multizone
Buildings.Airflow.Multizone.DoorDiscretizedOpen Buildings.Airflow.Multizone.DoorDiscretizedOperable	Removed term that assures non-zero flow rate in each path, reformulated flow balance to ensure that model is symmetric, and improved implementation to reduce number of calculations. This is for IBPSA, issue 937.
Buildings.Applications.DataCenters
Buildings.Applications.DataCenters.ChillerCooled.Equipment.BaseClasses.PartialParallelElectricEIR	Added `constrainedby` to declaration of chiller. This is for issue 1118.
Buildings.Controls.OBC.ASHRAE.G36_PR1
Buildings.Controls.OBC.ASHRAE.G36_PR1.AHUs.SingleZone.VAV.SetPoints.Supply	Revised implementation of fan speed control signal calculation to remove the hysteresis blocks. This is for issue 1153.
Buildings.Controls.OBC.CDL
Buildings.Controls.OBC.CDL.Continuous.Line	Improved documentation and icon, and added a warning if the limits are used and x1 > x2.
Buildings.Fluid.SolarCollectors
Buildings.Fluid.SolarCollectors.ASHRAE93 Buildings.Fluid.SolarCollectors.EN12975	Improved calculation of heat loss. This is for issue 1100.
Buildings.Fluid.Sources
Buildings.Fluid.Sources.Boundary_pT Buildings.Fluid.Sources.Boundary_ph Buildings.Fluid.Sources.FixedBoundary Buildings.Fluid.Sources.MassFlowSource_T Buildings.Fluid.Sources.MassFlowSource_h	Refactored models to allow using `Xi` rather than `X` as an input. By default, the check on the medium base properties is now removed to reduce translation and simulation time. This is for IBPSA, issue 882.
Buildings.Fluid.Storage.Stratified	Refactored tank to allow modeling of tanks that have multiple inlets or outlets along the height. The tank now has for each control volume a fluid port that can be connected from outside the model. This is for issue 1182.
Buildings.Utilities.IO
Buildings.Utilities.IO.Python27	Added option for a Python object to be passed from one Python function invocation to the next. This allows to build up a Python data structure (or to instantiate a Python object), and do computations on this object at each function invocation. For example, a Model Predictive Control algorithm or a machine learning algorithm, implemented in Python, could be fed with data at each time step. It could then store this data and use the current and its historical data to feed its algorithm. Based on this algorithm, it could output a control signal for use in another Modelica model. The function `Buildings.Utilities.IO.Python27.Functions.exchange` now takes two additional arguments: A class that contains a pointer to the Python interpreter (for efficiency, as this avoids initializing Python at each call), and a flag that determines whether the Python function returns an object and receives this object at the next invocation. See `Buildings.Utilities.IO.Python27.UsersGuide` and `Buildings.Utilities.IO.Python27.Real_Real` for how to use these two arguments. Models that use `Buildings.Utilities.IO.Python27.Real_Real` will still work as before. The change only affects the low-level function `Buildings.Utilities.IO.Python27.Functions.exchange`.
Buildings.Utilities.IO.Python27	Corrected `LibraryDirectory` annotation. This is for issue 1160.

The following critical errors have been fixed (i.e., errors that can lead to wrong simulation results):

Buildings.Fluid.Interfaces
Buildings.Fluid.Interfaces.PrescribedOutlet	Corrected error that caused the old model do not track `TSet` and `X_wSet` simultaneously. This is for IBPSA, issue 893.

Extends from Modelica.Icons.ReleaseNotes (Icon for release notes in documentation).

Modelica definition

class Version_5_1_0 "Version 5.1.0" extends Modelica.Icons.ReleaseNotes; end Version_5_1_0;

Buildings.UsersGuide.ReleaseNotes.Version_5_0_1

Version 5.0.1

Information

Version 5.0.1 corrects an error in Buildings.Fluid.SolarCollectors that led to too small heat losses if a collector has more than one panel. Also, Dymola specific annotations to load data files in a GUI have been replaced for compatibility with other tools. Otherwise, version 5.0.1 is identical to 5.0.0.

All models simulate with Dymola 2017FD01, Dymola 2018 and JModelica (revision 10374).

The following critical errors have been fixed (i.e., errors that can lead to wrong simulation results):

Buildings.Fluid.SolarCollectors
Buildings.Fluid.SolarCollectors.ASHRAE93 Buildings.Fluid.SolarCollectors.EN12975	Corrected error in parameterization of heat loss calculation that led to too small heat losses if a collector has more than one panel. This is for issue 1073.

Extends from Modelica.Icons.ReleaseNotes (Icon for release notes in documentation).

Modelica definition

class Version_5_0_1 "Version 5.0.1" extends Modelica.Icons.ReleaseNotes; end Version_5_0_1;

Buildings.UsersGuide.ReleaseNotes.Version_5_0_0

Version 5.0.0

Information

Version 5.0.0 is a major new release that contains new packages to model control sequences, a package with control sequences from ASHRAE Guideline 36 and a package with pre-configured models for data center chilled water plants. All models simulate with Dymola 2017FD01, Dymola 2018 and with JModelica (revision 10374).

The following major changes have been done:

The package Buildings.Controls.OBC.CDL has been added. This package provides elementary blocks to implemented control sequences. The blocks conform to the Control Description Language specification published at https://obc.lbl.gov.
The package Buildings.Controls.OBC.ASHRAE.G36_PR1 has been added. This package contains control sequences for variable air volume flow systems according to ASHRAE Guideline 36, public review draft 1. The implementation uses blocks from the above described Buildings.Controls.OBC.CDL package, and conforms to the Control Description Language specification.
New models for ideal heaters and sensible coolers, and ideal humidifiers have been added.
Various models have been improved.

The following new libraries have been added:

Buildings.Applications.DataCenter	Library with component models and pre-configured system models for data centers.
Buildings.Controls.OBC	Library with basic control blocks and ready-to-use control sequences from the OpenBuildingControl project (https://obc.lbl.gov). The subpackage `Buildings.Controls.OBC.ASHRAE` contains control sequences for HVAC systems as described in ASHRAE Guideline 36. The subpackage `Buildings.Controls.OBC.CDL` contains libraries with basic control blocks. These are a part of a Control Description Language (CDL) currently being developed, which is used to compose the sequences in `Buildings.Controls.OBC.ASHRAE`. The intent of this implementation is that Modelica models that are conformant with the CDL can be translated to product lines of different control vendors.
Buildings.Fluid.Humidifiers	Package with spray air washer, steam humidifier and a humidifer that adds a water vapor mass flow rate that is proportional to the control input.

The following new components have been added to existing libraries:

Buildings.Fluid.HeatExchangers
Buildings.Fluid.HeatExchangers.Heater_T Buildings.Fluid.HeatExchangers.SensibleCooler_T	Added these new components to allow modeling a heater and a sensible-only cooler that use an input signal to ideally control their outlet temperature, with optional capacity limitation and optional first order dynamics.
Buildings.Fluid.MassExchangers
Buildings.Fluid.Humidifiers.SprayAirWasher_X Buildings.Fluid.Humidifiers.SteamHumidifier_X	Added component which allows setting the outlet water vapor mass fraction using an input signal, and controlling it ideally with optional capacity limitation and optional first order dynamics.
Buildings.Fluid.Sources
Buildings.Fluid.Sources.MassFlowSource_WeatherData	Added component which allows prescribing a mass flow rate that has thermal properties obtained from weather data.

The following existing components have been improved in a backward compatible way:

Buildings.Fluid.Chillers
Buildings.Fluid.Chillers.Carnot_TEva Buildings.Fluid.Chillers.Carnot_y	Added approach temperature to avoid too large COPs if the temperature lift is small. This is for IBPSA, #698.
Buildings.Fluid.HeatExchangers
Buildings.Fluid.HeatExchangers.DryCoilCounterFlow Buildings.Fluid.HeatExchangers.DryCoilDiscretized Buildings.Fluid.HeatExchangers.WetCoilCounterFlow Buildings.Fluid.HeatExchangers.WetCoilDiscretized	Improved model so that for certain parameters (dynamic balance, or steady-state balance and no reverse flow, or hA-calculation that is independent of temperature), two fast state variables can be removed. This is for Buildings, #678. Added approximation of diffusion, which is needed for very small flow rates which can happen if fans are off but wind pressure entrains cold air through the HVAC system. This is for Buildings, #1038.
Buildings.Fluid.HeatPumps
Buildings.Fluid.HeatPumps.Carnot_TCon Buildings.Fluid.HeatPumps.Carnot_y	Added approach temperature to avoid too large COPs if the temperature lift is small. This is for IBPSA, #698.
Buildings.Fluid.Movers
Buildings.Fluid.Movers.FlowControlled_dp	Added optional input signal for differential pressure measurement, which will then be tracked by the model.
Buildings.Fluid.Sensors
Buildings.Fluid.Sensors.TemperatureTwoPort	Improved optional heat loss model. This is for IBPSA, #840.
Buildings.Fluid.SolarCollectors
Buildings.Fluid.SolarCollectors.ASHRAE93 Buildings.Fluid.SolarCollectors.EN12975	Changed models for incidence angles below 60° in order to increase the accuracy near sunrise and sunset. This is for #785.
Buildings.ThermalZones.Detailed
Buildings.ThermalZones.Detailed.MixedAir	Added an optional input that allows injecting trace substances, such as CO2 release from people, to the room air.

The following existing components have been improved in a non-backward compatible way:

Buildings.Fluid
Buildings.Fluid.HeatExchangers.HeaterCooler_T	Renamed `Buildings.Fluid.HeatExchangers.HeaterCooler_T` to `Buildings.Fluid.HeatExchangers.PrescribedOutlet` as it now also allows to set the outlet water vapor mass fraction. For Dymola, a conversion script makes this change. This is for IBPSA, #763.
Buildings.Fluid.MassExchangers.Humidifier_u	Moved model to `Buildings.Fluid.Humidifiers.Humidifier_u`. Removed parameters `use_T_in` and `T`, and removed input connector `T_in`, as these are no longer needed. For Dymola, the conversion script will remove the parameter settings. For Dymola, a conversion script makes this change. This is for #704.
Buildings.Fluid.Interfaces	Renamed `PrescribedOutletState` to `PrescribedOutlet` and removed `PrescribedOutletStateParameters`. This is for IBPSA, #763.
Buildings.Fluid.HeatExchangers	Removed the function `Buildings.Fluid.HeatExchangers.BaseClasses.appartusDewPoint` as it was nowhere used, and it also has no validation test. This is for Buildings, #724.

The following critical errors have been fixed (i.e., errors that can lead to wrong simulation results):

Buildings.Airflow
Buildings.Airflow.Multizone.EffectiveAirLeakageArea	Corrected error in computation of `A` which was `A=CD/CDRat * L * dpRat^(0.5-m))` rather than `A=CDRat/CD * L * dpRat^(0.5-m))`. See #743.
Buildings.Controls
Buildings.Controls.Continuous.OffTimer	Corrected implementation as the timer had the wrong if the simulation did not start at `time = 0`. After the first reset, the value was correct. See IBPSA, #743.
Buildings.Fluid
Buildings.Fluid.Interfaces.TwoPortHeatMassExchanger Buildings.Fluid.Interfaces.FourPortHeatMassExchanger	Corrected assignment of `Q_flow` (or `Q1_flow` and `Q2_flow`). Previously, these variables were assigned only the sensible heat flow rate, but they should include the latent heat exhange to be consistent with the variable naming, and because the cooling coils interpret these variables as if they contain the latent heat flow rate. This is for #704.
Buildings.Fluid.HeatExchangers.WetCoilCounterFlow Buildings.Fluid.HeatExchangers.WetCoilDiscretized Buildings.Fluid.HeatExchangers.BaseClasses.HexElementLatent	Added heat of condensation to coil surface heat balance and removed it from the air stream. This gives higher coil surface temperature and avoids overestimating the latent heat ratio that was observed in the previous implementation. The code change was in `Buildings.Fluid.HeatExchangers.BaseClasses.HexElementLatent` This is for #711.
Buildings.Fluid.HeatExchangers.BaseClasses.HADryCoil	Corrected coefficient for temperature-dependency correction of air-side convection coefficient. By default, the convection coefficient is assumed to be temperature-independent, in which cases this correction has no effect on the results. This is for #698.

The following uncritical errors have been fixed (i.e., errors that do not lead to wrong simulation results, e.g., units are wrong or errors in documentation):

Buildings.HeatTransfer
Buildings.HeatTransfer.Conduction.MultiLayer	Corrected wrong result variable `R` and `UA`. These variables are only used for reporting. All other calculations are not affected by this error.

Extends from Modelica.Icons.ReleaseNotes (Icon for release notes in documentation).

Modelica definition

class Version_5_0_0 "Version 5.0.0" extends Modelica.Icons.ReleaseNotes; end Version_5_0_0;

Buildings.UsersGuide.ReleaseNotes.Version_4_0_0

Version 4.0.0

Information

Version 4.0.0 is a major new release. It is the first release that is based on the Modelica IBPSA Library (https://github.com/ibpsa/modelica). All models simulate with Dymola 2017 FD01 and with JModelica, and the results of these simulators have been cross-compared and are equal within the expected tolerance.

The following major changes have been done:

It no longer uses the Modelica_StateGraph2 library. Instead, it uses Modelica.StateGraph which is part of the Modelica Standard Library.
The models in Buildings.Fluid.Movers have been refactored to increase the numerical robustness at very low speed when the fans or pumps are switched on or off.
The following new packages have been added:
- Buildings.Obsolete.DistrictHeatingCooling with models for district heating and cooling with bi-directional flow in the distribution pipes.
- Buildings.Fluid.FMI.Adaptors and Buildings.Fluid.FMI.ExportContainers, which allow export of HVAC systems and of thermal zones as Functional Mockup Units.
- Buildings.Fluid.HeatExchangers.ActiveBeams, with active beams for cooling and heating.
- Buildings.Fluid.DXSystems.WaterCooled, with water-cooled direct expansion cooling coils.
- Buildings.ThermalZones.ReducedOrder, with reduced order models of thermal zones based on VDI 6007 that are suitable for district energy simulation.
The package Buildings.Rooms has been renamed to Buildings.ThermalZones.Detailed. This was done because of the introduction of Buildings.ThermalZones.ReducedOrder, which is from the Annex60 library, in order for thermal zones to be in the same top-level package.
For Dymola, the conversion script will update models that use any model of the package Buildings.Rooms.
The model Buildings.Fluid.FixedResistances.FixedResistanceDpM has been refactored. Now, if the hydraulic diameter is not yet known, one can use the simpler model Buildings.Fluid.FixedResistances.PressureDrop, otherwise the model Buildings.Fluid.FixedResistances.HydraulicDiameter may be used. With this refactoring, also the model Buildings.Fluid.FixedResistances.SplitterFixedResistanceDpM has been renamed to Buildings.Fluid.FixedResistances.Junction and parameters that use the hydraulic diameter have been removed.
The models Buildings.HeatTransfer.Conduction.SingleLayer, Buildings.HeatTransfer.Conduction.MultiLayer, and Buildings.HeatTransfer.Windows.Window have been refactored to add the option to place a state at the surface of a construction. This leads in many examples that use the room model to a smaller number of non-linear system of equations and a 20% to 40% faster simulation.
The models Buildings.Fluid.HeatPumps.ReciprocatingWaterToWater and Buildings.Fluid.HeatPumps.ScrollWaterToWater have been added. Parameters to these models rely on calibration with tabulated heat pump performance data. Python scripts for the calibration of the heat pump models are in Buildings/Resources/src/fluid/heatpumps/calibration. This is for issue 587.

The following new libraries have been added:

Buildings.Obsolete.DistrictHeatingCooling	Package with models for district heating and cooling with bi-directional flow in the distribution pipes.
Buildings.Fluid.FMI.Adaptors Buildings.Fluid.FMI.ExportContainers	Library with adaptors to export HVAC systems and thermal zones as a Functional Mockup Unit for Model Exchange. This is for Buildings, #506.
Buildings.Fluid.HeatExchangers.ActiveBeams	Package with models of active beams for space cooling and heating.
Buildings.Fluid.DXSystems.WaterCooled	Package with models of water-cooled direct expansion cooling coils with single speed, variable speed or multi-stage compressor.
Buildings.Fluid.HeatPumps.Compressors	Package with models of compressors for heat pumps.
Buildings.ThermalZones.ReducedOrder	Package with reduced order models of thermal zones based on VDI 6007.

The following new components have been added to existing libraries:

Buildings.Fluid.Sensors
Buildings.Fluid.Sensors.Velocity	Sensor for the flow velocity.
Buildings.Fluid.HeatExchangers
Buildings.Fluid.HeatExchangers.EvaporatorCondenser	Model for evaporator/condenser with refrigerant experiencing constant temperature phase change.
Buildings.Fluid.HeatPumps
Buildings.Fluid.HeatPumps.ReciprocatingWaterToWater	Model for water to water heat pump with a reciprocating compressor.
Buildings.Fluid.HeatPumps.ScrollWaterToWater	Model for water to water heat pump with a scroll compressor.
Buildings.HeatTransfer.Windows.BaseClasses
Buildings.HeatTransfer.Windows.BaseClasses.HeatCapacity	Model for adding a state on the room-facing surface of a window. This closes issue 565.
Buildings.Media
Buildings.Media.Refrigerants.R410A	Model for thermodynamic properties of refrigerant R410A.
Buildings.Media.Specialized.Water.ConstantProperties_pT	Model for liquid water with constant properties at user-selected temperature. This closes IBPSA, #511.
Buildings.Utilities.Math
Buildings.Utilities.Math.IntegratorWithReset	Integrator with optional input that allows resetting the state if the input changes from `false` to `true`. This closes IBPSA, #494.
Buildings.Utilities.Time
Buildings.Utilities.Time.CalendarTime	Block that outputs the calendar time, time of the week, hour of the day etc. This closes IBPSA, #501.

The following existing components have been improved in a backward compatible way:

Buildings.BoundaryConditions
Buildings.BoundaryConditions.WeatherData.BaseClasses.Examples.GetHeaderElement Buildings.BoundaryConditions.WeatherData.BaseClasses.getAbsolutePath Buildings.BoundaryConditions.WeatherData.BaseClasses.getHeaderElementTMY3 Buildings.BoundaryConditions.WeatherData.ReaderTMY3 Buildings.BoundaryConditions.SolarGeometry.ProjectedShadowLength	Refactored the use of `Modelica.Utilities.Files.loadResource` to make the model work in JModelica. This closes issue 506. Removed the use of `Modelica.Utilities.Files.fullPathName` in `Buildings.BoundaryConditions.WeatherData.BaseClasses.getAbsolutePath` which is implicitly done in `Modelica.Utilities.Files.loadResource.` Removed in `Buildings.BoundaryConditions.WeatherData.BaseClasses.getAbsolutePath`the addition of `file://` to file names which do not start with `file://`, or `modelica://`. This is not required when using `Modelica.Utilities.Files.loadResource`. This closes issue 539.
Buildings.BoundaryConditions.WeatherData.ReaderTMY3	Shifted the computation of the infrared irradiation such that the results in `Buildings.BoundaryConditions.SkyTemperature.Examples.BlackBody` are consistent for both option of the black-body sky temperature calculation. This closes IBPSA, #648.
Buildings.BoundaryConditions.SolarIrradiation.BaseClasses.SkyClearness	Reduced tolerance for regularization if the sky clearness is near one or eight. This closes IBPSA, #521.
Buildings.Controls
Buildings.Controls.Continuous.LimPID Buildings.Controls.Continuous.PIDHysteresis Buildings.Controls.Continuous.PIDHysteresisTimer	Added option to reset the control output when an optional Boolean input signal changes from `false` to `true`. This closes IBPSA, #494.
Buildings.Electrical
Buildings.Electrical.DC.Storage.Examples.Battery	Replaced `Modelica_StateGraph2` with `Modelica.StateGraph`. This closes issue 504.
Buildings.Examples
Buildings.Examples.DualFanDualDuct.ClosedLoop Buildings.Examples.VAVReheat.ClosedLoop	Added hysteresis to the economizer control to avoid many events. This change was done in `Buildings.Examples.VAVReheat.Controls.EconomizerTemperatureControl`. This closes issue 502.
Buildings.Examples.DualFanDualDuct.ClosedLoop	Set `filteredSpeed=false` in fan models to avoid a large increase in computing time when simulated between t=1.60E7 and t=1.66E7.
Buildings.Examples.VAVReheat.ClosedLoop	Changed chilled water supply temperature to 6°C. This closes issue 509.
Buildings.Examples.ChillerPlant.BaseClasses.Controls.BatteryControl Buildings.Examples.ChillerPlant.BaseClasses.Controls.WSEControl Buildings.Examples.HydronicHeating.TwoRoomsWithStorage Buildings.Examples.Tutorial.Boiler.System7	Replaced `Modelica_StateGraph2` with `Modelica.StateGraph`. This closes issue 504.
Buildings.HeatTransfer
Buildings.HeatTransfer.Conduction.SingleLayer	Added option to place a state at the surface of a construction. This closes issue 565.
Buildings.HeatTransfer.Conduction.MultiLayer	Added option to place a state at the surface of a construction. This closes issue 565.
Buildings.HeatTransfer.Windows.Window	Added option to place a state at the surface of a construction. This closes issue 565.
Buildings.HeatTransfer.Windows.BeamDepthInRoom	Refactored the use of `Modelica.Utilities.Files.loadResource`. This closes issue 506.
Buildings.ThermalZones
Buildings.ThermalZones.Detailed.CFD Buildings.ThermalZones.Detailed.BaseClasses.CFDExchange	Refactored the use of `Modelica.Utilities.Files.loadResource`. This closes issue 506.
Buildings.ThermalZones.Detailed.MixedAir Buildings.ThermalZones.Detailed.CFD	Refactored the distribution of the diffuse solar irradiation. Previously, the model assumed that all diffuse irradiation first hits the floor before it is diffusely reflected to all other surfaces. Now, the incoming diffuse solar irradiation is distributed to all surfaces, proportional to their emissivity plus transmissivity times area. This closes issue 451.

The following existing components have been improved in a non-backward compatible way:

Buildings.BoundaryConditions
Buildings.BoundaryConditions.WeatherData.BaseClasses.getHeaderElementTMY3	This function is used to read location coordinates from the TMY3 weather data file. The call to `Buildings.BoundaryConditions.WeatherData.BaseClasses.getAbsolutePath` has been removed as it calls the function `Modelica.Utilities.Files.loadResource`, whose return value needs to be known at compilation time to store the weather data in the FMU. This is not supported by JModelica. Most models should still work as this call has been added at a higher level of the model hierarchy. If models don't work, add a call to `loadResource` at the top-level. This closes Buildings, #506.
Buildings.Controls
Buildings.Controls.Continuous.PIDHysteresis	Set `zer(final k=0)` and made `swi`, `zer` and `zer1` protected, as they are for `Buildings.Controls.Continuous.PIDHysteresis`. Only models that access these instances, which typically is not the case, are affected by this change.
Buildings.Controls.Continuous.LimPID Buildings.Controls.Continuous.PIDHysteresis Buildings.Controls.Continuous.PIDHysteresisTimer	Removed the parameter `limitsAtInit` as it is not used. For Dymola, the conversion script will update models that set this parameter.
Buildings.Controls.SetPoints.Table	Changed protected final parameter `nCol` to `nRow`. For Dymola, the conversion script will update models that access this parameter. This is for issue 555.
Buildings.Fluid.Actuators
Buildings.Fluid.Actuators.Dampers.Exponential Buildings.Fluid.Actuators.Dampers.MixingBox Buildings.Fluid.Actuators.Dampers.MixingBoxMinimumFlow Buildings.Fluid.Actuators.Dampers.VAVBoxExponential Buildings.Fluid.Actuators.Dampers.MixingBoxMinimumFlow Buildings.Fluid.Actuators.Valves.ThreeWayEqualPercentageLinear Buildings.Fluid.Actuators.Valves.ThreeWayLinear Buildings.Fluid.Actuators.Valves.TwoWayEqualPercentage Buildings.Fluid.Actuators.Valves.TwoWayLinear Buildings.Fluid.Actuators.Valves.TwoWayPressureIndependent Buildings.Fluid.Actuators.Valves.TwoWayQuickOpening Buildings.Fluid.Actuators.Valves.TwoWayTable	Renamed the parameter `filteredOpening` to `use_inputFilter`. For Dymola, the conversion script will update models that access this parameter. This is for IBPSA, #665
Buildings.Fluid.Actuators.Dampers.Exponential Buildings.Fluid.Actuators.Dampers.MixingBox Buildings.Fluid.Actuators.Dampers.MixingBoxMinimumFlow Buildings.Fluid.Actuators.Dampers.VAVBoxExponential Buildings.Fluid.Actuators.Dampers.MixingBoxMinimumFlow	Renamed the parameters `use_v_nominal` and all area related parameters, because `m_flow_nominal` and `v_nominal` are used to compute the area. For Dymola, the conversion script will update models that access this parameter. This is for IBPSA, #544
Buildings.Fluid.Chillers
Buildings.Fluid.Chillers.Carnot_TEva Buildings.Fluid.Chillers.Carnot_y	Removed the parameters `effInpEva` and `effInpCon`. Now, always the leaving water temperatures are used to compute the coefficient of performance (COP). Previously, the entering water temperature could be used, but this can give COPs that are higher than the Carnot efficiency if the temperature lift is small. For Dymola, the conversion script will update models. This is for IBPSA, #497
Buildings.Fluid.FixedResistances
Buildings.Fluid.FixedResistances.FixedResistanceDpM	Renamed `Buildings.Fluid.FixedResistances.FixedResistanceDpM` to `Buildings.Fluid.FixedResistances.PressureDrop` and removed the parameters `use_dh`, `dh` and `ReC`. For Dymola, the conversion script will update models. If a model needs to be used that allows specifying `dh` and `ReC`, then the new model `Buildings.Fluid.FixedResistances.HydraulicDiameter` can be used.
Buildings.Fluid.FixedResistances.SplitterFixedResistanceDpM	Renamed `Buildings.Fluid.FixedResistances.SplitterFixedResistanceDpM` to `Buildings.Fluid.FixedResistances.Junction` and removed the parameters `use_dh`, `dh` and `ReC`. For Dymola, the conversion script will update models. If a model needs to be used that allows specifying `dh` and `ReC`, then use `Buildings.Fluid.FixedResistances.Junction` with `dp_nominal = 0` (which removes the pressure drop) and use `Buildings.Fluid.FixedResistances.HydraulicDiameter` at each fluid port.
Buildings.Fluid.FMI
Buildings.Fluid.FMI.InletAdaptor Buildings.Fluid.FMI.OutletAdaptor Buildings.Fluid.FMI.TwoPort Buildings.Fluid.FMI.TwoPortComponent	Renamed `Buildings.Fluid.FMI.InletAdaptor` to `Buildings.Fluid.FMI.Adaptors.Inlet`, renamed `Buildings.Fluid.FMI.OutletAdaptor` to `Buildings.Fluid.FMI.Adaptors.Outlet`, renamed `Buildings.Fluid.FMI.TwoPort` to `Buildings.Fluid.FMI.ExportContainers.PartialTwoPort`, renamed `Buildings.Fluid.FMI.TwoPortComponent` to `Buildings.Fluid.FMI.ExportContainers.ReplaceableTwoPort`. This was due to the restructuring of the `Buildings.Fluid.FMI` package for Buildings, #506. For Dymola, the conversion script updates these models.
Buildings.Fluid.HeatExchangers
Buildings.Fluid.DXSystems.AirCooled.SingleSpeed Buildings.Fluid.DXSystems.AirCooled.VariableSpeed Buildings.Fluid.DXSystems.AirCooled.MultiStage Buildings.Fluid.DXSystems.Data	Renamed `Buildings.Fluid.DXSystems.AirCooled.SingleSpeed` to `Buildings.Fluid.DXSystems.AirCooled.SingleSpeed`, `Buildings.Fluid.DXSystems.AirCooled.VariableSpeed` to `Buildings.Fluid.DXSystems.AirCooled.VariableSpeed`, `Buildings.Fluid.DXSystems.AirCooled.MultiStage` to `Buildings.Fluid.DXSystems.AirCooled.MultiStage` and `Buildings.Fluid.DXSystems.Data` to `Buildings.Fluid.DXSystems.AirCooled.Data`. This was due to the addition of the new package `Buildings.Fluid.DXSystems.WaterCooled`. This is for Buildings, #635. For Dymola, the conversion script updates these models.
Buildings.Fluid.HeatPumps
Buildings.Fluid.HeatPumps.Carnot_TEva Buildings.Fluid.HeatPumps.Carnot_y	Removed the parameters `effInpEva` and `effInpCon`. Now, always the leaving water temperatures are used to compute the coefficient of performance (COP). Previously, the entering water temperature could be used, but this can give COPs that are higher than the Carnot efficiency if the temperature lift is small. For Dymola, the conversion script will update models. This is for IBPSA, #497
Buildings.Fluid.HeatExchangers.Boreholes	Moved the package `Buildings.Fluid.HeatExchangers.Boreholes` to `Buildings.Fluid.Geothermal.Boreholes`. This is for compatibility with an ongoing model development that will include a borefield model. For Dymola, the conversion script will update models that use any model of the package `Buildings.Fluid.HeatExchangers.Boreholes`.
Buildings.Fluid.Movers	Removed the function `Buildings.Fluid.Movers.BaseClasses.Characteristics.flowApproximationAtOrigin` and changed the arguments of the function `Buildings.Fluid.Movers.BaseClasses.Characteristics.pressure`. This was done due to the refactoring of the fan and pump model for low speed. This is for IBPSA, #458. Users who simply use the existing model in `Buildings.Fluid.Movers` are not affected by this change as the function are called by a low-level implementation only.
Buildings.Fluid.Movers. Buildings.Fluid.Movers.FlowControlled_dp Buildings.Fluid.Movers.FlowControlled_m_flow Buildings.Fluid.Movers.SpeedControlled_Nrpm Buildings.Fluid.Movers.SpeedControlled_y	Renamed the parameter `filteredSpeed` to `use_inputFilter`. For Dymola, the conversion script will update models that access this parameter. This is for IBPSA, #665
Buildings.Fluid.HeatExchangers.CoolingTowers	Changed the name of the function `Buildings.Fluid.HeatExchangers.CoolingTowers.BaseClasses.Characteristics.efficiency` to `Buildings.Fluid.HeatExchangers.CoolingTowers.BaseClasses.Characteristics.normalizedPower`. Changed the name of the record `Buildings.Fluid.HeatExchangers.CoolingTowers.BaseClasses.Characteristics.efficiencyParameters` to `Buildings.Fluid.HeatExchangers.CoolingTowers.BaseClasses.Characteristics.fan`, and changed the parameter of this record from `eta` to `r_P`. This change was done as the performance is for the relative power consumption, and not the fan efficiency, as the old parameter name suggests. Users who use the default parameters are not affected by this change. If the default parameters were changed, then for Dymola, the conversion script will update the model.
Buildings.HeatTransfer
Buildings.HeatTransfer.BaseClasses.TransmittedRadiation Buildings.HeatTransfer.BaseClasses.WindowRadiation	Refactored the model to allow separate treatment for the diffuse and direct irradiation, which is needed for issue 451.
Buildings.HeatTransfer.Conduction.BaseClasses.PartialConstruction	Removed parameter `A` as it is already declared in `Buildings.HeatTransfer.Conduction.BaseClasses.PartialConductor` which is often used with this class.
Buildings.ThermalZones
Buildings.ThermalZones.Detailed	Moved package from `Buildings.Rooms` to `Buildings.ThermalZones.Detailed`. This was done because `Buildings` has a new package `Buildings.ThermalZones.ReducedOrder` with reduced order building models. Hence, the more detailed room models should be in the same top-level package as they are also for modeling of thermal zones. For Dymola, the conversion script will update models that use any model of the package `Buildings.ThermalZones`.
Buildings.ThermalZones.Detailed.CFD Buildings.ThermalZones.Detailed.MixedAir Buildings.ThermalZones.Detailed.BaseClasses.CFDAirHeatMassBalance Buildings.ThermalZones.Detailed.BaseClasses.MixedAirHeatMassBalance Buildings.ThermalZones.Detailed.BaseClasses.PartialAirHeatMassBalance Buildings.ThermalZones.Detailed.BaseClasses.RoomHeatMassBalance	Refactored implementation of latent heat gain for Buildings, #515. Users who simply use `Buildings.MixedAir.Rooms.CFD` or `Buildings.MixedAir.Rooms.MixedAir` will not be affected by this change, except if they access variables related to the heat gain.
Buildings.ThermalZones.Detailed.BaseClasses.AirHeatMassBalanceMixed Buildings.ThermalZones.Detailed.BaseClasses.MixedAirHeatGain	Removed models as these are no longer needed due after the refactoring of the room model for Buildings, #515.
Buildings.ThermalZones.Detailed.BaseClasses.RoomHeatMassBalance Buildings.ThermalZones.Detailed.BaseClasses.SolarRadiationExchange	Refactored the distribution of the diffuse solar irradiation, which required replacing the input and output signals. Previously, the model assumed that all diffuse irradiation first hits the floor before it is diffusely reflected to all other surfaces. Now, the incoming diffuse solar irradiation is distributed to all surfaces, proportional to their emissivity plus transmissivity times area. This closes issue 451.
Buildings.ThermalZones.Detailed.BaseClasses.CFDHeatGain	Renamed model from `Buildings.ThermalZones.Detailed.BaseClasses.CFDHeatGain` to `Buildings.ThermalZones.Detailed.BaseClasses.HeatGain`. This is for Buildings, #515.
Buildings.ThermalZones.Detailed.BaseClasses.CFDExchange	Removed the parameter `uStart` as it is not required. As this is in a base class, users typically won't need to change their models unless they use this base class directly. This is for Buildings, #579.
Buildings.Utilities
Buildings.Utilities.Psychrometrics.WetBul_pTX	Deleted the model `Buildings.Utilities.Psychrometrics.WetBul_pTX` as the same functionality is provided by `Buildings.Utilities.Psychrometrics.TWetBul_TDryBulXi`. Users who use `Buildings.Utilities.Psychrometrics.WetBul_pTX` need to replace the model manually and reconnect the input and output ports. This is for IBPSA, #475.

The following critical errors have been fixed (i.e., errors that can lead to wrong simulation results):

Buildings.Fluid
Buildings.Fluid.DXSystems.AirCooled.MultiStage Buildings.Fluid.DXSystems.AirCooled.SingleSpeed Buildings.Fluid.DXSystems.AirCooled.VariableSpeed Buildings.Fluid.DXSystems.AirCooled.BaseClasses.Evaporation	Corrected the computation of the wet bulb state in the model that computes the reevaporation of water vapor into the air stream when the coil is switched off. The results change slightly. This closes issue 520 and integrates the change of IBPSA, #474.
Buildings.Fluid.Storage.StratifiedEnhancedInternalHex	Corrected computation of the heat exchanger location which was wrong if `hHex_a < hHex_b`, e.g., the port a of the heat exchanger is below the port b. This closes issue 531.
Buildings.Examples
Buildings.Examples.VAVReheat.ClosedLoop Buildings.Examples.DualFanDualDuct.ClosedLoop Buildings.Examples.VAVReheat.Controls.Economizer	Corrected the economizer controller which closed the outside air when there was no freeze concern during summer. This closes issue 511.

The following uncritical errors have been fixed (i.e., errors that do not lead to wrong simulation results, e.g., units are wrong or errors in documentation):

Buildings.Electrical
Buildings.Electrical.AC.OnePhase.Sources.Grid Buildings.Electrical.AC.ThreePhasesUnbalanced.Sources.Grid Buildings.Electrical.AC.ThreePhasesUnbalanced.Sources.Grid_N	Corrected sign error in documentation string of variable `P`.
Buildings.Fluid
Buildings.Fluid.HeatExchanger.WetCoilCounterFlow Buildings.Fluid.HeatExchanger.WetCoilDiscretized	Redeclared `Medium2` to force it to be a subclass of `Modelica.Media.Interfaces.PartialCondensingGases`. This is for issue 544.
Buildings.Fluid.Storage	Removed medium declaration, which is not needed and inconsistent with the declaration in the base class. This is for issue 544.
Buildings.ThermalZones.Detailed.Validation.BESTEST
Buildings.ThermalZones.Detailed.Validation.BESTEST.Cases9xx.Case900 Buildings.ThermalZones.Detailed.Validation.BESTEST.Cases9xx.Case900	Added missing `parameter` keyword, which is required as the variable (for the materials) is assigned to a parameter. This is for issue 543.

Extends from Modelica.Icons.ReleaseNotes (Icon for release notes in documentation).

Modelica definition

class Version_4_0_0 "Version 4.0.0" extends Modelica.Icons.ReleaseNotes; end Version_4_0_0;

Buildings.UsersGuide.ReleaseNotes.Version_3_0_0

Version 3.0.0

Information

Version 3.0.0 is a major new release.

The following major changes have been done:

Electrochromic windows have been added. See Buildings.ThermalZones.Detailed.Examples.ElectroChromicWindow.
The models in Buildings.Fluid.Movers can now be configured to use three different control input signals: a continuous signal (depending on the model either normalized speed, speed in rpm, prescribed mass flow rate or prescribed head), discrete stages of these quantities, or on/off. The models also have been refactored to make their implementation clearer.
The new package Buildings.Fluid.HeatPumps has been added. This package contains models for idealized heat pumps whose COP changes proportional to the change in COP of a Carnot cycle, with an optional correction for the part load efficiency.
Various models, in particular in the package Buildings.Electrical, have been reformulated to comply with the Modelica Language Definition. All models comply with the pedantic Modelica check of Dymola.

The following new libraries have been added:

Buildings.Fluid.HeatPumps Library with heat pump models. This library contains models for idealized heat pumps whose COP changes proportional to the change in COP of a Carnot cycle. Optionally, a part load efficiency curve can be specified. The model Buildings.Fluid.HeatPumps.Carnot_TCon takes as a control input the leaving condenser fluid temperature, and the model Buildings.Fluid.HeatPumps.Carnot_y takes as a control signal the compressor speed.

The following new components have been added to existing libraries:

Buildings.BoundaryConditions.SolarGeometry
Buildings.BoundaryConditions.SolarGeometry.ProjectedShadowLength	Block that computes the length of a shadow projected onto a horizontal plane into the direction that is perpendicular to the azimuth of a surface.
Buildings.Electrical
Buildings.Electrical.AC.ThreePhasesUnbalanced.Interfaces.Adapter3to3 Buildings.Electrical.AC.ThreePhasesUnbalanced.Interfaces.Connection3to3Ground_n Buildings.Electrical.AC.ThreePhasesUnbalanced.Interfaces.Connection3to3Ground_p	Adapters for unbalanced three phase systems which are required because the previous formulation used connect statements that violate the Modelica Language Definition. This change was required to enable pedantic model check and translation in Dymola 2016 FD01. This is for #426.
Buildings.Fluid.Chillers
Buildings.Fluid.Chillers.Carnot_TEva	Chiller model whose efficiency changes with temperatures similarly to a change in Carnot efficiency. The control input signal is the evaporator leaving fluid temperature. This is for IBPSA, #353.
Buildings.Fluid.Sensors
Buildings.Fluid.Sensors.PPM Buildings.Fluid.Sensors.PPMTwoPort	Sensors that measure trace substances in parts per million.
Buildings.HeatTransfer.Windows
Buildings.HeatTransfer.Windows.BeamDepthInRoom	Block that computes the maximum distance at which a solar beam that enters the window hits the workplane.
Buildings.Utilities.Math
Buildings.Utilities.Math.Functions.smoothInterpolation	Function that interpolates for vectors `xSup[]`, `ySup[]` and independent variable `x`. The interpolation is done using a cubic Hermite spline with linear extrapolation.

The following existing components have been improved in a backward compatible way:

Buildings.Fluid
Buildings.Fluid.Actuators.Valves.ThreeWayEqualPercentageLinear Buildings.Fluid.Actuators.Valves.ThreeWayLinear	Changed the default value for valve leakage parameter `l` from `0` to `0.0001`. This is the same value as is used for the two-way valves, and avoids an assertion that would be triggered if `l=0`.
Buildings.Fluid.Geothermal.Boreholes.UTube	Updated code for 64 bit on Linux and Windows. This closes issue 485.
Buildings.Fluid.HeatExchangers.DryEffectivenessNTU	Reformulated model to allow translation in OpenModelica. This is for issue #490.
Buildings.Fluid.Chillers.Carnot	Changed the sign convention for `dTEva_nominal`. Now, this quantity needs to be negative. This change was done to be consistent with other models. In this version, a warning will be written if the sign is not updated, but the results will be the same. In future versions the warning will be changed to an error. The parameters `dTEva_nominal` and `dTCon_nominal` are now used to assign default values for the nominal mass flow rates.
Buildings.Fluid.MixingVolumes.MixingVolume Buildings.Fluid.MixingVolumes.MixingVolumeMoistAir	Added the parameter `use_C_flow`. If set to `true`, an input connector will be enabled that can be used to add a trace substance flow rate, such as CO2, to the volume.
Buildings.Fluid.Movers.FlowControlled_dp Buildings.Fluid.Movers.FlowControlled_m_flow Buildings.Fluid.Movers.FlowControlled_Nrpm Buildings.Fluid.Movers.FlowControlled_y	Added the parameter `inputType` which allows to set the input as an continuous input signal, to set the input as an Integer input signal that selects the stage of the mover, or to remove the input connector and use a parameter to assign the control signal.
Buildings.Fluid.Storage.StratifiedEnhancedInternalHex	Added option to set dynamics of heat exchanger material separately from the dynamics of the fluid inside the heat exchanger. This is for issue #434.
Buildings.Fluid.Interfaces.FourPortHeatMassExchanger Buildings.Fluid.Interfaces.TwoPortHeatMassExchanger	Propagated parameter `allowFlowReversal` which can cause a simpler energy balance to be used.
Buildings.Fluid.Interfaces.PartialTwoPortTransport	Implemented more efficient computation of `port_a.Xi_outflow` and `port_a.C_outflow` when `allowFlowReversal=false`. This is for IBPSA issue 305.
Buildings.Fluid.BaseClasses.FlowModels.basicFlowFunction_dp Buildings.Fluid.BaseClasses.FlowModels.basicFlowFunction_m_flow	Refactored for a more efficient implementation. Removed double declaration of `smooth(..)` and `smoothOrder` and changed `Inline=true` to `LateInline=true`. This is for IBPSA issue 301 and for IBPSA issue 279.
Buildings.ThermalZones
Buildings.ThermalZones.Detailed.BaseClasses.CFDExchange	Set `start` and `fixed` attributes in `u[nWri](start=_uStart, each fixed=true)` to avoid a warning in Dymola 2016 about unspecified initial conditions. This closes issue 422. Set `start` and `fixed` attributes in `firstTrigger(start=false, fixed=true)`, `retVal(start=0, fixed=true)` and `modTimRea(fixed=false)` to avoid such a warning in the pedantic Modelica check in Dymola 2016. This closes issue 459.
Buildings.ThermalZones.Detailed.CFD	Updated code for 64 bit on Linux and Windows. This closes issue 485.
Buildings.Utilities.Math.Functions	Refactored `Buildings.Utilities.Math.Functions.inverseXRegularized` to make it more efficient as it is used in many steady-state energy balances. This closes IBPSA issue 302.

The following existing components have been improved in a non-backward compatible way:

Buildings.BoundaryConditions
Buildings.BoundaryConditions.SkyTemperature.BlackBody Buildings.BoundaryConditions.WeatherData.Bus	Renamed the connector from `radHorIR` to `HHorIR` This is for IBPSA issue 376. For Dymola, the conversion script updates these connections. However, this also results in a renaming of the weather bus variable `weaBus.radHorIR` to `HHorIR`, which may require a manual update.
Buildings.Fluid
Buildings.Fluid.Interfaces.StaticTwoPortConservationEquation	Removed the constant `sensibleOnly` and introduced instead the parameter `use_mWat_flow`. The new parameter, if set to `true`, will enable an input connector that can be used to add water to the conservation equation. For Dymola, the conversion script updates the model for these changes.
Buildings.Fluid.Chillers.Carnot	Renamed the model to `Buildings.Fluid.Chillers.Carnot_y` due to the addition of the new model `Buildings.Fluid.Chillers.Carnot_TEva`. In addition, the following parameter names were changed: `use_eta_Carnot` was changed to `use_eta_Carnot_nominal`, and `etaCar` was changed to `etaCarnot_nominal`. This is for IBPSA issue 353. For Dymola, the conversion script removes these parameters.
Buildings.Fluid.Movers.FlowControlled_dp Buildings.Fluid.Movers.FlowControlled_m_flow Buildings.Fluid.Movers.FlowControlled_Nrpm Buildings.Fluid.Movers.FlowControlled_y	Removed the parameters `use_powerCharacteristics` and `motorCooledByFluid` as these are already declared in the performance data record `per`. This is for issue #457. For Dymola, the conversion script removes these parameters.
Buildings.Fluid.Movers.FlowControlled_dp Buildings.Fluid.Movers.FlowControlled_m_flow Buildings.Fluid.Movers.FlowControlled_Nrpm Buildings.Fluid.Movers.FlowControlled_y	Removed the public variable `r_N`. This is for IBPSA issue 417. For Dymola, the conversion script removes assignments of `r_N(start)`.
Buildings.Fluid.Movers.FlowControlled_dp Buildings.Fluid.Movers.FlowControlled_m_flow	Write a warning if no pressure curve is provided because the efficiency calculation can only be done correctly if a pressure curve is provided. The warning can be suppressed by providing a pressure curve, or by setting `nominalValuesDefineDefaultPressureCurve=true`.
Buildings.Fluid.Movers.Data	Replaced the parameters `Buildings.Fluid.Movers.Data.FlowControlled`, `Buildings.Fluid.Movers.Data.SpeedControlled_y`, and `Buildings.Fluid.Movers.Data.SpeedControlled_Nrpm` by the parameter `Buildings.Fluid.Movers.Data.Generic` which is used for all four types of movers. This is for IBPSA issue 417. This change allows to correctly compute the fan or pump power also for the models `Buildings.Fluid.Movers.FlowControlled_dp`, `Buildings.Fluid.Movers.FlowControlled_m_flow` for speeds that are different from the nominal speed, provided that the user specifies the pressure curve. For Dymola, the conversion script updates this parameter. In the previous record `Buildings.Fluid.Movers.Data.SpeedControlled_Nrpm`, changed the parameter `N_nominal` to `speed_rpm_nominal`. This is for IBPSA issue 396. For Dymola, the conversion script updates this parameter.
Buildings.Fluid.BaseClasses.PartialThreeWayResistance Buildings.Fluid.Movers.BaseClasses.PartialFlowMachine Buildings.Fluid.Movers.FlowControlled_dp Buildings.Fluid.Movers.FlowControlled_m_flow Buildings.Fluid.Movers.FlowControlled_Nrpm Buildings.Fluid.Movers.FlowControlled_y Buildings.Fluid.Actuators.Valves.ThreeWayEqualPercentageLinear Buildings.Fluid.Actuators.Valves.ThreeWayLinear Buildings.Fluid.Actuators.Valves.TwoWayEqualPercentage	Removed parameter `dynamicBalance` that overwrote the setting of `energyDynamics` and `massDynamics`. This is for IBPSA, issue 411. For Dymola, the conversion script updates the models.
Buildings.Fluid.Interfaces.PartialTwoPort	Renamed the protected parameters `port_a_exposesState`, `port_b_exposesState` and `showDesignFlowDirection`. This is for IBPSA issue 349 and IBPSA issue 351. For Dymola, the conversion script updates models that extend from `Buildings.Fluid.Interfaces.PartialTwoPort`.
Buildings.Fluid.Interfaces.FourPort	Renamed model to `Buildings.Fluid.Interfaces.PartialFourPort` and removed the parameters `h_outflow_a1_start`, `h_outflow_b1_start`, `h_outflow_a2_start` and `h_outflow_b2_start` to make the model similar to `Buildings.Fluid.Interfaces.PartialTwoPort`. See IBPSA issue 299 for a discussion. For Dymola, the conversion script updates models that extend from `Buildings.Fluid.Interfaces.FourPort`.
Buildings.Fluid.Interfaces.StaticTwoPortConservationEquation	Revised implementation of conservation equations and added default values for outlet quantities at `port_a` if `allowFlowReversal=false`. This is for IBPSA issue 281. Also, revised implementation so that equations are always consistent and do not lead to division by zero, also when connecting a `prescribedHeatFlowRate` to `MixingVolume` instances. Renamed `use_safeDivision` to `prescribedHeatFlowRate`. See IBPSA issue 282 for a discussion. For users who simply instantiate existing component models, this change is backward compatible. However, developers who implement component models that extend from `Buildings.Fluid.Interfaces.StaticTwoPortConservationEquation` may need to update the parameter `use_safeDivision` and use instead `prescribedHeatFlowRate`. See the model documentation.
Buildings.ThermalZones
Buildings.ThermalZones.Detailed.MixedAir Buildings.ThermalZones.Detailed.CFD	These models can now be used with electrochromic windows. This required to change the glass properties `tauSol`, `rhoSol_a` and `rhoSol_b` to be arrays. For example, to convert an existing model, use `tauSol={0.6}` instead of `tauSol=0.6`. For Dymola, the conversion script will automatically update existing models.
Buildings.Obsolete
Buildings.Obsolete.Fluid.Movers Buildings.Obsolete.Media	Removed these packages which have models from release 2.0.0.

The following critical errors have been fixed (i.e., errors that can lead to wrong simulation results):

Buildings.Fluid.Chillers
Buildings.Fluid.Chillers.Carnot	Corrected wrong computation of state of leaving fluid `staB1` and `staB2` for the configuration without flow reversal. The previous implementation mistakenly used the `inStream` operator. This is for issue 476

The following uncritical errors have been fixed (i.e., errors that do not lead to wrong simulation results, e.g., units are wrong or errors in documentation):

Buildings.Electrical
Buildings.Electrical.Interfaces.PartialWindTurbine	Reformulated test for equality of `Real` variables. This closes issue 493.
Buildings.HeatTransfer
Buildings.HeatTransfer.Conduction.SingleLayer Buildings.HeatTransfer.Data.BaseClasses	Reformulated test for equality of `Real` variables. This closes issue 493.
Buildings.Fluid
Buildings.Fluid.FMI.FlowSplitter_u	Corrected wrong assert statement. This closes issue 442.
Buildings.Fluid.Chillers.Carnot	Corrected wrong assert statement for test on the efficiency function. This closes issue 468.
Buildings.Media
Buildings.Media.Specialized.Water.TemperatureDependentDensity	Removed dublicate entry of `smooth` and `smoothOrder`. This is for IBPSA issue 303.
Buildings.ThermalZones
Buildings.ThermalZones.Detailed.BaseClasses.MixedAirHeatGain	Reformulated test for equality of `Real` variables. This closes issue 493.
Buildings.Utilities.Math
Buildings.Utilities.Math.Functions.BaseClasses.der_2_regNonZeroPower Buildings.Utilities.Math.Functions.BaseClasses.der_polynomial Buildings.Utilities.Math.Functions.BaseClasses.der_regNonZeroPower	Corrected wrong derivative implementation and improved their regression tests. This is for IBPSA issue 303.
Buildings.Utilities.Psychrometrics
Buildings.Utilities.Psychrometrics.Density_pTX	Corrected wrong default component name.
Buildings.Utilities.Psychrometrics.Functions.saturationPressure	Changed `smoothOrder` from 5 to 1 as `Buildings.Utilities.Math.Functions.spliceFunction` is only once continuously differentiable. Inlined the function.
Buildings.Utilities.IO.Python27
Buildings.Utilities.IO.Python27.exchange	Updated Python implementation to allow compiling code on 64 bit Linux. Previously, on Linux a segmentation fault occurred during run-time if 64 bit code rather than 32 bit code was generated. This is now corrected. Also, Windows 64 bit binaries have been added. This closes issue 287.

Extends from Modelica.Icons.ReleaseNotes (Icon for release notes in documentation).

Modelica definition

class Version_3_0_0 "Version 3.0.0" extends Modelica.Icons.ReleaseNotes; end Version_3_0_0;

Buildings.UsersGuide.ReleaseNotes.Version_2_1_0

Version 2.1.0

Information

Version 2.1.0 is fully compatible with version 2.0.0. It adds the package Buildings.Fluid.FMI that provides containers for exporting thermofluid flow components as FMUs. It also updates the temperature sensor to optionally simulate heat losses, and it contains bug fixes for the trace substance sensor if used without flow reversal. Improvements have been made to various models to reduce the simulation time, and to Buildings.Examples.Tutorial.Boiler to simplify the control implementation.

The following new libraries have been added:

Buildings.Fluid.FMI This package contains blocks that serve as containers for exporting models from Buildings.Fluid as a Functional Mockup Unit (FMU).
This allows using models from Buildings.Fluid, add them to a block that only has input and output signals, but no acausal connectors, and then export the model as a Functional Mockup Unit. Models can be individual models or systems that are composed of various models. For more information, see the User's Guide.

The following existing components have been improved in a backward compatible way:

Buildings.Examples
Buildings.Examples.Tutorial.Boiler.System5 Buildings.Examples.Tutorial.Boiler.System6 Buildings.Examples.Tutorial.Boiler.System7	Changed control input for `conPIDBoi` and set `reverseAction=true` to address issue #436.
Buildings.Fluid
Buildings.Fluid.Chillers.Carnot Buildings.Fluid.DXSystems.Cooling.BaseClasses.PartialDXCoil Buildings.Fluid.HeatExchangers.HeaterCooler_u Buildings.Fluid.MassExchangers.Humidifier_u	Set parameter `prescribedHeatFlowRate=true` which causes a simpler energy balance to be used.
Buildings.Fluid.Sensors.TemperatureTwoPort	Added option to simulate thermal loss, which is useful if the sensor is used to measure the fluid temperature in a system with on/off control for the mass flow rate.
Buildings.Fluid.SolarCollectors.ASHRAE93 Buildings.Fluid.SolarCollectors.EN12975	Corrected sign error in computation of heat loss that prevents the medium to exceed `Medium.T_min` or `Medium.T_max`. With the previous implementation, an assertion may be generated unnecessarily rather than the model guiding against the violation of these bounds.
Buildings.Fluid.MixingVolumes.BaseClasses.PartialMixingVolume	Added test on `allowFlowReversal` in criteria about what energy balance implementation to use. This causes simpler models, for example when exporting `Buildings.Fluid.HeatExchangers.HeaterCooler_u` as an FMU.

The following critical errors have been fixed (i.e., errors that can lead to wrong simulation results):

Buildings.Fluid
Buildings.Fluid.Sensors.TraceSubstanceTwoPort	Corrected wrong sensor signal if `allowFlowReversal=false`. For this setting, the sensor output was for the wrong flow direction. This corrects issue 249.

The following uncritical errors have been fixed (i.e., errors that do not lead to wrong simulation results, e.g., units are wrong or errors in documentation):

Buildings.Fluid
Buildings.Fluid.Interfaces.ConservationEquation Buildings.Fluid.Interfaces.StaticTwoPortConservationEquation	Corrected documentation.

Extends from Modelica.Icons.ReleaseNotes (Icon for release notes in documentation).

Modelica definition

class Version_2_1_0 "Version 2.1.0" extends Modelica.Icons.ReleaseNotes; end Version_2_1_0;

Buildings.UsersGuide.ReleaseNotes.Version_2_0_0

Version 2.0.0

Information

Version 2.0.0 is a major release that contains various new packages, models and improvements.

The following major additions have been done in version 2.0:

A CFD model that is embedded in a thermal zone has been added. This model is implemented in Buildings.ThermalZones.Detailed.CFD. The CFD model is an implementation of the Fast Fluid Dynamics code that allows three-dimensional CFD inside a thermal zone, coupled to building heat transfer, HVAC components and feedback control loops.
A new package Buildings.Electrical has been added. This package allows studying buildings to electrical grid integration. It includes models for loads, transformers, cables, batteries, PV and wind turbines. Models exist for DC and AC systems with two- or three-phase that can be balanced and unbalanced. The models compute voltage, current, active and reactive power based on the quasi-stationary assumption or using the dynamic phasorial representation.
The new package Buildings.Controls.DemandResponse contains models for demand response simulation.
The new package Buildings.Controls.Predictors contains a data-driven model that predicts the electrical load of a building. The prediction can be done either using an average baseline or a linear regression with respect to outside temperature. For both, optionally a day-of adjustment can be made.

The tables below give more detailed information to the revisions of this library compared to the previous release 1.6 build 1.

The following new libraries have been added:

Buildings.Electrical	Library for electrical grid simulation that allows to study building to electrical grid integration. The library contains models of loads, generation and transmission for DC and AC systems.
Buildings.Controls.DemandResponse	Library with a model for demand response prediction.
Buildings.Controls.Predictors	Library with a data-driven model that predicts the electrical load of a building. The prediction can be done either using an average baseline or a linear regression with respect to outside temperature. For both, optionally a day-of adjustment can be made.

The following new components have been added to existing libraries:

Buildings.Fluid
Buildings.Fluid.Actuators.Valves.TwoWayPressureIndependent	Model of a pressure-independent two way valve.
Buildings.Fluid.HeatExchangers.HeaterCooler_T	Model of a heater or cooler that takes as an input the set point for the temperature of the fluid that leaves the component. The set point is tracked exactly if the component has sufficient capacity. Optionally, the component can be configured to compute a dynamic rather than a steady-state response.
Buildings.Utilities
Buildings.Utilities.Psychrometrics.Phi_pTX Buildings.Utilities.Psychrometrics.Functions.phi_pTX	Block and function that computes the relative humidity for given pressure, temperature and water vapor mass fraction.
Buildings.ThermalZones
Buildings.ThermalZones.Detailed.CFD	Room model that computes the room air flow using computational fluid dynamics (CFD). The CFD simulation is coupled to the thermal simulation of the room and, through the fluid port, to the air conditioning system. Currently, the supported CFD program is the Fast Fluid Dynamics (FFD) program. See `Buildings.ThermalZones.Detailed.UsersGuide.CFD` for detailed explanations.

The following existing components have been improved in a backward compatible way:

Buildings.BoundaryConditions
Buildings.BoundaryConditions.WeatherData.ReaderTMY3	Added option to obtain the black body sky temperature from a parameter or an input signal rather than computing it in the weather data reader. Removed redundant connection `connect(conHorRad.HOut, cheHorRad.HIn);`.
Buildings.Fluid
Buildings.Chillers.ElectricEIR Buildings.Chillers.ElectricReformulatedEIR	Changed implementation so that the model is continuously differentiable. This is for issue 373.
Buildings.Fluid.HeatExchangers.DryCoilCounterFlow	Changed assignment of `T_m` to avoid using the conditionally enabled model `ele[:].mas.T`, which is only valid in a connect statement. Moved assignments of `Q1_flow`, `Q2_flow`, `T1`, `T2` and `T_m` outside of equation section to avoid mixing graphical and textual modeling within the same model.
Buildings.Fluid.HeatExchangers.DryCoilDiscretized	Removed parameter `m1_flow_nominal`, as this parameter is already declared in its base class `Buildings.Fluid.Interfaces.PartialFourPortInterface`. This change avoids an error in OpenModelica as the two declarations had a different value for the `min` attribute, which is not valid in Modelica.
Buildings.Fluid.HeatExchangers.BaseClasses.CoilRegister Buildings.Fluid.HeatExchangers.BaseClasses.DuctManifoldDistributor	Reformulated the multiple iterators in the `sum` function as this language construct is not supported in OpenModelica.
Buildings.Fluid.HeatExchangers.RadiantSlabs.SingleCircuitSlab	Set start value for `hPip(fluid(T))` to avoid a warning about conflicting start values.
Buildings.Fluid.Movers.SpeedControlled_y Buildings.Fluid.Movers.SpeedControlled_Nrpm Buildings.Fluid.Movers.FlowControlled_dp Buildings.Fluid.Movers.FlowControlled_m_flow	For the parameter setting `use_powerCharacteristic=true`, changed the computation of the power consumption at reduced speed to properly account for the affinity laws. This is in response to #202.
Buildings.Fluid.SolarCollectors.ASHRAE93 Buildings.Fluid.SolarCollectors.EN12975	Reformulated the model to avoid a translation error if glycol is used. Propagated parameters for initialization in base class `Buildings.Fluid.SolarCollectors.BaseClasses.PartialSolarCollector` and set `prescribedHeatFlowRate=true`.
Buildings.Fluid.Storage.StratifiedEnhancedInternalHex	Replaced the `abs()` function in the assignment of the parameter `nSegHexTan` as the return value of `abs()` is a `Real` which causes a type error during model check.
Buildings.HeatTransfer
Buildings.HeatTransfer.Conduction.MultiLayer	Changed the assignment of `_T_a_start`, `_T_b_start` and `RTot` 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.
Buildings.HeatTransfer.Windows.InteriorHeatTransferConvective	Changed model to allow a temperature dependent convective heat transfer on the room side. This is for issue 52.
Buildings.Media
Buildings.Media.Interfaces.PartialSimpleIdealGasMedium Buildings.Media.Interfaces.PartialSimpleMedium	Set `T(start=T_default)` and `p(start=p_default)` in the `ThermodynamicState` record. Setting the start value for `T` is required to avoid an error due to conflicting start values when translating `Buildings.Examples.VAVReheat.ClosedLoop` in pedantic mode.
Buildings.ThermalZones
Buildings.ThermalZones.Detailed.MixedAir	Changed model to allow a temperature dependent convective heat transfer on the room side for windows. This is for issue 52.
Rooms.BaseClasses.ExteriorBoundaryConditionsWithWindow	Conditionally removed the shade model if no shade is present. This corrects #234.

The following existing components have been improved in a non-backward compatible way:

Buildings.Airflow
Buildings.Airflow.Multizone.ZonalFlow_ACS Buildings.Airflow.Multizone.ZonalFlow_m_flow	Removed parameter `forceErrorControlOnFlow` as it was not used. For Dymola, the conversion script will automatically update existing models.
Buildings.BoundaryConditions
Buildings.BoundaryConditions.WeatherData.ReaderTMY3	Changed the following signals for compatibility with OpenModelica: `weaBus.sol.zen` to `weaBus.solZen`. `weaBus.sol.dec` to `weaBus.solDec`. `weaBus.sol.alt` to `weaBus.solAlt`. `weaBus.sol.solHouAng` to `weaBus.solHouAng`. For Dymola, the conversion script will automatically update existing models.
Buildings.Examples
Buildings.Examples.VAVReheat.Controls.IntegerSum	Removed block as it is not used in any model. Models that require an integer sum can use `Modelica.Blocks.MathInteger.Sum`.
Buildings.Examples.VAVReheat.Controls.UnoccupiedOn	Removed block as it is not used in any model.
Buildings.HeatTransfer
Buildings.HeatTransfer.Data.GlazingSystems.Generic	Removed parameter `nLay` as OpenModelica could not assign it during translation. For Dymola, the conversion script will automatically update existing models.
Buildings.HeatTransfer.Conduction.BaseClasses.der_temperature_u	Changed the input argument for this function from type `Buildings.HeatTransfer.Data.BaseClasses.Material` to the elements of this type as OpenModelica fails to translate the model if the input to this function is a record.
Buildings.HeatTransfer.Types.Azimuth Buildings.HeatTransfer.Types.Tilt	Moved these types from `Buildings.HeatTransfer` to the top-level package `Buildings` because they are used in `Buildings.BoundaryConditions`, `Buildings.HeatTransfer` and `Buildings.ThermalZones.Detailed`. For Dymola, the conversion script will automatically update existing models.
Buildings.Fluid
Buildings.Fluid.FixedResistances.Pipe Buildings.Fluid.FixedResistances.BaseClasses.Pipe Buildings.Fluid.HeatExchangers.RadiantSlabs.SingleCircuitSlab	Renamed pressure drop from `res` to `preDro` to use the same name as in other models. This corrects #271. For Dymola, the conversion script will automatically update existing models.
Buildings.Fluid.HeatExchangers.DryCoilDiscretized Buildings.Fluid.HeatExchangers.WetCoilDiscretized	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 `dl` has also been removed. Replaced the parameters `energyDynamics1` and `energyDynamics2` with `energyDynamics`. Removed the parameter `ductConnectionDynamics`. For Dymola, the conversion script will automatically update existing models.
Buildings.Fluid.HeatExchangers.HeaterCoolerPrescribed	Renamed the model to `HeaterCooler_u` due to the introduction of the new model `HeaterCooler_T`. For Dymola, the conversion script will automatically update existing models.
Buildings.Fluid.HeatExchangers.RadiantSlabs.SingleCircuitSlab Buildings.Fluid.HeatExchangers.RadiantSlabs.ParallelCircuitsSlab	Changed the models to use by default an ε-NTU 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. The new ε-NTU formulation has shown to lead to about five times faster computation on several test cases including the models in `Buildings.ThermalZones.Detailed.FLEXLAB.Rooms.Examples`. For Dymola, the conversion script will automatically update existing models.
Buildings.Fluid.HeatExchangers.BaseClasses.DuctManifoldFixedResistance	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 `dl` and `energyDynamics` have also been removed. For Dymola, the conversion script will automatically update existing models.
Buildings.Fluid.HeatExchangers.BaseClasses.CoilRegister	Replaced the parameters `energyDynamics1` and `energyDynamics2` with the new parameter `energyDynamics`. Removed the parameters `steadyState_1` and `steadyState_2` as this information is already contained in `energyDynamics`. For Dymola, the conversion script will automatically update existing models.
Buildings.Fluid.MassExchangers.HumidifierPrescribed	Renamed the model to `Humidifier_u` due to the introduction of the new model `HeaterCooler_T` and to use the same naming pattern as `HeaterCooler_u`. For Dymola, the conversion script will automatically update existing models.
Buildings.Fluid.Movers	This package has been redesigned. The models have been renamed as follows: `Buildings.Fluid.Movers.FlowMachine_dp` is now called `Buildings.Fluid.Movers.FlowControlled_dp`. `Buildings.Fluid.Movers.FlowMachine_m_flow` is now called `Buildings.Fluid.Movers.FlowControlled_m_flow`. `Buildings.Fluid.Movers.FlowMachine_Nrpm` is now called `Buildings.Fluid.Movers.SpeedControlled_Nrpm`. `Buildings.Fluid.Movers.FlowMachine_y` is now called `Buildings.Fluid.Movers.SpeedControlled_y`. In addition, the performance data of all movers are now stored in a record. These records are in `Buildings.Fluid.Movers.Data`. For most existing instances, it should be sufficient to enclose the existing performance data in a record called `per`. For example, `Buildings.Fluid.Movers.FlowMachine_y fan( redeclare package Medium = Medium, pressure( V_flow={0,m_flow_nominal,2m_flow_nominal}/1.2, dp={2dp_nominal,dp_nominal,0})));` becomes `Buildings.Fluid.Movers.SpeedControlled_y fan( redeclare package Medium = Medium, per( pressure( V_flow={0,m_flow_nominal,2m_flow_nominal}/1.2, dp={2dp_nominal,dp_nominal,0})));` See the `Buildings.Fluid.Movers.UsersGuide` for more information about these records. For Dymola, the conversion script will update existing models to use the old implementations which are now in the package `Buildings.Obsolete.Fluid.Movers`.
Buildings.Media
Buildings.Media	Renamed all media to simplify the media selection. For typical building energy simulation, `Buildings.Media.Air` and `Buildings.Media.Water` should be used. The following changes were made. Renamed `Buildings.Media.GasesPTDecoupled.MoistAirUnsaturated` to `Buildings.Media.Air`. Renamed `Buildings.Media.ConstantPropertyLiquidWater` to `Buildings.Media.Water`. Renamed `Buildings.Media.PerfectGases.MoistAir` to `Buildings.Obsolete.Media.PerfectGases.MoistAir`. Renamed `Buildings.Media.GasesConstantDensity.MoistAirUnsaturated` to `Buildings.Obsolete.Media.GasesConstantDensity.MoistAirUnsaturated`. Renamed `Buildings.Media.GasesConstantDensity.MoistAir` to `Buildings.Obsolete.Media.GasesConstantDensity.MoistAir`. Renamed `Buildings.Media.GasesConstantDensity.SimpleAir` to `Buildings.Obsolete.Media.GasesConstantDensity.SimpleAir`. Renamed `Buildings.Media.IdealGases.SimpleAir` to `Buildings.Obsolete.Media.IdealGases.SimpleAir`. Renamed `Buildings.Media.GasesPTDecoupled.MoistAir` to `Buildings.Obsolete.Media.GasesPTDecoupled.MoistAir`. Renamed `Buildings.Media.GasesPTDecoupled.SimpleAir` to `Buildings.Obsolete.Media.GasesPTDecoupled.SimpleAir`. For Dymola, the conversion script will update existing models according to the above list.
Buildings.Media.Water	Removed option to model water as a compressible medium as this option was not useful.
Buildings.ThermalZones
Buildings.ThermalZones.Detailed.BaseClasses.ParameterConstructionWithWindow	Removed the keyword `replaceable` for the parameters `ove` and `sidFin`. Models that instantiate `Buildings.ThermalZones.Detailed.MixedAir` are not affected by this change.
Buildings.ThermalZones.Detailed.Examples.BESTEST	Moved the package to `Buildings.ThermalZones.Detailed.Validation.BESTEST`.
Buildings.Utilities
Buildings.Utilities.SimulationTime	Moved the block `Buildings.Utilities.SimulationTime` to `Buildings.Utilities.Time.ModelTime`. For Dymola, the conversion script will update existing models according to the above list.

The following critical errors have been fixed (i.e., errors that can lead to wrong simulation results):

Buildings.BoundaryConditions
Buildings.BoundaryConditions.WeatherData.ReaderTMY3	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.
Buildings.Fluid
Buildings.Fluid.Data.Pipes	Corrected wrong entries for inner and outer diameter of PEX pipes.
Buildings.Fluid.Geothermal.Boreholes.BaseClasses.singleUTubeResistances	Corrected error in function that used `beta` before it was assigned a value.
Buildings.Fluid.Storage.Stratified Buildings.Fluid.Storage.StratifiedEnhanced Buildings.Fluid.Storage.StratifiedEnhancedInternalHex	Replaced the use of `Medium.lambda_const` with `Medium.thermalConductivity(sta_default)` as `lambda_const` is not declared for all media. This avoids a translation error if certain media are used.
Buildings.Fluid.Storage.StratifiedEnhancedInternalHex	Corrected issue #271 which led to a compilation error if the heat exchanger and the tank had different media.
Buildings.HeatTransfer
Buildings.HeatTransfer.Windows.BaseClasses.GlassLayer	Corrected issue #304 that led to an error in the glass temperatures if the glass conductance is very small.
Buildings.ThermalZones
Buildings.ThermalZones.Detailed.MixedAir	Added propagation of the parameter value `linearizeRadiation` to the window model. Prior to this change, the radiation was never linearized for computing the glass long-wave radiation.
Buildings.ThermalZones.Detailed.FLEXLAB.Rooms.Examples.X3WithRadiantFloor Buildings.ThermalZones.Detailed.FLEXLAB.Rooms.Examples.X3AWithRadiantFloor Buildings.ThermalZones.Detailed.FLEXLAB.Rooms.Examples.X3BWithRadiantFloor	Corrected wrong entries for inner and outer diameter of PEX pipes.

The following uncritical errors have been fixed (i.e., errors that do not lead to wrong simulation results, e.g., units are wrong or errors in documentation):

Buildings.Fluid
Buildings.Fluid.FixedResistances.FixedResistanceDpM	Corrected error in documentation of computation of `k`.
Buildings.HeatTransfer
Buildings.HeatTransfer.Windows.BaseClasses.GlassLayer	Changed type of `tauIR` from `Modelica.Units.SI.Emissivity` to `Modelica.Units.SI.TransmissionCoefficient`. This avoids a type error in OpenModelica.

Note:

With version 2.0, we start using semantic versioning as described at http://semver.org/.

Extends from Modelica.Icons.ReleaseNotes (Icon for release notes in documentation).

Modelica definition

class Version_2_0_0 "Version 2.0.0" extends Modelica.Icons.ReleaseNotes; end Version_2_0_0;

Buildings.UsersGuide.ReleaseNotes.Version_1_6_build1

Version 1.6 build 1

Information

Version 1.6 build 1 updates the Buildings library to the Modelica Standard Library 3.2.1 and to Modelica_StateGraph2 2.0.2.

This is the first version of the Buildings library that contains models from the IEA EBC Annex 60 library, a Modelica library for building and community energy systems that is collaboratively developed within the project "New generation computational tools for building and community energy systems based on the Modelica and Functional Mockup Interface standards", a project that is conducted under the Energy in Buildings and Communities Programme (EBC) of the International Energy Agency (IEA).

The following new components have been added to existing libraries:

Buildings.Fluid
Buildings.Fluid.Actuators.Valves.TwoWayTable	Two way valve for which the opening characteristics is specified by a table.
Buildings.Utilities.Math
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	Various functions and blocks for mathematical operations.
Buildings.Utilities.Psychrometrics
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	Various functions and blocks for psychrometric calculations.

The following existing components have been improved in a backward compatible way:

Buildings.Fluid
Buildings.Fluid.Interfaces.PartialTwoPortInterface Buildings.Fluid.Interfaces.PartialFourPortInterface	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.
Buildings.Fluid.Actuators.Dampers.Exponential	Improved documentation of the flow resistance.
Buildings.BoundaryConditions
Buildings.BoundaryConditions.WeatherData.ReaderTMY3	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 `HInfHor`.

The following existing components have been improved in a non-backward compatible way:

Buildings.Fluid
Buildings.Fluid.Movers.FlowMachinePolynomial	Moved the model to the package `Buildings.Obsolete`, 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 `Buildings.Fluid.Movers`.
Buildings.Fluid.Storage.ExpansionVessel	Simplified the model to have a constant pressure. The following non-backward compatible changes have been made. The parameter `VTot` was renamed to `V_start`. The following parameters were removed: `VGas0`, `pMax`, `energyDynamics` and `massDynamics`. The conversion script should update old instances of this model automatically in Dymola.
Buildings.Fluid.Storage.StratifiedEnhancedInternalHex	Revised the model as the old version required the port_a of the heat exchanger to be located higher than port_b. 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: Changed `hexTopHeight` to `hHex_a`. Changed `hexBotHeight` to `hHex_b`. Changed `topHexSeg` to `segHex_a`, and made it protected as this is deduced from `hHex_a`. Changed `botHexSeg` to `segHex_b`, and made it protected as this is deduced from `hHex_b`. The names of the following ports have been changed: Changed `port_a1` to `portHex_a`. Changed `port_b1` to `portHex_b`. The conversion script should update old instances of this model automatically in Dymola for all of the above changes.

The following critical errors have been fixed (i.e., errors that can lead to wrong simulation results):

Buildings.Fluid
Buildings.Fluid.Geothermal.Boreholes.UTube	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 `B0` and `B1` as the new implementation does not require them.

The following uncritical errors have been fixed (i.e., errors that do not lead to wrong simulation results, e.g., units are wrong or errors in documentation):

Buildings.Fluid
Buildings.Fluid.Geothermal.Boreholes.BaseClasses.HexInternalElement	Corrected error in documentation which stated a wrong default value for the pipe spacing.
Buildings.Fluid.HeatExchangers.BaseClasses.ntu_epsilonZ()	Added dummy argument to function call of `Internal.solve` to avoid a warning during model check in Dymola 2015.
Buildings.Fluid.HeatExchangers.DryEffectivenessNTU	Changed `assert` statement to avoid comparing enumeration with an integer, which triggers a warning in Dymola 2015.
Buildings.ThermalZones.Detailed.Constructions.Examples.ExteriorWall Buildings.ThermalZones.Detailed.Constructions.Examples.ExteriorWallWithWindow Buildings.ThermalZones.Detailed.Constructions.Examples.ExteriorWallTwoWindows	Corrected wrong assignment of parameter in instance `bouConExt(conMod=...)` which was set to an interior instead of an exterior convection model.
Buildings.Utilities.Psychrometrics.Functions.TDewPoi_pW()	Added dummy argument to function call of `Internal.solve` to avoid a warning during model check in Dymola 2015.

The followings issues have been fixed:

Buildings.Fluid
#196	Change capacity location in borehole grout.

Extends from Modelica.Icons.ReleaseNotes (Icon for release notes in documentation).

Modelica definition

class Version_1_6_build1 "Version 1.6 build 1" extends Modelica.Icons.ReleaseNotes; end Version_1_6_build1;

Buildings.UsersGuide.ReleaseNotes.Version_1_5_build3

Version 1.5 build 3

Information

Version 1.5 build 3 is a maintenance release that corrects an error in Buildings.Fluid.MassExchangers.HumidifierPrescribed. It is fully compatible with version 1.5 build 2.

The following critical errors have been fixed (i.e., errors that can lead to wrong simulation results):

Buildings.Fluid
Buildings.Fluid.MassExchangers.HumidifierPrescribed	Corrected the enthalpy balance, which caused the latent heat flow rate to be added twice to the fluid stream. This closes issue #197.

The following issues have been fixed:

HumidifierPrescribed accounts twice for latent heat gain
#197	This issue has been addressed by correcting the latent heat added to the fluid stream.

Extends from Modelica.Icons.ReleaseNotes (Icon for release notes in documentation).

Modelica definition

class Version_1_5_build3 "Version 1.5 build 3" extends Modelica.Icons.ReleaseNotes; end Version_1_5_build3;

Buildings.UsersGuide.ReleaseNotes.Version_1_5_build2

Version 1.5 build 2

Information

Version 1.5 build 2 is a maintenance release that corrects an error in Buildings.Fluid.HeatExchangers.DryCoilDiscretized and in Buildings.Fluid.HeatExchangers.WetCoilDiscretized. It is fully compatible with version 1.5 build 1.

The following critical errors have been fixed (i.e., errors that can lead to wrong simulation results):

Buildings.Fluid
Buildings.Fluid.HeatExchangers.DryCoilDiscretized Buildings.Fluid.HeatExchangers.WetCoilDiscretized	Corrected wrong connect statements that caused the last register to have no liquid flow. This closes issue #194.

The following issues have been fixed:

DryCoilDiscretized model not using last register, liquid flow path
#194	This issue has been addressed by correcting the connect statements.

Extends from Modelica.Icons.ReleaseNotes (Icon for release notes in documentation).

Modelica definition

class Version_1_5_build2 "Version 1.5 build 2" extends Modelica.Icons.ReleaseNotes; end Version_1_5_build2;

Buildings.UsersGuide.ReleaseNotes.Version_1_5_build1

Version 1.5 build 1

Information

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.

This release also contains a major revision of all info sections to correct invalid html syntax. The package Buildings.HeatTransfer.Radiosity has been revised to comply with the Modelica language specification. The package Buildings.ThermalZones.Detailed 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.

The following new libraries have been added:

Buildings.Fluid.SolarCollectors	Library with solar collectors.
Buildings.ThermalZones.Detailed.FLEXLAB	Package with models for test cells of LBNL's FLEXLAB (Facility for Low Energy Experiments in Buildings).
Buildings.Utilities.IO.FLEXLAB	Package that demonstrates two-way data exchange between Modelica and LBNL's FLEXLAB (Facility for Low Energy Experiments in Buildings).

The following new components have been added to existing libraries:

Buildings.Fluid.Storage
Buildings.Fluid.Storage.StratifiedEnhancedInternalHex	Added a model of a tank with built-in heat exchanger. This model may be used together with solar thermal plants.
Buildings.Resources
Buildings.Resources.Include	Added an `Include` folder and the `bcvtb.h` header file to it to fix compilation errors in BCVTB example files.

The following existing components have been improved in a backward compatible way:

Buildings.BoundaryConditions
Buildings.BoundaryConditions.WeatherData.ReaderTMY3 Buildings.BoundaryConditions.WeatherData.BaseClasses.getAbsolutePath	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 `file://`, `modelica://` and `modelica://Buildings` 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 `Buildings` library is on the `MODELICAPATH`.
Buildings.Fluid
Buildings.Fluid.Interfaces.StaticTwoPortConservationEquation	Reformulated computation of outlet properties to avoid an event at zero mass flow rate.
Buildings.Fluid.HeatExchangers.CoolingTowers.YorkCalc	Simplified the implementation for the situation if `allowReverseFlow=false`. Avoided the use of the conditionally enabled variables `sta_a` and `sta_b` as this was not proper use of the Modelica syntax.
Buildings.Fluid.Interfaces.Examples.ReverseFlowHumidifier	Changed one instance of `Modelica.Fluid.Sources.MassFlowSource_T`, 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 #739.
Buildings.Fluid.Sensors.EnthalpyFlowRate Buildings.Fluid.Sensors.SensibleEnthalpyFlowRate Buildings.Fluid.Sensors.LatentEnthalpyFlowRate Buildings.Fluid.Sensors.VolumeFlowRate	Removed default value `tau=0` as the base class already sets `tau=1`. This change was made so that all sensors use the same default value.
Buildings.Fluid.Sensors.TraceSubstancesTwoPort	Added default value `C_start=0`.
Buildings.HeatTransfer
Buildings.HeatTransfer.Data.OpaqueConstructions.Generic	Changed the annotation of the instance `material` from `Evaluate=true` to `Evaluate=false`. This is required to allow changing the material properties after compilation. Note, however, that the number of state variables in `Buildings.HeatTransfer.Data.BaseClasses.Material` are only computed when the model is translated, because the number of state variables is fixed at compilation time.
Buildings.Utilities
Buildings.Utilities.Diagnostics.AssertEquality Buildings.Utilities.Diagnostics.AssertInequality	Added `time` in print statement as OpenModelica, in its error message, does not output the time when the assert is triggered.

The following existing components have been improved in a non-backward compatible way:

Buildings.Airflow
Buildings.Airflow.Multizone.Orifice Buildings.Airflow.Multizone.EffectiveAirLeakageArea Buildings.Airflow.Multizone.ZonalFlow_ACS	Changed the parameter `useConstantDensity` to `useDefaultProperties` to use consistent names within this package. A conversion script in `Resources/Scripts/Dymola` can be used to update old models that use this parameter.
Buildings.Fluid
Buildings.Fluid.BaseClasses.IndexWater	Renamed class to `Buildings.Fluid.BaseClasses.IndexMassFraction` as it is applicable for all mass fraction sensors.
Buildings.Fluid.HeatExchangers.ConstantEffectiveness Buildings.Fluid.HeatExchangers.DryEffectivenessNTU Buildings.Fluid.Interfaces.ConservationEquation Buildings.Fluid.Interfaces.StaticFourPortHeatMassExchanger Buildings.Fluid.Interfaces.StaticTwoPortConservationEquation Buildings.Fluid.Interfaces.StaticTwoPortHeatMassExchanger Buildings.Fluid.MassExchangers.ConstantEffectiveness Buildings.Fluid.MassExchangers.HumidifierPrescribed Buildings.Fluid.MixingVolumes.BaseClasses.PartialMixingVolumeWaterPort Buildings.Fluid.MixingVolumes.MixingVolume Buildings.Fluid.MixingVolumes.MixingVolumeDryAir Buildings.Fluid.MixingVolumes.MixingVolumeMoistAir Buildings.Fluid.Storage.ExpansionVessel	Changed the input connector `mXi_flow` (or `mXi1_flow` and `mXi2_flow`) to `mWat_flow` (or `mWat1_flow` and `mWat2_flow`). This change has been done as declaring `mXi_flow` is ambiguous because it does not specify what other species are added unless a mass flow rate `m_flow` is also known. To avoid this confusion, the connector variables have been renamed. The equations that were used were, however, correct. This addresses issue #165.
Buildings.Fluid.Storage.BaseClasses.IndirectTankHeatExchanger Buildings.Fluid.BaseClasses.PartialResistance Buildings.Fluid.FixedResistances.BaseClasses.Pipe Buildings.Fluid.FixedResistances.FixedResistanceDpM Buildings.Fluid.FixedResistances.LosslessPipe Buildings.Fluid.Geothermal.Boreholes.BaseClasses.BoreholeSegment Buildings.Fluid.Geothermal.Boreholes.UTube Buildings.Fluid.HeatExchangers.RadiantSlabs.ParallelCircuitsSlab Buildings.Fluid.Interfaces.FourPortHeatMassExchanger Buildings.Fluid.Interfaces.PartialFourPortInterface Buildings.Fluid.Interfaces.PartialTwoPortInterface Buildings.Fluid.Interfaces.StaticFourPortHeatMassExchanger Buildings.Fluid.Interfaces.StaticTwoPortHeatMassExchanger Buildings.Fluid.Interfaces.TwoPortHeatMassExchanger Buildings.Fluid.MixingVolumes.BaseClasses.PartialMixingVolume Buildings.Fluid.Movers.BaseClasses.FlowControlled Buildings.Fluid.Movers.BaseClasses.IdealSource Buildings.Fluid.Movers.BaseClasses.PrescribedFlowMachine	Removed the computation of `V_flow` and removed the parameter `show_V_flow`. The reason is that the computation of `V_flow` required the use of `sta_a` (to compute the density), but `sta_a` is also a variable that is conditionally enabled. However, this was not correct Modelica syntax as conditional variables can only be used in a `connect` statement, not in an assignment. Dymola 2014 FD01 beta3 is checking for this incorrect syntax. Hence, `V_flow` was removed as its conditional implementation would require a rather cumbersome implementation that uses a new connector that carries the state of the medium.
Buildings.Fluid.MixingVolumes	Removed `Buildings.Fluid.MixingVolumes.MixingVolumeDryAir` as this model is no longer used. The model `Buildings.Fluid.MixingVolumes.MixingVolume` can be used instead of. Removed base class `Buildings.Fluid.MixingVolumes.BaseClasses.PartialMixingVolumeWaterPort` as this model is no longer used.
Buildings.Fluid.Sensors.Examples.TraceSubstances	Renamed example from `ExtraProperty` to `TraceSubstances` in order to use the same name as the sensor.
Buildings.Fluid.Sources.PrescribedExtraPropertyFlowRate	Renamed model to`TraceSubstancesFlowRate` to use the same terminology than the Modelica Standard Library. The conversion script updates existing models that instantiate this model.
Buildings.Fluid.Sources.Examples.PrescribedExtraPropertyFlow	Renamed example to`TraceSubstancesFlowRate` in order to use the same name as the source model.
Buildings.Fluid.MixingVolumes.BaseClasses.PartialMixingVolume Buildings.Fluid.FixedResistances.Pipe Buildings.Fluid.HeatExchangers.RadiantSlabs.ParallelCircuitsSlab Buildings.Fluid.HeatExchangers.RadiantSlabs.SingleCircuitSlab Buildings.Fluid.Movers.BaseClasses.FlowControlled	Renamed `X_nominal` to `X_default` or `X_start`, where `X` may be `state`, `rho`, or `mu`, depending on whether the medium default values or the start values are used in the computation of the state and derived quantities.
Buildings.HeatTransfer Buildings.ThermalZones
Buildings.HeatTransfer.Interfaces.RadiosityInflow Buildings.HeatTransfer.Interfaces.RadiosityOutflow Buildings.HeatTransfer.Radiosity.BaseClasses.ParametersTwoSurfaces Buildings.HeatTransfer.Radiosity.Constant Buildings.HeatTransfer.Radiosity.Examples.OpaqueSurface Buildings.HeatTransfer.Radiosity.Examples.OutdoorRadiosity Buildings.HeatTransfer.Radiosity.IndoorRadiosity Buildings.HeatTransfer.Radiosity.OpaqueSurface Buildings.HeatTransfer.Radiosity.OutdoorRadiosity Buildings.HeatTransfer.Radiosity.RadiositySplitter Buildings.HeatTransfer.Radiosity.package Buildings.HeatTransfer.Windows.BaseClasses.Examples.CenterOfGlass Buildings.HeatTransfer.Windows.BaseClasses.Examples.GlassLayer Buildings.HeatTransfer.Windows.BaseClasses.Examples.Shade Buildings.HeatTransfer.Windows.BaseClasses.GlassLayer Buildings.HeatTransfer.Windows.BaseClasses.Shade Buildings.HeatTransfer.Windows.Examples.BoundaryHeatTransfer Buildings.HeatTransfer.Windows.ExteriorHeatTransfer Buildings.HeatTransfer.Windows.InteriorHeatTransfer Buildings.ThermalZones.Detailed.BaseClasses.InfraredRadiationExchange Buildings.ThermalZones.Detailed.BaseClasses.InfraredRadiationGainDistribution Buildings.ThermalZones.Detailed.BaseClasses.MixedAir Buildings.ThermalZones.Detailed.BaseClasses.Overhang Buildings.ThermalZones.Detailed.BaseClasses.SideFins	Changed the connectors for the radiosity model. The previous implemenation declared the radiosity as a `flow` variables, but the implementation did not use a potential variable. Therefore, the radiosity was the only variable in the connector, which is not allowed for `flow` variables. This change required a reformulation of models because with the new formulation, the incoming and outcoming radiosity are both non-negative values. This addresses issue #158.
Buildings.HeatTransfer Buildings.ThermalZones
Buildings.HeatTransfer.Windows.BaseClasses.PartialConvection Buildings.HeatTransfer.Windows.BaseClasses.PartialWindowBoundaryCondition Buildings.HeatTransfer.Windows.BaseClasses.Shade Buildings.HeatTransfer.Windows.BaseClasses.ShadeConvection Buildings.HeatTransfer.Windows.BaseClasses.ShadeRadiation Buildings.HeatTransfer.Windows.InteriorHeatTransfer Buildings.HeatTransfer.Windows.InteriorHeatTransferConvective Buildings.ThermalZones.Detailed.ExteriorBoundaryConditionsWithWindow Buildings.ThermalZones.Detailed.PartialSurfaceInterface Buildings.ThermalZones.Detailed.InfraredRadiationExchange Buildings.ThermalZones.Detailed.AirHeatMassBalanceMixed Buildings.ThermalZones.Detailed.SolarRadiationExchange Buildings.ThermalZones.Detailed.RadiationTemperature Buildings.ThermalZones.Detailed.InfraredRadiationGainDistribution	Redesigned the implementation of the room model and its base classes. This redesign separates convection from radiation, and it provides one composite model for the convection and the heat and mass balance in the room. This change was done to allow an implementation of the room air heat and mass balance that does not assume uniformly mixed room air.
Buildings.HeatTransfer
Buildings.HeatTransfer.Convection.Functions.HeatFlux.rayleigh	Renamed function from `raleigh` to `rayleigh`.

The following critical errors have been fixed (i.e., errors that can lead to wrong simulation results):

Buildings.Fluid
Buildings.Fluid.Sensors.SpecificEntropyTwoPort	Corrected wrong computation of the dynamics used for the sensor signal.
Buildings.HeatTransfer
Buildings.HeatTransfer.Data.GlazingSystems.DoubleClearAir13Clear	Corrected the glass layer thickness, which was 5.7 mm instead of 3 mm, as the documentation states.

The following uncritical errors have been fixed (i.e., errors that do not lead to wrong simulation results, e.g., units are wrong or errors in documentation):

Buildings
Buildings.BoundaryConditions.SkyTemperature.BlackBody Buildings.BoundaryConditions.WeatherData.BaseClasses.CheckTemperature Buildings.BoundaryConditions.WeatherData.ReaderTMY3 Buildings.Controls.SetPoints.HotWaterTemperatureReset Buildings.Examples.ChillerPlant.BaseClasses.Controls.ChillerSwitch Buildings.Examples.ChillerPlant.BaseClasses.Controls.WSEControl Buildings.Fluid.Boilers.BoilerPolynomial Buildings.Fluid.HeatExchangers.BaseClasses.HexElement Buildings.Fluid.HeatExchangers.BaseClasses.MassExchange Buildings.Fluid.HeatExchangers.BaseClasses.MassExchangeDummy Buildings.Fluid.DXSystems.Cooling.BaseClasses.ApparatusDewPoint Buildings.Fluid.DXSystems.Cooling.BaseClasses.ApparatusDryPoint Buildings.Fluid.DXSystems.BaseClasses.CoolingCapacity Buildings.Fluid.DXSystems.Cooling.BaseClasses.DXCooling Buildings.Fluid.DXSystems.BaseClasses.DryCoil Buildings.Fluid.DXSystems.Cooling.BaseClasses.DryWetSelector Buildings.Fluid.DXSystems.Cooling.BaseClasses.Evaporation Buildings.Fluid.DXSystems.Cooling.BaseClasses.WetCoil Buildings.Fluid.MixingVolumes.BaseClasses.PartialMixingVolumeWaterPort Buildings.Fluid.Sensors.RelativeTemperature Buildings.Fluid.Sensors.Temperature Buildings.Fluid.Sensors.TemperatureTwoPort Buildings.Fluid.Sensors.TemperatureWetBulbTwoPort Buildings.Fluid.SolarCollectors.BaseClasses.PartialHeatLoss Buildings.Utilities.Comfort.Fanger Buildings.Utilities.IO.BCVTB.From_degC Buildings.Utilities.IO.BCVTB.To_degC Buildings.Utilities.Psychrometrics.TDewPoi_pW Buildings.Utilities.Psychrometrics.TWetBul_TDryBulPhi Buildings.Utilities.Psychrometrics.TWetBul_TDryBulXi Buildings.Utilities.Psychrometrics.WetBul_pTX Buildings.Utilities.Psychrometrics.pW_TDewPoi	Replaced wrong attribute `quantity="Temperature"` with `quantity="ThermodynamicTemperature"`.
Buildings.Fluid
Buildings.Fluid.Data.Fuels.Generic	Corrected wrong type for `mCO2`. It was declared as `Modelica.Units.SI.MassFraction`, which is incorrect.
Buildings.Fluid.HeatExchangers.CoolingTowers.Correlations.BaseClasses.Bounds	Corrected wrong type for `FRWat_min`, `FRWat_max` and `liqGasRat_max`. They were declared as `Modelica.Units.SI.MassFraction`, which is incorrect as, for example, `FRWat_max` can be larger than one.
Buildings.Fluid.HeatExchangers.ConstantEffectiveness Buildings.Fluid.MassExchangers.ConstantEffectiveness	Corrected error in the documentation that was not updated when the implementation of zero flow rate was revised.
Buildings.Fluid.Interfaces.ConservationEquation	Corrected the syntax error `Medium.ExtraProperty C[Medium.nC](each nominal=C_nominal)` to `Medium.ExtraProperty C[Medium.nC](nominal=C_nominal)` because `C_nominal` is a vector. This syntax error caused a compilation error in OpenModelica.
Buildings.Fluid.Sensors.SensibleEnthalpyFlowRate Buildings.Fluid.Sensors.LatentEnthalpyFlowRate Buildings.Fluid.Sensors.MassFraction Buildings.Fluid.Sensors.MassFractionTwoPort	Changed medium declaration in the `extends` statement to `replaceable` to avoid a translation error in OpenModelica.
Buildings.Fluid.Sensors.TraceSubstances Buildings.Fluid.Sensors.TraceSubstancesTwoPort	Corrected syntax errors in setting nominal value for output signal and for state variable. This eliminates a compilation error in OpenModelica.
Buildings.Fluid.Sources.TraceSubstancesFlowSource	Added missing `each` in declaration of `C_in_internal`. This eliminates a compilation error in OpenModelica.
Buildings.Utilities.Python27
Buildings.Utilities.IO.Python27.Functions.exchange	Corrected error in C code that lead to message `'module' object has no attribute 'argv'` when a python module accessed `sys.argv`.

The following issues have been fixed:

Verify mass and species balance
#165	This issue has been addressed by renaming the connectors to avoid an ambiguity in the model equation. The equations were correct.
Remove flow attribute from radiosity connectors
#158	This issue has been addressed by reformulating the radiosity models. With the new implementation, incoming and outgoing radiosity are non-negative quantities.

Extends from Modelica.Icons.ReleaseNotes (Icon for release notes in documentation).

Modelica definition

class Version_1_5_build1 "Version 1.5 build 1" extends Modelica.Icons.ReleaseNotes; end Version_1_5_build1;

Buildings.UsersGuide.ReleaseNotes.Version_1_4_build1

Version 1.4 build 1

Information

Version 1.4 build 1 contains the new package Buildings.Utilities.IO.Python27 that allows calling Python functions from Modelica. It also contains in the package Buildings.HeatTransfer.Conduction.SingleLayer a new model for heat conduction in phase change material. This model can be used as a layer of the room heat transfer model.

Non-backward compatible changes had to be introduced in the valve models Buildings.Fluid.Actuators.Valves to fully comply with the Modelica language specification, and in the models in the package Buildings.Utilities.Diagnostics as they used the cardinality function which is deprecated in the Modelica Language Specification.

See below for details.

The following new libraries have been added:

Buildings.Utilities.IO.Python27

Package that contains blocks and functions that embed Python 2.7 in Modelica. Data can be sent to Python functions and received from Python functions. This allows for example data analysis in Python as part of a Modelica model, or data exchange as part of a hardware-in-the-loop simulation in which Python is used to communicate with hardware.

The following new components have been added to existing libraries:

Buildings.BoundaryConditions.WeatherData
Buildings.BoundaryConditions.WeatherData.BaseClasses.getAbsolutePath	This function is used by the weather data reader to set the path to the weather file relative to the root directory of the Buildings library.

The following existing components have been improved in a backward compatible way:

Buildings.Fluid
Buildings.Fluid.MixingVolumes.BaseClasses.PartialMixingVolume	Removed the check of multiple connections to the same element of a fluid port, as this check required the use of the deprecated `cardinality` function.
Buildings.HeatTransfer
Buildings.HeatTransfer.Conduction.SingleLayer	Added option to model layers with phase change material.
Buildings.ThermalZones
Buildings.ThermalZones.Detailed.BaseClasses.InfraredRadiationExchange	Removed the use of the `cardinality` function as this function is deprecated in the Modelica Language Specification.

The following existing components have been improved in a non-backward compatible way:

Buildings.Fluid
Buildings.Fluid.Actuators.Valves	All valves now require the declaration of `dp_nominal` if the parameter assignment is `CvData = Buildings.Fluid.Types.CvTypes.OpPoint`. This change was needed because in the previous version, `dp_nominal` had a default value of 6000 Pascals. However, if `CvData >< Buildings.Fluid.Types.CvTypes.OpPoint`, then `dp_nominal` is computed in the initial algorithm section and hence providing a default value is not allowed according to the Modelica Language Specification. Hence, it had to be removed. As part of this change, we set `dp(nominal=6000)` for all valves, because the earlier formulation uses a value that is not known during compilation, and hence leads to an error in Dymola 2014.
Buildings.Fluid.MixingVolumes.MixingVolumeDryAir Buildings.Fluid.MixingVolumes.MixingVolumeMoistAir	Removed the use of the deprecated `cardinality` function. Therefore, now all input signals must be connected.
Buildings.Utilities
Buildings.Utilities.Diagnostics.AssertEquality Buildings.Utilities.Diagnostics.AssertInequality	Removed the option to not connect input signals, as this required the use of the `cardinality` function which is deprecated in the MSL, and not correctly implemented in OpenModelica. Therefore, if using these models, both input signals must be connected.
Buildings.Utilities.Math.Functions.splineDerivatives	Removed the default value `input Boolean ensureMonotonicity=isMonotonic(y, strict=false)` as the Modelica language specification is not clear whether defaults can be computed or must be constants.

The following critical errors have been fixed (i.e., errors that can lead to wrong simulation results):

Buildings.Controls
Buildings.Controls.SetPoints.HotWaterTemperatureReset	Corrected error that led to wrong results if the room air temperature is different from its nominal value `TRoo_nominal`. This fixes issue 74.
Buildings.HeatTransfer
Buildings.Fluid.HeatExchangers.RadiantSlabs.SingleCircuitSlab Buildings.Fluid.HeatExchangers.RadiantSlabs.ParallelCircuitSlab	Fixed bug in the assignment of the fictitious thermal resistance by replacing `RFic[nSeg](each G=A/Rx)` with `RFic[nSeg](each G=A/nSeg/Rx)`. This fixes issue 79.
Buildings.Utilities
Buildings.Utilities.Diagnostics.AssertEquality Buildings.Utilities.Diagnostics.AssertInequality	Replaced `when` test with `if` test as equations within a `when` section are only evaluated when the condition becomes true. This fixes issue 72.

The following uncritical errors have been fixed (i.e., errors that do not lead to wrong simulation results, e.g., units are wrong or errors in documentation):

Buildings.Fluid
Buildings.Fluid.Actuators.Valves.ThreeWayEqualPercentageLinear Buildings.Fluid.Actuators.Valves.ThreeWayLinear	The documenation was Fraction Kv(port_1 → port_2)/Kv(port_3 → port_2) instead of Fraction Kv(port_3 → port_2)/Kv(port_1 → port_2). Because the parameter set correctly its attributes `min=0` and `max=1`, instances of these models used the correct value.
Buildings.Fluid.Actuators.BaseClasses.ValveParameters	Removed stray backslash in write statement.
Buildings.Fluid.Interfaces.ConservationEquation Buildings.Fluid.Interfaces.StaticTwoPortConservationEquation Buildings.Fluid.Interfaces.StaticTwoPortHeatMassExchanger	Removed wrong unit attribute of `COut`.
Buildings.Fluid.HeatExchangers.BaseClasses.HexElement	Changed the redeclaration of `vol2` to be replaceable, as `vol2` is replaced in some models.

The following issues have been fixed:

Add explanation of nStaRef.
#70	Described in `Buildings.HeatTransfer.Data.Solids` how the parameter `nStaRef` is used to compute the spatial grid that is used for simulating transient heat conduction.
Assert statement does not fire.
#72	The blocks `Buildings.Utilities.Diagnostics.AssertEquality` and `Buildings.Utilities.Diagnostics.AssertInequality` did not fire because the test on the time was in a `when` instead of an `if` statement. This was wrong because `when` sections are only evaluated when the condition becomes true.
`HotWaterTemperatureReset` computes wrong results if room temperature differs from nominal value.
#74	The equation TSup = TRoo_in_internal + ((TSup_nominal+TRet_nominal)/2-TRoo_in_internal) * qRel^(1/m) + (TSup_nominal-TRet_nominal)/2 * qRel; should be formulated as TSup = TRoo_in_internal + ((TSup_nominal+TRet_nominal)/2-TRoo_nominal) * qRel^(1/m) + (TSup_nominal-TRet_nominal)/2 * qRel;
Bug in `RadiantSlabs.SingleCircuitSlab` fictitious resistance RFic.
#79	This bug has been fixed in the assignment of the fictitious thermal resistance by replacing `RFic[nSeg](each G=A/Rx)` with `RFic[nSeg](each G=A/nSeg/Rx)`. The bug also affected `RadiantSlabs.ParallelCircuitSlab`.

Note:

This version contains various updates that allow the syntax of the example models to be checked in the pedantic mode in Dymola 2014.

Extends from Modelica.Icons.ReleaseNotes (Icon for release notes in documentation).

Modelica definition

class Version_1_4_build1 "Version 1.4 build 1" extends Modelica.Icons.ReleaseNotes; end Version_1_4_build1;

Buildings.UsersGuide.ReleaseNotes.Version_1_3_build1

Version 1.3 build 1

Information

In version 1.3 build 1, models for direct evaporative cooling coils with multiple stages or with a variable speed compressor have been added. This version also contains improvements to the fan and pump models to better treat zero mass flow rate. Various other improvements have been made to improve the numerics and to use consistent variable names. A detailed list of changes is shown below.

The following new libraries have been added:

Buildings.Fluid.DXSystems

Library with direct evaporative cooling coils.

The following new components have been added to existing libraries:

Buildings.Examples
Buildings.Examples.ChillerPlant.DataCenterContinuousTimeControl	Added chilled water plant model with continuous time control that replaces the discrete time control in `Buildings.Examples.ChillerPlant.DataCenterDiscreteTimeControl`.
Buildings.Utilities
Buildings.Utilities.Psychrometrics.Functions.X_pSatpphi	Function that computes moisture concentration based on saturation pressure, total pressure and relative humidity.
Buildings.Utilities.Psychrometrics.TWetBul_TDryBulPhi	Block that computes the wet bulb temperature for given dry bulb temperature, relative humidity and atmospheric pressure.
Buildings.Utilities.Psychrometrics.WetBul_pTX	Block that computes the temperature and mass fraction at the wet bulb state for given dry bulb temperature, species concentration and atmospheric pressure.

The following existing components have been improved in a backward compatible way:

Buildings.BoundaryConditions
Buildings.BoundaryConditions.WeatherData.ReaderTMY3	Added computation of the wet bulb temperature. Computing the wet bulb temperature introduces a nonlinear equation. As we have not observed an increase in computing time because of computing the wet bulb temperature, it is computed by default. By setting the parameter `computeWetBulbTemperature=false`, the computation of the wet bulb temperature can be removed.
Buildings.Controls
Buildings.Controls.SetPoints.OccupancySchedule	Added `pre` operator and relaxed tolerance in `assert` statement.
Buildings.Fluid
Buildings.Fluid.Movers.FlowControlled_dp Buildings.Fluid.Movers.FlowControlled_m_flow Buildings.Fluid.Movers.SpeedControlled_Nrpm Buildings.Fluid.Movers.SpeedControlled_y	Reformulated implementation of efficiency model to avoid a division by zero at zero mass flow rate for models in which a user specifies a power instead of an efficiency performance curve.
Buildings.Utilities
Buildings.Utilities.Psychrometrics.TWetBul_TDryBulXi	Added option to approximate the wet bulb temperature using an explicit equation. Reformulated the original model to change the dimension of the nonlinear system of equations from two to one.

The following existing components have been improved in a non-backward compatible way:

Buildings.BoundaryConditions
Buildings.BoundaryConditions.WeatherData.ReaderTMY3 Buildings.BoundaryConditions.Types	Improved the optional inputs for the radiation data global horizontal, diffuse horizontal and direct normal radiation. If a user specifies two of them, the third will be automatically calculated.
Buildings.BoundaryConditions.SkyTemperature.BlackBody	Renamed `radHor` to `radHorIR` to indicate that the radiation is in the infrared spectrum.
Buildings.Fluid
Buildings.Airflow.Multizone.BaseClasses.DoorDiscretized Buildings.Airflow.Multizone.DoorDiscretizedOpen Buildings.Airflow.Multizone.DoorDiscretizedOperable Buildings.Airflow.Multizone.Orifice Buildings.Airflow.Multizone.ZonalFlow_ACS Buildings.Fluid.Actuators.BaseClasses.PartialDamperExponential Buildings.Fluid.Actuators.Dampers.MixingBox Buildings.Fluid.Actuators.Dampers.VAVBoxExponential Buildings.Fluid.BaseClasses.PartialResistance Buildings.Fluid.Interfaces.TwoPortHeatMassExchanger Buildings.Fluid.Movers.BaseClasses.PowerInterface Buildings.Fluid.Storage.BaseClasses.Buoyancy Buildings.Fluid.HeatExchangers.BaseClasses.MassExchange	Renamed protected parameters for consistency with the naming conventions. In previous releases, fluid properties had the suffix `0` or `_nominal` instead of `_default` when they where computed based on the medium default properties.
Buildings.Fluid.Sensors.SensibleEnthalpyFlowRate Buildings.Fluid.Sensors.LatentEnthalpyFlowRate	Moved computation of parameter `i_w` to new base class `Buildings.Fluid.BaseClasses.IndexWater` The value of this parameter is now assigned dynamically and does not require to be specified by the user.
Buildings.Fluid.Storage.BaseClasses.ThirdOrderStratifier	Removed unused protected parameters `sta0` and `cp0`.
Buildings.Examples
Buildings.Examples.ChillerPlant.DataCenterDiscreteTimeControl Buildings.Examples.ChillerPlant.BaseClasses.Controls.TrimAndRespond Buildings.Examples.ChillerPlant.BaseClasses.Controls.ZeroOrderHold	Re-implemented the controls for setpoint reset. Revised the model `TrimAndRespond` and deleted the model `ZeroOrderHold`. Improved the documentation.

The following critical errors have been fixed (i.e., errors that can lead to wrong simulation results):

Buildings.Examples
Buildings.Examples.ChillerPlant.DataCenterDiscreteTimeControl	Fixed error in wet bulb temperature. The previous version used a model to compute the wet bulb temperature that takes as an input the relative humidity, but required mass fraction as an input.

The following uncritical errors have been fixed (i.e., errors that do not lead to wrong simulation results, e.g., units are wrong or errors in documentation):

Buildings.BoundaryConditions
Buildings.BoundaryConditions.WeatherData.ReaderTMY3 Buildings.BoundaryConditions.SkyTemperature.BlackBody	Renamed `radHor` to `radHorIR`.
Buildings.Fluid
Buildings.Fluid.BaseClasses.FlowModels.Examples.InverseFlowFunction	Fixed error in the documentation.
Buildings.Fluid.Interfaces.TwoPortHeatMassExchanger	Fixed broken link in the documentation.
Buildings.Fluid.Movers.BaseClasses.Characteristics.powerParameters	Fixed wrong `displayUnit` and `max` attribute for power.
Buildings.Fluid.MixingVolumes	In documentation, removed reference to the parameter `use_HeatTransfer` which no longer exists.
Buildings.HeatTransfer
Buildings.HeatTransfer.Windows.Functions.glassPropertyUncoated	Improved the documentation for implementation and added comments for model limitations.

Extends from Modelica.Icons.ReleaseNotes (Icon for release notes in documentation).

Modelica definition

class Version_1_3_build1 "Version 1.3 build 1" extends Modelica.Icons.ReleaseNotes; end Version_1_3_build1;

Buildings.UsersGuide.ReleaseNotes.Version_1_2_build1

Version 1.2 build 1

Information

In version 1.2 build 1, models for radiant slabs and window overhangs and sidefins have been added. This version also contains various improvements to existing models. A detailed list of changes is shown below.

The following new libraries have been added:

Buildings.Fluid.HeatExchangers.RadiantSlabs	Package with models for radiant slabs with pipes or a capillary heat exchanger embedded in the construction.
Buildings.Fluid.Data.Pipes	Package with records for pipes.

The following new components have been added to existing libraries:

Buildings.HeatTransfer
Buildings.HeatTransfer.Windows.FixedShade Buildings.HeatTransfer.Windows.Overhang Buildings.HeatTransfer.Windows.SideFins	For windows with either an overhang or side fins, these blocks output the fraction of the area that is sun exposed.
Buildings.ThermalZones
Buildings.ThermalZones.Detailed.Examples.BESTEST	Added BESTEST validation models for case 610, 620, 630, 640, 650FF, 650, 920, 940, 950FF, 950, and 960.

The following existing components have been improved in a backward compatible way:

Buildings.BoundaryConditions
Buildings.BoundaryConditions.WeatherData.ReaderTMY3	Removed assignment of `HGloHor_in` in its declaration, because this gives an overdetermined system if the input connector is used. Added new sub-bus that contains the solar position. This allows reusing the solar position in various other models.
Buildings.BoundaryConditions.SolarIrradiation.DiffuseIsotropic Buildings.BoundaryConditions.SolarIrradiation.DiffusePerez Buildings.BoundaryConditions.SolarIrradiation.BaseClasses.DiffuseIsotropic Buildings.BoundaryConditions.SolarIrradiation.BaseClasses.DiffusePerez	Added optional output of diffuse radiation from the sky and ground. This allows reusing the diffuse radiation in solar thermal collector.
Buildings.BoundaryConditions.SolarGeometry.BaseClasses.SolarAzimuth	Changed implementation to avoid an event at solar noon.
Buildings.HeatTransfer
Buildings.HeatTransfer.Data.BoreholeFillings	Renamed class to `BoreholeFillings` to be consistent with data records being plural.
Buildings.Media
Buildings.Media.GasesPTDecoupled.MoistAir Buildings.Media.Air Buildings.Media.PerfectGases.MoistAir Buildings.Media.PerfectGases.MoistAirUnsaturated Buildings.Media.GasesConstantDensity.MoistAir Buildings.Media.GasesConstantDensity.MoistAirUnsaturated	Added redeclaration of `ThermodynamicState` to avoid a warning during model check and translation.
Buildings.ThermalZones
Buildings.ThermalZones.Detailed.MixedAir	Added a check that ensures that the number of surfaces are equal to the length of the parameter that contains the surface area, and added a check to ensure that no surface area is equal to zero. These checks help detecting erroneous declarations of the room model. The changes were done in `Buildings.ThermalZones.Detailed.MixedAir.PartialSurfaceInterface`.

The following existing components have been improved in a non-backward compatible way:

Buildings.ThermalZones

Buildings.ThermalZones.Detailed.MixedAir Added optional modeling of window overhangs and side fins. The modeling of window overhangs and side fins required the introduction of the new parameters hWin for the window height and wWin for the window width, in addition to the parameters ove and sidFin which are used to declare the geometry of overhangs and side fins. The parameters hWin and wWin replace the previously used parameter AWin for the window area. Users need to manually replace AWin with hWin and wWin when updating models from a previous version of the library.
See the information section in Buildings.ThermalZones.Detailed.MixedAir for how to use these models.

The following critical errors have been fixed (i.e., errors that can lead to wrong simulation results):

Buildings.Controls
Buildings.Controls.SetPoints.OccupancySchedule	Fixed a bug that caused an error in the schedule if the simulation start time was negative or equal to the first entry in the schedule.
Buildings.Fluid
Buildings.Fluid.Storage.BaseClass.ThirdOrderStratifier	Revised the implementation to reduce the temperature overshoot.
Buildings.HeatTransfer
Buildings.HeatTransfer.Windows.BaseClasses.GlassLayer	Fixed the bug in the temperature linearization and in the heat flow through the glass layer if the transmissivity of glass in the infrared regime is non-zero.
Buildings.HeatTransfer.Windows.BaseClasses.CenterOfGlass	Fixed a bug in the parameter assignment of the instance `glass`. Previously, the infrared emissivity of surface a was assigned to the surface b.
Buildings.Utilities
Buildings.Utilities.IO.BCVTB	Added a call to `Buildings.Utilities.IO.BCVTB.BaseClasses.exchangeReals` in the `initial algorithm` section. This is needed to propagate the initial condition to the server. It also leads to one more data exchange, which is correct and avoids the warning message in Ptolemy that says that the simulation reached its stop time one time step prior to the final time.

The following uncritical errors have been fixed (i.e., errors that do not lead to wrong simulation results, e.g., units are wrong or errors in documentation):

Buildings.BoundaryConditions
Buildings.BoundaryConditions.WeatherData.ReaderTMY3	Corrected the documentation of the unit requirement for input files, parameters and connectors.
Buildings.Fluid
Buildings.Fluid.Interfaces.PartialFourPortInterface Buildings.Fluid.Interfaces.PartialTwoPortInterface	Replaced the erroneous function call `Medium.density` with `Medium1.density` and `Medium2.density` in `PartialFourPortInterface`. Changed condition to remove `sta_a1` and `sta_a2` in `PartialFourPortInterface`, and `sta_a` in `PartialTwoPortInterface`, to also compute the state at the inlet port if `show_V_flow=true`. The previous implementation resulted in a translation error if `show_V_flow=true`, but worked correctly otherwise because the erroneous function call is removed if `show_V_flow=false`.
Buildings.Fluid.Chillers.Examples.BaseClasses.PartialElectric	Corrected the nominal mass flow rate used in the mass flow source.

The following issues have been fixed:

Heat transfer in glass layer
#56	Fixed bug in heat flow through the glass layer if the infrared transmissivity is non-zero.
#57	Fixed bug in temperature linearization of window glass.
Overshooting in enhanced stratified tank
#15	Revised the implementation to reduce the temperature over-shoot.

Extends from Modelica.Icons.ReleaseNotes (Icon for release notes in documentation).

Modelica definition

class Version_1_2_build1 "Version 1.2 build 1" extends Modelica.Icons.ReleaseNotes; end Version_1_2_build1;

Buildings.UsersGuide.ReleaseNotes.Version_1_1_build1

Version 1.1 build 1

Information

Version 1.1 build 1 contains improvements to models that address numerical problems. In particular, flow machines and actuators now have an optional filter that converts step changes in the input signal to a smooth change in speed or actuator position. Also, (Buildings.Examples.Tutorial) has been added to provide step-by-step instruction for how to build system models.

The following new libraries have been added:

Buildings.Examples.Tutorial

Tutorial with step by step instructions for how to build system models.

The following new components have been added to existing libraries:

Buildings.Fluid
Buildings.Fluid.FixedResistances.Pipe	Added a model for a pipe with transport delay and optional heat exchange with the environment.
Buildings.Fluid.Actuators.UsersGuide	Added a user's guide for actuator models.
Buildings.Fluid.Interfaces.ConservationEquation Buildings.Fluid.Interfaces.StaticConservationEquation	These base classes have been added to simplify the implementation of dynamic and steady-state thermofluid models.
Buildings.Fluid.Data.Fuels	Package with physical properties of fuels that are used by the boiler model.

The following existing components have been improved in a backward compatible way:

Buildings.Fluid
Buildings.Fluid.Actuators.Dampers.Exponential Buildings.Fluid.Actuators.Dampers.VAVBoxExponential Buildings.Fluid.Actuators.Dampers.MixingBox Buildings.Fluid.Actuators.Dampers.MixingBoxMinimumFlow Buildings.Fluid.Actuators.Valves.ThreeWayEqualPercentageLinear Buildings.Fluid.Actuators.Valves.ThreeWayLinear Buildings.Fluid.Actuators.Valves.TwoWayEqualPercentage Buildings.Fluid.Actuators.Valves.TwoWayLinear Buildings.Fluid.Actuators.Valves.TwoWayQuickOpening	Added an optional 2nd order lowpass filter for the input signal. The filter approximates the travel time of the actuators. It also makes the system of equations easier to solve because a step change in the input signal causes a gradual change in the actuator position. Note that this filter affects the time response of closed loop control. Therefore, enabling the filter may require retuning of control loops. See the user's guide of the Buildings.Fluid.Actuators package.
Buildings.Fluid.Boilers.BoilerPolynomial	Added computation of fuel usage and improved the documentation.
Buildings.Fluid.Movers.SpeedControlled_y Buildings.Fluid.Movers.SpeedControlled_Nrpm Buildings.Fluid.Movers.FlowControlled_dp Buildings.Fluid.Movers.FlowControlled_m_flow	Added a 2nd order lowpass filter to the input signal. The filter approximates the startup and shutdown transients of fans or pumps. It also makes the system of equations easier to solve because a step change in the input signal causes a gradual change in the mass flow rate. Note that this filter affects the time response of closed loop control. Therefore, enabling the filter may require retuning of control loops. See the user's guide of the Buildings.Fluid.Movers package.
Buildings.Fluid.Interfaces.StaticTwoPortHeatMassExchanger	Changed model to use graphical implementation of models for pressure drop and conservation equations.
Buildings.Fluid.BaseClasses.PartialResistance Buildings.Fluid.FixedResistances.FixedResistanceDpM Buildings.Fluid.Actuators.BaseClasses.PartialTwoWayValve Buildings.Fluid.Actuators.BaseClasses.PartialDamperExponential	Revised base classes and models to simplify object inheritance tree. Set `m_flow_small` to `final` in Buildings.Fluid.BaseClasses.PartialResistance, and removed its assignment in the other classes.
Buildings.Fluid.FixedResistances.FixedResistanceDpM Buildings.Fluid.FixedResistances.SplitterFixedResistanceDpM	Improved documentation.
Buildings.HeatTransfer
Buildings.HeatTransfer.Windows.Functions.glassProperty	Added the function `glassPropertyUncoated` that calculates the property for uncoated glass.
Buildings.ThermalZones
Buildings.ThermalZones.Detailed.MixedAir	Changed model to use new implementation of Buildings.HeatTransfer.Radiosity.OutdoorRadiosity in its base classes. This change leads to the use of the same equations for the radiative heat transfer between window and ambient as is used for the opaque constructions.

The following existing components have been improved in a non-backward compatible way:

Buildings.Fluid
Buildings.Fluid.Actuators.Valves.ThreeWayEqualPercentageLinear Buildings.Fluid.Actuators.Valves.ThreeWayLinear Buildings.Fluid.Actuators.Valves.TwoWayEqualPercentage Buildings.Fluid.Actuators.Valves.TwoWayLinear Buildings.Fluid.Actuators.Valves.TwoWayQuickOpening	Changed models to allow modeling of a fixed resistance that is within the controlled flow leg. This allows in some cases to avoid a nonlinear equation if a flow resistance is in series to the valve. This change required changing the parameter for the valve resistance `dp_nominal` to `dpValve_nominal`, and introducing the parameter `dpFixed_nominal`, with `dpFixed_nominal=0` as its default value. Previous models that instantiate these components need to change the assignment of `dp_nominal` to an assignment of `dpValve_nominal`. See also `Buildings.Fluid.Actuators.UsersGuide`.
Buildings.HeatTransfer
Buildings.HeatTransfer.Radiosity.OutdoorRadiosity Buildings.HeatTransfer.Windows.ExteriorHeatTransfer	Changed model to use new implementation of Buildings.HeatTransfer.Radiosity.OutdoorRadiosity. This change leads to the use of the same equations for the radiative heat transfer between window and ambient as is used for the opaque constructions.
Buildings.Controls
Buildings.Controls.SetPoints.OccupancySchedule	Changed model to fix a bug that caused the output of the block to be incorrect when the simulation started at a time different from zero. When fixing this bug, the parameter `startTime` was removed, and the parameter `endTime` was renamed to `period`. The period always starts at t=0 seconds.

The following critical errors have been fixed (i.e., errors that can lead to wrong simulation results):

Buildings.Controls
Buildings.Controls.SetPoints.OccupancySchedule	The output of the block was incorrect when the simulation started at a time different from zero.
Buildings.Fluid.HeatExchangers
Buildings.Fluid.HeatExchangers.DryCoilCounterFlow Buildings.Fluid.HeatExchangers.WetCoilCounterFlow	Corrected error in assignment of `dp2_nominal`. The previous assignment caused a pressure drop in all except one element, instead of the opposite. This caused too high a flow resistance of the heat exchanger.

The following uncritical errors have been fixed (i.e., errors that do not lead to wrong simulation results, e.g., units are wrong or errors in documentation):

Buildings.BoundaryConditions
Buildings.BoundaryConditions.SkyTemperature.BlackBody	Fixed error in BlackBody model that was causing a translation error when `calTSky` was set to `Buildings.BoundaryConditions.Types.SkyTemperatureCalculation.HorizontalRadiation`.
Buildings.Fluid
Buildings.Fluid.Interfaces.TwoPortHeatMassExchanger	Fixed wrong class reference in information section.
Buildings.Utilities
Buildings.Utilities.IO.BCVTB.Examples.MoistAir	Updated fan parameters, which were still for version 0.12 of the Buildings library and hence caused a translation error with version 1.0 or higher.

The following issues have been fixed:

Exterior longwave radiation exchange in window model
#51	Changed model to use new implementation of Buildings.HeatTransfer.Radiosity.OutdoorRadiosity. This change leads to the use of the same equations for the radiative heat transfer between window and ambient as is used for the opaque constructions.
#53	Fixed bug in Buildings.Controls.SetPoints.OccupancySchedule that led to wrong results when the simulation started at a time different from zero.

Note:

The use of filters for actuator and flow machine input signals changes the dynamic response of feedback control loops. Therefore, control gains may need to be retuned. See Buildings.Fluid.Actuators.UsersGuide and Buildings.Fluid.Movers.UsersGuide for recommended control gains and further details.

Extends from Modelica.Icons.ReleaseNotes (Icon for release notes in documentation).

Modelica definition

class Version_1_1_build1 "Version 1.1 build 1" extends Modelica.Icons.ReleaseNotes; end Version_1_1_build1;

Buildings.UsersGuide.ReleaseNotes.Version_1_0_build2

Version 1.0 build 2

Information

Version 1.0 build 2 has been released to correct model errors that were present in version 1.0 build 1. Both versions are compatible. In addition, version 1.0 build 2 contains improved documentation of various example models.

The following existing components have been improved in a backward compatible way:

Buildings.Controls
Buildings.Controls.Continuous Buildings.Controls.Discrete Buildings.Controls.SetPoints	Improved documentation of models and of examples.
Buildings.Airflow.Multizone
Buildings.Airflow.Multizone.DoorDiscretizedOpen Buildings.Airflow.Multizone.DoorDiscretizedOperable	Changed the computation of the discharge coefficient to use the nominal density instead of the actual density. Computing `sqrt(2/rho)` sometimes causes warnings from the solver, as it seems to try negative values for the density during iterative solutions.
Buildings.Airflow.Multizone.Examples	Improved documentation of examples.
Buildings.Examples.DualFanDualDuct
Buildings.Examples.DualFanDualDuct.Controls.RoomMixingBox	Improved control of minimum air flow rate to avoid overheating.

The following critical errors have been fixed (i.e., errors that can lead to wrong simulation results):

Buildings.HeatTransfer
Buildings.HeatTransfer.Convection.Exterior	Fixed error in assignment of wind-based convection coefficient. The old implementation did not take into account the surface roughness.
Buildings.ThermalZones
Buildings.ThermalZones.Detailed.BaseClasses.SolarRadiationExchange	In the previous version, the radiative properties of the long-wave spectrum instead of the solar spectrum have been used to compute the distribution of the solar radiation among the surfaces inside the room.
Buildings.ThermalZones.Detailed.BaseClasses.MixedAir	Added missing connect statement between window frame surface and window frame convection model. Prior to this bug fix, no convective heat transfer was computed between window frame and room air.
Buildings.ThermalZones.Detailed.BaseClasses.HeatGain	Fixed bug that caused convective heat gains to be removed from the room instead of added to the room.

The following issues have been fixed:

Buildings.Fluid.Geothermal.Boreholes
#45	Dymola 2012 FD01 hangs when simulating a borehole heat exchanger. This was caused by a wrong release of memory in `freeArray.c`.
Buildings.ThermalZones
#46	The convective internal heat gain has the wrong sign.

Extends from Modelica.Icons.ReleaseNotes (Icon for release notes in documentation).

Modelica definition

class Version_1_0_build2 "Version 1.0 build 2" extends Modelica.Icons.ReleaseNotes; end Version_1_0_build2;

Buildings.UsersGuide.ReleaseNotes.Version_1_0_build1

Version 1.0 build 1

Information

Version 1.0 is the first official release of the Buildings library. Compared to the last pre-release, which is version 0.12, this version contains new models as well as significant improvements to the model formulation that leads to faster and more robust simulation. A detailed list of changes is shown below.

Version 1.0 is not backward compatible to version 0.12, i.e., models developed with versions 0.12 will require some changes in their parameters to work with version 1.0. The conversion script Buildings/Resources/Scripts/Conversion/ConvertBuildings_from_0.12_to_1.0.mos can help in converting old models to this version of the library.

The following new libraries have been added:

Buildings.Fluid.Geothermal.Boreholes

This is a library with a model for a borehole heat exchanger.

The following new components have been added to existing libraries:

Buildings.Airflow.Multizone
Buildings.Airflow.Multizone.BaseClasses.windPressureLowRise	Added a function that computes wind pressure on the facade of low-rise buildings.
Buildings.Examples
Buildings.Examples.ChillerPlant	Added an example for a chilled water plant model.
Buildings.Fluid.Interfaces
Buildings.Fluid.Interfaces.UsersGuide	Added a user's guide that describes the main functionality of all base classes.
Buildings.Fluid.Sources
Buildings.Fluid.Sources.Outside_Cp Buildings.Fluid.Sources.Outside_CpLowRise	Added models to compute wind pressure on building facades.
Buildings.HeatTransfer
Buildings.HeatTransfer.Conductor	Added a model for heat conduction in circular coordinates.
Buildings.ThermalZones.Detailed.Examples
Buildings.ThermalZones.Detailed.Examples.BESTEST	Added BESTEST validation models.
Buildings.Utilities.Math
Buildings.Utilities.Math.Functions.cubicHermiteLinearExtrapolation Buildings.Utilities.Math.Functions.splineDerivatives.	Added functions for cubic hermite spline interpolation, with option for monotone increasing (or decreasing) spline.

The following existing components have been improved in a backward compatible way:

Buildings.Airflow.Multizone
Buildings.Airflow.Multizone.BaseClasses.powerLaw	This function has been reimplemented to handle zero flow rate in a more robust and more efficient way. This change improves all components that model flow resistance in the package Buildings.Airflow.Multizone.
Buildings.BoundaryConditions.WeatherData
Buildings.BoundaryConditions.WeatherData.ReaderTMY3	This model has now the option of using a constant value, using the data from the weather file, or from an input connector for 7 variables, including atmospheric pressure, relative humidity, dry bulb temperature, global horizontal radiation, diffuse horizontal radiation, wind direction and wind speed.
Buildings.Fluid
Buildings.Fluid.Actuators.BaseClasses.PartialActuator Buildings.Fluid.Actuators.BaseClasses.PartialDamperExponential Buildings.Fluid.Actuators.BaseClasses.PartialTwoWayValve Buildings.Fluid.BaseClasses.PartialResistance Buildings.Fluid.BaseClasses.FlowModels.basicFlowFunction_dp Buildings.Fluid.BaseClasses.FlowModels.basicFlowFunction_m_flow Buildings.Fluid.Interfaces.StaticTwoPortHeatMassExchanger	The computation of the linearized flow resistance has been moved from the functions to the model, i.e., into an equation section. If the linear implementation is in a function body, then a symbolic processor may not invert the equation. This can lead to systems of coupled equations in cases where an explicit solution is possible. In addition, the handling of zero flow rate has been improved for the nonlinear pressure drop model. These improvements affect all models in `Buildings.Fluid` that compute flow resistance.
Buildings.Fluid.HeatExchangers
Buildings.Fluid.HeatExchangers.HeaterCoolerPrescribed	This model can now be configured as a steady-state or dynamic model.
Buildings.Fluid.HeatExchangers.DryCoilCounterFlow Buildings.Fluid.HeatExchangers.WetCoilCounterFlow Buildings.Fluid.HeatExchangers.DryCoilDiscretized Buildings.Fluid.HeatExchangers.WetCoilDiscretized	The implementation for handling zero flow rate, if the models are used as steady-state models, have been improved.
Buildings.Fluid.HeatExchangers.BaseClasses.ntu_epsilonZ	Changed implementation to use `Modelica.Media.Common.OneNonLinearEquation` instead of `Buildings.Utilities.Math.BaseClasses.OneNonLinearEquation`, which was removed for this version of the library.
Buildings.Fluid.HeatExchangers.CoolingTowers
Buildings.Fluid.HeatExchangers.CoolingTowers.YorkCalc Buildings.Fluid.HeatExchangers.CoolingTowers.FixedApproach	These models are now based on a new base class `Buildings.Fluid.HeatExchangers.CoolingTowers.BaseClasses.CoolingTower`. This allows using the models as replaceable models without warning when checking the model.
Buildings.Fluid.HeatExchangers.CoolingTowers.YorkCalc	Changed implementation of performance curve to avoid division by zero.
Buildings.Fluid.MassExchangers
Buildings.Fluid.MassExchangers.HumidifierPrescribed	This model can now be configured as a steady-state or dynamic model.
Buildings.Fluid.Sensors
Buildings.Fluid.Sensors.*TwoPort	All sensors with two ports, except for the mass flow rate sensor, have been revised to add sensor dynamics. Adding sensor dynamics avoids numerical problems when mass flow rates are close to zero and the sensor is configured to allow flow reversal. See `Buildings.Fluid.Sensors.UsersGuide` for details.
Buildings.Fluid.Storage
Buildings.Fluid.Storage.Stratified Buildings.Fluid.Storage.StratifiedEnhanced	Changed the implementation of the model `Buoyancy` to make it differentiable in the temperatures.
Buildings.Media
Buildings.Media.Interfaces.PartialSimpleMedium Buildings.Media.Interfaces.PartialSimpleIdealGasMedium	Moved the assignment of the `stateSelect` attribute for the `BaseProperties` to the model `Buildings.Fluid.MixingVolumes.MixingVolume`. This allows to handle it differently for steady-state and dynamic models.
Buildings.Utilities.Psychrometrics
Buildings.Utilities.Psychrometrics.Functions.TDewPoi_pW	Changed implementation to use `Modelica.Media.Common.OneNonLinearEquation` instead of `Buildings.Utilities.Math.BaseClasses.OneNonLinearEquation`, which was removed for this version of the library.

The following existing components have been improved in a non-backward compatible way:

Buildings.Airflow.Multizone
Buildings.Airflow.Multizone.MediumColumnDynamic	The implementation has been changed to better handle mass flow rates near zero flow. This required the introduction of a new parameter `m_flow_nominal` that is used for the regularization near zero mass flow rate.
Buildings.Fluid
Buildings.Fluid.Storage.Examples.Stratified Buildings.Fluid.MixingVolumes	Removed the parameters `use_T_start` and `h_start`, as `T_start` is more convenient to use than `h_start` for building simulation.
Buildings.Fluid.Boilers
Buildings.Fluid.Boilers.BoilerPolynomial	The parameter `dT_nominal` has been removed as it can be computed from the parameter `m_flow_nominal`. This change was needed to avoid a non-literal value for the nominal attribute for the mass flow rate in the pressure drop model.
Buildings.Fluid.MixingVolumes
Buildings.Fluid.MixingVolumes.MixingVolume Buildings.Fluid.MixingVolumes.MixingVolumeDryAir Buildings.Fluid.MixingVolumes.MixingVolumeMoistAir	The implementation has been changed to better handle mass flow rates near zero flow if the components have exactly two fluid ports connected. This required the introduction of a new parameter `m_flow_nominal` that is used for the regularization near zero mass flow rate.
Buildings.Fluid.Movers
Buildings.Fluid.Movers.SpeedControlled_y Buildings.Fluid.Movers.SpeedControlled_Nrpm Buildings.Fluid.Movers.FlowControlled_dp Buildings.Fluid.Movers.FlowControlled_m_flow	The performance data are now defined through records and not through replaceable functions. The performance data now needs to be declared in the form pressure(V_flow_nominal={0,V_flow_nominal,2V_flow_nominal}, dp_nominal={2dp_nominal,dp_nominal,0}) where `pressure` is an instance of a record. A similar declaration is used for power and efficiency. The parameter m_flow_nominal has been removed from FlowMachine_y and FlowMachine_Nrpm. The parameter m_flow_max has been replaced by m_flow_nominal in FlowMachine_m_flow. The implementation of the pressure drop computation as a function of speed and volume flow rate has been revised to avoid a singularity near zero volume flow rate and zero speed. The implementation has also been simplified to avoid using two different flow paths if the models are configured for steady-state or dynamic simulation.
Buildings.Fluid.Interfaces
Buildings.Fluid.Interfaces.FourPortHeatMassExchanger Buildings.Fluid.Interfaces.PartialDynamicStaticFourPortHeatMassExchanger Buildings.Fluid.Interfaces.TwoPortHeatMassExchanger Buildings.Fluid.Interfaces.PartialDynamicStaticTwoPortHeatMassExchanger Buildings.Fluid.Interfaces.ConservationEquation	The implementation has been changed to better handle mass flow rates near zero flow if the components have exactly two fluid ports connected.
Buildings.Fluid.Sensors
Buildings.Fluid.Sensors.TemperatureTwoPortDynamic	This model has been deleted since the sensor `Buildings.Fluid.Sensors.TemperatureTwoPort` has been revised and can now also be used as a dynamic model of a sensor.
Buildings.Fluid.Interfaces
Buildings.Fluid.Interfaces.PartialStaticTwoPortInterface	Renamed to Buildings.Fluid.Interfaces.PartialTwoPortInterface
Buildings.Fluid.Interfaces.PartialStaticStaticTwoPortHeatMassExchanger	Renamed to Buildings.Fluid.Interfaces.StaticTwoPortHeatMassExchanger
Buildings.Fluid.Interfaces.PartialTwoPortHeatMassExchanger	Renamed to Buildings.Fluid.Interfaces.TwoPortHeatMassExchanger
Buildings.Fluid.Interfaces.PartialFourPort	Renamed to Buildings.Fluid.Interfaces.FourPort
Buildings.Fluid.Interfaces.PartialStaticStaticFourPortHeatMassExchanger	Renamed to Buildings.Fluid.Interfaces.StaticFourPortHeatMassExchanger
Buildings.Fluid.Interfaces.PartialStaticFourPortInterface	Renamed to Buildings.Fluid.Interfaces.PartialFourPortInterface
Buildings.Fluid.Interfaces.PartialFourPortHeatMassExchanger	Renamed to Buildings.Fluid.Interfaces.FourPortHeatMassExchanger
Buildings.Utilities.Math
Buildings.Utilities.Math.BaseClasses.OneNonLinearEquation	This package has been removed, and all functions have been revised to use Modelica.Media.Common.OneNonLinearEquation.
Buildings.Utilities.Reports
Buildings.Utilities.IO.Files.Printer Buildings.Utilities.IO.Files.BaseClasses.printRealArray	Changed parameter `precision` to `significantDigits` and `minimumWidth` to `minimumLength` to use the same terminology as the Modelica Standard Library.

The following critical errors have been fixed (i.e., errors that can lead to wrong simulation results):

Buildings.BoundaryConditions
Buildings.BoundaryConditions.SkyTemperature.BlackBody	Fixed error in `if-then` statement that led to a selection of the wrong branch to compute the sky temperature.
Buildings.Media
Buildings.Media.PartialSimpleMedium Buildings.Media.GasesConstantDensity.SimpleAir	Fixed error in assignment of `singleState` parameter. This change can lead to different initial conditions if the density of water is modeled as a function of pressure, or if the medium model Buildings.Media.GasesConstantDensity.SimpleAir is used.
Buildings.Media.GasesConstantDensity Buildings.Media.GasesConstantDensity.MoistAir Buildings.Media.GasesConstantDensity.MoistAirUnsaturated Buildings.Media.GasesConstantDensity.SimpleAir	Fixed error in the function `density` which returned a non-constant density, and added a call to `ModelicaError(...)` in `setState_dTX` since this function cannot assign the medium pressure based on the density (as density is a constant in this model).
Buildings.Media.Interfaces.PartialSimpleIdealGasMedium	Updated package with a new copy from the Modelica Standard Library, since the Modelica Standard Library fixed a bug in computing the internal energy of the medium. This bug led to very fast temperature transients at the start of the simulation.
Buildings.Media.Interfaces.PartialSimpleMedium	Fixed bug in function density, which always returned `d_const`, regardless of the value of `constantDensity`.
Buildings.Media.GasesPTDecoupled	Fixed bug in `u=h-R*T`, which is only valid for ideal gases. For this medium, the function is `u=h-pStd/dStp`.
Buildings.Media.GasesConstantDensity	Fixed bug in `u=h-R*T`, which is only valid for ideal gases. For this medium, the function is `u=h-p/dStp`.
Buildings.ThermalZones
Buildings.ThermalZones.Detailed.MixedAir Buildings.ThermalZones.Detailed.BaseClasses.ExteriorBoundaryConditions	Fixed bug (issue 35) that leads to the wrong solar heat gain for roofs and for floors. Prior to this bug fix, the outside facing surface of a ceiling received solar irradiation as if it were a floor and vice versa.
Buildings.ThermalZones.Detailed.MixedAir Buildings.ThermalZones.Detailed.BaseClasses.ExteriorBoundaryConditionsWithWindow	Fixed bug (issue 36) that leads to too high a surface temperature of the window frame when it receives solar radiation. The previous version did not compute the infrared radiation exchange between the window frame and the sky.

The following uncritical errors have been fixed (i.e., errors that do not lead to wrong simulation results, but, e.g., units are wrong or errors in documentation):

Buildings.BoundaryConditions
Buildings.BoundaryConditions.WeatherData.BaseClasses.ConvertRadiation	Corrected wrong unit label.

The following issues have been fixed:

Buildings.BoundaryConditions
#8	Add switches for new data.
#19	Shift the time for the radiation data 30 min forth and output the local civil time in the data reader.
#41	Using when-then sentences to reduce CPU time.
#43	Add a ConvertRadiation to convert the unit of radiation from TMY3.
Buildings.Fluid
#28	Move scripts to Buildings\Resources\Scripts\Dymola.
Buildings.HeatTransfer
#18	Add a smooth interpolation function to avoid the event.
Buildings.Media
#30	Removed non-required structurally incomplete annotation.
Buildings.ThermalZones
#35	Wrong surface tilt for radiation at exterior surfaces of floors and ceilings.
#36	High window frame temperatures.

Note:

The version number scheme has been changed. It is now identical to the one used by the Modelica Standard Library. Versions are identified with two numbers x.y and a build number. The first official release of each version has the build number 1. For each released bug fix, the build number is incremented. See Modelica.UsersGuide.ReleaseNotes.VersionManagement for details.
To allow adding scripts for multiple simulation environments, all scripts have been moved to the directory Buildings/Resources/Scripts/Dymola and the annotation that generates the entry in the Command pull down menu has been changed to __Dymola_Commands(file=...)

Extends from Modelica.Icons.ReleaseNotes (Icon for release notes in documentation).

Modelica definition

class Version_1_0_build1 "Version 1.0 build 1" extends Modelica.Icons.ReleaseNotes; end Version_1_0_build1;

Buildings.UsersGuide.ReleaseNotes.Version_0_12_0

Version 0.12.0

Information

Note: The packages whose name ends with Beta are still being validated.

The following critical error has been fixed (i.e. error that can lead to wrong simulation results):

Buildings.ThermalZones

Buildings.ThermalZones.Detailed.BaseClasses.InfraredRadiationExchange The model Buildings.ThermalZones.Detailed.BaseClasses.InfraredRadiationExchange had an error in the view factor approximation. The error caused too much radiosity to flow from large to small surfaces because the law of reciprocity for view factors was not satisfied. This led to low surface temperatures if a surface had a large area compared to other surfaces. The bug has been fixed by rewriting the view factor calculation.

The following improvements and additions have been made:

Updated library to Modelica 3.2.
Added homotopy operator.
Restructured package Buildings.HeatTransfer.
Rewrote the models in Buildings.Fluid.Actuators to avoid having the flow coefficient k as an algebraic variable. This increases robustness.
Rewrote energy, species and trace substance balance in Buildings.Fluid.Interfaces.StaticTwoPortHeatMassExchanger to better handle zero mass flow rate.
Implemented functions enthalpyOfCondensingGas and saturationPressure in single substance media to allow use of the room model with media that do not contain water vapor.
Revised Buildings.Fluid.Sources.Outside to allow use of the room model with media that do not contain water vapor.

Extends from Modelica.Icons.ReleaseNotes (Icon for release notes in documentation).

Modelica definition

class Version_0_12_0 "Version 0.12.0" extends Modelica.Icons.ReleaseNotes; end Version_0_12_0;

Buildings.UsersGuide.ReleaseNotes.Version_0_11_0

Version 0.11.0

Information

Note: The packages whose name ends with Beta are still being validated.

Added the package Buildings.ThermalZones.Detailed to compute heat transfer in rooms and through the building envelope. Multiple instances of these models can be connected to create a multi-zone building model.
Added the package Buildings.HeatTransfer.Windows to compute heat transfer (solar radiation, infrared radiation, convection and conduction) through glazing systems.
In package Buildings.Fluid.Chillers, added the chiller models Buildings.Fluid.Chillers.ElectricReformulatedEIR and Buildings.Fluid.Cphillers.ElectricEIR, and added the package Buildings.Fluid.Chillers.Data that contains data sets of chiller performance data.
Added package Buildings.BoundaryConditions with models to compute boundary conditions, such as solar irradiation and sky temperature.
Added package Buildings.Utilities.IO.WeatherData with models to read weather data in the TMY3 format.
Revised the package Buildings.Fluid.Sensors.
Revised the package Buildings.Fluid.HeatExchangers.CoolingTowers.
In Buildings.Fluid.Interfaces.StaticFourPortHeatMassExchanger and Buildings.Fluid.Interfaces.StaticFourPortHeatMassExchanger, fixed bug in energy and moisture balance that affected results if a component adds or removes moisture to the air stream. In the old implementation, the enthalpy and species outflow at port_b was multiplied with the mass flow rate at port_a. The old implementation led to small errors that were proportional to the amount of moisture change. For example, if the moisture added by the component was 0.005 kg/kg, then the error was 0.5%. Also, the results for forward flow and reverse flow differed by this amount. With the new implementation, the energy and moisture balance is exact.
In Buildings.Fluid.Interfaces.ConservationEquation and in Buildings.Media.Interfaces.PartialSimpleMedium, set nominal attribute for medium to provide consistent normalization. Without this change, Dymola 7.4 uses different values for the nominal attribute based on the value of Advanced.OutputModelicaCodeWithJacobians=true/false; in the model Buildings.Examples.HydronicHeating.
Fixed bug in energy balance of Buildings.Fluid.Chillers.Carnot.
Fixed bug in efficiency curves in package Buildings.Fluid.Movers.BaseClasses.Characteristics.

Extends from Modelica.Icons.ReleaseNotes (Icon for release notes in documentation).

Modelica definition

class Version_0_11_0 "Version 0.11.0" extends Modelica.Icons.ReleaseNotes; end Version_0_11_0;

Buildings.UsersGuide.ReleaseNotes.Version_0_10_0

Version 0.10.0

Information

Added package Buildings.Airflow.Multizone with models for multizone airflow and contaminant transport.
Added the model Buildings.Utilities.Comfort.Fanger for thermal comfort calculations.
Rewrote Buildings.Fluid.Storage.BaseClasses.ThirdOrderStratifier, which is used in Buildings.Fluid.Storage.StratifiedEnhanced, to avoid state events when the flow reverses. This leads to faster and more robust simulation.
In models of package Buildings.Fluid.MixingVolumes, added nominal value for mC to avoid wrong trajectory when concentration is around 1E-7. See also https://trac.modelica.org/Modelica/ticket/393.
Fixed bug in fan and pump models that led to too small an enthalpy increase across the flow device.
In model Buildings.Fluid.Movers.FlowControlled_dp, changed assert(dp_in ≥ 0, ...) to assert(dp_in ≥ -0.1, ...). The former implementation triggered the assert if dp_in was solved for in a nonlinear equation since the solution can be slightly negative while still being within the solver tolerance.
Added model Buildings.Controls.SetPoints.Table that allows the specification of a floating setpoint using a table of values.
Revised model Buildings.Fluid.HeatExchangers.Radiators.RadiatorEN442_2. The new version has exactly the same nominal power during the simulation as specified by the parameters. This also required a change in the parameters.

Extends from Modelica.Icons.ReleaseNotes (Icon for release notes in documentation).

Modelica definition

class Version_0_10_0 "Version 0.10.0" extends Modelica.Icons.ReleaseNotes; end Version_0_10_0;

Buildings.UsersGuide.ReleaseNotes.Version_0_9_1

Version 0.9.1

Information

The following critical error has been fixed (i.e. error that can lead to wrong simulation results):

Buildings.Fluid.Storage.

Buildings.Fluid.Storage.StratifiedEnhanced The model Buildings.Fluid.Storage.BaseClasses.Stratifier had a sign error that lead to a wrong energy balance. The model that was affected by this error is Buildings.Fluid.Storage.StratifiedEnhanced. The model Buildings.Fluid.Storage.Stratified was not affected.
The bug has been fixed by using the newly introduced model Buildings.Fluid.Storage.BaseClasses.ThirdOrderStratifier. This model uses a third-order upwind scheme to reduce the numerical dissipation instead of the correction term that was used in Buildings.Fluid.Storage.BaseClasses.Stratifier. The model Buildings.Fluid.Storage.BaseClasses.Stratifier has been removed since it also led to significant overshoot in temperatures when the stratification was pronounced.

Extends from Modelica.Icons.ReleaseNotes (Icon for release notes in documentation).

Modelica definition

class Version_0_9_1 "Version 0.9.1" extends Modelica.Icons.ReleaseNotes; end Version_0_9_1;

Buildings.UsersGuide.ReleaseNotes.Version_0_9_0

Version 0.9.0

Information

Added the following heat exchanger models
- Buildings.Fluid.HeatExchangers.DryEffectivenessNTU for a sensible heat exchanger that uses the epsilon-NTU relations to compute the heat transfer.
- Buildings.Fluid.HeatExchangers.DryCoilCounterFlow and Buildings.Fluid.HeatExchangers.WetCoilCounterFlow to model a coil without and with water vapor condensation. These models approximate the coil as a counterflow heat exchanger.
Revised air damper Buildings.Fluid.Actuators.BaseClasses.exponentialDamper. The new implementation avoids warnings and leads to faster convergence since the solver does not attempt anymore to solve for a variable that needs to be strictly positive.
Revised package Buildings.Fluid.Movers to allow zero flow for some pump or fan models. If the input to the model is the control signal y, then the flow is equal to zero if y=0. This change required rewriting the package to avoid division by the rotational speed.
Revised package Buildings.HeatTransfer to include a model for a multi-layer construction, and to allow individual material layers to be computed steady-state or transient.
In package Buildings.Fluid, changed models so that if the parameter dp_nominal is set to zero, then the pressure drop equation is removed. This allows, for example, to model a heating and a cooling coil in series, and lump there pressure drops into a single element, thereby reducing the dimension of the nonlinear system of equations.
Added model Buildings.Controls.Continuous.LimPID, which is identical to Modelica.Blocks.Continuous.LimPID, except that it allows reverse control action. This simplifies use of the controller for cooling applications.
Added model Buildings.Fluid.Actuators.Dampers.MixingBox for an outside air mixing box with air dampers.
Changed implementation of flow resistance in Buildings.Fluid.Actuators.Dampers.MixingBoxMinimumFlow. Instead of using a fixed resistance and a damper model in series, only one model is used that internally adds these two resistances. This leads to smaller systems of nonlinear equations.
Changed Buildings.Media.PerfectGases.MoistAir.T_phX (and by inheritance all other moist air medium models) to first compute T in closed form assuming no saturation. Then, a check is done to determine whether the state is in the fog region. If the state is in the fog region, then Internal.solve is called. This new implementation can lead to significantly shorter computing time in models that frequently call T_phX.
Added package Buildings.Media.GasesConstantDensity which contains medium models for dry air and moist air. The use of a constant density avoids having pressure as a state variable in mixing volumes. Hence, fast transients introduced by a change in pressure are avoided. The drawback is that the dimensionality of the coupled nonlinear equation system is typically larger for flow networks.
In Buildings.Fluid.Actuators.BaseClasses.PartialDamperExponential, added default value for parameter A to avoid compilation error if the parameter is disabled but not specified.
Simplified the mixing volumes in Buildings.Fluid.MixingVolumes by removing the port velocity, pressure drop and height.

Extends from Modelica.Icons.ReleaseNotes (Icon for release notes in documentation).

Modelica definition

class Version_0_9_0 "Version 0.9.0" extends Modelica.Icons.ReleaseNotes; end Version_0_9_0;

Buildings.UsersGuide.ReleaseNotes.Version_0_8_0

Version 0.8.0

Information

In Buildings.Fluid.Interfaces.ConservationEquation, added to Medium.BaseProperties the initialization X(start=X_start[1:Medium.nX]). Previously, the initialization was only done for Xi but not for X, which caused the medium to be initialized to reference_X, ignoring the value of X_start.
Renamed Buildings.Media.PerfectGases.MoistAirNonSaturated to Buildings.Media.PerfectGases.MoistAirUnsaturated and Buildings.Media.GasesPTDecoupled.MoistAirNoLiquid to Buildings.Media.Air, and added assert statements if saturation occurs.
Added regularizaation near zero flow to Buildings.Fluid.HeatExchangers.ConstantEffectiveness and Buildings.Fluid.MassExchangers.ConstantEffectiveness.
Fixed bug regarding temperature offset in Buildings.Media.PerfectGases.MoistAirUnsaturated.T_phX.
Added implementation of function Buildings.Media.Air.enthalpyOfNonCondensingGas and its derivative.
In Buildings.Media.PerfectGases.MoistAir, fixed bug in implementation of Buildings.Media.PerfectGases.MoistAir.T_phX. In the previous version, it computed the inverse of its parent class, which gave slightly different results.
In Buildings.Utilities.IO.BCVTB.BCVTB, added parameter to specify the value to be sent to the BCVTB at the first data exchange, and added parameter that deactivates the interface. Deactivating the interface is sometimes useful during debugging.
In Buildings.Media.GasesPTDecoupled.MoistAir and in Buildings.Media.PerfectGases.MoistAir, added function enthalpyOfNonCondensingGas and its derivative.
In Buildings.Media, fixed bug in implementations of derivatives.
Added model Buildings.Fluid.Storage.ExpansionVessel.
Added Wrapper function Buildings.Fluid.Movers.BaseClasses.Characteristics.solve for Modelica.Math.Matrices.solve. This is currently needed since Modelica.Math.Matrices.solve does not specify a derivative.
Fixed bug in Buildings.Fluid.Storage.Stratified. In the previous version, for computing the heat conduction between the top (or bottom) segment and the outside, the whole thickness of the water volume was used instead of only half the thickness.
In Buildings.Media.ConstantPropertyLiquidWater, added the option to specify a compressibility. This can help reducing the size of the coupled nonlinear system of equations, at the expense of introducing stiffness. This change required to change the inheritance tree of the medium. Its base class is now Buildings.Media.Interfaces.PartialSimpleMedium, which contains the equation for the compressibility. The default setting will model the flow as incompressible.
In Buildings.Controls.Continuous.Examples.PIDHysteresis and Buildings.Controls.Continuous.Examples.PIDHysteresisTimer, fixed error in default parameter eOn. Fixed error by introducing parameter Td, which used to be hard-wired in the PID controller.
Added more models for fans and pumps to the package Buildings.Fluid.Movers. The models are similar to the ones in Modelica.Fluid.Machines but have been adapted for air-based systems, and to include more characteristic curves in Buildings.Fluid.Movers.BaseClasses.Characteristics. The new models are better suited than the existing fan model Buildings.Fluid.Movers.FlowMachinePolynomial for zero flow rate.
Added an optional mixing volume to Buildings.Fluid.BaseClasses.PartialThreeWayResistance and hence to the flow splitter and to the three-way valves. This often breaks algebraic loops and provides a state for the temperature if the mass flow rate goes to zero.

Extends from Modelica.Icons.ReleaseNotes (Icon for release notes in documentation).

Modelica definition

class Version_0_8_0 "Version 0.8.0" extends Modelica.Icons.ReleaseNotes; end Version_0_8_0;

Buildings.UsersGuide.ReleaseNotes.Version_0_7_0

Version 0.7.0

Information

Updated library from Modelica_Fluid to Modelica.Fluid 1.0
Merged sensor and source models from Modelica.Fluid to Buildings.Fluid.
Added sensor for sensible and latent enthalpy flow rate, Buildings.Fluid.Sensors.SensibleEnthalpyFlowRate and Buildings.Fluid.Sensors.LatentEnthalpyFlowRate. These sensors are needed, for example, to interface air-conditioning systems that are modeled with Modelica with the Building Controls Virtual Test Bed.

Extends from Modelica.Icons.ReleaseNotes (Icon for release notes in documentation).

Modelica definition

class Version_0_7_0 "Version 0.7.0" extends Modelica.Icons.ReleaseNotes; end Version_0_7_0;

Buildings.UsersGuide.ReleaseNotes.Version_0_6_0

Version 0.6.0

Information

Added the package Buildings.Utilities.IO.BCVTB which contains an interface to the Building Controls Virtual Test Bed.
Updated license to Modelica License 2.
Replaced Buildings.Utilities.Psychrometrics.HumidityRatioPressure by Buildings.Utilities.Psychrometrics.HumidityRatio_pWat and Buildings.Utilities.Psychrometrics.VaporPressure_X because the old model used RealInput ports, which are obsolete in Modelica 3.0.
Changed the base class Buildings.Fluid.Interfaces.StaticTwoPortHeatMassExchanger to enable computation of pressure drop of mechanical equipment.
Introduced package Buildings.Fluid.BaseClasses.FlowModels to model pressure drop, and rewrote Buildings.Fluid.BaseClasses.PartialResistance.
Redesigned package Buildings.Utilities.Math to allow having blocks and functions with the same name. Functions are now in Buildings.Utilities.Math.Functions.
Fixed sign error in Buildings.Fluid.Storage.BaseClasses.Stratifier which caused a wrong energy balance in Buildings.Fluid.Storage.StratifiedEnhanced.
Renamed Buildings.Fluid.HeatExchangers.HeaterCoolerIdeal to Buildings.Fluid.HeatExchangers.HeaterCoolerPrescribed to have the same nomenclatures as is used for Buildings.Fluid.MassExchangers.HumidifierPrescribed
In Buildings.Fluid/Actuators/BaseClasses/PartialDamperExponential, added option to compute linearization near zero based on the fraction of nominal flow instead of the Reynolds number. This was set as the default, as it leads most reliably to a model parametrization that leads to a derivative d m_flow/d p near the origin that is not too steep for a Newton-based solver.
In damper and VAV box models, added optional parameters to allow specifying the nominal face velocity instead of the area.
Set nominal attribute for pressure drop dp in Buildings.Fluid.BaseClasses.PartialResistance and in its child classes.
Added models for chiller (Buildings.Fluid.Chillers.Carnot), for occupancy (Buildings.Controls.SetPoints.OccupancySchedule) and for blocks that take a vector as an argument (Buildings.Utilities.Math.Min, Buildings.Utilities.Math.Max, and Buildings.Utilities.Math.Average).
Changed various variable names to be consistent with naming convention used in Modelica.Fluid 1.0.

Extends from Modelica.Icons.ReleaseNotes (Icon for release notes in documentation).

Modelica definition

class Version_0_6_0 "Version 0.6.0" extends Modelica.Icons.ReleaseNotes; end Version_0_6_0;

Buildings.UsersGuide.ReleaseNotes.Version_0_5_0

Version 0.5.0

Information

Updated library to Modelica.Fluid 1.0.
Moved most examples from package Buildings.Fluid.Examples to the example directory in the package of the individual model.
Renamed package Buildings.Utilites.Controls to Buildings.Utilites.Diagnostics.
Introduced packages Buildings.Controls, Buildings.HeatTransfer (which contains models for heat transfer that generally does not involve modeling of the fluid flow), Buildings.Fluid.Boilers and Buildings.Fluid.HeatExchangers.Radiators.
Changed valve models in Buildings.Fluid.Actuators.Valves so that Kv or Cv can be used as the flow coefficient (in [m3/h] or [USG/min]).

Extends from Modelica.Icons.ReleaseNotes (Icon for release notes in documentation).

Modelica definition

class Version_0_5_0 "Version 0.5.0" extends Modelica.Icons.ReleaseNotes; end Version_0_5_0;

Buildings.UsersGuide.ReleaseNotes.Version_0_4_0

Version 0.4.0

Information

Added package Buildings.Fluid.Storage with models for thermal energy storage.
Added a steady-state model for a heat and moisture exchanger with constant effectiveness. See Buildings.Fluid.MassExchangers.ConstantEffectiveness
Added package Buildings.Utilities.Reports. The package contains models that facilitate reporting.

Extends from Modelica.Icons.ReleaseNotes (Icon for release notes in documentation).

Modelica definition

class Version_0_4_0 "Version 0.4.0" extends Modelica.Icons.ReleaseNotes; end Version_0_4_0;

Buildings.UsersGuide.ReleaseNotes.Version_0_3_0

Version 0.3.0

Information

Added package Buildings.Fluid.Sources. The package contains models for modeling species that do not affect the medium balance of volumes. This can be used to track for example carbon dioxide or other species that have a small concentration.
The package Buildings.Fluid.Actuators.Motors has been added. The package contains a motor model for valves and dampers.
The package Buildings.Media has been reorganized and the new medium model Buildings.Media.GasesPTDecoupled.MoistAir has been added.
In addition, this package now contains a bug fix that is needed for Modelica 2.2.1 and 2.2.2. The bugs are fixed by using a new base class Buildings.Media.Interfaces.PartialSimpleIdealGasMedium (that fixes the bugs) instead of Modelica.Media.Interfaces.PartialSimpleIdealGasMedium. In the original implementation, initial states of fluid volumes can be far away from the steady-state value because of an inconsistent implementation of the enthalpy and internal energy. When the Buildings library is upgraded to to Modelica 3.0.0, it should be safe to remove this bug fix.
The package Buildings.Fluid.HeatExchangers has been revised and several models have been renamed. The heat exchanger models have been revised to allow computing the fluid volumes either dynamically, or in steady-state.
The damper with exponential opening characteristic has been revised to allow control signals over the whole range between 0 and 1. This was in earlier versions restricted. In the same model, a bug was fixed that caused the flow to be largest for y=0, i.e., when the damper is closed.
Additional models for psychrometric equations have been added. The new models contain equations that convert dew point temperature and water vapor pressure, as well as water vapor concentration and water vapor pressure.
A new mixing volume has been added that allows latent heat exchange with the volume. This model can be used to model a volume of moist air with water vapor condensation inside the volume. The condensate is removed from the volume in its liquid phase.

Extends from Modelica.Icons.ReleaseNotes (Icon for release notes in documentation).

Modelica definition

class Version_0_3_0 "Version 0.3.0" extends Modelica.Icons.ReleaseNotes; end Version_0_3_0;

Buildings.UsersGuide.ReleaseNotes.Version_0_2_0

Version 0.2.0

Information

New in this version are models for two and three way valves. In addition, the Fluids package has been slightly revised. The package Fluid.BaseClasses has been added because in the previous version, partial models for fixed resistances where part of the Actuator package.

Extends from Modelica.Icons.ReleaseNotes (Icon for release notes in documentation).

Modelica definition

class Version_0_2_0 "Version 0.2.0" extends Modelica.Icons.ReleaseNotes; end Version_0_2_0;

Buildings.UsersGuide.ReleaseNotes.Version_0_1_0

Version 0.1.0

Information

First release of the library.

This version contains basic models for modeling building HVAC systems. It also contains new medium models in the package Buildings.Media. These medium models have simpler property functions than the ones from Modelica.Media. For example, there is medium model with constant heat capacity which is often sufficiently accurate for building HVAC simulation, in contrast to the more detailed models from Modelica.Media that are valid in a larger temperature range, at the expense of introducing non-linearities due to the medium properties.

Extends from Modelica.Icons.ReleaseNotes (Icon for release notes in documentation).

Modelica definition

class Version_0_1_0 "Version 0.1.0" extends Modelica.Icons.ReleaseNotes; end Version_0_1_0;