openstudio-standards 0.8.3 → 0.8.5.rc1

data/lib/openstudio-standards/hvac/components/coil_heating_water.rb

@@ -0,0 +1,98 @@
+module OpenstudioStandards
+  # The HVAC module provides methods create, modify, and get information about HVAC systems in the model
+  module HVAC
+    # @!group Component:Coil
+    # Methods to create, modify, and get information about HVAC coil objects
+
+    # Create CoilHeatingWater object
+    #
+    # @param model [OpenStudio::Model::Model] OpenStudio model object
+    # @param hot_water_loop [<OpenStudio::Model::PlantLoop>] the coil will be placed on the demand side of this plant loop
+    # @param air_loop_node [<OpenStudio::Model::Node>] the coil will be placed on this node of the air loop
+    # @param name [String] the name of the coil, or nil in which case it will be defaulted
+    # @param schedule [String] name of the availability schedule, or [<OpenStudio::Model::Schedule>] Schedule object, or nil in which case default to always on
+    # @param rated_inlet_water_temperature [Double] rated inlet water temperature in degrees Celsius, default is hot water loop design exit temperature
+    # @param rated_outlet_water_temperature [Double] rated outlet water temperature in degrees Celsius, default is hot water loop design return temperature
+    # @param rated_inlet_air_temperature [Double] rated inlet air temperature in degrees Celsius, default is 16.6 (62F)
+    # @param rated_outlet_air_temperature [Double] rated outlet air temperature in degrees Celsius, default is 32.2 (90F)
+    # @param controller_convergence_tolerance [Double] controller convergence tolerance
+    # @return [OpenStudio::Model::CoilHeatingWater] the heating coil
+    def self.create_coil_heating_water(model,
+                                       hot_water_loop,
+                                       air_loop_node: nil,
+                                       name: 'Htg Coil',
+                                       schedule: nil,
+                                       rated_inlet_water_temperature: nil,
+                                       rated_outlet_water_temperature: nil,
+                                       rated_inlet_air_temperature: 16.6,
+                                       rated_outlet_air_temperature: 32.2,
+                                       controller_convergence_tolerance: 0.1)
+      htg_coil = OpenStudio::Model::CoilHeatingWater.new(model)
+
+      # add to hot water loop
+      hot_water_loop.addDemandBranchForComponent(htg_coil)
+
+      # add to air loop if specified
+      htg_coil.addToNode(air_loop_node) unless air_loop_node.nil?
+
+      # set coil name
+      if name.nil?
+        htg_coil.setName('Htg Coil')
+      else
+        htg_coil.setName(name)
+      end
+
+      # set coil availability schedule
+      if schedule.nil?
+        # default always on
+        coil_availability_schedule = model.alwaysOnDiscreteSchedule
+      elsif schedule.instance_of?(String)
+        coil_availability_schedule = model_add_schedule(model, schedule)
+
+        if coil_availability_schedule.nil? && schedule == 'alwaysOffDiscreteSchedule'
+          coil_availability_schedule = model.alwaysOffDiscreteSchedule
+        elsif coil_availability_schedule.nil?
+          coil_availability_schedule = model.alwaysOnDiscreteSchedule
+        end
+      elsif !schedule.to_Schedule.empty?
+        coil_availability_schedule = schedule
+      end
+      htg_coil.setAvailabilitySchedule(coil_availability_schedule)
+
+      # rated water temperatures, use hot water loop temperatures if defined
+      if rated_inlet_water_temperature.nil?
+        rated_inlet_water_temperature = hot_water_loop.sizingPlant.designLoopExitTemperature
+        htg_coil.setRatedInletWaterTemperature(rated_inlet_water_temperature)
+      else
+        htg_coil.setRatedInletWaterTemperature(rated_inlet_water_temperature)
+      end
+      if rated_outlet_water_temperature.nil?
+        rated_outlet_water_temperature = rated_inlet_water_temperature - hot_water_loop.sizingPlant.loopDesignTemperatureDifference
+        htg_coil.setRatedOutletWaterTemperature(rated_outlet_water_temperature)
+      else
+        htg_coil.setRatedOutletWaterTemperature(rated_outlet_water_temperature)
+      end
+
+      # rated air temperatures
+      if rated_inlet_air_temperature.nil?
+        htg_coil.setRatedInletAirTemperature(16.6)
+      else
+        htg_coil.setRatedInletAirTemperature(rated_inlet_air_temperature)
+      end
+      if rated_outlet_air_temperature.nil?
+        htg_coil.setRatedOutletAirTemperature(32.2)
+      else
+        htg_coil.setRatedOutletAirTemperature(rated_outlet_air_temperature)
+      end
+
+      # coil controller properties
+      # @note These inputs will get overwritten if addToNode or addDemandBranchForComponent is called on the htg_coil object after this
+      htg_coil_controller = htg_coil.controllerWaterCoil.get
+      htg_coil_controller.setName("#{htg_coil.name} Controller")
+      htg_coil_controller.setMinimumActuatedFlow(0.0)
+      htg_coil_controller.setControllerConvergenceTolerance(controller_convergence_tolerance) unless controller_convergence_tolerance.nil?
+
+      return htg_coil
+    end
+  end
+end

