openstudio-standards 0.8.3 → 0.8.5.rc1

data/lib/openstudio-standards/hvac/helpers.rb

@@ -0,0 +1,357 @@
+module OpenstudioStandards
+  # The HVAC module provides methods create, modify, and get information about HVAC systems in the model
+  module HVAC
+    # @!group Helpers
+    # Helper methods to remove HVAC equipment, rename nodes, and rename HVAC equipment
+
+    # Remove all air loops in model
+    #
+    # @param model [OpenStudio::Model::Model] OpenStudio model object
+    # @return [OpenStudio::Model::Model] OpenStudio model object
+    def self.remove_air_loops(model)
+      model.getAirLoopHVACs.each(&:remove)
+
+      return model
+    end
+
+    # Remove plant loops in model except those used for service hot water
+    #
+    # @param model [OpenStudio::Model::Model] OpenStudio model object
+    # @return [OpenStudio::Model::Model] OpenStudio model object
+    def self.remove_plant_loops(model)
+      plant_loops = model.getPlantLoops
+      plant_loops.each do |plant_loop|
+        shw_use = false
+        plant_loop.demandComponents.each do |component|
+          if component.to_WaterUseConnections.is_initialized || component.to_CoilWaterHeatingDesuperheater.is_initialized
+            shw_use = true
+            OpenStudio.logFree(OpenStudio::Info, 'openstudio.model.Model', "#{plant_loop.name} is used for SHW or refrigeration heat reclaim and will not be removed.")
+            break
+          end
+        end
+        plant_loop.remove unless shw_use
+      end
+
+      return model
+    end
+
+    # Remove all plant loops in model including those used for service hot water
+    #
+    # @param model [OpenStudio::Model::Model] OpenStudio model object
+    # @return [OpenStudio::Model::Model] OpenStudio model object
+    def self.remove_all_plant_loops(model)
+      model.getPlantLoops.each(&:remove)
+
+      return model
+    end
+
+    # Remove VRF units
+    #
+    # @param model [OpenStudio::Model::Model] OpenStudio model object
+    # @return [OpenStudio::Model::Model] OpenStudio model object
+    def self.remove_vrf(model)
+      model.getAirConditionerVariableRefrigerantFlows.each(&:remove)
+      model.getZoneHVACTerminalUnitVariableRefrigerantFlows.each(&:remove)
+
+      return model
+    end
+
+    # Remove zone equipment except for exhaust fans
+    #
+    # @param model [OpenStudio::Model::Model] OpenStudio model object
+    # @return [OpenStudio::Model::Model] OpenStudio model object
+    def self.remove_zone_equipment(model)
+      model.getThermalZones.each do |zone|
+        zone.equipment.each do |equipment|
+          if equipment.to_FanZoneExhaust.is_initialized
+            OpenStudio.logFree(OpenStudio::Info, 'openstudio.model.Model', "#{equipment.name} is a zone exhaust fan and will not be removed.")
+          else
+            equipment.remove
+          end
+        end
+      end
+
+      return model
+    end
+
+    # Remove all zone equipment including exhaust fans
+    #
+    # @param model [OpenStudio::Model::Model] OpenStudio model object
+    # @return [OpenStudio::Model::Model] OpenStudio model object
+    def self.remove_all_zone_equipment(model)
+      model.getThermalZones.each do |zone|
+        zone.equipment.each(&:remove)
+      end
+
+      return model
+    end
+
+    # Remove unused performance curves
+    #
+    # @param model [OpenStudio::Model::Model] OpenStudio model object
+    # @return [OpenStudio::Model::Model] OpenStudio model object
+    def self.remove_unused_curves(model)
+      model.getCurves.each do |curve|
+        if curve.directUseCount == 0
+          model.removeObject(curve.handle)
+        end
+      end
+
+      return model
+    end
+
+    # Remove HVAC equipment except for service hot water loops and zone exhaust fans
+    #
+    # @param model [OpenStudio::Model::Model] OpenStudio model object
+    # @return [OpenStudio::Model::Model] OpenStudio model object
+    def self.remove_hvac(model)
+      OpenstudioStandards::HVAC.remove_air_loops(model)
+      OpenstudioStandards::HVAC.remove_plant_loops(model)
+      OpenstudioStandards::HVAC.remove_vrf(model)
+      OpenstudioStandards::HVAC.remove_zone_equipment(model)
+      OpenstudioStandards::HVAC.remove_unused_curves(model)
+
+      return model
+    end
+
+    # Remove all HVAC equipment including service hot water loops and zone exhaust fans
+    #
+    # @param model [OpenStudio::Model::Model] OpenStudio model object
+    # @return [OpenStudio::Model::Model] OpenStudio model object
+    def self.remove_all_hvac(model)
+      OpenstudioStandards::HVAC.remove_air_loops(model)
+      OpenstudioStandards::HVAC.remove_all_plant_loops(model)
+      OpenstudioStandards::HVAC.remove_vrf(model)
+      OpenstudioStandards::HVAC.remove_all_zone_equipment(model)
+      OpenstudioStandards::HVAC.remove_unused_curves(model)
+
+      return model
+    end
+
+    # renames air loop nodes to readable values
+    #
+    # @param model [OpenStudio::Model::Model] OpenStudio model object
+    # @return [OpenStudio::Model::Model] OpenStudio model object
+    def self.rename_air_loop_nodes(model)
+      # rename all hvac components on air loops
+      model.getHVACComponents.sort.each do |component|
+        next if component.to_Node.is_initialized # skip nodes
+
+        unless component.airLoopHVAC.empty?
+          # rename water to air component outlet nodes
+          if component.to_WaterToAirComponent.is_initialized
+            component = component.to_WaterToAirComponent.get
+            unless component.airOutletModelObject.empty?
+              component_outlet_object = component.airOutletModelObject.get
+              next unless component_outlet_object.to_Node.is_initialized
+
+              component_outlet_object.setName("#{component.name} Outlet Air Node")
+            end
+          end
+
+          # rename air to air component nodes
+          if component.to_AirToAirComponent.is_initialized
+            component = component.to_AirToAirComponent.get
+            unless component.primaryAirOutletModelObject.empty?
+              component_outlet_object = component.primaryAirOutletModelObject.get
+              next unless component_outlet_object.to_Node.is_initialized
+
+              component_outlet_object.setName("#{component.name} Primary Outlet Air Node")
+            end
+            unless component.secondaryAirInletModelObject.empty?
+              component_inlet_object = component.secondaryAirInletModelObject.get
+              next unless component_inlet_object.to_Node.is_initialized
+
+              component_inlet_object.setName("#{component.name} Secondary Inlet Air Node")
+            end
+          end
+
+          # rename straight component outlet nodes
+          if component.to_StraightComponent.is_initialized && !component.to_StraightComponent.get.outletModelObject.empty?
+            component_outlet_object = component.to_StraightComponent.get.outletModelObject.get
+            next unless component_outlet_object.to_Node.is_initialized
+
+            component_outlet_object.setName("#{component.name} Outlet Air Node")
+          end
+        end
+
+        # rename zone hvac component nodes
+        if component.to_ZoneHVACComponent.is_initialized
+          component = component.to_ZoneHVACComponent.get
+          unless component.airInletModelObject.empty?
+            component_inlet_object = component.airInletModelObject.get
+            next unless component_inlet_object.to_Node.is_initialized
+
+            component_inlet_object.setName("#{component.name} Inlet Air Node")
+          end
+          unless component.airOutletModelObject.empty?
+            component_outlet_object = component.airOutletModelObject.get
+            next unless component_outlet_object.to_Node.is_initialized
+
+            component_outlet_object.setName("#{component.name} Outlet Air Node")
+          end
+        end
+      end
+
+      # rename supply side nodes
+      model.getAirLoopHVACs.sort.each do |air_loop|
+        air_loop_name = air_loop.name.to_s
+        air_loop.demandInletNode.setName("#{air_loop_name} Demand Inlet Node")
+        air_loop.demandOutletNode.setName("#{air_loop_name} Demand Outlet Node")
+        air_loop.supplyInletNode.setName("#{air_loop_name} Supply Inlet Node")
+        air_loop.supplyOutletNode.setName("#{air_loop_name} Supply Outlet Node")
+
+        unless air_loop.reliefAirNode.empty?
+          relief_node = air_loop.reliefAirNode.get
+          relief_node.setName("#{air_loop_name} Relief Air Node")
+        end
+
+        unless air_loop.mixedAirNode.empty?
+          mixed_node = air_loop.mixedAirNode.get
+          mixed_node.setName("#{air_loop_name} Mixed Air Node")
+        end
+
+        # rename outdoor air system and nodes
+        unless air_loop.airLoopHVACOutdoorAirSystem.empty?
+          oa_system = air_loop.airLoopHVACOutdoorAirSystem.get
+          unless oa_system.outboardOANode.empty?
+            oa_node = oa_system.outboardOANode.get
+            oa_node.setName("#{air_loop_name} Outdoor Air Node")
+          end
+        end
+      end
+
+      # rename zone air and terminal nodes
+      model.getThermalZones.sort.each do |zone|
+        zone.zoneAirNode.setName("#{zone.name} Zone Air Node")
+
+        unless zone.returnAirModelObject.empty?
+          zone.returnAirModelObject.get.setName("#{zone.name} Return Air Node")
+        end
+
+        unless zone.airLoopHVACTerminal.empty?
+          terminal_unit = zone.airLoopHVACTerminal.get
+          if terminal_unit.to_StraightComponent.is_initialized
+            component = terminal_unit.to_StraightComponent.get
+            component.inletModelObject.get.setName("#{terminal_unit.name} Inlet Air Node")
+          end
+        end
+      end
+
+      # rename zone equipment list objects
+      model.getZoneHVACEquipmentLists.sort.each do |obj|
+        begin
+          zone = obj.thermalZone
+          obj.setName("#{zone.name} Zone HVAC Equipment List")
+        rescue StandardError => e
+          OpenStudio.logFree(OpenStudio::Warn, 'openstudio.model.Model', "Removing ZoneHVACEquipmentList #{obj.name}; missing thermal zone.")
+          obj.remove
+        end
+      end
+
+      return model
+    end
+
+    # renames plant loop nodes to readable values
+    #
+    # @param model [OpenStudio::Model::Model] OpenStudio model object
+    # @return [OpenStudio::Model::Model] OpenStudio model object
+    def self.rename_plant_loop_nodes(model)
+      # rename all hvac components on plant loops
+      model.getHVACComponents.sort.each do |component|
+        next if component.to_Node.is_initialized # skip nodes
+
+        unless component.plantLoop.empty?
+          # rename straight component nodes
+          # some inlet or outlet nodes may get renamed again
+          if component.to_StraightComponent.is_initialized
+            unless component.to_StraightComponent.get.inletModelObject.empty?
+              component_inlet_object = component.to_StraightComponent.get.inletModelObject.get
+              next unless component_inlet_object.to_Node.is_initialized
+
+              component_inlet_object.setName("#{component.name} Inlet Water Node")
+            end
+            unless component.to_StraightComponent.get.outletModelObject.empty?
+              component_outlet_object = component.to_StraightComponent.get.outletModelObject.get
+              next unless component_outlet_object.to_Node.is_initialized
+
+              component_outlet_object.setName("#{component.name} Outlet Water Node")
+            end
+          end
+
+          # rename water to air component nodes
+          if component.to_WaterToAirComponent.is_initialized
+            component = component.to_WaterToAirComponent.get
+            unless component.waterInletModelObject.empty?
+              component_inlet_object = component.waterInletModelObject.get
+              next unless component_inlet_object.to_Node.is_initialized
+
+              component_inlet_object.setName("#{component.name} Inlet Water Node")
+            end
+            unless component.waterOutletModelObject.empty?
+              component_outlet_object = component.waterOutletModelObject.get
+              next unless component_outlet_object.to_Node.is_initialized
+
+              component_outlet_object.setName("#{component.name} Outlet Water Node")
+            end
+          end
+
+          # rename water to water component nodes
+          if component.to_WaterToWaterComponent.is_initialized
+            component = component.to_WaterToWaterComponent.get
+            unless component.demandInletModelObject.empty?
+              demand_inlet_object = component.demandInletModelObject.get
+              next unless demand_inlet_object.to_Node.is_initialized
+
+              demand_inlet_object.setName("#{component.name} Demand Inlet Water Node")
+            end
+            unless component.demandOutletModelObject.empty?
+              demand_outlet_object = component.demandOutletModelObject.get
+              next unless demand_outlet_object.to_Node.is_initialized
+
+              demand_outlet_object.setName("#{component.name} Demand Outlet Water Node")
+            end
+            unless component.supplyInletModelObject.empty?
+              supply_inlet_object = component.supplyInletModelObject.get
+              next unless supply_inlet_object.to_Node.is_initialized
+
+              supply_inlet_object.setName("#{component.name} Supply Inlet Water Node")
+            end
+            unless component.supplyOutletModelObject.empty?
+              supply_outlet_object = component.supplyOutletModelObject.get
+              next unless supply_outlet_object.to_Node.is_initialized
+
+              supply_outlet_object.setName("#{component.name} Supply Outlet Water Node")
+            end
+          end
+        end
+      end
+
+      # rename plant nodes
+      model.getPlantLoops.sort.each do |plant_loop|
+        plant_loop_name = plant_loop.name.to_s
+        plant_loop.demandInletNode.setName("#{plant_loop_name} Demand Inlet Node")
+        plant_loop.demandOutletNode.setName("#{plant_loop_name} Demand Outlet Node")
+        plant_loop.supplyInletNode.setName("#{plant_loop_name} Supply Inlet Node")
+        plant_loop.supplyOutletNode.setName("#{plant_loop_name} Supply Outlet Node")
+      end
+
+      return model
+    end
+
+    # converts existing string to ems friendly string
+    #
+    # @param name [String] original name
+    # @return [String] the resulting EMS friendly string
+    def self.ems_friendly_name(name)
+      # replace white space and special characters with underscore
+      # \W is equivalent to [^a-zA-Z0-9_]
+      new_name = name.to_s.gsub(/\W/, '_')
+
+      # prepend ems_ in case the name starts with a number
+      new_name = "ems_#{new_name}"
+
+      return new_name
+    end
+  end
+end

