Buildings.UsersGuide.ReleaseNotes

Release notes

Information

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

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

Package Content

Name Description
Buildings.UsersGuide.ReleaseNotes.Version_8_0_0 Version_8_0_0 Version 8.0.0
Buildings.UsersGuide.ReleaseNotes.Version_7_0_1 Version_7_0_1 Version 7.0.1
Buildings.UsersGuide.ReleaseNotes.Version_7_0_0 Version_7_0_0 Version 7.0.0
Buildings.UsersGuide.ReleaseNotes.Version_6_0_0 Version_6_0_0 Version 6.0.0
Buildings.UsersGuide.ReleaseNotes.Version_5_1_0 Version_5_1_0 Version 5.1.0
Buildings.UsersGuide.ReleaseNotes.Version_5_0_1 Version_5_0_1 Version 5.0.1
Buildings.UsersGuide.ReleaseNotes.Version_5_0_0 Version_5_0_0 Version 5.0.0
Buildings.UsersGuide.ReleaseNotes.Version_4_0_0 Version_4_0_0 Version 4.0.0
Buildings.UsersGuide.ReleaseNotes.Version_3_0_0 Version_3_0_0 Version 3.0.0
Buildings.UsersGuide.ReleaseNotes.Version_2_1_0 Version_2_1_0 Version 2.1.0
Buildings.UsersGuide.ReleaseNotes.Version_2_0_0 Version_2_0_0 Version 2.0.0
Buildings.UsersGuide.ReleaseNotes.Version_1_6_build1 Version_1_6_build1 Version 1.6 build 1
Buildings.UsersGuide.ReleaseNotes.Version_1_5_build3 Version_1_5_build3 Version 1.5 build 3
Buildings.UsersGuide.ReleaseNotes.Version_1_5_build2 Version_1_5_build2 Version 1.5 build 2
Buildings.UsersGuide.ReleaseNotes.Version_1_5_build1 Version_1_5_build1 Version 1.5 build 1
Buildings.UsersGuide.ReleaseNotes.Version_1_4_build1 Version_1_4_build1 Version 1.4 build 1
Buildings.UsersGuide.ReleaseNotes.Version_1_3_build1 Version_1_3_build1 Version 1.3 build 1
Buildings.UsersGuide.ReleaseNotes.Version_1_2_build1 Version_1_2_build1 Version 1.2 build 1
Buildings.UsersGuide.ReleaseNotes.Version_1_1_build1 Version_1_1_build1 Version 1.1 build 1
Buildings.UsersGuide.ReleaseNotes.Version_1_0_build2 Version_1_0_build2 Version 1.0 build 2
Buildings.UsersGuide.ReleaseNotes.Version_1_0_build1 Version_1_0_build1 Version 1.0 build 1
Buildings.UsersGuide.ReleaseNotes.Version_0_12_0 Version_0_12_0 Version 0.12.0
Buildings.UsersGuide.ReleaseNotes.Version_0_11_0 Version_0_11_0 Version 0.11.0
Buildings.UsersGuide.ReleaseNotes.Version_0_10_0 Version_0_10_0 Version 0.10.0
Buildings.UsersGuide.ReleaseNotes.Version_0_9_1 Version_0_9_1 Version 0.9.1
Buildings.UsersGuide.ReleaseNotes.Version_0_9_0 Version_0_9_0 Version 0.9.0
Buildings.UsersGuide.ReleaseNotes.Version_0_8_0 Version_0_8_0 Version 0.8.0
Buildings.UsersGuide.ReleaseNotes.Version_0_7_0 Version_0_7_0 Version 0.7.0
Buildings.UsersGuide.ReleaseNotes.Version_0_6_0 Version_0_6_0 Version 0.6.0
Buildings.UsersGuide.ReleaseNotes.Version_0_5_0 Version_0_5_0 Version 0.5.0
Buildings.UsersGuide.ReleaseNotes.Version_0_4_0 Version_0_4_0 Version 0.4.0
Buildings.UsersGuide.ReleaseNotes.Version_0_3_0 Version_0_3_0 Version 0.3.0
Buildings.UsersGuide.ReleaseNotes.Version_0_2_0 Version_0_2_0 Version 0.2.0
Buildings.UsersGuide.ReleaseNotes.Version_0_1_0 Version_0_1_0 Version 0.1.0

