urbanopt-geojson 0.3.0 → 0.5.2

data/lib/urbanopt/geojson/feature.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+# URBANopt (tm), Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without modification,
@@ -47,9 +47,8 @@ module URBANopt
       # rubocop:disable Style/MethodMissing
       def method_missing(name, *args, &blk)
         # rubocop:enable Style/MethodMissing
-        # rubocop:disable Style/GuardClause
         if @feature_json[:properties].keys.map(&:to_sym).include? name.to_sym
-          # rubocop:enable Style/GuardClause
+
           return @feature_json[:properties][name.to_sym]
         else
           super
@@ -99,6 +98,89 @@ module URBANopt
         return @@feature_schema[feature_type]
       end
 
+      ##
+      # Used to calculate the aspect ratio for a given floor polygon.
+      #
+      def calculate_aspect_ratio
+        multi_polygons = get_multi_polygons(@feature_json)
+        rad_per_deg = 0.017453293
+
+        multi_polygons.each do |multi_polygon|
+          if multi_polygon.size > 1
+            runner.registerWarning('Ignoring holes in polygon')
+          end
+          multi_polygon.each do |polygon|
+            n = polygon.size
+            length = 0
+            north = 0
+            east = 0
+            south = 0
+            west = 0
+            aspect_ratio = 0
+
+            for i in (0..n - 2) do i
+                                   vertex_1 = nil
+                                   vertex_2 = nil
+                                   if i == n - 2
+                                     vertex_1 = polygon[n - 2]
+                                     vertex_2 = polygon[0]
+                                   else
+                                     vertex_1 = polygon[i]
+                                     vertex_2 = polygon[i + 1]
+                                   end
+                                   x_1 = vertex_1[0]
+                                   y_1 = vertex_1[1]
+                                   x_2 = vertex_2[0]
+                                   y_2 = vertex_2[1]
+
+                                   dist = (x_2 - x_1)**2 + (y_2 - y_1)**2
+
+                                   length = Math.sqrt(dist)
+
+                                   # delta latitude
+                                   dlat = x_2 - x_1
+                                   # delta longitude
+                                   dlon = y_2 - y_1
+
+                                   # convert radian to degree
+                                   sin_angle = Math.asin(dlon / length) * (1 / rad_per_deg)
+                                   sin_angle = sin_angle.round(4)
+
+                                   cos_angle = Math.acos(dlat / length) * (1 / rad_per_deg)
+                                   cos_angle = cos_angle.round(4)
+
+                                   if cos_angle >= 45 && cos_angle <= 135 && sin_angle >= 45 && sin_angle <= 90
+                                     north += length
+                                   elsif cos_angle >= 0 && cos_angle < 45 && sin_angle > -45 && sin_angle < 45
+                                     east += length
+                                   elsif  cos_angle >= 45 && cos_angle <= 135 && sin_angle >= -90 && sin_angle <= -45
+                                     south += length
+                                   elsif  cos_angle > 135 && cos_angle <= 180 && sin_angle > -45 && sin_angle < 45
+                                     west += length
+                                   end
+
+                                   if east + west != 0
+                                     aspect_ratio = (north + south) / (east + west)
+                                   else
+                                     aspect_ratio = 1
+                                   end
+
+            end
+
+            aspect_ratio = aspect_ratio.round(4)
+            return aspect_ratio
+          end
+        end
+      end
+
+      ##
+      # Used to calculate the perimeter multiplier given the aspect ratio, original perimeter and area.
+      def get_perimeter_multiplier(area, aspect_ratio, perimeter_original)
+        perimeter_new = 2 * (Math.sqrt(area * aspect_ratio) + Math.sqrt(area / aspect_ratio))
+        perimeter_ratio = perimeter_original / perimeter_new
+        return perimeter_ratio
+      end
+
       ##
       # Returns coordinate with the minimum longitute and latitude within a given +building_json+ .
       def get_min_lon_lat
@@ -168,6 +250,38 @@ module URBANopt
         return OpenStudio::PointLatLon.new(min_lat, min_lon, 0)
       end
 
+      ##
+      # Used to determine the centroid for the feature's coordinates.
+      #
+      # [Parameters]
+      # * +vertices+ - The first set polygon vertices in the array of feature coordinates.
+      def find_feature_center(vertices)
+        number_of_locations = vertices.length
+
+        return vertices.first if number_of_locations == 1
+
+        x = y = z = 0.0
+        vertices.each do |station|
+          latitude = station[0] * Math::PI / 180
+          longitude = station[1] * Math::PI / 180
+
+          x += Math.cos(latitude) * Math.cos(longitude)
+          y += Math.cos(latitude) * Math.sin(longitude)
+          z += Math.sin(latitude)
+        end
+
+        x /= number_of_locations
+        y /= number_of_locations
+        z /= number_of_locations
+
+        central_longitude = Math.atan2(y, x)
+        central_square_root = Math.sqrt(x * x + y * y)
+        central_latitude = Math.atan2(z, central_square_root)
+
+        [central_latitude * 180 / Math::PI,
+         central_longitude * 180 / Math::PI]
+      end
+
       private
 
       ##