data/lib/openstudio-standards/hvac/setpoint_managers/information.rb

@@ -25,7 +25,7 @@ module OpenstudioStandards
           min_c = OpenstudioStandards::Schedules.schedule_constant_get_min_max(sch.to_ScheduleConstant.get)['min']
           max_c = OpenstudioStandards::Schedules.schedule_constant_get_min_max(sch.to_ScheduleConstant.get)['max']
         else
-          OpenStudio.logFree(OpenStudio::Error, 'openstudio.model.Model', "Could not find min and max values for #{obj_type} Setpoint Manager.")
+          OpenStudio.logFree(OpenStudio::Error, 'openstudio.standards.HVAC', "Could not find min and max values for #{obj_type} Setpoint Manager.")
         end
         loop_op_min_f = OpenStudio.convert(min_c, 'C', 'F').get
         loop_op_max_f = OpenStudio.convert(max_c, 'C', 'F').get
@@ -53,7 +53,7 @@ module OpenstudioStandards
           elsif low_sch.to_ScheduleConstant.is_initialized
             min_c = OpenstudioStandards::Schedules.schedule_constant_get_min_max(low_sch.to_ScheduleConstant.get)['min']
           else
-            OpenStudio.logFree(OpenStudio::Error, 'openstudio.model.Model', "Could not find min and max values for #{obj_type} Setpoint Manager.")
+            OpenStudio.logFree(OpenStudio::Error, 'openstudio.standards.HVAC', "Could not find min and max values for #{obj_type} Setpoint Manager.")
           end
           loop_op_min_f = OpenStudio.convert(min_c, 'C', 'F').get unless min_c.nil?
         end
