openstudio-standards 0.2.14 → 0.2.15.pre.rc1

data/lib/openstudio-standards/standards/Standards.Space.rb

@@ -7,6 +7,7 @@ class Standard
   #   and therefore may not return perfect results.  However, it works well in most tested
   #   situations.  When it fails, it will log warnings/errors for users to see.
   #
+  # @param space [OpenStudio::Model::Space] space object
   # @param draw_daylight_areas_for_debugging [Bool] If this argument is set to true,
   #   daylight areas will be added to the model as surfaces for visual debugging.
   #   Yellow = toplighted area, Red = primary sidelighted area,
@@ -15,7 +16,7 @@ class Standard
   #   Hash keys are: 'toplighted_area', 'primary_sidelighted_area',
   #   'secondary_sidelighted_area', 'total_window_area', 'total_skylight_area'
   # @todo add a list of valid choices for template argument
-  # TODO stop skipping non-vertical walls
+  # @todo stop skipping non-vertical walls
   def space_daylighted_areas(space, draw_daylight_areas_for_debugging = false)
     ### Begin the actual daylight area calculations ###
 
@@ -108,7 +109,7 @@ class Standard
     space.surfaces.sort.each do |surface|
       if surface.outsideBoundaryCondition == 'Outdoors' && surface.surfaceType == 'Wall'
 
-        # TODO: stop skipping non-vertical walls
+        # @todo stop skipping non-vertical walls
         surface_normal = surface.outwardNormal
         surface_normal_z = surface_normal.z
         unless surface_normal_z.abs < 0.001
@@ -251,7 +252,8 @@ class Standard
           down_vector = OpenStudio::Vector3d.new(0, 0, -1)
           outward_normal_vector = sub_surface.outwardNormal
           rot_vector = down_vector.cross(outward_normal_vector)
-          ninety_deg_in_rad = OpenStudio.degToRad(90) # TODO: change
+          ninety_deg_in_rad = OpenStudio.degToRad(90)
+          # @todo change
           new_rotation = OpenStudio.createRotation(rot_origin, rot_vector, ninety_deg_in_rad)
           pri_sidelit_sub_polygon = new_rotation * pri_sidelit_sub_polygon
           sec_sidelit_sub_polygon = new_rotation * sec_sidelit_sub_polygon
@@ -263,10 +265,10 @@ class Standard
           # Add these polygons to the list
           pri_sidelit_polygons << pri_sidelit_sub_polygon
           sec_sidelit_polygons << sec_sidelit_sub_polygon
-        end # Next subsurface
+        end
       elsif surface.outsideBoundaryCondition == 'Outdoors' && surface.surfaceType == 'RoofCeiling'
 
-        # TODO: stop skipping non-horizontal roofs
+        # @todo stop skipping non-horizontal roofs
         surface_normal = surface.outwardNormal
         straight_upward = OpenStudio::Vector3d.new(0, 0, 1)
         unless surface_normal.to_s == straight_upward.to_s
@@ -367,10 +369,10 @@ class Standard
 
           # Add these polygons to the list
           toplit_polygons << toplit_sub_polygon
-        end # Next subsurface
+        end
 
-      end # End if outdoor wall or roofceiling
-    end # Next surface
+      end
+    end
 
     # Set z=0 for all the polygons so that intersection will work
     toplit_polygons = space_polygons_set_z(space, toplit_polygons, 0.0)
@@ -540,13 +542,13 @@ class Standard
     return result
   end
 
-  # Determines the method used to extend the daylighted area horizontally
-  # next to a window.  If the method is 'fixed', 2 ft is added to the
-  # width of each window.  If the method is 'proportional', a distance
-  # equal to half of the head height of the window is added.  If the method is 'none',
-  # no additional width is added.
+  # Determines the method used to extend the daylighted area horizontally next to a window.
+  # If the method is 'fixed', 2 ft is added to the width of each window.
+  # If the method is 'proportional', a distance equal to half of the head height of the window is added.
+  # If the method is 'none', no additional width is added.
   # Default is none.
   #
+  # @param space [OpenStudio::Model::Space] space object
   # @return [String] returns 'fixed' or 'proportional'
   def space_daylighted_area_window_width(space)
     method = 'none'
