honeybee-openstudio 2.36.3 → 2.37.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d1fbc207b16eff02f4b762a09827b0fc6cf2e5bbcec27b85439dd1f5038c946e
-  data.tar.gz: '091fc6e1b26594885034f75988b8c97c7fcaf43b0ea6297abeed3d697b8cbb4a'
+  metadata.gz: d55f3b4e41dbed57ccc2aaad7de1254c5a02bd6e4c82c7308e615d9c449326c8
+  data.tar.gz: 4a2078fc0600a51f6441eed73a603b38496e4f4beae780be047f4251c274e880
 SHA512:
-  metadata.gz: b746bb50d8ad80906725481c3dd58d7bdab0cfb94c332b15d6212691d91c3bcf7be1fb3bf5d1e918ca91f3e489580f5c54b398d2066b5e606e4d2db08c9c57c2
-  data.tar.gz: f9d5307ebce3b2425d3d7d48877d91a648364ecc5252a57c4f7bf5eaefed9a7a89869fb166cf0b09a69b616afb5721661be6a0733df5103f7c0025079cbd9143
+  metadata.gz: f5f610b0d0f78fec02e2b4c7523678ca3d0b8db36872a5dd8e389dfafe2cc5ced5c7cb2cb022f33a2c062c4b6a21fb1767795688d4c333dd228e1098c446b371
+  data.tar.gz: 947221a88fb38a8ff3ec815c8a6073f09a2e424286ace005dbcf371f6c5c8e9777c829e6eb9a603e71469c25ec53a4846f4848cc3b675b6457ffeada5bf8971c

data/honeybee-openstudio.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'honeybee-openstudio'
-  spec.version       = '2.36.3'
+  spec.version       = '2.37.0'
   spec.authors       = ['Tanushree Charan', 'Dan Macumber', 'Chris Mackey', 'Mostapha Sadeghipour Roudsari']
   spec.email         = ['tanushree.charan@nrel.gov', 'chris@ladybug.tools']
 

data/lib/honeybee/_defaults/model.json

@@ -3,7 +3,7 @@
   "servers": [],
   "info": {
     "description": "Honeybee model schema.",
-    "version": "1.53.4",
+    "version": "1.54.0",
     "title": "Honeybee Model Schema",
     "contact": {
       "name": "Ladybug Tools",
@@ -889,6 +889,11 @@
       "x-displayName": "VentilationControlType",
       "description": "<SchemaDefinition schemaRef=\"#/components/schemas/VentilationControlType\" />\n"
     },
+    {
+      "name": "ventilationfan_model",
+      "x-displayName": "VentilationFan",
+      "description": "<SchemaDefinition schemaRef=\"#/components/schemas/VentilationFan\" />\n"
+    },
     {
       "name": "ventilationopening_model",
       "x-displayName": "VentilationOpening",
@@ -899,6 +904,11 @@
       "x-displayName": "VentilationSimulationControl",
       "description": "<SchemaDefinition schemaRef=\"#/components/schemas/VentilationSimulationControl\" />\n"
     },
+    {
+      "name": "ventilationtype_model",
+      "x-displayName": "VentilationType",
+      "description": "<SchemaDefinition schemaRef=\"#/components/schemas/VentilationType\" />\n"
+    },
     {
       "name": "view_model",
       "x-displayName": "View",
@@ -1173,8 +1183,10 @@
         "ventilationabridged_model",
         "ventilationcontrolabridged_model",
         "ventilationcontroltype_model",
+        "ventilationfan_model",
         "ventilationopening_model",
         "ventilationsimulationcontrol_model",
+        "ventilationtype_model",
         "view_model",
         "viewtype_model",
         "vintages_model",
@@ -3175,6 +3187,90 @@
         },
         "additionalProperties": false
       },