data/lib/urbanopt/geojson/geo_file.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+# URBANopt (tm), Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without modification,
@@ -161,9 +161,8 @@ module URBANopt
           if f[:properties] && f[:properties][:id] == feature_id
             # merge site origin properties
             f = merge_site_properties(f)
-            # rubocop:disable Style/GuardClause
             if f[:properties][:type] == 'Building'
-              # rubocop:enable Style/GuardClause
+
               return URBANopt::GeoJSON::Building.new(f)
             elsif f[:properties] && f[:properties][:type] == 'District System'
               return URBANopt::GeoJSON::DistrictSystem.new(f)
@@ -200,7 +199,7 @@ module URBANopt
         add_props.each do |prop|
           if project.key?(prop[:site]) && project[prop[:site]]
             # property exists in site
-            if !feature[:properties].key?(prop[:feature]) || feature[:properties][prop[:feature]].nil? || feature[:properties][prop[:feature]].empty?
+            if !feature[:properties].key?(prop[:feature]) || feature[:properties][prop[:feature]].nil? || feature[:properties][prop[:feature]].to_s.empty?
               # property does not exist in feature or is nil: add site property (don't overwrite)
               feature[:properties][prop[:feature]] = project[prop[:site]]
             end

data/lib/urbanopt/geojson/helper.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+# URBANopt (tm), Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without modification,
@@ -154,7 +154,7 @@ module URBANopt
         stories.each_index do |i|
           space_type = nil
           space = stories[i].spaces.first
-          if space && space.spaceType.is_initialized
+          if space&.spaceType&.is_initialized
             space_type = space.spaceType.get
           else
             space_type = OpenStudio::Model::SpaceType.new(model)
@@ -183,7 +183,9 @@ module URBANopt
       # * +origin_lat_lon+ - _Type:Float_ - An instance of +OpenStudio::PointLatLon+ indicating the origin's latitude and longitude.
       # * +runner+ - _Type:String_ - The measure run's instance of +OpenStudio::Measure::OSRunner+ .
       # * +zoning+ - _Type:Boolean_ - Value is +True+ if utilizing detailed zoning, else +False+. Zoning is set to False by default.
-      def self.floor_print_from_polygon(polygon, elevation, origin_lat_lon, runner, zoning = false)
+      # * +scaled_footprint_area+ - Used to scale the footprint area using the floor area. 0 by
+      #   default (no scaling).
+      def self.floor_print_from_polygon(polygon, elevation, origin_lat_lon, runner, zoning = false, scaled_footprint_area = 0)
         floor_print = OpenStudio::Point3dVector.new
         all_points = OpenStudio::Point3dVector.new
         polygon.each do |p|
@@ -207,9 +209,42 @@ module URBANopt
           floor_print = OpenStudio.reverse(floor_print)
           runner.registerWarning('Reversing floor print')
         end
+
+        # check for scaling
+        if scaled_footprint_area > 0
+
+          # check that the scaled_footprint_area desired is no less than X % of the original
+          original_floor_print_area = OpenStudio.getArea(floor_print).get
+          if scaled_footprint_area / original_floor_print_area <= 0.5 || scaled_footprint_area / original_floor_print_area >= 2
+            # TOO MUCH SCALING...using original footprint when scaled is 2x bigger or smaller than the original
+            runner.registerWarning('Desired scaled_footprint_area is a factor of 2 of the original footprint...keeping original footprint (no scaling!)')
+          else
+            new_floor_print = adjust_vertices_to_area(floor_print, scaled_footprint_area, runner)
+            new_footprint_area = OpenStudio.getArea(new_floor_print).get
+            runner.registerInfo("New floor area: #{new_footprint_area}, compared to scaled area desired: #{scaled_footprint_area}")
+            floor_print = new_floor_print
+          end
+        end
+
         return floor_print
       end
 
+      ##
+      # Used to scale footprint to desired area while keeping the original shape.
+      #
+      # [Parameters]
+      # * +vertices+ - _Type:Array_ - An array of vertices for the original floorprint 
+      # * +desired_area+ - _Type:String_ - Area to which you want to scale the vertices to
+      # * +runner+ - _Type:String_ - An instance of +Openstudio::Measure::OSRunner+ for the measure run.
+      # 
+      def self.adjust_vertices_to_area(vertices, desired_area, runner, eps = 0.1)
+        ar = ScaleArea.new(vertices, desired_area, runner, eps)
+
+        n = Newton.nlsolve(ar, [0])
+
+        return ar.new_vertices
+      end
+
       ##
       # Calculate which other buildings are shading the current feature and return as an array of
       # +OpenStudio::Model::Space+.
