urbanopt-geojson 0.2.0.pre3 → 0.4.0

data/lib/urbanopt/geojson/derived_extension.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/district_system.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/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,
@@ -44,8 +44,11 @@ module URBANopt
         @feature_json = validate_feat(feature)
       end
 
+      # rubocop:disable Style/MethodMissing
       def method_missing(name, *args, &blk)
+        # rubocop:enable Style/MethodMissing
         if @feature_json[:properties].keys.map(&:to_sym).include? name.to_sym
+
           return @feature_json[:properties][name.to_sym]
         else
           super
@@ -95,6 +98,84 @@ module URBANopt
         return @@feature_schema[feature_type]
       end
 
+      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
+
+      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
@@ -164,13 +245,46 @@ 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
 
       ##
       # Used to validate the feature by checking +feature_id+ , +geometry+, +properties+
       # and +geometry_type+ .
-
+      # rubocop:disable Style/CommentedKeyword
       def validate_feat(feature) #:doc:
+        # rubocop:enable Style/CommentedKeyword
         if feature.nil? || feature.empty?
           raise("Feature '#{feature_id}' could not be found")
           return false

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,
@@ -80,7 +80,7 @@ module URBANopt
 
         # initialize @@logger
         @@logger ||= URBANopt::GeoJSON.logger
-        
+
         # validate each feature against schema
         geojson_file[:features].each do |feature|
           properties = feature[:properties]
@@ -93,16 +93,16 @@ module URBANopt
             # Incase detailed_model_filename present check for fewer properties
             if feature[:properties][:detailed_model_filename]
               if feature[:properties][:id].nil?
-                raise("No id found for Building Feature")
+                raise('No id found for Building Feature')
               end
               if feature[:properties][:name].nil?
-                raise("No name found for Building Feature")
+                raise('No name found for Building Feature')
               end
               if feature[:properties][:number_of_stories].nil?
                 @@logger.warn("Number of stories is required to calculate shading using the UrbanGeometryCreation measure...ignoring #{feature[:properties][:id]} in shading calculations")
               end
               feature[:additionalProperties] = true
-            # Else validate for all required properties in the schema 
+            # Else validate for all required properties in the schema
             else
               errors = validate(@@building_schema, properties)
             end
@@ -114,16 +114,15 @@ module URBANopt
             errors = validate(@@electrical_junction_schema, properties)
           when 'ElectricalConnector'
             errors = validate(@@electrical_connector_schema, properties)
-          when 'ElectricalJunction'
+          when 'ThermalJunction'
             errors = validate(@@thermal_junction_schema, properties)
           when 'ThermalConnector'
             errors = validate(@@thermal_connector_schema, properties)
           end
-          
+
           unless errors.empty?
-            raise ("#{type} does not adhere to schema: \n #{errors.join('\n  ')}")
+            raise "#{type} does not adhere to schema: \n #{errors.join('\n  ')}"
           end
-        
         end
         return new(geojson_file, path)
       end
@@ -163,6 +162,7 @@ module URBANopt
             # merge site origin properties
             f = merge_site_properties(f)
             if f[:properties][:type] == 'Building'
+
               return URBANopt::GeoJSON::Building.new(f)
             elsif f[:properties] && f[:properties][:type] == 'District System'
               return URBANopt::GeoJSON::DistrictSystem.new(f)
@@ -172,9 +172,9 @@ module URBANopt
         return nil
       end
 
-      ## 
-      # Merge Site Properties in Feature.  Returns feature with site properties added to its properties section. Does not overwrite existing properties.
-      # 
+      ##
+      # Merge Site Properties in Feature. Returns feature with site properties added to its properties section. Does not overwrite existing properties.
+      #
       # [Parameters]
       # +feature+ - _Type:Hash_ - feature object.
       def merge_site_properties(feature)
@@ -183,23 +183,23 @@ module URBANopt
           project = @geojson_file[:project]
         end
 