+      "VentilationType": {
+        "title": "VentilationType",
+        "description": "An enumeration.",
+        "enum": [
+          "Exhaust",
+          "Intake",
+          "Balanced"
+        ],
+        "type": "string"
+      },
+      "VentilationFan": {
+        "title": "VentilationFan",
+        "description": "Base class for all objects requiring a valid EnergyPlus identifier.",
+        "type": "object",
+        "properties": {
+          "identifier": {
+            "title": "Identifier",
+            "description": "Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \\n \\t).",
+            "maxLength": 100,
+            "minLength": 1,
+            "pattern": "^[^,;!\\n\\t]+$",
+            "type": "string"
+          },
+          "flow_rate": {
+            "title": "Flow Rate",
+            "description": "A number for the flow rate of the fan in m3/s.",
+            "exclusiveMinimum": 0,
+            "type": "number",
+            "format": "double"
+          },
+          "pressure_rise": {
+            "title": "Pressure Rise",
+            "description": "A number for the the pressure rise across the fan in Pascals (N/m2). This is often a function of the fan speed and the conditions in which the fan is operating since having the fan blow air through filters or narrow ducts will increase the pressure rise that is needed to deliver the input flow rate. The pressure rise plays an important role in determining the amount of energy consumed by the fan. Smaller fans like a 0.05 m3/s desk fan tend to have lower pressure rises around 60 Pa. Larger fans, such as a 6 m3/s fan used for ventilating a large room tend to have higher pressure rises around 400 Pa. The highest pressure rises are typically for large fans blowing air through ducts and filters, which can have pressure rises as high as 1000 Pa.",
+            "exclusiveMinimum": 0,
+            "type": "number",
+            "format": "double"
+          },
+          "efficiency": {
+            "title": "Efficiency",
+            "description": "A number between 0 and 1 for the overall efficiency of the fan. Specifically, this is the ratio of the power delivered to the fluid to the electrical input power. It is the product of the fan motor efficiency and the fan impeller efficiency. Fans that have a higher blade diameter and operate at lower speeds with smaller pressure rises for their size tend to have higher efficiencies. Because motor efficiencies are typically between 0.8 and 0.9, the best overall fan efficiencies tend to be around 0.7 with most typical fan efficiencies between 0.5 and 0.7. The lowest efficiencies often happen for small fans in situations with high pressure rises for their size, which can result in efficiencies as low as 0.15.",
+            "minimum": 0,
+            "maximum": 1,
+            "type": "number",
+            "format": "double"
+          },
+          "display_name": {
+            "title": "Display Name",
+            "description": "Display name of the object with no character restrictions.",
+            "type": "string"
+          },
+          "type": {
+            "title": "Type",
+            "default": "VentilationFan",
+            "pattern": "^VentilationFan$",
+            "type": "string",
+            "readOnly": true
+          },
+          "ventilation_type": {
+            "description": "Text to indicate the type of type of ventilation. Choose from the options below. For either Exhaust or Intake, values for fan pressure and efficiency define the fan electric consumption. For Exhaust ventilation, the conditions of the air entering the space are assumed to be equivalent to outside air conditions. For Intake and Balanced ventilation, an appropriate amount of fan heat is added to the entering air stream. For Balanced ventilation, both an intake fan and an exhaust fan are assumed to co-exist, both having the same flow rate and power consumption (using the entered values for fan pressure rise and fan total efficiency). Thus, the fan electric consumption for Balanced ventilation is twice that for the Exhaust or Intake ventilation types which employ only a single fan.",
+            "default": "Balanced",
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/VentilationType"
+              }
+            ]
+          },
+          "control": {
+            "title": "Control",
+            "description": "A VentilationControl object that dictates the conditions under which the fan is turned on. If None, a default VentilationControl will be generated, which will keep the fan on all of the time.",
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/VentilationControlAbridged"
+              }
+            ]
+          }
+        },
+        "required": [
+          "identifier",
+          "flow_rate",
+          "pressure_rise",
+          "efficiency"
+        ],
+        "additionalProperties": false
+      },
       "InternalMassAbridged": {
         "title": "InternalMassAbridged",
         "description": "Base class for all objects requiring an EnergyPlus identifier and user_data.",
@@ -3474,6 +3570,14 @@
               }
             ]
           },