@@ -243,6 +278,7 @@ module URBANopt
             if number_of_stories_above_ground.nil?
               number_of_stories_above_ground = number_of_stories
               number_of_stories_below_ground = 0
+
             else
               number_of_stories_below_ground = number_of_stories - number_of_stories_above_ground
             end
@@ -251,6 +287,13 @@ module URBANopt
             if number_of_stories_above_ground && number_of_stories_above_ground > 0 && maximum_roof_height
               floor_to_floor_height = maximum_roof_height / number_of_stories_above_ground
             end
+
+            # check that feature has a # stories
+            if number_of_stories_above_ground.nil?
+              runner.registerWarning("[geojson process_other_buildings] Unable to include feature #{other_building[:properties][:id]} in shading calculations: no 'number of stories' data")
+            end
+            next if number_of_stories_above_ground.nil?
+
             other_height = number_of_stories_above_ground * floor_to_floor_height
             # find the polygon of the other_building by passing it to the get_multi_polygons method
             other_building_points = building.other_points(other_building, other_height, origin_lat_lon, runner, zoning)

data/lib/urbanopt/geojson/logging.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+# URBANopt (tm), Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without modification,

data/lib/urbanopt/geojson/mapper_classes.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+# URBANopt (tm), Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without modification,

data/lib/urbanopt/geojson/model.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+# URBANopt (tm), Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without modification,

data/lib/urbanopt/geojson/region.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+# URBANopt (tm), Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without modification,

data/lib/urbanopt/geojson/scale_area.rb

@@ -0,0 +1,95 @@
+# *********************************************************************************
+# URBANopt (tm), Copyright (c) 2019-2020, Alliance for Sustainable Energy, 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:
+#
+# Redistributions of source code must retain the above copyright notice, this list
+# of conditions and the following disclaimer.
+#
+# 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.
+#
+# Neither the name of the copyright holder nor the names of its contributors may be
+# used to endorse or promote products derived from this software without specific
+# prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND 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 OR CONTRIBUTORS 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 'json'
+require 'net/http'
+require 'uri'
+require 'openssl'
+require 'bigdecimal/newton'
+
+module Newton
+  def self.jacobian(f, fx, x)
+    Jacobian.jacobian(f, fx, x)
+  end
+
+  def self.ludecomp(a, n, zero = 0, one = 1)
+    LUSolve.ludecomp(a, n, zero, one)
+  end
+
+  def self.lusolve(a, b, ps, zero = 0.0)
+    LUSolve.lusolve(a, b, ps, zero)
+  end
+end
+
+module URBANopt
+  module GeoJSON
+    class ScaleArea
+      def initialize(vertices, desired_area, runner, eps)
+        @vertices = vertices
+        @centroid = OpenStudio.getCentroid(vertices)
+        raise "Cannot compute centroid for '#{vertices}'" if @centroid.empty?
+        @centroid = @centroid.get
+        @desired_area = desired_area
+        @new_vertices = vertices
+        @runner = runner
+        @zero = BigDecimal('0.0')
+        @one  = BigDecimal('1.0')
+        @two  = BigDecimal('2.0')
+        @ten  = BigDecimal('10.0')
+        @eps  = eps
+      end
+
+      attr_reader :zero
+
+      attr_reader :one
+
+      attr_reader :two
+
+      attr_reader :ten
+
+      attr_reader :eps
+
+      ##
+      # Used to determine new scaled vertices, by iteratively passing in the perimeter distance to
+      # minimise the difference of the new and scaled area. Returns the difference of the new area and desired area.
+      #
+      def values(x)
+        @new_vertices = URBANopt::GeoJSON::Zoning.divide_floor_print(@vertices, x[0].to_f, @runner, scale = true)
+        new_area = OpenStudio.getArea(@new_vertices)
+        raise "Cannot compute area for '#{@new_vertices}'" if new_area.empty?
+        new_area = new_area.get
+
+        return [new_area - @desired_area]
+      end
+
+      attr_reader :new_vertices
+    end # ScaleArea
+  end # GeoJSON
+end # URBANopt

data/lib/urbanopt/geojson/schema/building_properties.json