Buildings.UsersGuide.ReleaseNotes.Version_8_0_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:

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 issue 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 issue 1893.
Buildings.Controls.OBC.CDL.Continuous.PID New implementation of the PID controller.
This is for issue 2056 and for issue 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 issue 2056 and for issue 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 issue 2101.
Buildings.Controls.OBC.CDL.Integers.Sources.Pulse Integer pulse source signal.
This is for issue 2125 and issue 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 issue 2125.
Buildings.Controls.OBC.CDL.Logical.Sources.TimeTable Time table for Boolean outputs.
This is for issue 2125.
Buildings.Examples
Buildings.Examples.VAVReheat.Controls.SupplyAirTemperature Control block for tracking the supply air temperature set point.
This is for issue 2024.
Buildings.Examples.VAVReheat.Controls.SupplyAirTemperatureSetpoint Computation of the supply air temperature set point based on the operation mode.
This is for issue 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 issue 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 issue 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 issue 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.Sine
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.SIunits.
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:

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_1 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:

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 Buidings, #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.HeatExchangers.DXCoils.AirCooled.Examples.MultiStage
Buildings.Fluid.HeatExchangers.DXCoils.AirCooled.Examples.PerformanceCurves.Curve_I
Buildings.Fluid.HeatExchangers.DXCoils.AirCooled.Examples.PerformanceCurves.Curve_II
Buildings.Fluid.HeatExchangers.DXCoils.AirCooled.Examples.PerformanceCurves.Curve_III
Buildings.Fluid.HeatExchangers.DXCoils.AirCooled.Examples.SingleSpeed
Buildings.Fluid.HeatExchangers.DXCoils.AirCooled.Examples.SpaceCooling
Buildings.Fluid.HeatExchangers.DXCoils.AirCooled.Examples.VariableSpeed
Buildings.Fluid.HeatExchangers.DXCoils.AirCooled.Validation.SingleSpeedEnergyPlus
Buildings.Fluid.HeatExchangers.DXCoils.AirCooled.Validation.SingleSpeedPLREnergyPlus
Buildings.Fluid.HeatExchangers.DXCoils.BaseClasses.Examples.WetCoil
Buildings.Fluid.HeatExchangers.DXCoils.WaterCooled.Examples.MultiStage
Buildings.Fluid.HeatExchangers.DXCoils.WaterCooled.Examples.SingleSpeed
Buildings.Fluid.HeatExchangers.DXCoils.WaterCooled.Examples.VariableSpeed
Buildings.Fluid.HeatExchangers.DXCoils.WaterCooled.Validation.VariableSpeedEnergyPlus
Buildings.Fluid.HeatExchangers.DXCoils.WaterCooled.Validation.VariableSpeedEnergyPlusPartLoad
Corrected placement of each keyword.
See Buidings, 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 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:

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.HeatExchangers.DXCoils.AirCooled.MultiStage
Buildings.Fluid.HeatExchangers.DXCoils.AirCooled.SingleSpeed
Buildings.Fluid.HeatExchangers.DXCoils.AirCooled.VariableSpeed
Buildings.Fluid.HeatExchangers.DXCoils.WaterCooled.MultiStage
Buildings.Fluid.HeatExchangers.DXCoils.WaterCooled.SingleSpeed
Buildings.Fluid.HeatExchangers.DXCoils.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 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:

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 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 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 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 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 (http://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 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:

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.HeatExchangers.DXCoils.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.HeatExchangers.DXCoils.AirCooled.SingleSpeed
Buildings.Fluid.HeatExchangers.DXCoils.AirCooled.VariableSpeed
Buildings.Fluid.HeatExchangers.DXCoils.AirCooled.MultiStage
Buildings.Fluid.HeatExchangers.DXCoils.Data
Renamed Buildings.Fluid.HeatExchangers.DXCoils.AirCooled.SingleSpeed to
Buildings.Fluid.HeatExchangers.DXCoils.AirCooled.SingleSpeed,
Buildings.Fluid.HeatExchangers.DXCoils.AirCooled.VariableSpeed to
Buildings.Fluid.HeatExchangers.DXCoils.AirCooled.VariableSpeed,
Buildings.Fluid.HeatExchangers.DXCoils.AirCooled.MultiStage to
Buildings.Fluid.HeatExchangers.DXCoils.AirCooled.MultiStage and
Buildings.Fluid.HeatExchangers.DXCoils.Data to
Buildings.Fluid.HeatExchangers.DXCoils.AirCooled.Data.
This was due to the addition of the new package Buildings.Fluid.HeatExchangers.DXCoils.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.HeatExchangers.DXCoils.AirCooled.MultiStage
Buildings.Fluid.HeatExchangers.DXCoils.AirCooled.SingleSpeed
Buildings.Fluid.HeatExchangers.DXCoils.AirCooled.VariableSpeed
Buildings.Fluid.HeatExchangers.DXCoils.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 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:

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 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.HeatExchangers.DXCoils.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 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:

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,2*m_flow_nominal}/1.2,
  dp={2*dp_nominal,dp_nominal,0})));
