urbanopt-geojson 0.1.0

data/lib/urbanopt/geojson/helper.rb

@@ -0,0 +1,340 @@
+# *********************************************************************************
+# URBANopt, Copyright (c) 2019, 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.
+# *********************************************************************************
+
+module URBANopt
+  module GeoJSON
+    module Helper
+      ##
+      # This method loops though all the surfaces of the space and creates shading
+      # surfaces. It also removes the thermal zone and space type assigned to the space,
+      # if any.
+      #
+      # Returns an Array of instances of +OpenStudio::Model::ShadingSurfaceGroup+ .
+      #
+      # Used to convert adjacent buildings to shading surfaces.
+      # [Parameters]
+      # * +space+ - _Type:String_ - An instance of +OpenStudio::Model::Space+ .
+      def self.convert_to_shading_surface_group(space)
+        name = space.name.to_s
+        model = space.model
+        shading_group = OpenStudio::Model::ShadingSurfaceGroup.new(model)
+        space.surfaces.each do |surface|
+          shading_surface = OpenStudio::Model::ShadingSurface.new(surface.vertices, model)
+          shading_surface.setShadingSurfaceGroup(shading_group)
+        end
+        thermal_zone = space.thermalZone
+        if !thermal_zone.empty?
+          thermal_zone.get.remove
+        end
+        space_type = space.spaceType
+        space.remove
+        if !space_type.empty? && space_type.get.spaces.empty?
+          space_type.get.remove
+        end
+        shading_group.setName(name)
+        return [shading_group]
+      end
+
+      ##
+      # Returns array containing instance of +OpenStudio::Model::ShadingSurface+ .
+      #
+      # Used to create Photovoltaics and assign efficiency.
+      #
+      # [Parameters]
+      # * +feature+ - _Type:String_ - An instance of Feature class.
+      # * +height+ - _Type:Integer_ - Indicates the building height.
+      # * +model+ - _Type:String_ - An instance of +OpenStudio::Model::Model+ .
+      # * +origin_lat_lon+ - _Type:Float_ - An instance of +OpenStudio::PointLatLon+ indicating the
+      #   origin's latitude & longitude.
+      # * +runner+ - _Type:String_ - An instance of +Openstudio::Measure::OSRunner+ for the measure run.
+      def self.create_photovoltaics(feature, height, model, origin_lat_lon, runner)
+        feature_id = feature.feature_json[:properties][:properties]
+        name = feature.name
+        floor_prints = []
+        multi_polygons = feature.get_multi_polygons
+        multi_polygons.each do |multi_polygon|
+          if multi_polygon.size > 1
+            runner.registerWarning('Ignoring holes in polygon')
+          end
+          multi_polygon.each do |polygon|
+            floor_print = floor_print_from_polygon(polygon, height, origin_lat_lon, runner)
+            if floor_print
+              floor_prints << OpenStudio.reverse(floor_print)
+            else
+              runner.registerWarning("Cannot create footprint for '#{name}'")
+            end
+            break
+          end
+        end
+        shading_surfaces = []
+        floor_prints.each do |floor_print|
+          shading_group = OpenStudio::Model::ShadingSurfaceGroup.new(model)
+          shading_surface = OpenStudio::Model::ShadingSurface.new(floor_print, model)
+          shading_surface.setShadingSurfaceGroup(shading_group)
+          shading_surface.setName('Photovoltaic Panel')
+          shading_surfaces << shading_surface
+        end
+        # create the inverter # :nodoc:
+        inverter = OpenStudio::Model::ElectricLoadCenterInverterSimple.new(model)
+        inverter.setInverterEfficiency(0.95)
+        # create the distribution system # :nodoc:
+        elcd = OpenStudio::Model::ElectricLoadCenterDistribution.new(model)
+        elcd.setInverter(inverter)
+        shading_surfaces.each do |shading_surface|
+          panel = OpenStudio::Model::GeneratorPhotovoltaic.simple(model)
+          panel.setSurface(shading_surface)
+          performance = panel.photovoltaicPerformance.to_PhotovoltaicPerformanceSimple.get
+          performance.setFractionOfSurfaceAreaWithActiveSolarCells(1.0)
+          performance.setFixedEfficiency(0.3)
+          elcd.addGenerator(panel)
+        end
+        return shading_surfaces
+      end
+
+      ##
+      # Returns array containing instance of +OpenStudio::Model::ShadingSurface+ .
+      #
+      # [Parameters]
+      # * +feature+ - _Type:String_ - An instance of Feature class.
+      # * +model+ - _Type:String_ - An instance of _OpenStudio::Model::Model_ .
+      # * +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_ .
+      # * +spaces+ -_Type:Array_ - Instances of _OpenStudio::Model::Space_ .
+      def self.create_shading_surfaces(feature, model, origin_lat_lon, runner, spaces)
+        max_z = 0
+        spaces.each do |space|
+          bb = space.boundingBox
+          max_z = [max_z, bb.maxZ.get].max
+        end
+        return create_photovoltaics(feature, max_z + 1, model, origin_lat_lon, runner)
+      end
+
+      ##
+      # This method loops through all the stories in the model, and returns any space
+      # types previously assigned.
+      #
+      # Returns array of +OpenStudio::Model::SpaceTypes+ .
+      #
+      # Used to create space types for each building story.
+      #
+      # [Parameters]
+      # * +stories+ - _Type:Array_ - An array of model/building stories.
+      # * +model+ - _Type:String_ - An instance of _OpenStudio::Model::Model_ .
+      # * +runner+ - _Type:String_ - The measure run's instance of _OpenStudio::Measure::OSRunner_ .
+      def self.create_space_types(stories, model, runner)
+        space_types = []
+        stories.each_index do |i|
+          space_type = nil
+          space = stories[i].spaces.first
+          if space && space.spaceType.is_initialized
+            space_type = space.spaceType.get
+          else
+            space_type = OpenStudio::Model::SpaceType.new(model)
+            runner.registerInfo("Story #{i} does not have a space type, creating new one")
+          end
+          space_types[i] = space_type
+        end
+        return space_types
+      end
+
+      ##
+      # Returns an +OpenStudio::Point3dVector+ .
+      #
+      # Creates the floor print for a given polygon.
+      #
+      # [Parameters]
+      # * +polygon+ - _Type:Array_ - An array of coordinate pairs.
+      # e.g.
+      #  polygon = [
+      #   [1, 5],
+      #   [5, 5],
+      #   [5, 1],
+      #  ]
+      #
+      # * +elevation+ - _Type:Integer_ - Indicates the elevation.
+      # * +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)
+        floor_print = OpenStudio::Point3dVector.new
+        all_points = OpenStudio::Point3dVector.new
+        polygon.each do |p|
+          lon = p[0]
+          lat = p[1]
+          point_3d = origin_lat_lon.toLocalCartesian(OpenStudio::PointLatLon.new(lat, lon, 0))
+          point_3d = OpenStudio::Point3d.new(point_3d.x, point_3d.y, elevation)
+          curr_print = zoning ? OpenStudio.getCombinedPoint(point_3d, all_points, 1.0) : point_3d
+          floor_print << curr_print
+        end
+        if floor_print.size < 3
+          runner.registerWarning('Cannot create floor print, fewer than 3 points')
+          return nil
+        end
+        floor_print = OpenStudio.removeCollinear(floor_print)
+        normal = OpenStudio.getOutwardNormal(floor_print)
+        if normal.empty?
+          runner.registerWarning('Cannot create floor print, cannot compute outward normal')
+          return nil
+        elsif normal.get.z > 0
+          floor_print = OpenStudio.reverse(floor_print)
+          runner.registerWarning('Reversing floor print')
+        end
+        return floor_print
+      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. Currently 'ShadingOnly' is the only option that is processed.
+      # * +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. Currently, zoning set to +false+ is
+      #   only supported.
+      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)
+
+        other_spaces = []
+        runner.registerInfo("#{other_buildings[:features].size} nearby buildings found")
+        other_buildings[:features].each do |other_building|
+          other_id = other_building[:properties][:id]
+          next if other_id == building.id
+          if other_building_type == 'ShadingOnly'
+            # Checks if any building point is shaded by any other building point.
+            roof_elevation = other_building[:properties][:roof_elevation]
+            number_of_stories = other_building[:properties][:number_of_stories]
+            number_of_stories_above_ground = other_building[:properties][:number_of_stories_above_ground]
+            maximum_roof_height = other_building[:properties][:maximum_roof_height]
+
+            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
+
+            floor_to_floor_height = 3
+            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
+            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
+          end
+
+          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}'")
+          end
+          other_spaces.concat(new_building)
+        end
+        return other_spaces
+      end
+
+      ##
+      # Returns Boolean which indicates whether the specified building is shadowed by
+      # other building.
+      #
+      # [Parameters]
+      # * +potentially_shaded+ - _Type:Array_ - An array of instances of +OpenStudio::Point3d+ .
+      # * +potential_shader+ - _Type:Array_ - Other array of instances of +OpenStudio::Point3d+ .
+      # * +origin_lat_lon+ _Type:Float_ - An instance of OpenStudio::PointLatLon indicating the origin's
+      #   latitude and longitude.
+      def self.is_shadowed(potentially_shaded, potential_shader, origin_lat_lon)
+        all_pairs = []
+        potentially_shaded.each do |building_point|
+          potential_shader.each do |other_building_point|
+            vector = other_building_point - building_point
+            all_pairs << {
+              building_point: building_point,
+              other_building_point: other_building_point,
+              vector: vector,
+              distance: vector.length
+            }
+          end
+        end
+        all_pairs.sort! { |x, y| x[:distance] <=> y[:distance] }
+        all_pairs.each do |pair|
+          if is_shaded(pair[:building_point], pair[:other_building_point], origin_lat_lon)
+            return true
+          end
+        end
+        return false
+      end
+
+      ##
+      # Returns Boolean indicating if specified building is shadowed.
+      #
+      # [Parameters]
+      # * +building_point+ - _Type:Float_ - An instance of +OpenStudio::Point3d+ .
+      # * +other_building_point+ - _Type:Float_ - Other instance of +OpenStudio::Point3d+ .
+      # * +origin_lat_lon+ - _Type:Float_ - An instance of +OpenStudio::PointLatLon+ indicating the
+      #   origin's latitude and longitude.
+      def self.is_shaded(building_point, other_building_point, origin_lat_lon)
+        vector = other_building_point - building_point
+        height = vector.z
+        distance = Math.sqrt(vector.x * vector.x + vector.y * vector.y)
+        if distance < 1
+          return true
+        end
+        hour_angle_rad = Math.atan2(-vector.x, -vector.y)
+        hour_angle = OpenStudio.radToDeg(hour_angle_rad)
+        latitude_rad = OpenStudio.degToRad(origin_lat_lon.lat)
+        result = false
+        (-24..24).each do |declination|
+          declination_rad = OpenStudio.degToRad(declination)
+          zenith_angle_rad = Math.acos(Math.sin(latitude_rad) * Math.sin(declination_rad) + Math.cos(latitude_rad) * Math.cos(declination_rad) * Math.cos(hour_angle_rad))
+          zenith_angle = OpenStudio.radToDeg(zenith_angle_rad)
+          elevation_angle = 90 - zenith_angle
+          apparent_angle_rad = Math.atan2(height, distance)
+          apparent_angle = OpenStudio.radToDeg(apparent_angle_rad)
+          if elevation_angle > 0 && elevation_angle < apparent_angle
+            result = true
+            break
+          end
+        end
+        return result
+      end
+
+      class << self
+        private :is_shaded
+      end
+    end
+  end
+end

data/lib/urbanopt/geojson/logging.rb

@@ -0,0 +1,46 @@
+# *********************************************************************************
+# URBANopt, Copyright (c) 2019, 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 'logger'
+
+module URBANopt
+  module GeoJSON
+    @@logger = Logger.new(STDERR)
+    @@logger.progname = 'URBANopt::GeoJSON'
+
+    def self.logger
+      @@logger
+    end
+
+    def self.setLogger(l)
+      @@logger = l
+    end
+  end
+end

data/lib/urbanopt/geojson/mapper_classes.rb

@@ -0,0 +1,85 @@
+# *********************************************************************************
+# URBANopt, Copyright (c) 2019, 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 'urbanopt/scenario'
+require 'json'
+
+module URBANopt
+    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. 
+
+            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
+            end
+        end
+    end
+end