data/lib/openstudio-standards/hvac/components/coil_heating_water_to_air_heat_pump_equation_fit.rb

@@ -0,0 +1,147 @@
+module OpenstudioStandards
+  # The HVAC module provides methods create, modify, and get information about HVAC systems in the model
+  module HVAC
+    # @!group Component:Coil
+    # Methods to create, modify, and get information about HVAC coil objects
+
+    # Create CoilHeatingWaterToAirHeatPumpEquationFit object
+    # Enters in default curves for coil by type of coil
+    #
+    # @param model [OpenStudio::Model::Model] OpenStudio model object
+    # @param plant_loop [<OpenStudio::Model::PlantLoop>] the coil will be placed on the demand side of this plant loop
+    # @param air_loop_node [<OpenStudio::Model::Node>] the coil will be placed on this node of the air loop
+    # @param name [String] the name of the system, or nil in which case it will be defaulted
+    # @param type [String] the type of coil to reference the correct curve set
+    # @param cop [Double] rated heating coefficient of performance
+    # @return [OpenStudio::Model::CoilHeatingWaterToAirHeatPumpEquationFit] the heating coil
+    def self.create_coil_heating_water_to_air_heat_pump_equation_fit(model,
+                                                                     plant_loop,
+                                                                     air_loop_node: nil,
+                                                                     name: 'Water-to-Air HP Htg Coil',
+                                                                     type: nil,
+                                                                     cop: 4.2)
+      htg_coil = OpenStudio::Model::CoilHeatingWaterToAirHeatPumpEquationFit.new(model)
+
+      # add to air loop if specified
+      htg_coil.addToNode(air_loop_node) unless air_loop_node.nil?
+
+      # set coil name
+      htg_coil.setName(name)
+
+      # add to plant loop
+      if plant_loop.nil?
+        OpenStudio.logFree(OpenStudio::Error, 'openstudio.standards.HVAC', 'No plant loop supplied for heating coil')
+        return false
+      end
+      plant_loop.addDemandBranchForComponent(htg_coil)
+
+      # set coil cop
+      if cop.nil?
+        htg_coil.setRatedHeatingCoefficientofPerformance(4.2)
+      else
+        htg_coil.setRatedHeatingCoefficientofPerformance(cop)
+      end
+
+      # curve sets
+      if type == 'OS default'
+        # use OS default curves
+      else # default curve set
+        if model.version < OpenStudio::VersionString.new('3.2.0')
+          htg_coil.setHeatingCapacityCoefficient1(0.237847462869254)
+          htg_coil.setHeatingCapacityCoefficient2(-3.35823796081626)
+          htg_coil.setHeatingCapacityCoefficient3(3.80640467406376)
+          htg_coil.setHeatingCapacityCoefficient4(0.179200417311554)
+          htg_coil.setHeatingCapacityCoefficient5(0.12860719846082)
+          htg_coil.setHeatingPowerConsumptionCoefficient1(-3.79175529243238)
+          htg_coil.setHeatingPowerConsumptionCoefficient2(3.38799239505527)
+          htg_coil.setHeatingPowerConsumptionCoefficient3(1.5022612076303)
+          htg_coil.setHeatingPowerConsumptionCoefficient4(-0.177653510577989)
+          htg_coil.setHeatingPowerConsumptionCoefficient5(-0.103079864171839)
+        else
+          if model.getCurveByName('Water to Air Heat Pump Heating Capacity Curve').is_initialized
+            heating_capacity_curve = model.getCurveByName('Water to Air Heat Pump Heating Capacity Curve').get
+            heating_capacity_curve = heating_capacity_curve.to_CurveQuadLinear.get
+          else
+            heating_capacity_curve = OpenStudio::Model::CurveQuadLinear.new(model)
+            heating_capacity_curve.setName('Water to Air Heat Pump Heating Capacity Curve')
+            heating_capacity_curve.setCoefficient1Constant(0.237847462869254)
+            heating_capacity_curve.setCoefficient2w(-3.35823796081626)
+            heating_capacity_curve.setCoefficient3x(3.80640467406376)
+            heating_capacity_curve.setCoefficient4y(0.179200417311554)
+            heating_capacity_curve.setCoefficient5z(0.12860719846082)
+            heating_capacity_curve.setMinimumValueofw(-100)
+            heating_capacity_curve.setMaximumValueofw(100)
+            heating_capacity_curve.setMinimumValueofx(-100)
+            heating_capacity_curve.setMaximumValueofx(100)
+            heating_capacity_curve.setMinimumValueofy(0)
+            heating_capacity_curve.setMaximumValueofy(100)
+            heating_capacity_curve.setMinimumValueofz(0)
+            heating_capacity_curve.setMaximumValueofz(100)
+          end
+          htg_coil.setHeatingCapacityCurve(heating_capacity_curve)
+
+          if model.getCurveByName('Water to Air Heat Pump Heating Power Consumption Curve').is_initialized
+            heating_power_consumption_curve = model.getCurveByName('Water to Air Heat Pump Heating Power Consumption Curve').get
+            heating_power_consumption_curve = heating_power_consumption_curve.to_CurveQuadLinear.get
+          else
+            heating_power_consumption_curve = OpenStudio::Model::CurveQuadLinear.new(model)
+            heating_power_consumption_curve.setName('Water to Air Heat Pump Heating Power Consumption Curve')
+            heating_power_consumption_curve.setCoefficient1Constant(-3.79175529243238)
+            heating_power_consumption_curve.setCoefficient2w(3.38799239505527)
+            heating_power_consumption_curve.setCoefficient3x(1.5022612076303)
+            heating_power_consumption_curve.setCoefficient4y(-0.177653510577989)
+            heating_power_consumption_curve.setCoefficient5z(-0.103079864171839)
+            heating_power_consumption_curve.setMinimumValueofw(-100)
+            heating_power_consumption_curve.setMaximumValueofw(100)
+            heating_power_consumption_curve.setMinimumValueofx(-100)
+            heating_power_consumption_curve.setMaximumValueofx(100)
+            heating_power_consumption_curve.setMinimumValueofy(0)
+            heating_power_consumption_curve.setMaximumValueofy(100)
+            heating_power_consumption_curve.setMinimumValueofz(0)
+            heating_power_consumption_curve.setMaximumValueofz(100)
+          end
+          htg_coil.setHeatingPowerConsumptionCurve(heating_power_consumption_curve)
+        end
+
+        # part load fraction correlation curve added as a required curve in OS v3.7.0
+        if model.version > OpenStudio::VersionString.new('3.6.1')
+          if model.getCurveByName('Water to Air Heat Pump Part Load Fraction Correlation Curve').is_initialized
+            part_load_correlation_curve = model.getCurveByName('Water to Air Heat Pump Part Load Fraction Correlation Curve').get
+            part_load_correlation_curve = part_load_correlation_curve.to_CurveLinear.get
+          else
+            part_load_correlation_curve = OpenStudio::Model::CurveLinear.new(model)
+            part_load_correlation_curve.setName('Water to Air Heat Pump Part Load Fraction Correlation Curve')
+            part_load_correlation_curve.setCoefficient1Constant(0.833746458696111)
+            part_load_correlation_curve.setCoefficient2x(0.166253541303889)
+            part_load_correlation_curve.setMinimumValueofx(0)
+            part_load_correlation_curve.setMaximumValueofx(1)
+            part_load_correlation_curve.setMinimumCurveOutput(0)
+            part_load_correlation_curve.setMaximumCurveOutput(1)
+          end
+          htg_coil.setPartLoadFractionCorrelationCurve(part_load_correlation_curve)
+        end
+      end
+
+      return htg_coil
+    end
+
+    # Return the capacity in W of a CoilHeatingWaterToAirHeatPumpEquationFit
+    #
+    # @param coil_heating_water_to_air_heat_pump [OpenStudio::Model::CoilHeatingWaterToAirHeatPumpEquationFit] coil coheating water to air heat pump object
+    # @param multiplier [Double] zone multiplier, if applicable
+    # @return [Double] capacity in W
+    def self.coil_heating_water_to_air_heat_pump_equation_fit_get_capacity(coil_heating_water_to_air_heat_pump, multiplier: 1.0)
+      capacity_w = nil
+      if coil_heating_water_to_air_heat_pump.ratedHeatingCapacity.is_initialized
+        capacity_w = coil_heating_water_to_air_heat_pump.ratedHeatingCapacity.get
+      elsif coil_heating_water_to_air_heat_pump.autosizedRatedHeatingCapacity.is_initialized
+        capacity_w = coil_heating_water_to_air_heat_pump.autosizedRatedHeatingCapacity.get
+      else
+        OpenStudio.logFree(OpenStudio::Warn, 'openstudio.standards.HVAC.coil_heating_water_to_air_heat_pump_equation_fit', "For #{coil_heating_water_to_air_heat_pump.name} capacity is not available.")
+        return capacity_w
+      end
+
+      return capacity_w
+    end
+  end
+end

