buildingsync 0.2.0

data/lib/buildingsync/model_articulation/building_and_system_types.json

@@ -0,0 +1,121 @@
+{
+  "Retail": [{
+    "standards_building_type": "RetailStandalone",
+    "bar_division_method": "Multiple Space Types - Individual Stories Sliced",
+    "system_type": "PSZ-AC with gas coil heat"
+  }],
+  "Office": [
+    {
+      "standards_building_type": "SmallOffice",
+      "bar_division_method": "Single Space Type - Core and Perimeter",
+      "system_type": "PSZ-AC with gas coil heat",
+      "max_floor_area": "20000"
+    },
+    {
+      "standards_building_type": "MediumOffice",
+      "bar_division_method": "Single Space Type - Core and Perimeter",
+      "system_type": "PVAV with reheat",
+      "min_floor_area": "20000",
+      "max_floor_area": "75000"
+    },
+    {
+      "standards_building_type": "LargeOffice",
+      "bar_division_method": "Single Space Type - Core and Perimeter",
+      "system_type": "VAV with reheat",
+      "min_floor_area": "75000"
+    }
+  ],
+  "StripMall": [{
+    "standards_building_type": "RetailStripmall",
+    "bar_division_method": "Single Space Type - Core and Perimeter",
+    "system_type": "PSZ-AC with gas coil heat"
+  }],
+  "Education-Primary": [{
+    "standards_building_type": "PrimarySchool",
+    "bar_division_method": "Single Space Type - Core and Perimeter",
+    "system_type": "PVAV with reheat"
+  }],
+  "Education-Secondary": [{
+    "standards_building_type": "SecondarySchool",
+    "bar_division_method": "Single Space Type - Core and Perimeter",
+    "system_type": "VAV with reheat"
+  }],
+  "Health care-Outpatient rehabilitation": [{
+    "standards_building_type": "Outpatient",
+    "bar_division_method": "Single Space Type - Core and Perimeter",
+    "system_type": "PVAV with reheat"
+  }],
+  "Health care-Outpatient facility": [{
+    "standards_building_type": "Outpatient",
+    "bar_division_method": "Single Space Type - Core and Perimeter",
+    "system_type": "PVAV with reheat"
+  }],
+  "Health care-Outpatient non-diagnostic": [{
+    "standards_building_type": "Outpatient",
+    "bar_division_method": "Single Space Type - Core and Perimeter",
+    "system_type": "PVAV with reheat"
+  }],
+  "Health care-Outpatient surgical": [{
+    "standards_building_type": "Outpatient",
+    "bar_division_method": "Single Space Type - Core and Perimeter",
+    "system_type": "PVAV with reheat"
+  }],
+  "Health care-Inpatient hospital": [{
+    "standards_building_type": "Hospital",
+    "bar_division_method": "Single Space Type - Core and Perimeter",
+    "system_type": "VAV with reheat"
+  }],
+  "Lodging": [
+    {
+      "standards_building_type": "SmallHotel",
+      "bar_division_method": "Single Space Type - Core and Perimeter",
+      "system_type": "PTAC with electric baseboard heat",
+      "max_floor_area": "50000"
+    },
+    {
+      "standards_building_type": "LargeHotel",
+      "bar_division_method": "Single Space Type - Core and Perimeter",
+      "system_type": "VAV with reheat",
+      "min_floor_area": "50000"
+    }
+  ],
+  "Food service-Fast": [{
+    "standards_building_type": "QuickServiceRestaurant",
+    "bar_division_method": "Single Space Type - Core and Perimeter",
+    "system_type": "PSZ-AC with gas coil heat"
+  }],
+  "Food service-Full": [{
+    "standards_building_type": "FullServiceRestaurant",
+    "bar_division_method": "Single Space Type - Core and Perimeter",
+    "system_type": "PSZ-AC with gas coil heat"
+  }],
+  "Food service": [{
+    "standards_building_type": "FullServiceRestaurant",
+    "bar_division_method": "Single Space Type - Core and Perimeter",
+    "system_type": "PSZ-AC with gas coil heat"
+  }],
+  "Multifamily": [
+    {
+      "standards_building_type": "MidriseApartment",
+      "bar_division_method": "Single Space Type - Core and Perimeter",
+      "system_type": "PTAC",
+      "max_number_floors": "10"
+    },
+    {
+      "standards_building_type": "HighriseApartment",
+      "bar_division_method": "Single Space Type - Core and Perimeter",
+      "system_type": "PSZ-HP",
+      "min_number_floors": "10"
+    }
+  ],
+  "Warehouse": [{
+    "standards_building_type": "Warehouse",
+    "bar_division_method": "Single Space Type - Core and Perimeter",
+    "system_type": "PSZ-AC with gas coil heat"
+  }],
+  "Food sales-Grocery store": [{
+    "standards_building_type": "SuperMarket",
+    "bar_division_method": "Single Space Type - Core and Perimeter",
+    "system_type": "PSZ-AC with gas coil heat"
+  }]
+}

