honeybee-openstudio 2.11.0 → 2.12.1

data/lib/to_openstudio/hvac/template.rb

@@ -35,6 +35,14 @@ require 'to_openstudio/model_object'
 
 module Honeybee
   class TemplateHVAC
+    @@vintage_mapper = {
+      DOE_Ref_Pre_1980: 'DOE Ref Pre-1980',
+      DOE_Ref_1980_2004: 'DOE Ref 1980-2004',
+      ASHRAE_2004: '90.1-2004',
+      ASHRAE_2007: '90.1-2007',
+      ASHRAE_2010: '90.1-2010',
+      ASHRAE_2013: '90.1-2013'
+    }
 
     def to_openstudio(openstudio_model, room_ids)
 
@@ -47,9 +55,9 @@ module Honeybee
 
       # make the standard applier
       if @hash[:vintage]
-        standard = Standard.build(@hash[:vintage])
+        standard = Standard.build(@@vintage_mapper[@hash[:vintage].to_sym])
       else
-        standard = Standard.build(hvac_defaults[:vintage][:default])
+        standard = Standard.build(@@vintage_mapper[hvac_defaults[:vintage][:default].to_sym])
       end
 
       # get the default equipment type
@@ -120,7 +128,43 @@ module Honeybee
         erv.setLatentEffectivenessat75HeatingAirFlow(@hash[:latent_heat_recovery])
       end
 
-      # set all plants to non-coincident sizing to avoid simualtion control on design days
+      # if the systems are PTAC and there is ventilation, ensure the system includes it
+      if equipment_type.include?('PTAC') || equipment_type.include?('PTHP')
+        always_on = openstudio_model.getScheduleByName('Always On').get
+        zones.each do |zone|
+          # check if the space type has ventilation assigned to it
+          out_air = zone.spaces[0].designSpecificationOutdoorAir
+          unless out_air.empty?
+            # get any ventilation schedules
+            vent_sched = always_on
+            out_air = out_air.get
+            air_sch = out_air.outdoorAirFlowRateFractionSchedule
+            unless air_sch.empty?
+              vent_sched = air_sch.get
+            end
+            # get the PTAC object
+            ptac = nil
+            zone.equipment.each do |equip|
+              e_name = equip.name
+              unless e_name.empty?
+                e_name = e_name.get
+                if e_name.include? 'PTAC'
+                  ptac = openstudio_model.getZoneHVACPackagedTerminalAirConditioner(equip.handle)
+                elsif e_name.include? 'PTHP'
+                  ptac = openstudio_model.getZoneHVACPackagedTerminalHeatPump(equip.handle)
+                end
+              end
+            end
+            # assign the schedule to the PTAC object
+            unless ptac.nil? || ptac.empty?
+              ptac = ptac.get
+              ptac.setSupplyAirFanOperatingModeSchedule(vent_sched)
+            end
+          end
+        end
+      end
+
+      # set all plants to non-coincident sizing to avoid simualtion control issues on design days
       openstudio_model.getPlantLoops.each do |loop|
         sizing = loop.sizingPlant
         sizing.setSizingOption('NonCoincident')

data/lib/to_openstudio/load/daylight.rb

