.Buildings.UsersGuide.ReleaseNotes.Version_1_5_build1

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

The following issues have been fixed:

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

Generated at 2024-12-26T19:25:54Z by OpenModelicaOpenModelica 1.24.3 using GenerateDoc.mos