@@ -554,8 +556,9 @@ class Standard
   end
 
   # Returns the sidelighting effective aperture
-  # space_sidelighting_effective_aperture(space)  = E(window area * window VT) / primary_sidelighted_area
+  # space_sidelighting_effective_aperture(space) = E(window area * window VT) / primary_sidelighted_area
   #
+  # @param space [OpenStudio::Model::Space] space object
   # @param primary_sidelighted_area [Double] the primary sidelighted area (m^2) of the space
   # @return [Double] the unitless sidelighting effective aperture metric
   def space_sidelighting_effective_aperture(space, primary_sidelighted_area)
@@ -666,8 +669,9 @@ class Standard
   end
 
   # Returns the skylight effective aperture
-  # space_skylight_effective_aperture(space)  = E(0.85 * skylight area * skylight VT * WF) / toplighted_area
+  # space_skylight_effective_aperture(space) = E(0.85 * skylight area * skylight VT * WF) / toplighted_area
   #
+  # @param space [OpenStudio::Model::Space] space object
   # @param toplighted_area [Double] the toplighted area (m^2) of the space
   # @return [Double] the unitless skylight effective aperture metric
   def space_skylight_effective_aperture(space, toplighted_area)
@@ -787,6 +791,7 @@ class Standard
   #   and therefore may not return perfect results.  However, it works well in most tested
   #   situations.  When it fails, it will log warnings/errors for users to see.
   #
+  # @param space [OpenStudio::Model::Space] the space with daylighting
   # @param remove_existing_controls [Bool] if true, will remove existing controls then add new ones
   # @param draw_daylight_areas_for_debugging [Bool] If this argument is set to true,
   #   daylight areas will be added to the model as surfaces for visual debugging.
@@ -837,12 +842,6 @@ class Standard
 
     areas = nil
 
-    # Get the area of the space
-    space_area_m2 = space.floorArea
-
-    # Get the LPD of the space
-    space_lpd_w_per_m2 = space.lightingPowerPerFloorArea
-
     # Get the daylighting areas
     areas = space_daylighted_areas(space, draw_daylight_areas_for_debugging)
 
@@ -851,6 +850,7 @@ class Standard
 
     # Stop here if no controls are required
     if !req_top_ctrl && !req_pri_ctrl && !req_sec_ctrl
+      OpenStudio.logFree(OpenStudio::Debug, 'openstudio.standards.Space', "For #{space.name}, no daylighting control is required.")
       return false
     end
 
@@ -859,13 +859,6 @@ class Standard
     OpenStudio.logFree(OpenStudio::Debug, 'openstudio.standards.Space', "For #{space.name}, primary sidelighting control required = #{req_pri_ctrl}")
     OpenStudio.logFree(OpenStudio::Debug, 'openstudio.standards.Space', "For #{space.name}, secondary sidelighting control required = #{req_sec_ctrl}")
 
-    # Stop here if no lighting controls are required.
-    # Do not put daylighting control points into the space.
-    if !req_top_ctrl && !req_pri_ctrl && !req_sec_ctrl
-      OpenStudio.logFree(OpenStudio::Debug, 'openstudio.standards.Space', "For #{space.name}, no daylighting control is required.")
-      return false
-    end
-
     # Record a floor in the space for later use
     floor_surface = nil
     space.surfaces.sort.each do |surface|
@@ -885,7 +878,7 @@ class Standard
       straight_upward = OpenStudio::Vector3d.new(0, 0, 1)
       surface_normal = surface.outwardNormal
       if surface.surfaceType == 'Wall'
-        # TODO: stop skipping non-vertical walls
+        # @todo stop skipping non-vertical walls
         unless surface_normal.z.abs < 0.001
           unless surface.subSurfaces.empty?
             OpenStudio.logFree(OpenStudio::Warn, 'openstudio.standards.Space', "Cannot currently handle non-vertical walls; skipping windows on #{surface.name} in #{space.name} for daylight sensor positioning.")
@@ -893,7 +886,7 @@ class Standard
           end
         end
       elsif surface.surfaceType == 'RoofCeiling'
