classVersion_14_0_0

Version 14.0.0

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

Information

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

The library has been tested with Dymola 2026x, OpenModelica 1.26.3, OPTIMICA 1.66 and recent versions of Impact.

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

  • The packages Buildings.Applications.DataCenters.LiquidCooled and Buildings.Fluid.DataCenters have been added with system and component models for liquid-cooled data centers, such as CDUs and racks.
  • An autosizing feature has been added to the package Buildings.ThermalZones.EnergyPlus_24_2_0, where, during initialization, the EnergyPlus sizing routine can be invoked, resulting in parameter values being passed to Modelica thermal zone and HVAC system objects. These parameter values include heating and cooling loads, zone set points, outdoor conditions, and minimum outside air flow all at design conditions, and can be used throughout the Modelica model to size HVAC equipment based on the EnergyPlus sizing results.
  • The air-to-water heat pump plant template in Buildings.Templates.Plants.HeatPumps has been extended to support 4-pipe polyvalent heat pumps that can simultaneously provide heating and cooling. Associated control subsequences have been added to Buildings.Templates.Plants.Controls.
  • The package Buildings.Fluid.Geothermal.Borefields.TOUGH has been added with models and a user guide for coupled simulation between Modelica and the TOUGH simulator that calculates the ground response.
  • New functions for pressure drop calculations with flow exponents between 1 and 2 have been added to Buildings.Fluid.BaseClasses.FlowModels, enabling modeling of partially turbulent flows such as in microchannel heat exchangers. The model Buildings.Fluid.FixedResistances.PressureDrop and several heat exchangers in Buildings.Fluid.HeatExchangers have been updated to expose these parameters.

Also, many models have been updated to improve performance, to improve compliance with the Modelica Language Standard and to correct model errors.

The following new libraries have been added:

Buildings.Applications.DataCenters.LiquidCooled System models for liquid cooled data centers.
Buildings.Fluid.DataCenters Component models for liquid cooled data centers, such as CDUs and racks that are air-cooled, liquid-cooled, or hybrid liquid- and air-cooled. The racks can also have an optional active or passive rear door heat exchanger.

The following new components have been added to existing libraries:

Buildings.Fluid.Geothermal
Buildings.Fluid.Geothermal.Borefields.TOUGH Created models and the user guide for coupled simulation between Modelica simulation and the TOUGH simulation that calculates the ground response.
This is for issue 1495.
Buildings.Fluid.BaseClasses.FlowModels
Buildings.Fluid.BaseClasses.FlowModels.powerLaw_dp
Buildings.Fluid.BaseClasses.FlowModels.powerLaw_m_flow
Buildings.Fluid.BaseClasses.FlowModels.powerLaw_dp_der
Buildings.Fluid.BaseClasses.FlowModels.powerLaw_m_flow_der
Buildings.Fluid.BaseClasses.FlowModels.powerLaw_dp_der2
Buildings.Fluid.BaseClasses.FlowModels.powerLaw_m_flow_der2
Buildings.Fluid.BaseClasses.FlowModels.powerLawData
Added functions for pressure drop calculations with flow exponents between 1 and 2, enabling modeling of partially turbulent flows such as in microchannel heat exchangers.
This is for Buildings, #4620.
Buildings.ThermalZones.EnergyPlus_24_2_0
Buildings.ThermalZones.EnergyPlus_24_2_0.Examples.SingleFamilyHouse.AirHeating_Autosizing
Buildings.ThermalZones.EnergyPlus_24_2_0.Examples.SmallOffice.ASHRAE2006Summer_Autosizing
Buildings.ThermalZones.EnergyPlus_24_2_0.Examples.SmallOffice.ASHRAE2006Winter_Autosizing
Buildings.ThermalZones.EnergyPlus_24_2_0.Examples.SmallOffice.Guideline36Summer_Autosizing
Buildings.ThermalZones.EnergyPlus_24_2_0.Examples.SmallOffice.Guideline36Winter_Autosizing
Buildings.ThermalZones.EnergyPlus_24_2_0.Examples.SmallOffice.IdealHeatingCoolingSummer_Autosizing
Buildings.ThermalZones.EnergyPlus_24_2_0.Examples.SmallOffice.IdealHeatingCoolingWinter_Autosizing
Buildings.ThermalZones.EnergyPlus_24_2_0.Examples.SmallOffice.BaseClasses.Floor_Autosizing
Buildings.ThermalZones.EnergyPlus_24_2_0.Examples.SmallOffice.BaseClasses.Floor_Autosizing_MultipleSystems
Added example models for autosizing using EnergyPlus.
This is for Buildings, #3866.
Buildings.ThermalZones.EnergyPlus_24_2_0.SystemSizing Added system sizing object for autosizing using EnergyPlus.
This is for Buildings, #3866.
Buildings.ThermalZones.EnergyPlus_24_2_0.BaseClasses.Sizing Added sizing record for autosizing using EnergyPlus.
This is for Buildings, #3866.
Buildings.ThermalZones.EnergyPlus_24_2_0.UsersGuide Added documentation for autosizing using EnergyPlus.
This is for Buildings, #3866.
Buildings.Templates.Plants.Controls
Buildings.Templates.Plants.Controls.PolyvalentHeatPumps Added a package of subsequences specific to polyvalent heat pump controls (mode alternation, staging parameters and minimum runtime assertion).
This is for Buildings, #4512.
Buildings.Templates.Plants.Controls.Utilities.ConcatenateLogical
Buildings.Templates.Plants.Controls.Utilities.ConcatenateParameterLogical
Buildings.Templates.Plants.Controls.Utilities.ConcatenateSelectLogical
Added blocks to concatenate Boolean arrays.
This is for Buildings, #4512.
Buildings.Templates.Plants.Controls.HeatPumps
Buildings.Templates.Plants.Controls.HeatPumps.Subsequences.AssertMinimumRuntime
Buildings.Templates.Plants.Controls.HeatPumps.Subsequences.EquipmentAvailability
Buildings.Templates.Plants.Controls.HeatPumps.Subsequences.EventSequencingMultiple
Buildings.Templates.Plants.Controls.HeatPumps.Subsequences.EventSequencingSingle
Buildings.Templates.Plants.Controls.HeatPumps.Subsequences.RoutingPrimaryPumpStatus
Buildings.Templates.Plants.Controls.HeatPumps.Subsequences.SelectModeState
Added control subsequences for heat pump staging, equipment availability, event sequencing for multiple heat pumps, and primary pump status routing, supporting both reversible and polyvalent heat pumps.
This is for Buildings, #4512.
Buildings.Templates.Components
Buildings.Templates.Components.Types.HeatPumpCapability Added enumeration to specify the operating mode capability of a heat pump: heating only, reversible (2-pipe), or polyvalent (4-pipe).
This is for Buildings, #4512.

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