data/lib/buildingsync/model_articulation/building_section.rb

@@ -0,0 +1,190 @@
+# frozen_string_literal: true
+
+# *******************************************************************************
+# OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
+# BuildingSync(R), Copyright (c) 2015-2020, Alliance for Sustainable Energy, LLC.
+# 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.
+#
+# (4) Other than as required in clauses (1) and (2), distributions in any form
+# of modifications or other derivative works may not use the "OpenStudio"
+# trademark, "OS", "os", or any other confusingly similar designation without
+# specific prior written permission from Alliance for Sustainable Energy, LLC.
+#
+# 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 'openstudio-standards'
+
+require 'buildingsync/constants'
+require 'buildingsync/helpers/helper'
+
+module BuildingSync
+  # BuildingSection class
+  class BuildingSection < SpatialElement
+    include OpenstudioStandards
+    include BuildingSync::Helper
+    include BuildingSync::XmlGetSet
+    # initialize
+    # @param base_xml [REXML:Element] an element corresponding to a single auc:Section
+    # @param bldgsync_occ_type [String] Office, Retail, etc.
+    # @param building_total_floor_area [Float]
+    # @param num_stories [Float]
+    # @param ns [String] namespace, likely 'auc'
+    def initialize(base_xml, building_occupancy_classification, building_total_floor_area, num_stories, ns)
+      super(base_xml, ns)
+      @base_xml = base_xml
+      @ns = ns
+
+      help_element_class_type_check(base_xml, 'Section')
+
+      @door_ids = []
+      @wall_ids = []
+      @window_ids = []
+      @roof_ids = []
+      @skylight_ids = []
+      @exterior_floor_ids = []
+      @foundation_ids = []
+
+      # parameter to read and write.
+      @fraction_area = nil
+      @standards_building_type = nil
+      @occupancy_classification_original = nil
+      @typical_occupant_usage_value_hours = nil
+      @typical_occupant_usage_value_weeks = nil
+      @occupant_quantity = nil
+      @principal_hvac_type = nil
+      @num_stories = num_stories
+
+      @total_floor_area = read_floor_areas(building_total_floor_area)
+      xset_or_create('OccupancyClassification', building_occupancy_classification, false)
+
+      # code to initialize
+      read_xml
+    end
+
+    # read xml
+    # @param building_occupancy_classification [String]
+    # @param building_total_floor_area [Float]
+    def read_xml
+      # floor areas
+      # based on the occupancy type set building type, system type and bar division method
+      read_building_section_other_detail
+      read_construction_types
+
+      if @base_xml.elements["#{@ns}:OccupancyLevels/#{@ns}:OccupancyLevel/#{@ns}:OccupantQuantity"]
+        @occupant_quantity = @base_xml.elements["#{@ns}:OccupancyLevels/#{@ns}:OccupancyLevel/#{@ns}:OccupantQuantity"].text
+      else
+        @occupant_quantity = nil
+      end
+    end
+
+    # read building section other details
+    def read_building_section_other_detail
+      if @base_xml.elements["#{@ns}:TypicalOccupantUsages"]
+        @base_xml.elements.each("#{@ns}:TypicalOccupantUsages/#{@ns}:TypicalOccupantUsage") do |occ_usage|
+          if occ_usage.elements["#{@ns}:TypicalOccupantUsageUnits"].text == 'Hours per week'
+            @typical_occupant_usage_value_hours = occ_usage.elements["#{@ns}:TypicalOccupantUsageValue"].text
+          elsif occ_usage.elements["#{@ns}:TypicalOccupantUsageUnits"].text == 'Weeks per year'
+            @typical_occupant_usage_value_weeks = occ_usage.elements["#{@ns}:TypicalOccupantUsageValue"].text
+          end
+        end
+      end
+
+      if @base_xml.elements["#{@ns}:OccupancyLevels"]
+        @base_xml.elements.each("#{@ns}:OccupancyLevels/#{@ns}:OccupancyLevel") do |occ_level|
+          if occ_level.elements["#{@ns}:OccupantQuantityType"].text == 'Peak total occupants'
+            @occupant_quantity = occ_level.elements["#{@ns}:OccupantQuantity"].text
+          end
+        end
+      end
+    end
+
+    # read construction types
+    def read_construction_types
+      if @base_xml.elements["#{@ns}:Sides"]
+        @base_xml.elements.each("#{@ns}:Sides/#{@ns}:Side/#{@ns}:DoorID") do |door|
+          @door_ids.push(door.attributes['IDref'])
+        end
+        @base_xml.elements.each("#{@ns}:Sides/#{@ns}:Side/#{@ns}:WallID") do |wall|
+          @wall_ids.push(wall.attributes['IDref'])
+        end
+        @base_xml.elements.each("#{@ns}:Sides/#{@ns}:Side/#{@ns}:WindowID") do |window|
+          @window_ids.push(window.attributes['IDref'])
+        end
+      end
+      if @base_xml.elements["#{@ns}:Roofs"]
+        @base_xml.elements.each("#{@ns}:Roofs/#{@ns}:Roof/#{@ns}:RoofID") do |roof|
+          @roof_ids.push(roof.attributes['IDref'])
+        end
+        @base_xml.elements.each("#{@ns}:Roofs/#{@ns}:Roof/#{@ns}:RoofID/#{@ns}:SkylightIDs/#{@ns}:SkylightID") do |skylight|
+          @skylight_ids.push(skylight.attributes['IDref'])
+        end
+      end
+      if @base_xml.elements["#{@ns}:ExteriorFloors"]
+        @base_xml.elements.each("#{@ns}:ExteriorFloors/#{@ns}:ExteriorFloor/#{@ns}:ExteriorFloorID ") do |floor|
+          @exterior_floor_ids.push(floor.attributes['IDref'])
+        end
+      end
+      if @base_xml.elements["#{@ns}:Foundations"]
+        @base_xml.elements.each("#{@ns}:Foundations/#{@ns}:Foundation/#{@ns}:FoundationID  ") do |foundation|
+          @foundation_ids.push(foundation.attributes['IDref'])
+        end
+      end
+    end
+
+    # add principal hvac type
+    def prepare_final_xml
+      @base_xml.elements["#{@ns}:fraction_area"].text = @fraction_area
+      @base_xml.elements["#{@ns}:OriginalOccupancyClassification"].text = @occupancy_classification_original if !@occupancy_classification_original.nil?
+
+      @base_xml.elements["#{@ns}:TypicalOccupantUsages/#{@ns}:TypicalOccupantUsage/#{@ns}:TypicalOccupantUsageValue"].text = @typical_occupant_usage_value_hours if !@typical_occupant_usage_value_hours.nil?
+      @base_xml.elements["#{@ns}:TypicalOccupantUsages/#{@ns}:TypicalOccupantUsage/#{@ns}:TypicalOccupantUsageValue"].text = @typical_occupant_usage_value_weeks if !@typical_occupant_usage_value_weeks.nil?
+      @base_xml.elements["#{@ns}:OccupancyLevels/#{@ns}:OccupancyLevel/#{@ns}:OccupantQuantity"].text = @occupant_quantity if !@occupant_quantity.nil?
+
+      prepare_final_xml_for_spatial_element
+    end
+
+    # set building and system type
+    def set_bldg_and_system_type
+      super(xget_text('OccupancyClassification'), @total_floor_area, @number_floors, false)
+    end
+
+    # get peak occupancy
+    # @return [String]
+    def get_peak_occupancy
+      return @occupant_quantity
+    end
+
+    # get floor area of this building section
+    # @return [Float]
+    def get_floor_area
+      return @total_floor_area
+    end
+
+    attr_reader :space_types_floor_area, :occupancy_classification, :typical_occupant_usage_value_weeks, :typical_occupant_usage_value_hours, :standards_building_type, :section_type, :id
+    attr_accessor :fraction_area
+  end
+end