@@ -0,0 +1,100 @@
+# *******************************************************************************
+# Honeybee OpenStudio Gem, Copyright (c) 2020, Alliance for Sustainable
+# Energy, LLC, Ladybug Tools LLC and other contributors. All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# (1) Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+#
+# (2) Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation
+# and/or other materials provided with the distribution.
+#
+# (3) Neither the name of the copyright holder nor the names of any contributors
+# may be used to endorse or promote products derived from this software without
+# specific prior written permission from the respective party.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) AND ANY CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S), ANY CONTRIBUTORS, THE
+# UNITED STATES GOVERNMENT, OR THE UNITED STATES DEPARTMENT OF ENERGY, NOR ANY OF
+# THEIR EMPLOYEES, BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
+# OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+# STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+# *******************************************************************************
+
+require 'honeybee/load/daylight'
+
+require 'to_openstudio/model_object'
+
+module Honeybee
+  class DaylightingControl
+
+    def find_existing_openstudio_object(openstudio_model, parent_space_name)
+      dl_cntrl_name = parent_space_name + '_Daylighting'
+      model_dl_cntrl = openstudio_model.getDaylightingControlByName(dl_cntrl_name)
+      return model_dl_cntrl.get unless model_dl_cntrl.empty?
+      nil
+    end
+
+    def to_openstudio(openstudio_model, parent_zone, parent_space)
+      # create daylighting control openstudio object and set identifier
+      os_dl_control = OpenStudio::Model::DaylightingControl.new(openstudio_model)
+      space_name = parent_space.name
+      unless space_name.empty?
+        os_dl_control.setName(parent_space.name.get + '_Daylighting')
+      end
+      os_dl_control.setSpace(parent_space)
+      parent_zone.setPrimaryDaylightingControl(os_dl_control)
+
+      # assign the position of the sensor point
+      os_dl_control.setPositionXCoordinate(@hash[:sensor_position][0])
+      os_dl_control.setPositionYCoordinate(@hash[:sensor_position][1])
+      os_dl_control.setPositionZCoordinate(@hash[:sensor_position][2])
+
+      # assign the illuminance setpoint if it exists
+      if @hash[:illuminance_setpoint]
+        os_dl_control.setIlluminanceSetpoint(@hash[:illuminance_setpoint])
+      else
+        os_dl_control.setIlluminanceSetpoint(defaults[:illuminance_setpoint][:default])
+      end
+
+      # assign power fraction if it exists
+      if @hash[:min_power_input]
+        os_dl_control.setMinimumInputPowerFractionforContinuousDimmingControl(@hash[:min_power_input])
+      else
+        os_dl_control.setMinimumInputPowerFractionforContinuousDimmingControl(defaults[:min_power_input][:default])
+      end
+
+      # assign light output fraction if it exists
+      if @hash[:min_power_input]
+        os_dl_control.setMinimumLightOutputFractionforContinuousDimmingControl(@hash[:min_light_output])
+      else
+        os_dl_control.setMinimumLightOutputFractionforContinuousDimmingControl(defaults[:min_light_output][:default])
+      end
+
+      # set whether the lights go off when they reach their minimum
+      if @hash[:off_at_minimum]
+        os_dl_control.setLightingControlType('Continuous/Off')
+      else
+        os_dl_control.setLightingControlType('Continuous')
+      end
+
+      # set the fraction of the zone lights that are dimmed
+      if @hash[:control_fraction]
+        parent_zone.setFractionofZoneControlledbyPrimaryDaylightingControl(@hash[:control_fraction])
+      else
+        parent_zone.setFractionofZoneControlledbyPrimaryDaylightingControl(defaults[:control_fraction][:default])
+      end
+
+      os_dl_control
+    end
+
+  end #DaylightingControl
+end #Honeybee

metadata

@@ -1,102 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: honeybee-openstudio
 version: !ruby/object:Gem::Version
-  version: 2.11.0
+  version: 2.12.1
 platform: ruby
 authors:
 - Tanushree Charan
 - Dan Macumber
 - Chris Mackey
 - Mostapha Sadeghipour Roudsari
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-01-06 00:00:00.000000000 Z
+date: 2021-03-26 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
-- !ruby/object:Gem::Dependency
-  name: public_suffix
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.1.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.1.1
-- !ruby/object:Gem::Dependency
-  name: json-schema
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.8.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.8.1
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.9'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.54.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.54.0
 - !ruby/object:Gem::Dependency
   name: json_pure
   requirement: !ruby/object:Gem::Requirement
@@ -196,6 +112,7 @@ files:
 - lib/honeybee/geometry/shade.rb
 - lib/honeybee/hvac/ideal_air.rb
 - lib/honeybee/hvac/template.rb
+- lib/honeybee/load/daylight.rb
 - lib/honeybee/load/electric_equipment.rb
 - lib/honeybee/load/gas_equipment.rb
 - lib/honeybee/load/infiltration.rb
@@ -252,6 +169,7 @@ files:
 - lib/to_openstudio/hvac/Model.hvac.rb
 - lib/to_openstudio/hvac/ideal_air.rb
 - lib/to_openstudio/hvac/template.rb
+- lib/to_openstudio/load/daylight.rb
 - lib/to_openstudio/load/electric_equipment.rb
 - lib/to_openstudio/load/gas_equipment.rb
 - lib/to_openstudio/load/infiltration.rb
@@ -284,24 +202,23 @@ files:
 homepage: https://github.com/ladybug-tools/honeybee-openstudio-gem
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Gem for translating between Honeybee JSON and OpenStudio Model.
 test_files: []