New 2017 and 2023 flow rate fields

developer/doc/ReleaseNotes/OpenStudio_Release_Notes_3_4_1_TBD.md

@@ -73,12 +73,15 @@ You can also refer to the [OpenStudio SDK Python Binding Version Compatibility M
 * [#4642](https://github.com/NREL/OpenStudio/pull/4642) - Addresses #4575, API change for EvaporativeCoolerFluid:SingleSpeed
     * `EvaporativeCoolerFluid:SingleSpeed` has an API-breaking change related to its `performanceInputMethod` getter. It is now a required field that returns `std::string` instead of `boost::optional<std::string>`.
 * [#4644](https://github.com/NREL/OpenStudio/pull/4644) - Addresses #4575, API change for Coil:Cooling:DX:SingleSpeed and Coil:Cooling:DX:TwoSpeed
-    * ` Coil:Cooling:DX:SingleSpeed` and `Coil:Cooling:DX:TwoSpeed` have API-breaking changes related to many of their getters. They are now required fields that return `double` instead of `boost::optional<double>`. Also removes many deprecated methods.
+    * `Coil:Cooling:DX:SingleSpeed` and `Coil:Cooling:DX:TwoSpeed` have API-breaking changes related to many of their getters. They are now required fields that return `double` instead of `boost::optional<double>`. Also removes many deprecated methods.
 * [#4632](https://github.com/NREL/OpenStudio/pull/4632) - Remove deprecated methods for AirWallMaterial, Node, SizingSystem, ZoneAirMassFlowConservation
     * Removes the deprecated `AirWallMaterial` class completely, in favor of `ConstructionAirBoundary`
     * Removes functions in `Node` that have been deprecated for 9+ years
     * Removes deprecated methods in the `SizingSystem`, `ZoneAirMassFlowConservation`, `PlantLoop` & `AirLoopHVAC`, `AvailablilityManagerNightCycle`, `ZoneVentilationDesignFlowRate` classes
     * Refer to the CSV file at [developer/ruby/deprecated_methods.csv](https://github.com/NREL/OpenStudio/blob/develop/developer/ruby/deprecated_methods.csv) for more information
+* [#4665](https://github.com/NREL/OpenStudio/pull/4665) - Deprecate methods on Coil DX objects
+    * `Coil:Cooling:DX:SingleSpeed`, `Coil:Cooling:DX:MultiSpeed:StageData`, and `Coil:Cooling:DX:CurveFit:Speed`: `ratedEvaporatorFanPowerPerVolumeFlowRate` and `setRatedEvaporatorFanPowerPerVolumeFlowRate` in favor of `ratedEvaporatorFanPowerPerVolumeFlowRate2017` and `setRatedEvaporatorFanPowerPerVolumeFlowRate2017`
+    * `Coil:Heating:DX:SingleSpeed` and `Coil:Heating:DX:MultiSpeed:StageData`: `ratedSupplyFanPowerPerVolumeFlowRate` and `setRatedSupplyFanPowerPerVolumeFlowRate` in favor of `ratedSupplyFanPowerPerVolumeFlowRate2017` and `setRatedSupplyFanPowerPerVolumeFlowRate2017`
 
 
 ## Minor changes and bug fixes

src/energyplus/ForwardTranslator/ForwardTranslateCoilCoolingDXCurveFitSpeed.cpp

@@ -81,7 +81,11 @@ namespace energyplus {
 
     // RatedEvaporatorFanPowerPerVolumeFlowRate2017
     idfObject.setDouble(Coil_Cooling_DX_CurveFit_SpeedFields::RatedEvaporatorFanPowerPerVolumeFlowRate2017,
-                        modelObject.ratedEvaporatorFanPowerPerVolumeFlowRate());
+                        modelObject.ratedEvaporatorFanPowerPerVolumeFlowRate2017());
+
+    // RatedEvaporatorFanPowerPerVolumeFlowRate2023
+    idfObject.setDouble(Coil_Cooling_DX_CurveFit_SpeedFields::RatedEvaporatorFanPowerPerVolumeFlowRate2023,
+                        modelObject.ratedEvaporatorFanPowerPerVolumeFlowRate2023());
 
     // EvaporativeCondenserPumpPowerFraction
     idfObject.setDouble(Coil_Cooling_DX_CurveFit_SpeedFields::EvaporativeCondenserPumpPowerFraction,

src/energyplus/ForwardTranslator/ForwardTranslateCoilCoolingDXMultiSpeed.cpp

@@ -73,9 +73,7 @@ namespace energyplus {
     // CondenserAirInletNodeName: stays blank so we get condition from weather file
 
     // CondenserType
-    if ((s = modelObject.condenserType())) {
-      idfObject.setString(Coil_Cooling_DX_MultiSpeedFields::CondenserType, s.get());
-    }
+    idfObject.setString(Coil_Cooling_DX_MultiSpeedFields::CondenserType, modelObject.condenserType());
 
     // SupplyWaterStorageTankName
 
@@ -97,29 +95,21 @@ namespace energyplus {
     }
 
     // Minimum Outdoor Dry-Bulb Temperature for Compressor Operation
-    if ((value = modelObject.minimumOutdoorDryBulbTemperatureforCompressorOperation())) {
-      idfObject.setDouble(Coil_Cooling_DX_MultiSpeedFields::MinimumOutdoorDryBulbTemperatureforCompressorOperation, value.get());
-    }
+    idfObject.setDouble(Coil_Cooling_DX_MultiSpeedFields::MinimumOutdoorDryBulbTemperatureforCompressorOperation,
+                        modelObject.minimumOutdoorDryBulbTemperatureforCompressorOperation());
 
     // CrankcaseHeaterCapacity
-    if ((value = modelObject.crankcaseHeaterCapacity())) {
-      idfObject.setDouble(Coil_Cooling_DX_MultiSpeedFields::CrankcaseHeaterCapacity, value.get());
-    }
+    idfObject.setDouble(Coil_Cooling_DX_MultiSpeedFields::CrankcaseHeaterCapacity, modelObject.crankcaseHeaterCapacity());
 
     // MaximumOutdoorDryBulbTemperatureforCrankcaseHeaterOperation
-    if ((value = modelObject.maximumOutdoorDryBulbTemperatureforCrankcaseHeaterOperation())) {
-      idfObject.setDouble(Coil_Cooling_DX_MultiSpeedFields::MaximumOutdoorDryBulbTemperatureforCrankcaseHeaterOperation, value.get());
-    }
+    idfObject.setDouble(Coil_Cooling_DX_MultiSpeedFields::MaximumOutdoorDryBulbTemperatureforCrankcaseHeaterOperation,
+                        modelObject.maximumOutdoorDryBulbTemperatureforCrankcaseHeaterOperation());
 
     // BasinHeaterCapacity
-    if ((value = modelObject.basinHeaterCapacity())) {
-      idfObject.setDouble(Coil_Cooling_DX_MultiSpeedFields::BasinHeaterCapacity, value.get());
-    }
+    idfObject.setDouble(Coil_Cooling_DX_MultiSpeedFields::BasinHeaterCapacity, modelObject.basinHeaterCapacity());
 
     // BasinHeaterSetpointTemperature
-    if ((value = modelObject.basinHeaterSetpointTemperature())) {
-      idfObject.setDouble(Coil_Cooling_DX_MultiSpeedFields::BasinHeaterSetpointTemperature, value.get());
-    }
+    idfObject.setDouble(Coil_Cooling_DX_MultiSpeedFields::BasinHeaterSetpointTemperature, modelObject.basinHeaterSetpointTemperature());
 
     // BasinHeaterOperatingScheduleName
     if (auto schedule = modelObject.basinHeaterOperatingSchedule()) {
@@ -129,9 +119,7 @@ namespace energyplus {
     }
 
     // FuelType
-    if ((s = modelObject.fuelType())) {
-      idfObject.setString(Coil_Cooling_DX_MultiSpeedFields::FuelType, s.get());
-    }
+    idfObject.setString(Coil_Cooling_DX_MultiSpeedFields::FuelType, modelObject.fuelType());
 
     const auto stages = modelObject.stages();
 
@@ -158,9 +146,7 @@ namespace energyplus {
       }
 
       // SpeedGrossRatedCoolingCOP
-      if ((value = stage.grossRatedCoolingCOP())) {
-        eg.setDouble(Coil_Cooling_DX_MultiSpeedExtensibleFields::SpeedGrossRatedCoolingCOP, value.get());
-      }
+      eg.setDouble(Coil_Cooling_DX_MultiSpeedExtensibleFields::SpeedGrossRatedCoolingCOP, stage.grossRatedCoolingCOP());
 
       // SpeedRatedAirFlowRate
       if (stage.isRatedAirFlowRateAutosized()) {
@@ -170,9 +156,12 @@ namespace energyplus {
       }
 
       // RatedEvaporatorFanPowerPerVolumeFlowRate2017
-      if ((value = stage.ratedEvaporatorFanPowerPerVolumeFlowRate())) {
-        eg.setDouble(Coil_Cooling_DX_MultiSpeedExtensibleFields::SpeedRatedEvaporatorFanPowerPerVolumeFlowRate2017, value.get());
-      }
+      eg.setDouble(Coil_Cooling_DX_MultiSpeedExtensibleFields::SpeedRatedEvaporatorFanPowerPerVolumeFlowRate2017,
+                   stage.ratedEvaporatorFanPowerPerVolumeFlowRate2017());
+
+      // RatedEvaporatorFanPowerPerVolumeFlowRate2023
+      eg.setDouble(Coil_Cooling_DX_MultiSpeedExtensibleFields::SpeedRatedEvaporatorFanPowerPerVolumeFlowRate2023,
+                   stage.ratedEvaporatorFanPowerPerVolumeFlowRate2023());
 
       // SpeedTotalCoolingCapacityFunctionofTemperatureCurveName
       {
@@ -220,24 +209,17 @@ namespace energyplus {
       }
 
       // SpeedRatioofInitialMoistureEvaporationRateandSteadyStateLatentCapacity
-      if ((value = stage.ratioofInitialMoistureEvaporationRateandSteadyStateLatentCapacity())) {
-        eg.setDouble(Coil_Cooling_DX_MultiSpeedExtensibleFields::SpeedRatioofInitialMoistureEvaporationRateandSteadyStateLatentCapacity, value.get());
-      }
+      eg.setDouble(Coil_Cooling_DX_MultiSpeedExtensibleFields::SpeedRatioofInitialMoistureEvaporationRateandSteadyStateLatentCapacity,
+                   stage.ratioofInitialMoistureEvaporationRateandSteadyStateLatentCapacity());
 
       // SpeedMaximumCyclingRate
-      if ((value = stage.maximumCyclingRate())) {
-        eg.setDouble(Coil_Cooling_DX_MultiSpeedExtensibleFields::SpeedMaximumCyclingRate, value.get());
-      }
+      eg.setDouble(Coil_Cooling_DX_MultiSpeedExtensibleFields::SpeedMaximumCyclingRate, stage.maximumCyclingRate());
 
       // SpeedLatentCapacityTimeConstant
-      if ((value = stage.latentCapacityTimeConstant())) {
-        eg.setDouble(Coil_Cooling_DX_MultiSpeedExtensibleFields::SpeedLatentCapacityTimeConstant, value.get());
-      }
+      eg.setDouble(Coil_Cooling_DX_MultiSpeedExtensibleFields::SpeedLatentCapacityTimeConstant, stage.latentCapacityTimeConstant());
 
       // SpeedRatedWasteHeatFractionofPowerInput
-      if ((value = stage.ratedWasteHeatFractionofPowerInput())) {
-        eg.setDouble(Coil_Cooling_DX_MultiSpeedExtensibleFields::SpeedRatedWasteHeatFractionofPowerInput, value.get());
-      }
+      eg.setDouble(Coil_Cooling_DX_MultiSpeedExtensibleFields::SpeedRatedWasteHeatFractionofPowerInput, stage.ratedWasteHeatFractionofPowerInput());
 
       // SpeedWasteHeatFunctionofTemperatureCurveName
       {
@@ -248,9 +230,7 @@ namespace energyplus {
       }
 
       // SpeedEvaporativeCondenserEffectiveness
-      if ((value = stage.evaporativeCondenserEffectiveness())) {
-        eg.setDouble(Coil_Cooling_DX_MultiSpeedExtensibleFields::SpeedEvaporativeCondenserEffectiveness, value.get());
-      }
+      eg.setDouble(Coil_Cooling_DX_MultiSpeedExtensibleFields::SpeedEvaporativeCondenserEffectiveness, stage.evaporativeCondenserEffectiveness());
 
       // SpeedEvaporativeCondenserAirFlowRate
       if (stage.isEvaporativeCondenserAirFlowRateAutosized()) {

src/energyplus/ForwardTranslator/ForwardTranslateCoilCoolingDXSingleSpeed.cpp

@@ -103,10 +103,7 @@ namespace energyplus {
       idfObject.setString(Coil_Cooling_DX_SingleSpeedFields::GrossRatedSensibleHeatRatio, "Autosize");
     }
 
-    d = modelObject.ratedCOP();
-    if (d) {
-      idfObject.setDouble(Coil_Cooling_DX_SingleSpeedFields::GrossRatedCoolingCOP, *d);
-    }
+    idfObject.setDouble(Coil_Cooling_DX_SingleSpeedFields::GrossRatedCoolingCOP, modelObject.ratedCOP());
 
     d = modelObject.ratedAirFlowRate();
     if (d) {
@@ -115,10 +112,11 @@ namespace energyplus {
       idfObject.setString(Coil_Cooling_DX_SingleSpeedFields::RatedAirFlowRate, "Autosize");
     }
 
-    d = modelObject.ratedEvaporatorFanPowerPerVolumeFlowRate();
-    if (d) {
-      idfObject.setDouble(Coil_Cooling_DX_SingleSpeedFields::RatedEvaporatorFanPowerPerVolumeFlowRate2017, *d);
-    }
+    idfObject.setDouble(Coil_Cooling_DX_SingleSpeedFields::RatedEvaporatorFanPowerPerVolumeFlowRate2017,
+                        modelObject.ratedEvaporatorFanPowerPerVolumeFlowRate2017());
+
+    idfObject.setDouble(Coil_Cooling_DX_SingleSpeedFields::RatedEvaporatorFanPowerPerVolumeFlowRate2023,
+                        modelObject.ratedEvaporatorFanPowerPerVolumeFlowRate2023());
 
     OptionalModelObject omo = modelObject.inletModelObject();
     if (omo) {
@@ -138,28 +136,18 @@ namespace energyplus {
       }
     }
 
-    d = modelObject.nominalTimeForCondensateRemovalToBegin();
-    if (d) {
-      idfObject.setDouble(Coil_Cooling_DX_SingleSpeedFields::NominalTimeforCondensateRemovaltoBegin, *d);
-    }
+    idfObject.setDouble(Coil_Cooling_DX_SingleSpeedFields::NominalTimeforCondensateRemovaltoBegin,
+                        modelObject.nominalTimeForCondensateRemovalToBegin());
 
     idfObject.setDouble(Coil_Cooling_DX_SingleSpeedFields::MinimumOutdoorDryBulbTemperatureforCompressorOperation,
                         modelObject.minimumOutdoorDryBulbTemperatureforCompressorOperation());
 
-    d = modelObject.ratioOfInitialMoistureEvaporationRateAndSteadyStateLatentCapacity();
-    if (d) {
-      idfObject.setDouble(Coil_Cooling_DX_SingleSpeedFields::RatioofInitialMoistureEvaporationRateandSteadyStateLatentCapacity, *d);
-    }
+    idfObject.setDouble(Coil_Cooling_DX_SingleSpeedFields::RatioofInitialMoistureEvaporationRateandSteadyStateLatentCapacity,
+                        modelObject.ratioOfInitialMoistureEvaporationRateAndSteadyStateLatentCapacity());
 
-    d = modelObject.maximumCyclingRate();
-    if (d) {
-      idfObject.setDouble(Coil_Cooling_DX_SingleSpeedFields::MaximumCyclingRate, *d);
-    }
+    idfObject.setDouble(Coil_Cooling_DX_SingleSpeedFields::MaximumCyclingRate, modelObject.maximumCyclingRate());
 
-    d = modelObject.latentCapacityTimeConstant();
-    if (d) {
-      idfObject.setDouble(Coil_Cooling_DX_SingleSpeedFields::LatentCapacityTimeConstant, *d);
-    }
+    idfObject.setDouble(Coil_Cooling_DX_SingleSpeedFields::LatentCapacityTimeConstant, modelObject.latentCapacityTimeConstant());
 
     s = modelObject.condenserAirInletNodeName();
     if (s) {
@@ -168,10 +156,7 @@ namespace energyplus {
 
     idfObject.setString(Coil_Cooling_DX_SingleSpeedFields::CondenserType, modelObject.condenserType());
 
-    d = modelObject.evaporativeCondenserEffectiveness();
-    if (d) {
-      idfObject.setDouble(Coil_Cooling_DX_SingleSpeedFields::EvaporativeCondenserEffectiveness, *d);
-    }
+    idfObject.setDouble(Coil_Cooling_DX_SingleSpeedFields::EvaporativeCondenserEffectiveness, modelObject.evaporativeCondenserEffectiveness());
 
     d = modelObject.evaporativeCondenserAirFlowRate();
     if (d) {
@@ -187,29 +172,18 @@ namespace energyplus {
       idfObject.setString(Coil_Cooling_DX_SingleSpeedFields::EvaporativeCondenserPumpRatedPowerConsumption, "Autosize");
     }
 
-    d = modelObject.crankcaseHeaterCapacity();
-    if (d) {
-      idfObject.setDouble(Coil_Cooling_DX_SingleSpeedFields::CrankcaseHeaterCapacity, *d);
-    }
+    idfObject.setDouble(Coil_Cooling_DX_SingleSpeedFields::CrankcaseHeaterCapacity, modelObject.crankcaseHeaterCapacity());
 
-    d = modelObject.maximumOutdoorDryBulbTemperatureForCrankcaseHeaterOperation();
-    if (d) {
-      idfObject.setDouble(Coil_Cooling_DX_SingleSpeedFields::MaximumOutdoorDryBulbTemperatureforCrankcaseHeaterOperation, *d);
-    }
+    idfObject.setDouble(Coil_Cooling_DX_SingleSpeedFields::MaximumOutdoorDryBulbTemperatureforCrankcaseHeaterOperation,
+                        modelObject.maximumOutdoorDryBulbTemperatureForCrankcaseHeaterOperation());
 
     //TODO
     //getSupplyWaterStorageTankName
     //getCondensateCollectionWaterStorageTankName
 
-    d = modelObject.basinHeaterCapacity();
-    if (d) {
-      idfObject.setDouble(Coil_Cooling_DX_SingleSpeedFields::BasinHeaterCapacity, *d);
-    }
+    idfObject.setDouble(Coil_Cooling_DX_SingleSpeedFields::BasinHeaterCapacity, modelObject.basinHeaterCapacity());
 
-    d = modelObject.basinHeaterSetpointTemperature();
-    if (d) {
-      idfObject.setDouble(Coil_Cooling_DX_SingleSpeedFields::BasinHeaterSetpointTemperature, *d);
-    }
+    idfObject.setDouble(Coil_Cooling_DX_SingleSpeedFields::BasinHeaterSetpointTemperature, modelObject.basinHeaterSetpointTemperature());
 
     OptionalSchedule os = modelObject.basinHeaterOperatingSchedule();
     if (os) {