Buildings.Air.Systems.SingleZone.VAV.Examples.OptimalStart
Buildings.Air.Systems.SingleZone.VAV.Examples.OptimalStart.BaseClasses.ZoneWithAHUConventional
Buildings.Air.Systems.SingleZone.VAV.Examples.OptimalStart.BaseClasses.ZoneWithAHUG36
Changed the class type from block to model.
This is for Buildings, issue 4606.
Buildings.Fluid.FixedResistances
Buildings.Fluid.FixedResistances.PressureDrop Updated to allow a flow exponent between 1 and 2, enabling modeling of partially turbulent flows such as in microchannel heat exchangers.
This is for Buildings, #4620.
Buildings.Fluid.FixedResistances.BaseClasses.PlugFlowTransportDelay Added nominal attribute to state variable.
This is for IBPSA, issue 2132.
Buildings.Fluid.HeatExchangers
Buildings.Fluid.HeatExchangers.DryCoilCounterFlow
Buildings.Fluid.HeatExchangers.DryCoilDiscretized
Buildings.Fluid.HeatExchangers.DryCoilEffectivenessNTU
Buildings.Fluid.HeatExchangers.PlateHeatExchangerEffectivenessNTU
Buildings.Fluid.HeatExchangers.WetCoilCounterFlow
Buildings.Fluid.HeatExchangers.WetCoilDiscretized
Buildings.Fluid.HeatExchangers.WetCoilEffectivenessNTU
Updated parameters to consistently expose ratio of heat transfer coefficients and exponents for convective heat transfer coefficients.
This is for Buildings, #4620.
Buildings.Fluid.Interfaces
Buildings.Fluid.Interfaces.ConservationEquation Added nominal attribute to state variable.
This is for IBPSA, issue 2132.
Buildings.Fluid.Sensors
Buildings.Fluid.Sensors.DensityTwoPort
Buildings.Fluid.Sensors.EnthalpyFlowRate
Buildings.Fluid.Sensors.EntropyFlowRate
Buildings.Fluid.Sensors.LatentEnthalpyFlowRate
Buildings.Fluid.Sensors.MassFractionTwoPort
Buildings.Fluid.Sensors.PPMTwoPort
Buildings.Fluid.Sensors.RelativeHumidityTwoPort
Buildings.Fluid.Sensors.SensibleEnthalpyFlowRate
Buildings.Fluid.Sensors.SpecificEnthalpyTwoPort
Buildings.Fluid.Sensors.SpecificEntropyTwoPort
Buildings.Fluid.Sensors.TemperatureTwoPort
Buildings.Fluid.Sensors.TemperatureWetBulbTwoPort
Buildings.Fluid.Sensors.TraceSubstancesTwoPort
Buildings.Fluid.Sensors.Velocity
Buildings.Fluid.Sensors.VolumeFlowRate
Added nominal attribute to state variable.
This is for IBPSA, issue 2132.
Buildings.HeatTransfer.Windows
Buildings.HeatTransfer.Windows.BaseClasses.Overhang Changed the class type from block to model.
This is for Buildings, issue 4606.
Buildings.BoundaryConditions
Buildings.BoundaryConditions.SolarGeometry.IncidenceAngle
Buildings.BoundaryConditions.SolarGeometry.ZenithAngle
Buildings.BoundaryConditions.SolarIrradiation.DiffuseIsotropic
Buildings.BoundaryConditions.SolarIrradiation.DiffusePerez
Buildings.BoundaryConditions.SolarIrradiation.DirectTiltedSurface
Buildings.BoundaryConditions.SolarIrradiation.GlobalPerezTiltedSurface
Changed the class type from block to model.
This is for IBPSA, issue 2122.
Buildings.Controls.OBC.CDL
Buildings.Controls.OBC.CDL.Integers.Change
Buildings.Controls.OBC.CDL.Logical.Change
Replaced initial equation with start attribute on input.
This is for Buildings, issue 4581.
Buildings.Controls.OBC.CDL.Logical.Edge
Buildings.Controls.OBC.CDL.Logical.FallingEdge
Buildings.Controls.OBC.CDL.Logical.Pre
Buildings.Controls.OBC.CDL.Logical.TrueFalseHold
Replaced initial equation with start attribute on input.
This is for IBPSA, #2136.
Buildings.ThermalZones.Detailed
Buildings.ThermalZones.Detailed.Examples.FFD Improved C source codes and recompiled FFD library to allow the examples being simulated with OpenModelica.
This is for Buildings, #4015.
Buildings.ThermalZones.EnergyPlus_24_2_0
Buildings.ThermalZones.EnergyPlus_24_2_0.ThermalZone Added parameters in record for autosizing with EnergyPlus.
Added parameter, with default as zero, for considering infiltration flow during autosizing for EnergyPlus.
Updated exchange with C-code to exchange variables for autosizing with EnergyPlus.
This is for Buildings, #3866.
Buildings.ThermalZones.EnergyPlus_24_2_0.Actuator
Buildings.ThermalZones.EnergyPlus_24_2_0.OpaqueConstruction
Buildings.ThermalZones.EnergyPlus_24_2_0.OutputVariable
Buildings.ThermalZones.EnergyPlus_24_2_0.Schedule
Buildings.ThermalZones.EnergyPlus_24_2_0.ThermalZone
Buildings.ThermalZones.EnergyPlus_24_2_0.ZoneSurface
Updated exchange with C-code to exchange variables for autosizing with EnergyPlus.
This is for Buildings, #3866.
Buildings.Fluid.Sources
Buildings.Fluid.Sources.BaseClasses.PartialSource
Buildings.Fluid.Sources.BaseClasses.PartialAirSource
Removed deprecated cardinality function.
Removed protected parameter flowDirection as it was set to Bidirectional and had no effect on the model. The annoation mayOnlyConnectOnce must not be used for these models as they are often used to set the reference presssure in closed system flow networks.
This is for Buildings, #4607.
Buildings.Fluid.Sources.TraceSubstancesFlowSource Removed deprecated cardinality function and replaced with mayOnlyConnectOnce annotation.
Removed protected parameter flowDirection as it was set to Bidirectional and had no effect on the model.
This is for Buildings, #4607.
Buildings.Templates
Buildings.Templates.Components.Fans.ArrayVariable
Buildings.Templates.Components.Fans.SingleConstant
Buildings.Templates.Components.Fans.SingleVariable
Buildings.Templates.Components.Pumps.Multiple
Buildings.Templates.Components.Pumps.Single
Refactored to use a compiler-friendly mover model.
This is for Buildings, #4653.
Buildings.Templates.Plants.Controls.HeatPumps.AirToWater Refactored with a single instance of SortRuntime for both modes.
This is for Buildings, #4624.
Buildings.Templates.Plants.Controls.StagingRotation.EquipmentEnable Added logic to remove unavailable equipment from staging order. Removed restriction on enable state updates. Modularized the implementation.
This is for Buildings, #4624.
Buildings.Templates.Plants.Controls.StagingRotation.SortRuntime Corrected runtime weighting for unavailable units. Updated handling and default value of runtime initialization.
This is for Buildings, #4624.
Buildings.Templates.Plants.Controls.StagingRotation.StageCompletion Use both enable command and returned status to handle multiple operating modes for polyvalent units.
This is for Buildings, #4512.
Buildings.Templates.Plants.Controls.Utilities.TrueArrayConditional Refactored using CDL Elementary Blocks.
This is for Buildings, #4624.
Buildings.ThermalZones.Detailed
Buildings.ThermalZones.Detailed.Examples.FFD Improved C source codes and recompiled FFD library to allow the examples being simulated with OpenModelica.
This is for Buildings, #4015.
Buildings.ThermalZones.EnergyPlus_24_2_0
Buildings.ThermalZones.EnergyPlus_24_2_0.Validation.MultipleBuildings Improved C source codes to allow the validation model being simulated with OpenModelica.
This is for Buildings, #3345.
Buildings.ThermalZones.EnergyPlus_24_2_0.OpaqueConstruction Removed deprecated cardinality function and replaced with mustBeConnected annotation.
This is for Buildings, #4607.
Buildings.Utilities.IO.BCVTB
Buildings.Utilities.IO.BCVTB.BaseClasses.FluidInterface Removed protected parameter flowDirection as it was set to Bidirectional and had no effect on the model.
This is for Buildings, #4607.
Buildings.Utilities.Psychrometrics
Buildings.Utilities.Psychrometrics.TWetBul_TDryBulXi Added nominal attribute for temperature.
This is for IBPSA, #2155.

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