-        # this maps site properties to building/district system properties. 
+        # this maps site properties to building/district system properties.
         add_props = [
-          {site: :surface_elevation, feature: :surface_elevation}, 
-          {site: :timesteps_per_hour, feature: :timesteps_per_hour},
-          {site: :begin_date, feature: :begin_date},
-          {site: :end_date, feature: :end_date},
-          {site: :cec_climate_zone, feature: :cec_climate_zone},
-          {site: :climate_zone, feature: :climate_zone},
-          {site: :default_template, feature: :template},
-          {site: :weather_filename, feature: :weather_filename},
-          {site: :tariff_filename, feature: :tariff_filename}
+          { site: :surface_elevation, feature: :surface_elevation },
+          { site: :timesteps_per_hour, feature: :timesteps_per_hour },
+          { site: :begin_date, feature: :begin_date },
+          { site: :end_date, feature: :end_date },
+          { site: :cec_climate_zone, feature: :cec_climate_zone },
+          { site: :climate_zone, feature: :climate_zone },
+          { site: :default_template, feature: :template },
+          { site: :weather_filename, feature: :weather_filename },
+          { site: :tariff_filename, feature: :tariff_filename }
         ]
 
         add_props.each do |prop|
-          if project.key?(prop[:site]) and project[prop[:site]]
+          if project.key?(prop[:site]) && project[prop[:site]]
             # property exists in site
-            if !feature[:properties].key?(prop[:feature]) or feature[:properties][prop[:feature]].nil? or feature[:properties][prop[:feature]].empty?
+            if !feature[:properties].key?(prop[:feature]) || feature[:properties][prop[:feature]].nil? || feature[:properties][prop[:feature]].empty?
               # property does not exist in feature or is nil: add site property (don't overwrite)
               feature[:properties][prop[:feature]] = project[prop[:site]]
             end
@@ -210,10 +210,10 @@ module URBANopt
       end
 
       ##
-      # Validate GeoJSON against schema
+      # Validate GeoJSON against schema.
       #
       # [Parameters]
-      # * +data+ - + - _Type:Hash_ - Input GeoJSON file 
+      # * +data+ - + - _Type:Hash_ - Input GeoJSON file
       def self.validate(schema_json, data)
         errors = JSON::Validator.fully_validate(schema_json, data, errors_as_objects: true)
         return errors
@@ -243,7 +243,7 @@ module URBANopt
         end
         return result
       end
-      
+
       def self.get_district_system_schema(strict)
         result = nil
         File.open(File.dirname(__FILE__) + '/schema/district_system_properties.json') do |f|
@@ -256,7 +256,7 @@ module URBANopt
         end
         return result
       end
-      
+
       def self.get_region_schema(strict)
         result = nil
         File.open(File.dirname(__FILE__) + '/schema/region_properties.json') do |f|
@@ -331,7 +331,6 @@ module URBANopt
       @@electrical_junction_schema = get_electrical_junction_schema(strict)
       @@thermal_connector_schema = get_thermal_connector_schema(strict)
       @@thermal_junction_schema = get_thermal_junction_schema(strict)
-
     end
   end
 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,22 +209,48 @@ 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
 
+      # scale footprint to desired area, keeping the shape
+      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+.
       #
       # [Parameters]
       # * +building+ - _Type:URBANopt::GeoJSON::Building_ - The core building that other buildings will be referenced.
-      # * +other_building_type+ - _Type:String_ - Describes the surrounding buildings. 
+      # * +other_building_type+ - _Type:String_ - Describes the surrounding buildings.
       # * +other_buildings+ - _Type:URBANopt::GeoJSON::FeatureCollection_ - List of surrounding buildings to include (self will be ignored if present in list).
       # * +model+ - _Type:OpenStudio::Model::Model_ - An instance of an OpenStudio Model.
       # * +origin_lat_lon+ - _Type:Float_ - An instance of +OpenStudio::PointLatLon+ indicating the latitude and longitude of the origin.
       # * +runner+ - _Type:String_ - An instance of +Openstudio::Measure::OSRunner+ for the measure run.
       # * +zoning+ - _Type:Boolean_ - Value is +true+ if utilizing detailed zoning, else
-      #   +false+. Zoning is set to false by default. 
+      #   +false+. Zoning is set to false by default.
       def self.process_other_buildings(building, other_building_type, other_buildings, model, origin_lat_lon, runner, zoning = false)
         # Empty array to store the new OpenStudio model spaces that need to be converted to shading objects
         feature_points = building.feature_points(origin_lat_lon, runner, zoning)
@@ -243,6 +271,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,11 +280,18 @@ 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)
             shadowed = URBANopt::GeoJSON::Helper.is_shadowed(feature_points, other_building_points, origin_lat_lon)
-            next unless shadowed 
+            next unless shadowed
             new_building = building.create_other_building(:space_per_building, model, origin_lat_lon, runner, zoning, other_building)
             if new_building.nil? || new_building.empty?
               runner.registerWarning("Failed to create spaces for other building '#{name}'")