data/lib/openstudio-standards/hvac/components/component.rb

@@ -0,0 +1,39 @@
+module OpenstudioStandards
+  # The HVAC module provides methods create, modify, and get information about HVAC systems in the model
+  module HVAC
+    # @!group Component
+    # Methods to create, modify, and get information about HVAC components
+
+    # Returns the thermal zone associated with an HVAC component
+    #
+    # @param hvac_component [OpenStudio::Model::HVACComponent] HVAC component object
+    # @return [OpenStudio::Model::ThermalZone] thermal zone object
+    def self.hvac_component_get_thermal_zone(hvac_component)
+      if hvac_component.to_ZoneHVACComponent.is_initialized
+        hvac_component = hvac_component.to_ZoneHVACComponent.get
+        if hvac_component.thermalZone.is_initialized
+          return hvac_component.thermalZone.get
+        end
+      end
+
+      if hvac_component.containingHVACComponent.is_initialized
+        hvac_component = hvac_component.containingHVACComponent.get
+        if hvac_component.to_AirLoopHVACUnitarySystem.is_initialized
+          unitary = hvac_component.to_AirLoopHVACUnitarySystem.get
+          if unitary.controllingZoneorThermostatLocation.is_initialized
+            return unitary.controllingZoneorThermostatLocation.get
+          end
+        end
+      end
+
+      if hvac_component.containingZoneHVACComponent.is_initialized
+        hvac_component = hvac_component.containingZoneHVACComponent.get
+        if hvac_component.thermalZone.is_initialized
+          return hvac_component.thermalZone.get
+        end
+      end
+
+      return nil
+    end
+  end
+end