Buildings.Templates.Components
Buildings.Templates.Components.Data.HeatPump
Buildings.Templates.Components.Interfaces.PartialHeatPump
Replaced the is_rev parameter with typMod, of the new type Buildings.Templates.Components.Types.HeatPumpCapability, to also support polyvalent heat pumps.
This is for Buildings, #4512.
Buildings.Templates.Plants.Controls
Buildings.Templates.Plants.Controls.MinimumFlow.ControllerDualMode Renamed to Buildings.Templates.Plants.Controls.MinimumFlow.ControllerHeatPumps and refactored to support plants with polyvalent heat pumps.
This is for Buildings, #4512.
Buildings.Templates.Plants.Controls.Pumps.Primary.VariableSpeed Renamed to Buildings.Templates.Plants.Controls.Pumps.Primary.VariableSpeedWithHeatPumps and refactored to support plants with polyvalent heat pumps.
This is for Buildings, #4512.
Buildings.Templates.Plants.Controls.StagingRotation.EquipmentAvailability
Buildings.Templates.Plants.Controls.StagingRotation.EventSequencing
Removed and replaced with Buildings.Templates.Plants.Controls.HeatPumps.Subsequences.EquipmentAvailability, EventSequencingSingle, which also support polyvalent heat pumps.
This is for Buildings, #4512.
Buildings.Templates.Plants.Controls.Utilities.Initialization Removed as it is no longer used.
This is for Buildings, #4512.
Buildings.Templates.Plants.HeatPumps
Buildings.Templates.Plants.HeatPumps.AirToWater
Buildings.Templates.Plants.HeatPumps.Components.Data.Controller
Buildings.Templates.Plants.HeatPumps.Components.Data.HeatPumpGroup
Buildings.Templates.Plants.HeatPumps.Components.Interfaces.PartialHeatPumpGroup
Buildings.Templates.Plants.HeatPumps.Components.PumpsPrimaryDedicated
Buildings.Templates.Plants.HeatPumps.Components.ValvesIsolation
Buildings.Templates.Plants.HeatPumps.Configuration.HeatPumpPlant
Buildings.Templates.Plants.HeatPumps.Data.HeatPumpPlant
Buildings.Templates.Plants.HeatPumps.Interfaces.PartialHeatPumpPlant
Refactored the heat pump plant template and its components to support polyvalent heat pumps. This renamed existing parameters, and added multiple new required configuration and sizing parameters for polyvalent heat pumps.
This is for Buildings, #4512.
Buildings.ThermalZones.EnergyPlus_24_2_0
Buildings.ThermalZones.EnergyPlus_24_2_0.BaseClasses.SpawnExternalObject Corrected C function implementation to comply with Modelica Language Standard.
This change only affects the C function implementation and does not impact the Modelica function signature.
This is for issue 4658.