@@ -264,7 +300,6 @@ module URBANopt
 
           elsif other_building_type == 'None'
           end
-
         end
         return other_spaces
       end

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,
@@ -32,54 +32,54 @@ require 'urbanopt/scenario'
 require 'json'
 
 module URBANopt
-    module GeoJSON
-        class Mapper < MapperBase
-            @@instance_lock = Mutex.new
-            @@osw = nil
+  module GeoJSON
+    class Mapper < MapperBase
+      @@instance_lock = Mutex.new
+      @@osw = nil
 
-            ##
-            # This class inherits from the +MapperBase+ . 
-            # Used to perform initializing functions, used to define the osw_path for
-            # baseline.osw for the URBANopt GeoJSON example project and the weather file. 
+      ##
+      # This class inherits from the +MapperBase+ .
+      # Used to perform initializing functions, used to define the osw_path for
+      # baseline.osw for the URBANopt GeoJSON example project and the weather file.
 
-            def initialize()
-                @@instance_lock.synchronize do
-                if @@osw.nil?
-                    osw_path = File.join(File.dirname(__FILE__), 'baseline.osw')
-                    File.open(osw_path, 'r') do |file|
-                    @@osw = JSON.parse(file.read, symbolize_names: true)
-                    end
-                    @@osw[:file_paths] << File.join(File.dirname(__FILE__), '../weather/')
-                    @@osw = OpenStudio::Extension.configure_osw(@@osw)
-                end
-            end
-
-            ##
-            # Creates an OpenStudio Workflow file for a given ScenarioBase object,
-            # feature id and feature name.
-            #
-            # [Parameters]
-            # * +scenario+ - _Type:String_ - Used to define the Scenario for the osw. 
-
-            # * +feature_id+ - _Type:String/Number_ - Used to define the feature_id for
-            #   which the osw is implemented.
-            # 
-            # * +feature_name+ - _Type:String_ - The name of the feature. 
-            def create_osw(scenario, feature_id, feature_name)
-                # get the feature from the scenario's feature_file #:nodoc:
-                feature_file = scenario.feature_file
-                feature = feature_file.get_feature_by_id(feature_id)
-
-                raise "Cannot find feature '#{feature_id}' in '#{scenario.geometry_file}'" if feature.nil?
-
-                # deep clone of @@osw before we configure it #:nodoc:
-                osw = Marshal.load(Marshal.dump(@@osw))
-
-                osw[:name] = feature_name
-                osw[:description] = feature_name
-
-                return osw
+      def initialize
+        @@instance_lock.synchronize do
+          if @@osw.nil?
+            osw_path = File.join(File.dirname(__FILE__), 'baseline.osw')
+            File.open(osw_path, 'r') do |file|
+              @@osw = JSON.parse(file.read, symbolize_names: true)
             end
+            @@osw[:file_paths] << File.join(File.dirname(__FILE__), '../weather/')
+            @@osw = OpenStudio::Extension.configure_osw(@@osw)
+          end
         end
+
+        ##
+        # Creates an OpenStudio Workflow file for a given ScenarioBase object,
+        # feature id and feature name.
+        #
+        # [Parameters]
+        # * +scenario+ - _Type:String_ - Used to define the Scenario for the osw.
+        # * +feature_id+ - _Type:String/Number_ - Used to define the feature_id for
+        #   which the osw is implemented.
+        #
+        # * +feature_name+ - _Type:String_ - The name of the feature.
+        # rubocop:disable Lint/NestedMethodDefinition
+        def create_osw(scenario, feature_id, feature_name)
+          # rubocop:enable Lint/NestedMethodDefinition
+          # get the feature from the scenario's feature_file #:nodoc:
+          feature_file = scenario.feature_file
+          feature = feature_file.get_feature_by_id(feature_id)
+          raise "Cannot find feature '#{feature_id}' in '#{scenario.geometry_file}'" if feature.nil?
+          # deep clone of @@osw before we configure it #:nodoc:
+          osw = Marshal.load(Marshal.dump(@@osw))
+          osw[:name] = feature_name
+          osw[:description] = feature_name
+          end
+        # rubocop:disable Lint/ReturnInVoidContext
+        return osw
+       # rubocop:enable Lint/ReturnInVoidContext
+     end
     end
-end
+  end
+end