-        # TODO: stop skipping non-horizontal roofs
+        # @todo stop skipping non-horizontal roofs
         unless surface_normal.to_s == straight_upward.to_s
           unless surface.subSurfaces.empty?
             OpenStudio.logFree(OpenStudio::Warn, 'openstudio.standards.Space', "Cannot currently handle non-horizontal roofs; skipping skylights on #{surface.name} in #{space.name} for daylight sensor positioning.")
@@ -906,29 +899,26 @@ class Standard
       # Find the azimuth of the facade
       facade = nil
       group = surface.planarSurfaceGroup
-      if group.is_initialized
-        group = group.get
-        site_transformation = group.buildingTransformation
-        site_vertices = site_transformation * surface.vertices
-        site_outward_normal = OpenStudio.getOutwardNormal(site_vertices)
-        if site_outward_normal.empty?
-          OpenStudio.logFree(OpenStudio::Error, 'openstudio.standards.Space', "Could not compute outward normal for #{surface.name.get}")
-          next
-        end
-        site_outward_normal = site_outward_normal.get
-        north = OpenStudio::Vector3d.new(0.0, 1.0, 0.0)
-        azimuth = if site_outward_normal.x < 0.0
-                    360.0 - OpenStudio.radToDeg(OpenStudio.getAngle(site_outward_normal, north))
-                  else
-                    OpenStudio.radToDeg(OpenStudio.getAngle(site_outward_normal, north))
-                  end
-      else
-        # The surface is not in a group; should not hit, since
-        # called from Space.surfaces
+      # The surface is not in a group; should not hit, since called from Space.surfaces
+      next unless group.is_initialized
+
+      group = group.get
+      site_transformation = group.buildingTransformation
+      site_vertices = site_transformation * surface.vertices
+      site_outward_normal = OpenStudio.getOutwardNormal(site_vertices)
+      if site_outward_normal.empty?
+        OpenStudio.logFree(OpenStudio::Error, 'openstudio.standards.Space', "Could not compute outward normal for #{surface.name.get}")
         next
       end
-
-      # TODO: modify to work for buildings in the southern hemisphere?
+      site_outward_normal = site_outward_normal.get
+      north = OpenStudio::Vector3d.new(0.0, 1.0, 0.0)
+      azimuth = if site_outward_normal.x < 0.0
+                  360.0 - OpenStudio.radToDeg(OpenStudio.getAngle(site_outward_normal, north))
+                else
+                  OpenStudio.radToDeg(OpenStudio.getAngle(site_outward_normal, north))
+                end
+
+      # @todo modify to work for buildings in the southern hemisphere?
       if azimuth >= 315.0 || azimuth < 45.0
         facade = '4-North'
       elsif azimuth >= 45.0 && azimuth < 135.0
@@ -967,8 +957,8 @@ class Standard
         else
           windows[sub_surface] = properties
         end
-      end # next sub-surface
-    end # next surface
+      end
+    end
 
     # Determine the illuminance setpoint for the controls based on space type
     daylight_stpt_lux = 375
@@ -1105,9 +1095,9 @@ class Standard
       sensor_1.setName("#{space.name} Daylt Sensor 1")
       sensor_1.setSpace(space)
       sensor_1.setIlluminanceSetpoint(daylight_stpt_lux)
-      sensor_1.setLightingControlType('Stepped')
-      sensor_1.setNumberofSteppedControlSteps(3) # all sensors 3-step per design
-      sensor_1.setMinimumInputPowerFractionforContinuousDimmingControl(0.3)
+      sensor_1.setLightingControlType(space_daylighting_control_type(space))
+      sensor_1.setNumberofSteppedControlSteps(3) unless space_daylighting_control_type(space) != 'Stepped' # all sensors 3-step per design
+      sensor_1.setMinimumInputPowerFractionforContinuousDimmingControl(space_daylighting_minimum_input_power_fraction(space))
       sensor_1.setMinimumLightOutputFractionforContinuousDimmingControl(0.2)
       sensor_1.setProbabilityLightingwillbeResetWhenNeededinManualSteppedControl(1.0)
       sensor_1.setMaximumAllowableDiscomfortGlareIndex(22.0)
@@ -1134,7 +1124,7 @@ class Standard
       end
       sensor_1.setPosition(sensor_vertex)
 