@@ -87,7 +87,7 @@
       "type": "string"
     },
     "floor_area": {
-      "description": "Usable floor area (ft^2).",
+      "description": "Usable floor area (ft^2). Required for residential buildings, this represents conditioned floor area.",
       "type": "number"
     },
     "number_of_stories": {
@@ -95,7 +95,7 @@
       "type": "integer"
     },
     "number_of_stories_above_ground": {
-      "description": "The number of building stories above ground. Defaults to number_of_stories.",
+      "description": "The number of building stories above ground. Defaults to number_of_stories. Required for residential buildings.",
       "type": "integer"
     },
     "maximum_roof_height": {
@@ -194,7 +194,7 @@
       "maximum": 100
     },
     "number_of_residential_units": {
-      "description": "Total number of residential units in the building. Required for single-family attached or multifamily residential buildings.",
+      "description": "Total number of residential units in the building. Required for single-family attached and multifamily residential buildings.",
       "type": "integer"
     },
     "number_of_bedrooms": {
@@ -225,6 +225,45 @@
     },
     "user_data": {
       "description": "Arbitrary user data"
+    },
+    "ev_charging": {
+      "description": "Should be set to true if EV charging is associated with the building.",
+      "type": "boolean"
+    },
+    "ev_charging_station_type": {
+      "description": "Indicates whether EV charging associated with the building is for Typical Home, Public or Work charging station",
+      "type": "string",
+      "enum": [
+        "Typical Home",
+        "Typical Public",
+        "Typical Work"
+      ]
+    },
+    "delay_type": {
+      "description": "Adds workplace charging flexibility for different scenarios. Min delay scenario indicates EV charging immediately upon arriving to work, Max delay indicates not charging until necessary thereby shifting EV charging load to later in the day and Min power indicates charging EVs at a minimum rate over the parking event.",
+      "type": "string",
+      "enum": [
+        "Min Delay",
+        "Max Delay",
+        "Min Power"
+      ]
+    },
+    "ev_charging_behavior": {
+      "description": "Describes scenarios for EV charging behavior, Business as Usual implies home dominant charging behavior, Free Workplace Charging at Project Site implies peak power draw from EV charging during morning hours due to EV charging at workplaces and Free Workplace Charging Across Metro Area scenario reduces Home EV charging relative to Free Workplace Charging at Project Site for residents who work elsewhere and can charge their vehicles for free at those workplaces.",
+      "type": "string",
+      "enum": [
+        "Business as Usual",
+        "Free Workplace Charging at Project Site",
+        "Free Workplace Charging Across Metro Area"
+      ]
+    },
+    "ev_percent": {
+      "description": "Denotes the % of vehicles parked at the building that are EVs.",
+      "type": "number"
+    },
+    "ev_curtailment_frac": {
+      "description": "Fraction between 0 and 1 that denotes curtailment of EV charging load to better align EV charging with expected energy production from a solar PV system",
+      "type": "number"
     }
   },
   "oneOf": [
@@ -241,8 +280,8 @@
         "type",
         "name",
         "floor_area",
+        "number_of_stories_above_ground",
         "number_of_stories",
-        "footprint_area",
         "building_type",
         "number_of_bedrooms",
         "foundation_type",
@@ -262,8 +301,8 @@
         "type",
         "name",
         "floor_area",
+        "number_of_stories_above_ground",
         "number_of_stories",
-        "footprint_area",
         "building_type",
         "number_of_residential_units",
         "number_of_bedrooms",
@@ -284,8 +323,8 @@
         "type",
         "name",
         "floor_area",
+        "number_of_stories_above_ground",
         "number_of_stories",
-        "footprint_area",
         "building_type",
         "number_of_residential_units",
         "number_of_bedrooms",
@@ -296,6 +335,9 @@
       "properties": {
         "building_type": {
           "enum": [
+            "Single-Family",
+            "Multifamily (2 to 4 units)",
+            "Multifamily (5 or more units)",
             "Vacant",
             "Office",
             "Laboratory",
@@ -341,6 +383,9 @@
         "Single-Family Detached",
         "Single-Family Attached",
         "Multifamily",
+        "Single-Family",
+        "Multifamily (2 to 4 units)",
+        "Multifamily (5 or more units)",
         "Vacant",
         "Office",
         "Laboratory",
@@ -513,7 +558,12 @@
         "DEER 2060",
         "DEER 2065",
         "DEER 2070",
-        "DEER 2075"
+        "DEER 2075",
+        "Residential IECC 2006 - Customizable Template Sep 2020",
+        "Residential IECC 2009 - Customizable Template Sep 2020",
+        "Residential IECC 2012 - Customizable Template Sep 2020",
+        "Residential IECC 2015 - Customizable Template Sep 2020",
+        "Residential IECC 2018 - Customizable Template Sep 2020"
       ]
     },
     "foundationType": {