Standards.Construction.rb in openstudio-standards-0.5.0.rc1

- old
+ new

@@ -10,15 +10,15 @@
   #   Valid choices:  'AtticFloor', 'AtticWall', 'AtticRoof', 'DemisingFloor', 'InteriorFloor', 'InteriorCeiling',
   #   'DemisingWall', 'InteriorWall', 'InteriorPartition', 'InteriorWindow', 'InteriorDoor', 'DemisingRoof',
   #   'ExteriorRoof', 'Skylight', 'TubularDaylightDome', 'TubularDaylightDiffuser', 'ExteriorFloor',
   #   'ExteriorWall', 'ExteriorWindow', 'ExteriorDoor', 'GlassDoor', 'OverheadDoor', 'GroundContactFloor',
   #   'GroundContactWall', 'GroundContactRoof'
-  # @param target_includes_int_film_coefficients [Bool] if true, subtracts off standard film interior coefficients from your
+  # @param target_includes_int_film_coefficients [Boolean] if true, subtracts off standard film interior coefficients from your
   #   target_u_value before modifying insulation thickness.  Film values from 90.1-2010 A9.4.1 Air Films
-  # @param target_includes_ext_film_coefficients [Bool] if true, subtracts off standard exterior film coefficients from your
+  # @param target_includes_ext_film_coefficients [Boolean] if true, subtracts off standard exterior film coefficients from your
   #   target_u_value before modifying insulation thickness.  Film values from 90.1-2010 A9.4.1 Air Films
-  # @return [Bool] returns true if successful, false if not
+  # @return [Boolean] returns true if successful, false if not
   # @todo Put in Phlyroy's logic for inferring the insulation layer of a construction
   def construction_set_u_value(construction, target_u_value_ip, insulation_layer_name = nil, intended_surface_type = 'ExteriorWall', target_includes_int_film_coefficients, target_includes_ext_film_coefficients)
     OpenStudio.logFree(OpenStudio::Debug, 'openstudio.standards.Construction', "Setting U-Value for #{construction.name}.")
 
     # Skip layer-by-layer fenestration constructions
@@ -132,15 +132,15 @@
   #   Valid choices:  'AtticFloor', 'AtticWall', 'AtticRoof', 'DemisingFloor', 'InteriorFloor', 'InteriorCeiling',
   #   'DemisingWall', 'InteriorWall', 'InteriorPartition', 'InteriorWindow', 'InteriorDoor', 'DemisingRoof',
   #   'ExteriorRoof', 'Skylight', 'TubularDaylightDome', 'TubularDaylightDiffuser', 'ExteriorFloor',
   #   'ExteriorWall', 'ExteriorWindow', 'ExteriorDoor', 'GlassDoor', 'OverheadDoor', 'GroundContactFloor',
   #   'GroundContactWall', 'GroundContactRoof'
-  # @param target_includes_int_film_coefficients [Bool] if true, subtracts off standard film interior coefficients from your
+  # @param target_includes_int_film_coefficients [Boolean] if true, subtracts off standard film interior coefficients from your
   #   target_u_value before modifying insulation thickness.  Film values from 90.1-2010 A9.4.1 Air Films
-  # @param target_includes_ext_film_coefficients [Bool] if true, subtracts off standard exterior film coefficients from your
+  # @param target_includes_ext_film_coefficients [Boolean] if true, subtracts off standard exterior film coefficients from your
   #   target_u_value before modifying insulation thickness.  Film values from 90.1-2010 A9.4.1 Air Films
-  # @return [Bool] returns true if successful, false if not
+  # @return [Boolean] returns true if successful, false if not
   def construction_set_glazing_u_value(construction, target_u_value_ip, intended_surface_type = 'ExteriorWall', target_includes_int_film_coefficients, target_includes_ext_film_coefficients)
     OpenStudio.logFree(OpenStudio::Debug, 'openstudio.standards.Construction', "Setting U-Value for #{construction.name}.")
 
     # Skip layer-by-layer fenestration constructions
     unless construction_simple_glazing?(construction)
@@ -217,11 +217,11 @@
 
   # Sets the U-value of a construction to a specified value by modifying the thickness of the insulation layer.
   #
   # @param construction [OpenStudio::Model::Construction] construction object
   # @param target_shgc [Double] Solar Heat Gain Coefficient
-  # @return [Bool] returns true if successful, false if not
+  # @return [Boolean] returns true if successful, false if not
   def construction_set_glazing_shgc(construction, target_shgc)
     OpenStudio.logFree(OpenStudio::Debug, 'openstudio.standards.Construction', "Setting SHGC for #{construction.name}.")
 
     # Skip layer-by-layer fenestration constructions
     unless construction_simple_glazing?(construction)
@@ -242,11 +242,11 @@
 
   # Determines if the construction is a simple glazing construction,
   # as indicated by having a single layer of type SimpleGlazing.
   #
   # @param construction [OpenStudio::Model::Construction] construction object
-  # @return [Bool] returns true if it is a simple glazing, false if not
+  # @return [Boolean] returns true if it is a simple glazing, false if not
   def construction_simple_glazing?(construction)
     # Not simple if more than 1 layer
     if construction.layers.length > 1
       return false
     end