+          "fans": {
+            "title": "Fans",
+            "description": "An optional list of VentilationFan objects for fans within the room. Note that these fans are not connected to the heating or cooling system and are meant to represent the intentional circulation of unconditioned outdoor air for the purposes of keeping a space cooler, drier or free of indoor pollutants (as in the case of kitchen or bathroom exhaust fans). For the specification of mechanical ventilation of conditioned outdoor air, the Room.ventilation property should be used and the Room should be given a HVAC that can meet this specification.",
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/VentilationFan"
+            }
+          },
           "internal_masses": {
             "title": "Internal Masses",
             "description": "An optional list of of InternalMass objects for thermal mass exposed to Room air. Note that internal masses assigned this way cannot \"see\" solar radiation that may potentially hit them and, as such, caution should be taken when using this component with internal mass objects that are not always in shade. Masses are factored into the the thermal calculations of the Room by undergoing heat transfer with the indoor air.",
@@ -14519,7 +14623,7 @@
           "version": {
             "title": "Version",
             "description": "Text string for the current version of the schema.",
-            "default": "1.53.4",
+            "default": "1.54.0",
             "pattern": "([0-9]+)\\.([0-9]+)\\.([0-9]+)",
             "type": "string",
             "readOnly": true

data/lib/honeybee/ventcool/fan.rb

@@ -0,0 +1,42 @@
+# *******************************************************************************
+# 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/model_object'
+
+module Honeybee
+  class VentilationFanAbridged < ModelObject
+
+    def defaults
+      @@schema[:components][:schemas][:VentilationFanAbridged][:properties]
+    end
+
+  end #VentilationFanAbridged
+end #Honeybee

data/lib/honeybee.rb

@@ -91,6 +91,7 @@ require 'honeybee/schedule/ruleset'
 
 # import the ventilation and internal mass objects
 require 'honeybee/ventcool/control'
+require 'honeybee/ventcool/fan'
 require 'honeybee/ventcool/opening'
 require 'honeybee/ventcool/simulation'
 require 'honeybee/internalmass'

data/lib/to_openstudio/geometry/room.rb

@@ -435,6 +435,15 @@ module Honeybee
           end
         end
 
+        # assign any ventilation fan loads if specified
+        if @hash[:properties][:energy][:fans]
+          @hash[:properties][:energy][:fans].each do |fan|
+            hb_fan = VentilationFanAbridged.new(fan)
+            os_fan = hb_fan.to_openstudio(openstudio_model, os_thermal_zone)
+            os_fan.addToThermalZone(os_thermal_zone)
+          end
+        end
+
         # assign any internal masses if specified
         if @hash[:properties][:energy][:internal_masses]
           @hash[:properties][:energy][:internal_masses].each do |int_mass|

data/lib/to_openstudio/ventcool/fan.rb

@@ -0,0 +1,117 @@
+# *******************************************************************************
+# 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/ventcool/fan'
+
+require 'to_openstudio/model_object'
+
+module Honeybee
+  class VentilationFanAbridged
+
+    def find_existing_openstudio_object(openstudio_model)
+      model_zone_vent = openstudio_model.getZoneVentilationDesignFlowRateByName(@hash[:identifier])
+      return model_zone_vent.get unless model_zone_vent.empty?
+      nil
+    end
+
+    def to_openstudio(openstudio_model, parent)
+      # create zone ventilation object and set identifier
+      os_zone_vent = OpenStudio::Model::ZoneVentilationDesignFlowRate.new(openstudio_model)
+      os_zone_vent.setName(@hash[:identifier] + '..' + parent.name.get)
+      unless @hash[:display_name].nil?
+        os_zone_vent.setDisplayName(@hash[:display_name])
+      end
+
+      # assign flow rate
+      os_zone_vent.setDesignFlowRate(@hash[:flow_rate])
+      os_zone_vent.setFanPressureRise(@hash[:pressure_rise])
+      os_zone_vent.setFanTotalEfficiency(@hash[:efficiency])
+
+      # assign the ventilation type if it exists
+      if @hash[:ventilation_type]
+        os_zone_vent.setVentilationType(@hash[:ventilation_type])
+      else
+        os_zone_vent.setVentilationType(defaults[:ventilation_type][:default])
+      end
+
+      # set all of the ventilation control properties
+      vent_control_hash = @hash[:control]
+      if vent_control_hash
+        # assign min_indoor_temperature
+        if vent_control_hash[:min_indoor_temperature]
+          os_zone_vent.setMinimumIndoorTemperature(vent_control_hash[:min_indoor_temperature])
+        else
+          os_zone_vent.setMinimumIndoorTemperature(
+            defaults_control[:min_indoor_temperature][:default])
+        end
+        # assign max_indoor_temperature
+        if vent_control_hash[:max_indoor_temperature]
+          os_zone_vent.setMaximumIndoorTemperature(vent_control_hash[:max_indoor_temperature])
+        else
+          os_zone_vent.setMaximumIndoorTemperature(
+            defaults_control[:max_indoor_temperature][:default])
+        end
+        # assign min_outdoor_temperature
+        if vent_control_hash[:min_outdoor_temperature]
+          os_zone_vent.setMinimumOutdoorTemperature(vent_control_hash[:min_outdoor_temperature])
+        else
+          os_zone_vent.setMinimumOutdoorTemperature(
+            defaults_control[:min_outdoor_temperature][:default])
+        end
+        # assign max_outdoor_temperature
+        if vent_control_hash[:max_outdoor_temperature]
+          os_zone_vent.setMaximumOutdoorTemperature(vent_control_hash[:max_outdoor_temperature])
+        else
+          os_zone_vent.setMaximumOutdoorTemperature(
+            defaults_control[:max_outdoor_temperature][:default])
+        end
+        # assign delta_temperature
+        if vent_control_hash[:delta_temperature]
+          os_zone_vent.setDeltaTemperature(vent_control_hash[:delta_temperature])
+        else
+          os_zone_vent.setDeltaTemperature(
+            defaults_control[:delta_temperature][:default])
+        end
+        # assign schedule if it exists
+        if vent_control_hash[:schedule]
+          vent_sch = openstudio_model.getScheduleByName(vent_control_hash[:schedule])
+          unless vent_sch.empty?
+            vent_sch_object = vent_sch.get
+            os_zone_vent.setOpeningAreaFractionSchedule(vent_sch_object)
+          end
+        end
+      end
+
+      os_zone_vent
+    end
+
+  end # VentilationFanAbridged
+end # Honeybee

data/lib/to_openstudio.rb

@@ -91,6 +91,7 @@ require 'to_openstudio/schedule/ruleset'
 
 # import the ventilation and internal mass objects
 require 'to_openstudio/ventcool/control'
+require 'to_openstudio/ventcool/fan'
 require 'to_openstudio/ventcool/opening'
 require 'to_openstudio/ventcool/simulation'
 require 'to_openstudio/internalmass'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: honeybee-openstudio
 version: !ruby/object:Gem::Version
-  version: 2.36.3
+  version: 2.37.0
 platform: ruby
 authors:
 - Tanushree Charan
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-12-02 00:00:00.000000000 Z
+date: 2023-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json_pure
@@ -174,6 +174,7 @@ files:
 - lib/honeybee/simulation/parameter_model.rb
 - lib/honeybee/simulation/simulation_output.rb
 - lib/honeybee/ventcool/control.rb
+- lib/honeybee/ventcool/fan.rb
 - lib/honeybee/ventcool/opening.rb
 - lib/honeybee/ventcool/simulation.rb
 - lib/measures/.gitkeep
@@ -267,6 +268,7 @@ files:
 - lib/to_openstudio/simulation/design_day.rb
 - lib/to_openstudio/simulation/parameter_model.rb
 - lib/to_openstudio/ventcool/control.rb
+- lib/to_openstudio/ventcool/fan.rb
 - lib/to_openstudio/ventcool/opening.rb
 - lib/to_openstudio/ventcool/simulation.rb
 homepage: https://github.com/ladybug-tools/honeybee-openstudio-gem