-      # TODO: rotate sensor to face window (only needed for glare calcs)
+      # @todo rotate sensor to face window (only needed for glare calcs)
       zone.setPrimaryDaylightingControl(sensor_1)
       zone.setFractionofZoneControlledbyPrimaryDaylightingControl(sensor_1_frac)
     end
@@ -1147,9 +1137,9 @@ class Standard
       sensor_2.setName("#{space.name} Daylt Sensor 2")
       sensor_2.setSpace(space)
       sensor_2.setIlluminanceSetpoint(daylight_stpt_lux)
-      sensor_2.setLightingControlType('Stepped')
-      sensor_2.setNumberofSteppedControlSteps(3) # all sensors 3-step per design
-      sensor_2.setMinimumInputPowerFractionforContinuousDimmingControl(0.3)
+      sensor_2.setLightingControlType(space_daylighting_control_type(space))
+      sensor_2.setNumberofSteppedControlSteps(3) unless space_daylighting_control_type(space) != 'Stepped' # all sensors 3-step per design
+      sensor_2.setMinimumInputPowerFractionforContinuousDimmingControl(space_daylighting_minimum_input_power_fraction(space))
       sensor_2.setMinimumLightOutputFractionforContinuousDimmingControl(0.2)
       sensor_2.setProbabilityLightingwillbeResetWhenNeededinManualSteppedControl(1.0)
       sensor_2.setMaximumAllowableDiscomfortGlareIndex(22.0)
@@ -1176,7 +1166,7 @@ class Standard
       end
       sensor_2.setPosition(sensor_vertex)
 
-      # TODO: rotate sensor to face window (only needed for glare calcs)
+      # @todo rotate sensor to face window (only needed for glare calcs)
       zone.setSecondaryDaylightingControl(sensor_2)
       zone.setFractionofZoneControlledbySecondaryDaylightingControl(sensor_2_frac)
     end
@@ -1199,12 +1189,17 @@ class Standard
     return [req_top_ctrl, req_pri_ctrl, req_sec_ctrl]
   end
 
-  # Determine the fraction controlled by each sensor and which
-  # window each sensor should go near.
+  # Determine the fraction controlled by each sensor and which window each sensor should go near.
   #
-  # @param space [OpenStudio::Model::Space] the space with the daylighting
+  # @param space [OpenStudio::Model::Space] space object
+  # @param areas [Hash] a hash of daylighted areas
   # @param sorted_windows [Hash] a hash of windows, sorted by priority
   # @param sorted_skylights [Hash] a hash of skylights, sorted by priority