@@ -267,11 +267,11 @@
   # Table A6.3 Assembly F-Factors for Slab-on-Grade Floors.
   #
   # @param construction [OpenStudio::Model::Construction] construction object
   # @param target_f_factor_ip [Double] F-Factor
   # @param insulation_layer_name [String] The name of the insulation layer in this construction
-  # @return [Bool] returns true if successful, false if not
+  # @return [Boolean] returns true if successful, false if not
   def construction_set_slab_f_factor(construction, target_f_factor_ip, insulation_layer_name = nil)
     # Regression from table A6.3 unheated, fully insulated slab
     r_value_ip = 1.0248 * target_f_factor_ip**-2.186
     u_value_ip = 1.0 / r_value_ip
 
@@ -287,11 +287,11 @@
   # Set the surface specific F-factor parameters of a construction
   #
   # @param construction [OpenStudio::Model::FFactorGroundFloorConstruction] OpenStudio F-factor construction object
   # @param target_f_factor_ip [Float] Targeted F-Factor in IP units
   # @param surface [OpenStudio::Model::Surface] OpenStudio surface object
-  # @return [Bool] returns true if successful, false if not
+  # @return [Boolean] returns true if successful, false if not
   def construction_set_surface_slab_f_factor(construction, target_f_factor_ip, surface)
     # Get space associated with surface
     space = surface.space.get
 
     # Find this space's exposed floor area and perimeter. NOTE: this assumes only only floor per space.
@@ -323,11 +323,11 @@
   # Table A4.2 Assembly C-Factors for Below-Grade walls.
   #
   # @param construction [OpenStudio::Model::Construction] construction object
   # @param target_c_factor_ip [Double] C-Factor
   # @param insulation_layer_name [String] The name of the insulation layer in this construction
-  # @return [Bool] returns true if successful, false if not
+  # @return [Boolean] returns true if successful, false if not
   def construction_set_underground_wall_c_factor(construction, target_c_factor_ip, insulation_layer_name = nil)
     # Regression from table A4.2 continuous exterior insulation
     r_value_ip = 0.775 * target_c_factor_ip**-1.067
     u_value_ip = 1.0 / r_value_ip
 
@@ -343,11 +343,11 @@
   # Set the surface specific C-factor parameters of a construction
   #
   # @param construction [OpenStudio::Model::CFactorUndergroundWallConstruction] OpenStudio C-factor construction object
   # @param target_c_factor_ip [Float] Targeted C-Factor in IP units
   # @param surface [OpenStudio::Model::Surface] OpenStudio surface object
-  # @return [Bool] returns true if successful, false if not
+  # @return [Boolean] returns true if successful, false if not
   def construction_set_surface_underground_wall_c_factor(construction, target_c_factor_ip, surface)
     # Get space associated with surface
     space = surface.space.get
 
     # Get height of the first below grade wall in this space.
@@ -527,12 +527,11 @@
   end
 
   # Calculate the fenestration U-Factor base on the glass, frame,
   # and divider performance and area calculated by EnergyPlus.
   #
-  # @param [OpenStudio:Model:Construction] OpenStudio Construction object
-  #
+  # @param construction [OpenStudio:Model:Construction] OpenStudio Construction object
   # @return [Double] the U-Factor in W/m^2*K
   def construction_calculated_fenestration_u_factor_w_frame(construction)
     construction_name = construction.name.get.to_s
 
     u_factor_w_per_m2_k = nil
@@ -682,11 +681,11 @@
 
   # change construction properties based on an a set of values
   #
   # @param model [OpenStudio::Model::Model] OpenStudio model object
   # @param values [Hash] has of values
-  # @param is_percentage [Bool] toggle is percentage
+  # @param is_percentage [Boolean] toggle is percentage
   # @return [Hash] json information
   def change_construction_properties_in_model(model, values, is_percentage = false)
     # puts JSON.pretty_generate(values)
     # copy orginal model for reporting.
     before_measure_model = BTAP::FileIO.deep_copy(model)
@@ -744,12 +743,12 @@
   # @param model [OpenStudio::Model::Model] OpenStudio model object
   # @param surface [OpenStudio::Model::Surface] surface object
   # @param conductance [Double] conductance value in SI
   # @param shgc [Double] solar heat gain coefficient value, unitless
   # @param tvis [Double] visible transmittance
-  # @param is_percentage [Bool] toggle is percentage
-  # @return [Bool] returns true if successful, false if not
+  # @param is_percentage [Boolean] toggle is percentage
+  # @return [Boolean] returns true if successful, false if not
   def apply_changes_to_surface_construction(model, surface, conductance = nil, shgc = nil, tvis = nil, is_percentage = false)
     # If user has no changes...do nothing and return true.
     return true if conductance.nil? && shgc.nil? && tvis.nil?
 
     standard = Standard.new
@@ -875,10 +874,10 @@
   # Sets the T-vis of a simple glazing construction to a specified value
   # by modifying the thickness of the insulation layer.
   #
   # @param construction [OpenStudio::Model::Construction] construction object
   # @param target_tvis [Double] Visible Transmittance
-  # @return [Bool] returns true if successful, false if not
+  # @return [Boolean] returns true if successful, false if not
   def construction_set_glazing_tvis(construction, target_tvis)
     if target_tvis >= 1.0
       OpenStudio.logFree(OpenStudio::Error, 'openstudio.standards.Construction', "Can only set the Tvis can only be set to less than 1.0. #{target_tvis} is greater than 1.0")
       return false
     end