becomes
Buildings.Fluid.Movers.SpeedControlled_y fan(
 redeclare package Medium = Medium,
 per(
  pressure(
   V_flow={0,m_flow_nominal,2*m_flow_nominal}/1.2,
   dp={2*dp_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.SIunits.Emissivity to Modelica.SIunits.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 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.
  1. The parameter VTot was renamed to V_start.
  2. 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 porta of the heat exchanger to be located higher than portb. 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:
  1. Changed hexTopHeight to hHex_a.
  2. Changed hexBotHeight to hHex_b.
  3. Changed topHexSeg to segHex_a, and made it protected as this is deduced from hHex_a.
  4. 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:
  1. Changed port_a1 to portHex_a.
  2. 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 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 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 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 toTraceSubstancesFlowRate 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 toTraceSubstancesFlowRate 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.HeatExchangers.DXCoils.BaseClasses.ApparatusDewPoint
Buildings.Fluid.HeatExchangers.DXCoils.BaseClasses.ApparatusDryPoint
Buildings.Fluid.HeatExchangers.DXCoils.BaseClasses.CoolingCapacity
Buildings.Fluid.HeatExchangers.DXCoils.BaseClasses.DXCooling
Buildings.Fluid.HeatExchangers.DXCoils.BaseClasses.DryCoil
Buildings.Fluid.HeatExchangers.DXCoils.BaseClasses.DryWetSelector
Buildings.Fluid.HeatExchangers.DXCoils.BaseClasses.Evaporation
Buildings.Fluid.HeatExchangers.DXCoils.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.SIunits.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.SIunits.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 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:

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 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.HeatExchangers.DXCoils 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 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 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:

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 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 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/Dymola/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,2*V_flow_nominal},
          dp_nominal={2*dp_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:

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 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:

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 Buildings.UsersGuide.ReleaseNotes.Version_0_11_0

Version 0.11.0

Information

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

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 Buildings.UsersGuide.ReleaseNotes.Version_0_10_0

Version 0.10.0

Information

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 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 Buildings.UsersGuide.ReleaseNotes.Version_0_9_0

Version 0.9.0

Information

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 Buildings.UsersGuide.ReleaseNotes.Version_0_8_0

Version 0.8.0

Information

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 Buildings.UsersGuide.ReleaseNotes.Version_0_7_0

Version 0.7.0

Information

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 Buildings.UsersGuide.ReleaseNotes.Version_0_6_0

Version 0.6.0

Information

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 Buildings.UsersGuide.ReleaseNotes.Version_0_5_0

Version 0.5.0

Information

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 Buildings.UsersGuide.ReleaseNotes.Version_0_4_0

Version 0.4.0

Information

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 Buildings.UsersGuide.ReleaseNotes.Version_0_3_0

Version 0.3.0

Information

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 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 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;