data/lib/buildingsync/model_articulation/building_system.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# *******************************************************************************
+# OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
+# BuildingSync(R), Copyright (c) 2015-2020, Alliance for Sustainable Energy, LLC.
+# 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.
+#
+# (4) Other than as required in clauses (1) and (2), distributions in any form
+# of modifications or other derivative works may not use the "OpenStudio"
+# trademark, "OS", "os", or any other confusingly similar designation without
+# specific prior written permission from Alliance for Sustainable Energy, LLC.
+#
+# 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 'buildingsync/helpers/helper'
+require 'buildingsync/helpers/xml_get_set'
+
+module BuildingSync
+  # BuildingSystem class to share functionality between system classes
+  class BuildingSystem
+    # no features here yet
+    include BuildingSync::Helper
+    include BuildingSync::XmlGetSet
+  end
+end

data/lib/buildingsync/model_articulation/envelope_system.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+# *******************************************************************************
+# OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
+# BuildingSync(R), Copyright (c) 2015-2020, Alliance for Sustainable Energy, LLC.
+# 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.
+#
+# (4) Other than as required in clauses (1) and (2), distributions in any form
+# of modifications or other derivative works may not use the "OpenStudio"
+# trademark, "OS", "os", or any other confusingly similar designation without
+# specific prior written permission from Alliance for Sustainable Energy, LLC.
+#
+# 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_relative 'building_system'
+module BuildingSync
+  # EnvelopeSystem class
+  class EnvelopeSystem < BuildingSystem
+    # initialize
+    def initialize
+      # code to initialize
+    end
+
+    # add internal loads from standard definitions
+    # @param model [OpenStudio::Model]
+    # @param standard [Standard]
+    # @param primary_bldg_type [String]
+    # @param lookup_building_type [String]
+    # @param remove_objects [Boolean]
+    # @return [Boolean]
+    def create(model, standard, primary_bldg_type, lookup_building_type, remove_objects)
+      # remove default construction sets
+      if remove_objects
+        model.getDefaultConstructionSets.each(&:remove)
+      end
+
+      # TODO: - allow building type and space type specific constructions set selection.
+      if ['SmallHotel', 'LargeHotel', 'MidriseApartment', 'HighriseApartment'].include?(primary_bldg_type)
+        is_residential = 'Yes'
+      else
+        is_residential = 'No'
+      end
+      climate_zone = standard.model_get_building_climate_zone_and_building_type(model)['climate_zone']
+      OpenStudio.logFree(OpenStudio::Error, 'BuildingSync.Facility.create_building_system', 'Could not find climate zone in the model. Verify that the climate zone is set in the BuildingSync File or can be derived from other inputs.') if climate_zone.nil?
+      bldg_def_const_set = standard.model_add_construction_set(model, climate_zone, lookup_building_type, nil, is_residential)
+      if bldg_def_const_set.is_initialized
+        bldg_def_const_set = bldg_def_const_set.get
+        if is_residential then bldg_def_const_set.setName("Res #{bldg_def_const_set.name}") end
+        model.getBuilding.setDefaultConstructionSet(bldg_def_const_set)
+        OpenStudio.logFree(OpenStudio::Info, 'BuildingSync.Facility.create_building_system', "Adding default construction set named #{bldg_def_const_set.name}")
+        puts "Adding default construction set named #{bldg_def_const_set.name} in climate zone #{climate_zone}"
+      else
+        OpenStudio.logFree(OpenStudio::Error, 'BuildingSync.Facility.create_building_system', "Could not create default construction set for the building type #{lookup_building_type} in climate zone #{climate_zone}.")
+        return false
+      end
+
+      # address any adiabatic surfaces that don't have hard assigned constructions
+      model.getSurfaces.each do |surface|
+        next if surface.outsideBoundaryCondition != 'Adiabatic'
+        next if surface.construction.is_initialized
+
+        surface.setAdjacentSurface(surface)
+        surface.setConstruction(surface.construction.get)
+        surface.setOutsideBoundaryCondition('Adiabatic')
+      end
+
+      # Modify the infiltration rates
+      if remove_objects
+        model.getSpaceInfiltrationDesignFlowRates.each(&:remove)
+      end
+      standard.model_apply_infiltration_standard(model)
+      standard.model_modify_infiltration_coefficients(model, primary_bldg_type, climate_zone)
+
+      # set ground temperatures from DOE prototype buildings
+      standard.model_add_ground_temperatures(model, primary_bldg_type, climate_zone)
+    end
+  end
+end