+  # @param req_top_ctrl [Bool] if toplighting controls are required
+  # @param req_pri_ctrl [Bool] if primary sidelighting controls are required
+  # @param req_sec_ctrl [Bool] if secondary sidelighting controls are required
+  # @return [Array] array of 4 items
+  #   [sensor 1 fraction, sensor 2 fraction, sensor 1 window, sensor 2 window]
   def space_daylighting_fractions_and_windows(space,
                                               areas,
                                               sorted_windows,
@@ -1220,9 +1215,9 @@ class Standard
     return [sensor_1_frac, sensor_2_frac, sensor_1_window, sensor_2_window]
   end
 
-  # Set the infiltration rate for this space to include
-  # the impact of air leakage requirements in the standard.
+  # Set the infiltration rate for this space to include the impact of air leakage requirements in the standard.
   #
+  # @param space [OpenStudio::Model::Space] space object
   # @return [Double] true if successful, false if not
   # @todo handle doors and vestibules
   def space_apply_infiltration_rate(space)
@@ -1317,15 +1312,16 @@ class Standard
 
   # Baseline infiltration rate
   #
+  # @param space [OpenStudio::Model::Space] space object
   # @return [Double] the baseline infiltration rate, in cfm/ft^2 exterior above grade wall area at 75 Pa
   def space_infiltration_rate_75_pa(space)
     basic_infil_rate_cfm_per_ft2 = 1.8
     return basic_infil_rate_cfm_per_ft2
   end
 
-  # Calculate the area of the exterior walls,
-  # including the area of the windows on these walls.
+  # Calculate the area of the exterior walls, including the area of the windows on these walls.
   #
+  # @param space [OpenStudio::Model::Space] space object
   # @return [Double] area in m^2
   def space_exterior_wall_and_window_area(space)
     area_m2 = 0.0
@@ -1348,9 +1344,9 @@ class Standard
     return area_m2
   end
 
-  # Calculate the area of the exterior walls,
-  # including the area of the windows on these walls.
+  # Calculate the area of the exterior walls, including the area of the windows on these walls.
   #
+  # @param space [OpenStudio::Model::Space] space object
   # @return [Double] area in m^2
   def space_exterior_wall_and_roof_and_subsurface_area(space)
     area_m2 = 0.0
@@ -1374,12 +1370,11 @@ class Standard
   end
 
   # Determine if the space is a plenum.
-  # Assume it is a plenum if it is a supply
-  # or return plenum for an AirLoop,
+  # Assume it is a plenum if it is a supply or return plenum for an AirLoop,
   # if it is not part of the total floor area,
-  # or if the space type name contains the
-  # word plenum.
+  # or if the space type name contains the word plenum.
   #
+  # @param space [OpenStudio::Model::Space] space object
   # return [Bool] returns true if plenum, false if not
   def space_plenum?(space)
     plenum_status = false
@@ -1394,7 +1389,7 @@ class Standard
       return plenum_status
     end
 
-    # TODO: - update to check if it has internal loads
+    # @todo update to check if it has internal loads
 
     # Check if the space type name
     # contains the word plenum.
@@ -1416,12 +1411,12 @@ class Standard
     return plenum_status
   end
 
-  # Determine if the space is residential based on the
-  # space type properties for the space.
+  # Determine if the space is residential based on the space type properties for the space.
   # For spaces with no space type, assume nonresidential.
   # For spaces that are plenums, base the decision on the space
   # type of the space below the largest floor in the plenum.
   #
+  # @param space [OpenStudio::Model::Space] space object
   # return [Bool] true if residential, false if nonresidential
   def space_residential?(space)
     is_res = false
@@ -1480,10 +1475,10 @@ class Standard
     return is_res
   end
 
-  # Determines whether the space is conditioned per 90.1,
-  # which is based on heating and cooling loads.
+  # Determines whether the space is conditioned per 90.1, which is based on heating and cooling loads.
   #
-  # @param climate_zone [String] climate zone
+  # @param space [OpenStudio::Model::Space] space object
+  # @param climate_zone [String] ASHRAE climate zone, e.g. 'ASHRAE 169-2013-4A'
   # @return [String] NonResConditioned, ResConditioned, Semiheated, Unconditioned
   # @todo add logic to detect indirectly-conditioned spaces
   def space_conditioning_category(space, climate_zone)
@@ -1501,12 +1496,12 @@ class Standard
     return cond_cat
   end
 
-  # Determines heating status.  If the space's
-  # zone has a thermostat with a maximum heating
-  # setpoint above 5C (41F), counts as heated.
+  # Determines heating status.
+  # If the space's zone has a thermostat with a maximum heating setpoint above 5C (41F), counts as heated.
   #
   # @author Andrew Parker, Julien Marrec
-  # @return [Bool] true if heated, false if not
+  # @param space [OpenStudio::Model::Space] space object
+  # @return [Bool] returns true if heated, false if not
   def space_heated?(space)
     # Get the zone this space is inside
     zone = space.thermalZone
@@ -1522,12 +1517,12 @@ class Standard
     return htd
   end
 
-  # Determines cooling status.  If the space's
-  # zone has a thermostat with a minimum cooling
-  # setpoint above 33C (91F), counts as cooled.
+  # Determines cooling status.
+  # If the space's zone has a thermostat with a minimum cooling setpoint above 33C (91F), counts as cooled.
   #
   # @author Andrew Parker, Julien Marrec
-  # @return [Bool] true if cooled, false if not
+  # @param space [OpenStudio::Model::Space] space object
+  # @return [Bool] returns true if cooled, false if not
   def space_cooled?(space)
     # Get the zone this space is inside
     zone = space.thermalZone
@@ -1543,13 +1538,11 @@ class Standard
     return cld
   end
 
-  # Determine the design internal load (W) for
-  # this space without space multipliers.
-  # This include People, Lights, Electric Equipment,
-  # and Gas Equipment.  It assumes 100% of the wattage
-  # is converted to heat, and that the design peak
-  # schedule value is 1 (100%).
+  # Determine the design internal load (W) for this space without space multipliers.
+  # This include People, Lights, Electric Equipment, and Gas Equipment.
+  # It assumes 100% of the wattage is converted to heat, and that the design peak schedule value is 1 (100%).
   #
+  # @param space [OpenStudio::Model::Space] space object
   # @return [Double] the design internal load, in W
   def space_design_internal_load(space)
     load_w = 0.0
@@ -1590,6 +1583,10 @@ class Standard
   end
 
   # will return a sorted array of array of spaces and connected area (Descending)
+  #
+  # @param space [OpenStudio::Model::Space] space object
+  # @param same_floor [Bool] only consider spaces on the same floor
+  # @return [Array<OpenStudio::Model::Space>] sorted array of spaces
   def space_get_adjacent_spaces_with_shared_wall_areas(space, same_floor = true)
     same_floor_spaces = []
     spaces = []
@@ -1651,19 +1648,22 @@ class Standard
   end
 
   # Find the space that has the most wall area touching this space.
+  #
+  # @param space [OpenStudio::Model::Space] space object
+  # @param same_floor [Bool] only consider spaces on the same floor
+  # @return [OpenStudio::Model::Space] space object
   def space_get_adjacent_space_with_most_shared_wall_area(space, same_floor = true)
     return get_adjacent_spaces_with_touching_area(same_floor)[0][0]
   end
 
-  # TODO: - add related related to space_hours_of_operation like set_space_hours_of_operation and shift_and_expand_space_hours_of_operation
-  # todo - ideally these could take in a date range, array of dates and or days of week. Hold off until need is a bit more defined.
-
+  # @todo add related related to space_hours_of_operation like set_space_hours_of_operation and shift_and_expand_space_hours_of_operation
+  # @todo ideally these could take in a date range, array of dates and or days of week. Hold off until need is a bit more defined.
   # If the model has an hours of operation schedule set in default schedule set for building that looks valid it will
   # report hours of operation. Won't be a single set of values, will be a collection of rules
   # note Building, space, and spaceType can get hours of operation from schedule set, but not buildingStory
   #
   # @author David Goldwasser
-  # @param space [Space] takes space
+  # @param space [OpenStudio::Model::Space] space object
   # @return [Hash] start and end of hours of operation, stat date, end date, bool for each day of the week
   def space_hours_of_operation(space)
     default_sch_type = OpenStudio::Model::DefaultScheduleType.new('HoursofOperationSchedule')
@@ -1829,7 +1829,7 @@ class Standard
   # expand hours of operation. When hours of operation do not overlap for two spaces, add logic to remove all but largest gap
   #
   # @author David Goldwasser
-  # @param space [Spaces] takes array of spaces
+  # @param spaces [Array<OpenStudio::Model::Space>] takes array of spaces
   # @return [Hash] start and end of hours of operation, stat date, end date, bool for each day of the week
   def spaces_hours_of_operation(spaces)
     hours_of_operation_array = []
@@ -1843,7 +1843,7 @@ class Standard
       end
     end
 
-    # TODO: - replace this with logic to get combined hours of operation for collection of spaces.
+    # @todo replace this with logic to get combined hours of operation for collection of spaces.
     # each hours_of_operation_array is hash with key for each profile.
     # each profile has hash with keys for hoo_start, hoo_end, hoo_hours, days_used
     # my goal is to compare profiles and days used across all profiles to create new entries as necessary
@@ -1853,7 +1853,7 @@ class Standard
 
     # OpenStudio.logFree(OpenStudio::Debug, 'openstudio.standards.Space', "Evaluating hours of operation for #{space_names.join(',')}: #{hours_of_operation_array}")
 
-    # TODO: - what is this getting max of, it isn't longest hours of operation, is it the most profiles?
+    # @todo what is this getting max of, it isn't longest hours of operation, is it the most profiles?
     hours_of_operation = hours_of_operation_array.max_by { |i| hours_of_operation_array.count(i) }
 
     return hours_of_operation
@@ -1861,11 +1861,15 @@ class Standard
 
   private
 
-  # A series of private methods to modify polygons.  Most are
-  # wrappers of native OpenStudio methods, but with
-  # workarounds for known issues or limitations.
+  # A series of private methods to modify polygons.
+  # Most are wrappers of native OpenStudio methods, but with workarounds for known issues or limitations.
 
   # Check the z coordinates of a polygon
+  #
+  # @param space [OpenStudio::Model::Space] space object
+  # @param polygons [Array<Array>] Array of array of vertices (polygons)
+  # @param name [String] name of polygons
+  # @return [Integer] return number of errors
   # @api private
   def space_check_z_zero(space, polygons, name)
     fails = []
@@ -1881,13 +1885,15 @@ class Standard
       end
     end
     # OpenStudio::logFree(OpenStudio::Error, "openstudio.standards.Space", "Checking z=0: #{name} is greater than or equal to #{clsss.uniq.to_s.gsub(/\[|\]/,'|')}.")
-    if errs > 0
-      OpenStudio.logFree(OpenStudio::Info, 'openstudio.standards.Space', "***FAIL*** #{space.name} z=0 failed for #{errs} vertices in #{name}; #{fails.join(', ')}.")
-    end
+    OpenStudio.logFree(OpenStudio::Info, 'openstudio.standards.Space', "***FAIL*** #{space.name} z=0 failed for #{errs} vertices in #{name}; #{fails.join(', ')}.") if errs > 0
+    return errs
   end
 
-  # A method to convert an array of arrays to
-  # an array of OpenStudio::Point3ds.
+  # A method to convert an array of arrays to an array of OpenStudio::Point3ds.
+  #
+  # @param space [OpenStudio::Model::Space] space object
+  # @param ruby_polygons [Array<Array>] Array of array of vertices (polygons)
+  # @return [Array<Array>] Array of array of Point3D objects (polygons)
   # @api private
   def space_ruby_polygons_to_point3d_z_zero(space, ruby_polygons)
     # Convert the final polygons back to OpenStudio
@@ -1905,6 +1911,11 @@ class Standard
   end
 
   # A method to zero-out the z vertex of an array of polygons
+  #
+  # @param space [OpenStudio::Model::Space] space object
+  # @param polygons [Array<Array>] Array of array of vertices (polygons)
+  # @param new_z [Double] new z value in meters
+  # @return [Array<Array>] Array of array of Point3D objects (polygons)
   # @api private
   def space_polygons_set_z(space, polygons, new_z)
     OpenStudio.logFree(OpenStudio::Debug, 'openstudio.standards.Space', "### #{polygons}")
@@ -1924,7 +1935,12 @@ class Standard
   end
 
   # A method to returns the number of duplicate vertices in a polygon.
-  # TODO does not actually wor
+  # @todo does not actually work
+  #
+  # @param space [OpenStudio::Model::Space] space object
+  # @param ruby_polygon [Array] array of vertices (polygon)
+  # @param tol [Double] tolerance
+  # @return [Array] array of duplicates
   # @api private
   def space_find_duplicate_vertices(space, ruby_polygon, tol = 0.001)
     OpenStudio.logFree(OpenStudio::Debug, 'openstudio.standards.Space', '***')
@@ -1946,8 +1962,14 @@ class Standard
     return duplicates
   end
 
-  # Subtracts one array of polygons from the next,
-  # returning an array of resulting polygons.
+  # Subtracts one array of polygons from the next, returning an array of resulting polygons.
+  #
+  # @param space [OpenStudio::Model::Space] space object
+  # @param a_polygons [Array<Array>] Array of array of vertices (polygons)
+  # @param b_polygons [Array<Array>] Array of array of vertices (polygons)
+  # @param a_name [String] name of a polygons
+  # @param b_name [String] name of b polygons
+  # @return [Array<Array>] Array of array of vertices (polygons)
   # @api private
   def space_a_polygons_minus_b_polygons(space, a_polygons, b_polygons, a_name, b_name)
     final_polygons_ruby = []
@@ -1972,7 +1994,7 @@ class Standard
         a_polygon_ruby << [vertex.x, vertex.y, vertex.z]
       end
 
-      # TODO: Skip really small polygons
+      # @todo Skip really small polygons
       # reduced_b_polygons = []
       # b_polygons.each do |b_polygon|
       # next
@@ -2015,7 +2037,7 @@ class Standard
 
       OpenStudio.logFree(OpenStudio::Debug, 'openstudio.standards.Space', "---Remove duplicates: #{a_minus_b_polygons_ruby.size} to #{unique_a_minus_b_polygons_ruby.size}")
 
-      # TODO: bug workaround?
+      # @todo bug workaround?
       # If the result includes the a polygon, the a polygon
       # was unchanged; only include that polgon and throw away the other junk?/bug? polygons.
       # If the result does not include the a polygon, the a polygon was
@@ -2039,7 +2061,7 @@ class Standard
     # Remove duplicate polygons again
     unique_final_polygons_ruby = final_polygons_ruby.uniq
 
-    # TODO: remove this workaround
+    # @todo remove this workaround
     # Split any polygons that are joined by a line into two separate
     # polygons.  Do this by finding duplicate
     # unique_final_polygons_ruby.each do |unique_final_polygon_ruby|
@@ -2062,6 +2084,12 @@ class Standard
 
   # Wrapper to catch errors in joinAll method
   # [utilities.geometry.joinAll] <1> Expected polygons to join together
+  #
+  # @param space [OpenStudio::Model::Space] space object
+  # @param polygons [Array] array of vertices (polygon)
+  # @param tol [Double] tolerance
+  # @param name [String] name of polygons
+  # @return [Array<Array>] Array of array of vertices (polygons)
   # @api private
   def space_join_polygons(space, polygons, tol, name)
     OpenStudio.logFree(OpenStudio::Debug, 'openstudio.standards.Space', "Joining #{name} from #{space.name}")
@@ -2097,7 +2125,7 @@ class Standard
     # Disable the log sink to prevent memory hogging
     msg_log.disable
 
-    # TODO: remove this workaround, which is tried if there
+    # @todo remove this workaround, which is tried if there
     # are any join errors.  This handles the case of polygons
     # that make an inner loop, the most common case being
     # when all 4 sides of a space have windows.
@@ -2161,6 +2189,10 @@ class Standard
   end
 
   # Gets the total area of a series of polygons
+  #
+  # @param space [OpenStudio::Model::Space] space object
+  # @param polygons [Array] array of vertices (polygon)
+  # @return [Double] area in meters
   # @api private
   def space_total_area_of_polygons(space, polygons)
     total_area_m2 = 0
@@ -2178,6 +2210,12 @@ class Standard
 
   # Returns an array of resulting polygons.
   # Assumes that a_polygons don't overlap one another, and that b_polygons don't overlap one another
+  #
+  # @param a_polygons [Array<Array>] Array of array of vertices (polygons)
+  # @param b_polygons [Array<Array>] Array of array of vertices (polygons)
+  # @param a_name [String] name of a polygons
+  # @param b_name [String] name of b polygons
+  # @return [Double] overlapping area in meters
   # @api private
   def space_area_a_polygons_overlap_b_polygons(space, a_polygons, b_polygons, a_name, b_name)
     OpenStudio.logFree(OpenStudio::Debug, 'openstudio.standards.Space', "#{a_polygons.size} #{a_name} overlaps #{b_polygons.size} #{b_name}")
@@ -2266,4 +2304,29 @@ class Standard
 
     return overlap_area
   end
+
+  # Determine if a space should be modeled with an occupancy standby mode
+  #
+  # @param space [OpenStudio::Model::Space] OpenStudio Space object
+  # @return [Boolean] true if occupancy standby mode is to be modeled, false otherwise
+  def space_occupancy_standby_mode_required?(space)
+    return false
+  end
+
+  # Provide the type of daylighting control type
+  #
+  # @param [OpenStudio::Model::Space] OpenStudio Space object
+  # return [String] daylighting control type
+  def space_daylighting_control_type(space)
+    return 'Stepped'
+  end
+
+  # Provide the minimum input power fraction for continuous
+  # dimming daylighting control
+  #
+  # @param [OpenStudio::Model::Space] OpenStudio Space object
+  # return [Float] daylighting minimum input power fraction
+  def space_daylighting_minimum_input_power_fraction(space)
+    return 0.3
+  end
 end