@@ -68,7 +68,7 @@ module OpenstudioStandards
           elsif high_sch.to_ScheduleConstant.is_initialized
             max_c = OpenstudioStandards::Schedules.schedule_constant_get_min_max(high_sch.to_ScheduleConstant.get)['max']
           else
-            OpenStudio.logFree(OpenStudio::Error, 'openstudio.model.Model', "Could not find min and max values for #{obj_type} Setpoint Manager.")
+            OpenStudio.logFree(OpenStudio::Error, 'openstudio.standards.HVAC', "Could not find min and max values for #{obj_type} Setpoint Manager.")
           end
           loop_op_max_f = OpenStudio.convert(max_c, 'C', 'F').get unless max_c.nil?
         end
@@ -83,7 +83,7 @@ module OpenstudioStandards
         loop_op_min_f = OpenStudio.convert(spm.minimumSetpointTemperature, 'C', 'F').get
         loop_op_max_f = OpenStudio.convert(spm.maximumSetpointTemperature, 'C', 'F').get
       else
-        OpenStudio.logFree(OpenStudio::Error, 'openstudio.model.Model', "Could not find min and max values for #{obj_type} Setpoint Manager.")
+        OpenStudio.logFree(OpenStudio::Error, 'openstudio.standards.HVAC', "Could not find min and max values for #{obj_type} Setpoint Manager.")
       end
 
       return { 'min_temp' => loop_op_min_f, 'max_temp' => loop_op_max_f }