Added inputs for autosizing with EnergyPlus.
This is for issue 3866.
Buildings.ThermalZones.EnergyPlus_24_2_0.BaseClasses.ThermalZoneAdapter Added parameters for autosizing with EnergyPlus.
This is for issue 3866.

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

Buildings.Fluid.HeaExchangers
Buildings.Fluid.HeaExchangers.DryCooler Corrected the initialization of the efficiency, which assumed counter flow rather than cross flow with both streams unmixed.
This is for Buildings, #4648.

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.DXSystems
Buildings.Fluid.DXSystems.Cooling.BaseClasses.Evaporation Added missing variable assignment for ununsed variable in a branch that will not compute evaporation.
This is for Buildings, #4715.
Buildings.Fluid.Geothermal.Borefields.BaseClasses.HeatTransfer.ThermalResponseFactors
Buildings.Fluid.Geothermal.Borefields.BaseClasses.HeatTransfer.ThermalResponseFactors.gFunction Initialized local variables A and B to avoid use of uninitialized elements of a matrix. This update does not change the results.
This is for Buildings, #4707.
Buildings.Fluid.HeatPumps.ModularReversible.BaseClasses
Buildings.Fluid.HeatPumps.ModularReversible.BaseClasses.PartialReversibleRefrigerantMachine Corrected the flow reversal parameter in the condenser mass flow sensor (allowFlowReversalEva was used instead of allowFlowReversalCon). Also corrected the sensor description from evaporator to condenser.
This is for IBPSA, #2162.