data/lib/openstudio-standards/{standards/ashrae_90_1/data/ashrae_90_1.fans.json → hvac/components/data/fans.json}

@@ -33,7 +33,7 @@
       "motor_in_airstream_fraction": 1.0,
       "fan_power_minimum_flow_rate_fraction": 0.25,
       "fan_power_minimum_flow_rate_input_method": "Fraction",
-      "fan_curve": "Single zone VAV fan",
+      "fan_curve": "Single Zone VAV",
       "notes": null
     },
     {
@@ -153,7 +153,7 @@
       "motor_in_airstream_fraction": 1.0,
       "fan_power_minimum_flow_rate_fraction": 0.25,
       "fan_power_minimum_flow_rate_input_method": "Fraction",
-      "fan_curve": "Single zone VAV fan",
+      "fan_curve": "Single Zone VAV",
       "notes": null
     },
     {
@@ -255,7 +255,7 @@
     {
       "name": "Unit_Heater_Fan",
       "type": "ConstantVolume",
-      "pressure_rise": null,
+      "pressure_rise": 0.2,
       "fan_efficiency": 0.53625,
       "motor_efficiency": 0.825,
       "motor_in_airstream_fraction": 1.0,
@@ -273,7 +273,7 @@
       "motor_in_airstream_fraction": 1.0,
       "fan_power_minimum_flow_rate_fraction": 0.25,
       "fan_power_minimum_flow_rate_input_method": "Fraction",
-      "fan_curve": "Multi zone VAV with static pressure reset",
+      "fan_curve": "Multi Zone VAV with Static Pressure Setpoint Reset",
       "notes": null
     },
     {
@@ -285,7 +285,7 @@
       "motor_in_airstream_fraction": 1.0,
       "fan_power_minimum_flow_rate_fraction": 0.25,
       "fan_power_minimum_flow_rate_input_method": "Fraction",
-      "fan_curve": "Multi zone VAV with static pressure reset",
+      "fan_curve": "Multi Zone VAV with Static Pressure Setpoint Reset",
       "notes": null
     },
     {
@@ -309,7 +309,7 @@
       "motor_in_airstream_fraction": 1.0,
       "fan_power_minimum_flow_rate_fraction": null,
       "fan_power_minimum_flow_rate_input_method": null,
-      "fan_curve": "Multi zone VAV with static pressure reset",
+      "fan_curve": "Multi Zone VAV with Static Pressure Setpoint Reset",
       "notes": null
     },
     {