data/lib/openstudio-standards/interior_lighting/create_lights.rb

@@ -0,0 +1,52 @@
+module OpenstudioStandards
+  # The InteriorLighting module provides methods to create, modify, and get information about interior lighting
+  module InteriorLighting
+    # @!group Create Lights
+    # Methods to create lights objects
+
+    # Adds a lights object to a space or space type.
+    #
+    # @param model [OpenStudio::Model::Model] OpenStudio model object
+    # @param name [String] the name of the lights object
+    # @param lighting_power [Double] lighting power in watts per unit area or per person
+    # @param lighting_power_type [Double] type of lighting power ('Watts/Area', 'Watts/Person'). 'Watts/Area' is W/m^2.
+    # @param return_air_fraction [Double] return air fraction
+    # @param radiant_fraction [Double] radiant fraction
+    # @param visible_fraction [Double] visible fraction
+    # @param space_type [OpenStudio::Model::SpaceType] OpenStudio space type object
+    # @param space [OpenStudio::Model::Space] OpenStudio space object
+    # @return [OpenStudio::Model::Lights] The created lights object
+    def self.create_lights(model,
+                           name: nil,
+                           lighting_power: 5.0,
+                           lighting_power_type: 'Watts/Area',
+                           return_air_fraction: 0.0,
+                           radiant_fraction: 0.365,
+                           visible_fraction: 0.2,
+                           space_type: nil,
+                           space: nil)
+      # create lights definition object
+      lights_def = OpenStudio::Model::LightsDefinition.new(model)
+      lights_def.setName("#{name} Definition") unless name.nil?
+      lights_def.setWattsperSpaceFloorArea(lighting_power) if lighting_power_type == 'Watts/Area'
+      lights_def.setWattsperPerson(lighting_power) if lighting_power_type == 'Watts/Person'
+      lights_def.setReturnAirFraction(return_air_fraction)
+      lights_def.setFractionRadiant(radiant_fraction)
+      lights_def.setFractionVisible(visible_fraction)
+
+      # create lights object
+      lights = OpenStudio::Model::Lights.new(lights_def)
+      lights.setName(name) unless name.nil?
+      if !space_type.nil? && space.nil?
+        lights.setSpaceType(space_type)
+      elsif !space.nil? && space_type.nil?
+        lights.setSpace(space)
+      else
+        OpenStudio.logFree(OpenStudio::Error, 'openstudio.standards.InteriorLighting.create_lights', 'Must pass in either space_type or space.')
+        return nil
+      end
+
+      return lights
+    end
+  end
+end