openstudio-model-articulation 0.3.1 → 0.6.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (203) hide show
  1. checksums.yaml +4 -4
  2. data/.rubocop.yml +2 -1
  3. data/CHANGELOG.md +28 -0
  4. data/Gemfile +6 -0
  5. data/Jenkinsfile +1 -0
  6. data/LICENSE.md +1 -1
  7. data/README.md +22 -3
  8. data/doc_templates/LICENSE.md +1 -1
  9. data/doc_templates/copyright_erb.txt +1 -1
  10. data/doc_templates/copyright_js.txt +1 -1
  11. data/doc_templates/copyright_ruby.txt +1 -1
  12. data/lib/measures/AssignConstructionSetToBuilding/LICENSE.md +1 -1
  13. data/lib/measures/AssignConstructionSetToBuilding/measure.rb +1 -1
  14. data/lib/measures/AssignConstructionSetToBuilding/measure.xml +16 -15
  15. data/lib/measures/AssignSpaceTypeBySpaceName/LICENSE.md +1 -1
  16. data/lib/measures/AssignSpaceTypeBySpaceName/measure.rb +1 -1
  17. data/lib/measures/AssignSpaceTypeBySpaceName/measure.xml +32 -13
  18. data/lib/measures/AssignSpaceTypeToBuilding/LICENSE.md +1 -1
  19. data/lib/measures/AssignSpaceTypeToBuilding/measure.rb +1 -1
  20. data/lib/measures/AssignSpaceTypeToBuilding/measure.xml +16 -15
  21. data/lib/measures/AssignSpacesToStories/LICENSE.md +1 -1
  22. data/lib/measures/AssignSpacesToStories/measure.rb +3 -5
  23. data/lib/measures/AssignSpacesToStories/measure.xml +14 -13
  24. data/lib/measures/BarAspectRatioStudy/LICENSE.md +1 -1
  25. data/lib/measures/BarAspectRatioStudy/measure.rb +3 -2
  26. data/lib/measures/BarAspectRatioStudy/measure.xml +8 -7
  27. data/lib/measures/CleanupSpaceOrigins/LICENSE.md +1 -1
  28. data/lib/measures/CleanupSpaceOrigins/measure.rb +4 -1
  29. data/lib/measures/CleanupSpaceOrigins/measure.xml +14 -13
  30. data/lib/measures/FindAndReplaceObjectNames/LICENSE.md +1 -1
  31. data/lib/measures/FindAndReplaceObjectNames/measure.rb +1 -1
  32. data/lib/measures/FindAndReplaceObjectNames/measure.xml +13 -12
  33. data/lib/measures/InjectOsmGeometryIntoAnExternalIdf/LICENSE.md +1 -1
  34. data/lib/measures/InjectOsmGeometryIntoAnExternalIdf/measure.rb +3 -3
  35. data/lib/measures/InjectOsmGeometryIntoAnExternalIdf/measure.xml +28 -10
  36. data/lib/measures/RemoveHardAssignedConstructions/LICENSE.md +1 -1
  37. data/lib/measures/RemoveHardAssignedConstructions/measure.rb +1 -1
  38. data/lib/measures/RemoveHardAssignedConstructions/measure.xml +13 -12
  39. data/lib/measures/RenameSpaceSurfacesBasedonParentSpaceandOrientation/LICENSE.md +1 -1
  40. data/lib/measures/RenameSpaceSurfacesBasedonParentSpaceandOrientation/measure.rb +1 -1
  41. data/lib/measures/RenameSpaceSurfacesBasedonParentSpaceandOrientation/measure.xml +42 -11
  42. data/lib/measures/RotateBuilding/LICENSE.md +1 -1
  43. data/lib/measures/RotateBuilding/measure.rb +1 -1
  44. data/lib/measures/RotateBuilding/measure.xml +13 -12
  45. data/lib/measures/SetExtWallToGroundBoundaryConditionByStory/LICENSE.md +1 -1
  46. data/lib/measures/SetExtWallToGroundBoundaryConditionByStory/measure.rb +1 -1
  47. data/lib/measures/SetExtWallToGroundBoundaryConditionByStory/measure.xml +17 -10
  48. data/lib/measures/SetInteriorWallsAndFloorsToAdiabatic/LICENSE.md +1 -1
  49. data/lib/measures/SetInteriorWallsAndFloorsToAdiabatic/measure.rb +2 -2
  50. data/lib/measures/SetInteriorWallsAndFloorsToAdiabatic/measure.xml +13 -12
  51. data/lib/measures/SetInteriorWallsToSelectedConstruction/LICENSE.md +1 -1
  52. data/lib/measures/SetInteriorWallsToSelectedConstruction/measure.rb +2 -2
  53. data/lib/measures/SetInteriorWallsToSelectedConstruction/measure.xml +13 -12
  54. data/lib/measures/SetWindowToWallRatioByFacade/LICENSE.md +1 -1
  55. data/lib/measures/SetWindowToWallRatioByFacade/README.md +11 -0
  56. data/lib/measures/SetWindowToWallRatioByFacade/measure.rb +91 -143
  57. data/lib/measures/SetWindowToWallRatioByFacade/measure.xml +32 -11
  58. data/lib/measures/SetWindowToWallRatioByFacade/resources/functions.rb +176 -0
  59. data/lib/measures/SimplifyGeometryToSlicedBar/LICENSE.md +1 -1
  60. data/lib/measures/SimplifyGeometryToSlicedBar/measure.rb +9 -5
  61. data/lib/measures/SimplifyGeometryToSlicedBar/measure.xml +31 -13
  62. data/lib/measures/SimplifyGeometryToSlicedBar/resources/os_lib_cofee.rb +7 -5
  63. data/lib/measures/SimplifyGeometryToSlicedBar/resources/os_lib_geometry.rb +14 -9
  64. data/lib/measures/SimplifyGeometryToSlicedBar/resources/os_lib_helper_methods.rb +3 -5
  65. data/lib/measures/SpaceTypeAndConstructionSetWizard/LICENSE.md +1 -1
  66. data/lib/measures/SpaceTypeAndConstructionSetWizard/measure.rb +2 -2
  67. data/lib/measures/SpaceTypeAndConstructionSetWizard/measure.xml +63 -11
  68. data/lib/measures/SurfaceMatching/LICENSE.md +1 -1
  69. data/lib/measures/SurfaceMatching/measure.rb +2 -1
  70. data/lib/measures/SurfaceMatching/measure.xml +13 -12
  71. data/lib/measures/{BarAspectRatioSlicedBySpaceType → add_empd_material_properties}/LICENSE.md +1 -1
  72. data/lib/measures/add_empd_material_properties/README.md +116 -0
  73. data/lib/measures/{BarAspectRatioSlicedBySpaceType → add_empd_material_properties}/README.md.erb +0 -0
  74. data/lib/measures/add_empd_material_properties/docs/.gitkeep +0 -0
  75. data/lib/measures/add_empd_material_properties/measure.rb +247 -0
  76. data/lib/measures/add_empd_material_properties/measure.xml +201 -0
  77. data/lib/measures/blended_space_type_from_floor_area_ratios/LICENSE.md +1 -1
  78. data/lib/measures/blended_space_type_from_floor_area_ratios/measure.rb +5 -4
  79. data/lib/measures/blended_space_type_from_floor_area_ratios/measure.xml +5 -5
  80. data/lib/measures/blended_space_type_from_model/LICENSE.md +1 -1
  81. data/lib/measures/blended_space_type_from_model/{resources → docs}/replace_occupied_spaces_with_blended_space_type_design_doc.txt +0 -0
  82. data/lib/measures/blended_space_type_from_model/measure.rb +16 -4
  83. data/lib/measures/blended_space_type_from_model/measure.xml +16 -22
  84. data/lib/measures/clone_building_from_external_model/LICENSE.md +1 -1
  85. data/lib/measures/clone_building_from_external_model/measure.rb +1 -1
  86. data/lib/measures/clone_building_from_external_model/measure.xml +5 -5
  87. data/lib/measures/create_DOE_prototype_building/LICENSE.md +1 -1
  88. data/lib/measures/create_DOE_prototype_building/measure.rb +4 -3
  89. data/lib/measures/create_DOE_prototype_building/measure.xml +163 -27
  90. data/lib/measures/create_and_assign_thermal_zones_for_unassigned_spaces/LICENSE.md +1 -1
  91. data/lib/measures/create_and_assign_thermal_zones_for_unassigned_spaces/measure.rb +1 -1
  92. data/lib/measures/create_and_assign_thermal_zones_for_unassigned_spaces/measure.xml +5 -5
  93. data/lib/measures/create_bar_from_building_type_ratios/LICENSE.md +1 -1
  94. data/lib/measures/create_bar_from_building_type_ratios/README.md +109 -35
  95. data/lib/measures/create_bar_from_building_type_ratios/README.md.erb +54 -35
  96. data/lib/measures/create_bar_from_building_type_ratios/measure.rb +9 -4
  97. data/lib/measures/create_bar_from_building_type_ratios/measure.xml +124 -12
  98. data/lib/measures/create_bar_from_deer_building_type_ratios/LICENSE.md +1 -1
  99. data/lib/measures/create_bar_from_deer_building_type_ratios/README.md +301 -79
  100. data/lib/measures/create_bar_from_deer_building_type_ratios/README.md.erb +62 -79
  101. data/lib/measures/create_bar_from_deer_building_type_ratios/measure.rb +10 -5
  102. data/lib/measures/create_bar_from_deer_building_type_ratios/measure.xml +15 -59
  103. data/lib/measures/create_bar_from_doe_building_type_ratios/LICENSE.md +1 -1
  104. data/lib/measures/create_bar_from_doe_building_type_ratios/README.md +298 -57
  105. data/lib/measures/create_bar_from_doe_building_type_ratios/README.md.erb +54 -57
  106. data/lib/measures/create_bar_from_doe_building_type_ratios/measure.rb +10 -5
  107. data/lib/measures/create_bar_from_doe_building_type_ratios/measure.xml +122 -14
  108. data/lib/measures/create_bar_from_model/LICENSE.md +1 -1
  109. data/lib/measures/create_bar_from_model/measure.rb +11 -7
  110. data/lib/measures/create_bar_from_model/measure.xml +5 -5
  111. data/lib/measures/create_bar_from_space_type_ratios/LICENSE.md +27 -0
  112. data/lib/measures/create_bar_from_space_type_ratios/README.md +556 -0
  113. data/lib/measures/create_bar_from_space_type_ratios/README.md.erb +324 -0
  114. data/lib/measures/create_bar_from_space_type_ratios/docs/ar_05.png +0 -0
  115. data/lib/measures/create_bar_from_space_type_ratios/docs/ar_1.png +0 -0
  116. data/lib/measures/create_bar_from_space_type_ratios/docs/ar_2.png +0 -0
  117. data/lib/measures/create_bar_from_space_type_ratios/docs/bar_double_loaded.png +0 -0
  118. data/lib/measures/create_bar_from_space_type_ratios/docs/bar_single_core_perim.png +0 -0
  119. data/lib/measures/create_bar_from_space_type_ratios/docs/bar_sliced_indiv.png +0 -0
  120. data/lib/measures/create_bar_from_space_type_ratios/docs/bar_sliced_simple.png +0 -0
  121. data/lib/measures/create_bar_from_space_type_ratios/docs/basement.png +0 -0
  122. data/lib/measures/create_bar_from_space_type_ratios/docs/custom_height_false.png +0 -0
  123. data/lib/measures/create_bar_from_space_type_ratios/docs/custom_height_true.png +0 -0
  124. data/lib/measures/create_bar_from_space_type_ratios/docs/no_party_mult.png +0 -0
  125. data/lib/measures/create_bar_from_space_type_ratios/docs/party.png +0 -0
  126. data/lib/measures/create_bar_from_space_type_ratios/docs/party_multi.png +0 -0
  127. data/lib/measures/create_bar_from_space_type_ratios/docs/perim_mult_2010.png +0 -0
  128. data/lib/measures/create_bar_from_space_type_ratios/docs/perim_mult_2012.png +0 -0
  129. data/lib/measures/create_bar_from_space_type_ratios/docs/perim_mult_2020.png +0 -0
  130. data/lib/measures/create_bar_from_space_type_ratios/docs/sep_05.png +0 -0
  131. data/lib/measures/create_bar_from_space_type_ratios/docs/sep_10.png +0 -0
  132. data/lib/measures/create_bar_from_space_type_ratios/docs/sep_3.png +0 -0
  133. data/lib/measures/create_bar_from_space_type_ratios/docs/story_sort.png +0 -0
  134. data/lib/measures/create_bar_from_space_type_ratios/docs/wwr_custom.png +0 -0
  135. data/lib/measures/create_bar_from_space_type_ratios/measure.rb +314 -0
  136. data/lib/measures/create_bar_from_space_type_ratios/measure.xml +687 -0
  137. data/lib/measures/create_baseline_building/LICENSE.md +1 -1
  138. data/lib/measures/create_baseline_building/measure.rb +4 -3
  139. data/lib/measures/create_baseline_building/measure.xml +5 -5
  140. data/lib/measures/create_deer_prototype_building/LICENSE.md +1 -1
  141. data/lib/measures/create_deer_prototype_building/measure.rb +1 -1
  142. data/lib/measures/create_deer_prototype_building/measure.xml +6 -6
  143. data/lib/measures/create_deer_prototype_building/resources/deer_building_types.rb +1 -1
  144. data/lib/measures/create_parametric_schedules/LICENSE.md +1 -1
  145. data/lib/measures/create_parametric_schedules/measure.rb +16 -11
  146. data/lib/measures/create_parametric_schedules/measure.xml +5 -5
  147. data/lib/measures/create_typical_building_from_model/LICENSE.md +1 -1
  148. data/lib/measures/create_typical_building_from_model/README.md +82 -17
  149. data/lib/measures/create_typical_building_from_model/README.md.erb +36 -16
  150. data/lib/measures/create_typical_building_from_model/measure.rb +8 -6
  151. data/lib/measures/create_typical_building_from_model/measure.xml +59 -27
  152. data/lib/measures/create_typical_building_from_model/resources/Model.hvac.rb +8 -5
  153. data/lib/measures/create_typical_deer_building_from_model/LICENSE.md +1 -1
  154. data/lib/measures/create_typical_deer_building_from_model/README.md +173 -53
  155. data/lib/measures/create_typical_deer_building_from_model/README.md.erb +57 -53
  156. data/lib/measures/create_typical_deer_building_from_model/measure.rb +8 -3
  157. data/lib/measures/create_typical_deer_building_from_model/measure.xml +26 -26
  158. data/lib/measures/create_typical_deer_building_from_model/resources/Model.hvac.rb +8 -5
  159. data/lib/measures/create_typical_doe_building_from_model/LICENSE.md +1 -1
  160. data/lib/measures/create_typical_doe_building_from_model/README.md +182 -44
  161. data/lib/measures/create_typical_doe_building_from_model/README.md.erb +58 -44
  162. data/lib/measures/create_typical_doe_building_from_model/measure.rb +8 -3
  163. data/lib/measures/create_typical_doe_building_from_model/measure.xml +60 -28
  164. data/lib/measures/create_typical_doe_building_from_model/resources/Model.hvac.rb +8 -5
  165. data/lib/measures/deer_space_type_and_construction_set_wizard/LICENSE.md +1 -1
  166. data/lib/measures/deer_space_type_and_construction_set_wizard/measure.rb +2 -2
  167. data/lib/measures/deer_space_type_and_construction_set_wizard/measure.xml +17 -17
  168. data/lib/measures/find_and_replace_in_all_thermal_zone_names/LICENSE.md +1 -1
  169. data/lib/measures/find_and_replace_in_all_thermal_zone_names/measure.rb +1 -1
  170. data/lib/measures/find_and_replace_in_all_thermal_zone_names/measure.xml +8 -7
  171. data/lib/measures/make_shading_surfaces_based_on_zone_multipliers/LICENSE.md +1 -1
  172. data/lib/measures/make_shading_surfaces_based_on_zone_multipliers/measure.rb +3 -1
  173. data/lib/measures/make_shading_surfaces_based_on_zone_multipliers/measure.xml +5 -5
  174. data/lib/measures/merge_floorspace_js_with_model/LICENSE.md +1 -1
  175. data/lib/measures/merge_floorspace_js_with_model/measure.rb +5 -2
  176. data/lib/measures/merge_floorspace_js_with_model/measure.xml +5 -5
  177. data/lib/measures/merge_spaces_from_external_file/LICENSE.md +1 -1
  178. data/lib/measures/merge_spaces_from_external_file/measure.rb +1 -1
  179. data/lib/measures/merge_spaces_from_external_file/measure.xml +6 -6
  180. data/lib/measures/merge_spaces_from_external_file/resources/ScheduleTranslator.rb +1 -1
  181. data/lib/measures/radiance_measure/LICENSE.md +1 -1
  182. data/lib/measures/radiance_measure/measure.rb +63 -57
  183. data/lib/measures/radiance_measure/measure.xml +11 -11
  184. data/lib/measures/radiant_slab_with_doas/LICENSE.md +1 -1
  185. data/lib/measures/radiant_slab_with_doas/measure.rb +9 -2
  186. data/lib/measures/radiant_slab_with_doas/measure.xml +10 -10
  187. data/lib/measures/replace_geometry_by_story/LICENSE.md +1 -1
  188. data/lib/measures/replace_geometry_by_story/measure.rb +5 -1
  189. data/lib/measures/replace_geometry_by_story/measure.xml +5 -5
  190. data/lib/measures/scale_geometry/LICENSE.md +1 -1
  191. data/lib/measures/scale_geometry/measure.rb +1 -1
  192. data/lib/measures/scale_geometry/measure.xml +5 -5
  193. data/lib/openstudio/model_articulation/extension.rb +1 -1
  194. data/lib/openstudio/model_articulation/version.rb +2 -2
  195. data/lib/openstudio/model_articulation.rb +1 -1
  196. data/lib/openstudio-model-articulation.rb +1 -1
  197. data/openstudio-model-articulation.gemspec +3 -3
  198. metadata +42 -16
  199. data/lib/measures/BarAspectRatioSlicedBySpaceType/README.md +0 -64
  200. data/lib/measures/BarAspectRatioSlicedBySpaceType/measure.rb +0 -184
  201. data/lib/measures/BarAspectRatioSlicedBySpaceType/measure.xml +0 -130
  202. data/lib/measures/BarAspectRatioSlicedBySpaceType/resources/os_lib_cofee.rb +0 -252
  203. data/lib/measures/blended_space_type_from_model/resources/os_lib_model_simplification.rb +0 -1049
@@ -12,59 +12,251 @@ The building floor area can be described as a footprint size or as a total build
12
12
  ## Measure Type
13
13
  ModelMeasure
14
14
 
15
- [//]: # (Commenting out until it works in SDK)
16
- [//]: # (## Taxonomy)
17
- [//]: # ()
15
+ [//]: # (Only finds value if taxonomy method is added to measure.rb, won't read out of measure.xml)
16
+ ## Taxonomy
17
+ Envelope.Form
18
18
 
19
19
  ___
20
20
  ## Table of Contents
21
21
  - [Measure Overview](#measure-overview)<br/>
22
22
  - [DOE Template and Building Type Mapping](#doe-template-and-building-type-mapping)<br/>
23
- - [Building Type Mix](#building-type-mix)<br/>
24
- - [Floor Area](#floor-area)<br/>
25
- - [Height, Stories, and Orientation](#height-stories-and-orientation)<br/>
26
- - [Building Shape](#building-shape)<br/>
27
- - [Window to Wall Ratio](#window-to-wall-ratio)<br/>
28
- - [Party Walls and Exposure of Top and Bottom Stories](#party-walls-and-exposure-of-top-and-bottom-stories)<br/>
29
- - [Calculation Methods and Articulation Logic](#calculation-methods-and-articulation-logic)<br/>
23
+ - [Functionality and Input Overview](#functionality-and-input-overview)<br/>
24
+ - [Building Type Mix](#building-type-mix)<br/>
25
+ - [Floor Area](#floor-area)<br/>
26
+ - [Height, Stories, and Orientation](#height-stories-and-orientation)<br/>
27
+ - [Template](#template)<br/>
28
+ - [Building Shape](#building-shape)<br/>
29
+ - [Window to Wall Ratio](#window-to-wall-ratio)<br/>
30
+ - [Party Walls and Exposure of Top and Bottom Stories](#party-walls-and-exposure-of-top-and-bottom-stories)<br/>
31
+ - [Calculation Methods and Articulation Logic](#calculation-methods-and-articulation-logic)<br/>
30
32
  - [Development Comments](#development-comments)<br/>
31
33
  - [Automatically Generated Argument List](#arguments)<br/>
32
34
 
33
35
  ## Measure Overview
34
36
 
35
- The intent of this measure is to create basic geometry given a mix of building types and high level characteristics about the building envelope like the number of stories, aspect ratio, orientation etc. This will result in one or more rectangular building elements. The spaces will have stub space type assignments but will not have any internal loads or and the surfaces will not have constructions. The stub space type ratios are based on DOE prototype buildings, depending on the building type you select. The typical workflow is to run other measures after this measure that populate the stub space types and other model elements. This measure has 38 arguments and can look intimidating, but all of them have defaults, so it will run properly without you changing any arguments; however at a minimum you will typically want to at least choose the primary building type, building floor area, and number of stories above grade. Make use of additional arguments as you have a need to.
37
+ The intent of this measure is to create basic geometry given a mix of building types and high level characteristics about the building envelope like the number of stories, aspect ratio, orientation etc. This will result in one or more rectangular building elements. The spaces will have stub space type assignments but will not have any internal loads or and the surfaces will not have constructions. The stub space type ratios are based on DOE prototype buildings, depending on the building type you select. The typical workflow is to run other measures after this measure that populate the stub space types and other model elements. This measure has more than 30 arguments and can look intimidating, but all of them have defaults, so it will run properly without you changing any arguments; however at a minimum you will typically want to at least choose the primary building type, building floor area, and number of stories above grade. Make use of additional arguments as you have a need to.
36
38
 
37
- This is generally meant to run on an empty model, but it does not activily delete any geometry or objects that may already be in the model.
39
+ This is generally meant to run on an empty model, but it does not actively delete any geometry or objects that may already be in the model.
38
40
 
39
41
  ## DOE Template and Building Type Mapping
40
42
 
41
- - Templates:
42
- - DOE Ref Pre-1980
43
- - DOE Ref 1980 - 2004
44
- - 90.1-2004
45
- - 90.1-2007
46
- - 90.1-2010
47
- - 90.1-2013
48
- - Building Types:
49
- - SecondarySchool
50
- - PrimarySchool
51
- - SmallOffice
52
- - MediumOffice
53
- - LargeOffice
54
- - SmallHotel
55
- - LargeHotel
56
- - Warehouse
57
- - RetailStandalone
58
- - RetailStripmall
59
- - QuickServiceRestaurant
60
- - FullServiceRestaurant
61
- - MidriseApartment
62
- - HighriseApartment
63
- - Hospital
64
- - Outpatient
65
- - SuperMarket
66
-
67
- [//]: # (Would be nice to make these lists dynamic from the measure to they don't become outdated)
43
+ The Templates prefixed with "Comstock"" have been slightly modified over the template of the same name without the prefix to be more representation of general use inputs."
44
+
45
+ #### Templates:
46
+
47
+
48
+
49
+
50
+
51
+
52
+
53
+
54
+
55
+
56
+
57
+
58
+
59
+
60
+
61
+
62
+
63
+
64
+
65
+
66
+
67
+
68
+
69
+
70
+
71
+
72
+
73
+
74
+
75
+
76
+
77
+ - DOE Ref Pre-1980<br/>
78
+
79
+ - DOE Ref 1980-2004<br/>
80
+
81
+ - 90.1-2004<br/>
82
+
83
+ - 90.1-2007<br/>
84
+
85
+ - 90.1-2010<br/>
86
+
87
+ - 90.1-2013<br/>
88
+
89
+ - 90.1-2016<br/>
90
+
91
+ - 90.1-2019<br/>
92
+
93
+ - ComStock DOE Ref Pre-1980<br/>
94
+
95
+ - ComStock DOE Ref 1980-2004<br/>
96
+
97
+ - ComStock 90.1-2004<br/>
98
+
99
+ - ComStock 90.1-2007<br/>
100
+
101
+ - ComStock 90.1-2010<br/>
102
+
103
+ - ComStock 90.1-2013<br/>
104
+
105
+
106
+
107
+
108
+
109
+
110
+
111
+
112
+
113
+
114
+
115
+
116
+
117
+
118
+
119
+
120
+
121
+
122
+
123
+
124
+
125
+
126
+
127
+
128
+
129
+
130
+
131
+
132
+
133
+
134
+
135
+
136
+
137
+
138
+
139
+
140
+
141
+
142
+
143
+
144
+ #### Building Types::
145
+
146
+
147
+
148
+ - SecondarySchool<br/>
149
+
150
+ - PrimarySchool<br/>
151
+
152
+ - SmallOffice<br/>
153
+
154
+ - MediumOffice<br/>
155
+
156
+ - LargeOffice<br/>
157
+
158
+ - SmallHotel<br/>
159
+
160
+ - LargeHotel<br/>
161
+
162
+ - Warehouse<br/>
163
+
164
+ - RetailStandalone<br/>
165
+
166
+ - RetailStripmall<br/>
167
+
168
+ - QuickServiceRestaurant<br/>
169
+
170
+ - FullServiceRestaurant<br/>
171
+
172
+ - MidriseApartment<br/>
173
+
174
+ - HighriseApartment<br/>
175
+
176
+ - Hospital<br/>
177
+
178
+ - Outpatient<br/>
179
+
180
+ - SuperMarket<br/>
181
+
182
+ - Laboratory<br/>
183
+
184
+ - LargeDataCenterLowITE<br/>
185
+
186
+ - LargeDataCenterHighITE<br/>
187
+
188
+ - SmallDataCenterLowITE<br/>
189
+
190
+ - SmallDataCenterHighITE<br/>
191
+
192
+
193
+
194
+
195
+
196
+
197
+
198
+
199
+
200
+
201
+
202
+
203
+
204
+
205
+
206
+
207
+
208
+
209
+
210
+
211
+
212
+
213
+
214
+
215
+
216
+
217
+
218
+
219
+
220
+
221
+
222
+
223
+
224
+
225
+
226
+
227
+
228
+
229
+
230
+
231
+
232
+
233
+
234
+
235
+
236
+
237
+
238
+
239
+
240
+
241
+
242
+
243
+
244
+
245
+
246
+
247
+
248
+
249
+
250
+
251
+
252
+
253
+
254
+
255
+
256
+
257
+
258
+
259
+ [//]: # (argument values for template and bldg_type_a are dynamically generated from current version of the measure.)
68
260
 
69
261
  ## Functionality and Input Overview
70
262
 
@@ -76,7 +268,7 @@ Building Type A is an exception from the others in that it doesn't have an argum
76
268
 
77
269
  #### Floor Area
78
270
 
79
- The typical use case for this measure is to set the total building floor area using the `Total Building Floor Area` argument. With this approach you can maintain a set building floor area while changing the number of stories. An alternate workflow is to set a static footprint area. This alternate workflow is enabled by seeting a non-zero value for the `Single Floor Area` argument.
271
+ The typical use case for this measure is to set the total building floor area using the `Total Building Floor Area` argument. With this approach you can maintain a set building floor area while changing the number of stories. An alternate workflow is to set a static footprint area. This alternate workflow is enabled by setting a non-zero value for the `Single Floor Area` argument.
80
272
 
81
273
  [//]: # (todo - add screenshot of same floor area on different num stories and shapes)
82
274
 
@@ -84,7 +276,7 @@ The typical use case for this measure is to set the total building floor area us
84
276
 
85
277
  The Floor to floor height for the building is controlled through the `Typical Floor to FLoor Height` argument. It is the first of a number of arguments where a value of 0 represents a **smart default**. If leave the default value of zero in place it will pick a building specific floor to floor height. For example 9' would be picked for a small hotel and 14' for a hospital.
86
278
 
87
- Some building types have space type specific definitions for height that can be enabled with the `Enable Custom Height Bar Application` argument. If I building doesn't have any custom heights defined the value of this argument will not matter. One example of where this argument would have an impact is for the gym and auditorum in the SecondarySchool which would have a height 26' instead of the default school height of 13'. This is accomplished by pulling space types with a custom height into a separate rectangular building that sits away from the main structure. If this argument is set to false then all of the space types will have the same height, which for the school would be the default of 13'
279
+ Some building types have space type specific definitions for height that can be enabled with the `Enable Custom Height Bar Application` argument. If I building doesn't have any custom heights defined the value of this argument will not matter. One example of where this argument would have an impact is for the gym and auditorium in the SecondarySchool which would have a height 26' instead of the default school height of 13'. This is accomplished by pulling space types with a custom height into a separate rectangular building that sits away from the main structure. If this argument is set to false then all of the space types will have the same height, which for the school would be the default of 13'
88
280
 
89
281
  ![No Custom Height Space Types](./docs/custom_height_false.png?raw=true)
90
282
  *Secondary school without custom space type heights enabled*
@@ -97,11 +289,11 @@ There are two arguments that control the number of stories the building has. `Nu
97
289
  ![Baesment](./docs/basement.png?raw=true)
98
290
  *Secondary school with 1 below grade story*
99
291
 
100
- The `Building Rotation` argument will rotate the building after the geometry is created. So if you for example make a bar oriented east/west and then rotate it 80 degrees, the end result will be a bar just off of being north/south orientation. A positive value rotates clockwise. If you had a party wall assigned to the south facade, after the 80 degree rotation, those party walls would not be 10 degress south of due west.
292
+ The `Building Rotation` argument will rotate the building after the geometry is created. So if you for example make a bar oriented east/west and then rotate it 80 degrees, the end result will be a bar just off of being north/south orientation. A positive value rotates clockwise. If you had a party wall assigned to the south facade, after the 80 degree rotation, those party walls would not be 10 degrees south of due west.
101
293
 
102
294
  #### Template
103
295
 
104
- The `Template` is uesed in OpenStudio measures and the OpenStudio standards gem to refer to a specific target building code standard or vintage. For exampe ASHRAE 90.1 2004 or the DOE Ref Pre-1980 vintage used for the DOE reference buildings. Template is used here along with the building types selected to define the list and ratios of space types in the model. While generally the space type ratio is the same across different templates there are exceptions to this such as the inclusion of data centers in newer LargeOffice buildings.
296
+ The `Template` is used in OpenStudio measures and the OpenStudio standards gem to refer to a specific target building code standard or vintage. For example ASHRAE 90.1 2004 or the DOE Ref Pre-1980 vintage used for the DOE reference buildings. Template is used here along with the building types selected to define the list and ratios of space types in the model. While generally the space type ratio is the same across different templates there are exceptions to this such as the inclusion of data centers in newer LargeOffice buildings.
105
297
 
106
298
  #### Building Shape
107
299
 
@@ -111,12 +303,12 @@ While the floor area and number of stories arguments determine the size of the b
111
303
  *Aspect Ratio of 2.0*
112
304
 
113
305
  ![Aspect Ratio 1.0](./docs/ar_1.png?raw=true)
114
- *Aspect Ratio of 2.0*
306
+ *Aspect Ratio of 1.0*
115
307
 
116
308
  ![Aspect Ratio 0.5](./docs/ar_05.png?raw=true)
117
309
  *Aspect Ratio of 0.5*
118
310
 
119
- The `Perimeter Multiplier` provides a mechanism to maintain your target footprint floor area and your target aspect ratio while increasing the total exterior perimeter exposure. The intent here is to support, in a simplified way, the impacts of non-rectangular buildings. This is accomplished by adding a second bar when necessary that is turned 90 degrees relative ot the primary bar but maintains the same width. These two building elements are separate from each other and from the custom height bar, if it exists. If you keep the default value of 0.0 the measure will lookup a value inferred from the prototype buidling. For most prototype buidling types this will result in a value of 1.0, because the buildings are rectangular, but for PrimarySchool, SecondarySchool, and Outpatient a value larger than 1.0 will be used. If you use or a smart default of 1.0 applied for this argument you get a single bar. As you increase the multiplier higher than 1.0 it will add a second bar to increase the building perimeter while maintaining both the floor area and the north south to east west aspect ratio. Below is an example of the calculation method. If you use a very small multiplier such as 1.05, a situation may exist that would have too small of a secondary bar to properly model. In this case the single bar will just be extended a bit to achive the target total perimeter, but will sacrifice meeting the requested north/south versus east/west aspect ratio. In some cases with when the multiplier is not high enough above 1 the ends of the secondary bar may be made adiabatic to achive target values.
311
+ The `Perimeter Multiplier` provides a mechanism to maintain your target footprint floor area and your target aspect ratio while increasing the total exterior perimeter exposure. The intent here is to support, in a simplified way, the impacts of non-rectangular buildings. This is accomplished by adding a second bar when necessary that is turned 90 degrees relative ot the primary bar but maintains the same width. These two building elements are separate from each other and from the custom height bar, if it exists. If you keep the default value of 0.0 the measure will lookup a value inferred from the prototype building. For most prototype building types this will result in a value of 1.0, because the buildings are rectangular, but for PrimarySchool, SecondarySchool, and Outpatient a value larger than 1.0 will be used. If you use or a smart default of 1.0 applied for this argument you get a single bar. As you increase the multiplier higher than 1.0 it will add a second bar to increase the building perimeter while maintaining both the floor area and the north south to east west aspect ratio. Below is an example of the calculation method. If you use a very small multiplier such as 1.05, a situation may exist that would have too small of a secondary bar to properly model. In this case the single bar will just be extended a bit to achieve the target total perimeter, but will sacrifice meeting the requested north/south versus east/west aspect ratio. In some cases with when the multiplier is not high enough above 1 the ends of the secondary bar may be made adiabatic to achieve target values.
120
312
 
121
313
  ![Perim Mult b](./docs/perim_mult_2012.png?raw=true)
122
314
  *Aspect Ratio of 2.0 with a Perimeter Multiplier of 1.2. Able to add second bar but needs to have adiabatic ends. See earlier screenshot for Aspect Ratio of 2.0 with Perimeter Multiplier of 1.0*
@@ -131,9 +323,9 @@ The `Perimeter Multiplier` provides a mechanism to maintain your target footprin
131
323
 
132
324
  Representing for example a U shaped footprint (which might have a "Perimeter Multiplier" of 3 or higher) with a single bar would either under-estimate the perimeter if a reduced bounding box was fit around it to match the area, or over skew the orientation if a single long skinny bar was created with almost all of the exposure in only two opposing cardinal directions. A more common term that could have been used for an argument would have been a 1building perimeter to floor area ratio(P/A)`. That was considered but there could have been incompatible inputs passed in where the target P/A isn't possible for the given footprint area and aspect ratio. A 100' square has a P/A of 0.04 while a 1000' square has a ratio 0.004. In addition to changing with size it would also change with the shape of the rectangle. This measure in uses the multiplier to increase the perimeter of the foorprint(s) given a specified area and aspect ratio above the minim possible rectangular perimeter value. If you just want to make a single bar, you can leave the value at 1.0 and not worry about it. As a last note, if you also are using a custom height bar, that excluded from the calculation of the primary bar(s)
133
325
 
134
- `Bar Width` can be specified. If you know due to the layout of your building or other factors that you have a specific building width you would like to have you can enter that in the `Bar Width` argument. `Perimeter Multiplier` will be engored when a non-zero `Bar Width` is used. If you leave this argument value at the default value of 0 then it will not impact the model. A non-zero value here will also bypass the `Perimeter Multiplier` argument.
326
+ `Bar Width` can be specified. If you know due to the layout of your building or other factors that you have a specific building width you would like to have you can enter that in the `Bar Width` argument. `Perimeter Multiplier` will be ignored when a non-zero `Bar Width` is used. If you leave this argument value at the default value of 0 then it will not impact the model. A non-zero value here will also bypass the `Perimeter Multiplier` argument.
135
327
 
136
- `Bar Separation Distance Multiplier` is used when there is more than one bar, to specify the distance between the bars as a multiple of the building height. The default value is 10 x the height of the building, but that can be customized here. Currently 0 is not a valid multiplier, since all the intersection, matching, and fenestration occur in the indivdual bar elements. When two bars are required to meet the `Perimeter Multiplier` target they are in configruation of an with the vertical leg to the right of the horizontal leg, like a backwards "L". If a custom heigth bar was use that will be positioned ot the left of the other bars.
328
+ `Bar Separation Distance Multiplier` is used when there is more than one bar, to specify the distance between the bars as a multiple of the building height. The default value is 10 x the height of the building, but that can be customized here. Currently 0 is not a valid multiplier, since all the intersection, matching, and fenestration occur in the individual bar elements. When two bars are required to meet the `Perimeter Multiplier` target they are in configuration of an with the vertical leg to the right of the horizontal leg, like a backwards "L". If a custom height bar was used that will be positioned to the left of the other bars.
137
329
 
138
330
  ![Sept Dist 0.5](./docs/sep_05.png?raw=true)
139
331
  *Bar Separation Distance Multiplier of 0.5*
@@ -153,7 +345,7 @@ There is just a single `Window to Wall Ratio` argument for this measure. It has
153
345
  ![Custom WWR](./docs/wwr_custom.png?raw=true)
154
346
  *Example of space type specific WWR for warehouse model, shown with custom space type height enabled*
155
347
 
156
- Orientation specific characteristics and/or overhangs may be added to this in the future, but are currenty possible by adding existing measure to the workflow after this measure. Currently skylights are not directly supported either, but can be added outside of this measure.
348
+ Orientation specific characteristics and/or overhangs may be added to this in the future, but are currently possible by adding existing measure to the workflow after this measure. Currently skylights are not directly supported either, but can be added outside of this measure.
157
349
 
158
350
  #### Party Walls and Exposure of Top and Bottom Stories
159
351
 
@@ -163,7 +355,7 @@ There are two approaches for the party walls. One approach is a single fraction
163
355
 
164
356
  The second approach is ideal when you know more about the conditions of a specific condition and allows you to enter an integer for reach cardinal direction with arguments named `Number of North facing stories with party wall` etc. You can for example have a 5 story building that has a 1 story building to the west, a 3 story building to the east, a 2 story building to the north, and exterior exposure to the south. If you are using this as part of a parametric study where number of stories is changeling and you want all of a specific facade to be adjacent to a building that is taller, You can enter an large value such as 99 for the value; the overly large value relative to number of stories in the building will not create any issues.
165
357
 
166
- The ability to model what is essence party floor/ceilings in your model are controlled through two bool arguments named `Is the Bottom Story Exposed to Ground` and `Is the Top Story an Exterior Roof`
358
+ The ability to model what is in essence party floor/ceilings in your model are controlled through two bool arguments named `Is the Bottom Story Exposed to Ground` and `Is the Top Story an Exterior Roof`
167
359
 
168
360
  ![Party Wall](./docs/party.png?raw=true)
169
361
  *1 story Party wall on south, 2 story on east, story multipliers not enabled*
@@ -176,11 +368,11 @@ The ability to model what is essence party floor/ceilings in your model are cont
176
368
 
177
369
  #### Calculation Methods and Articulation Logic
178
370
 
179
- - `Calculation Method for Story Multiplier` is used to determine if zone multipliers should be used as story multipliers on taller buildings. This reduces the nubmer of zones and should speed up simulations, but may not be approriate in all cases. If you select a value of `None` then no (non 1) zone multipliers will be used and zones will be modeled for all building stories. The other choice currently available is `Basements Ground Mid Top` which for a building without party walls will never have more than 4 modeled stories regardless of the number of stories. The measure will evaluate uniqueness of stories taking into account party walls and may add additional stories to accommodate this. Note that while the size of space types on a story with a multiplier greater than 1 may appear smaller, they may be larger once the multiplier is applied. More options may be added in the future, specifically vacations of something like `Basements Ground Midx5 Top` that for very tall buildings would and multiple mid-stories vs. a single mid-story.
371
+ - `Calculation Method for Story Multiplier` is used to determine if zone multipliers should be used as story multipliers on taller buildings. This reduces the number of zones and should speed up simulations, but may not be appropriate in all cases. If you select a value of `None` then no (non 1) zone multipliers will be used and zones will be modeled for all building stories. The other choice currently available is `Basements Ground Mid Top` which for a building without party walls will never have more than 4 modeled stories regardless of the number of stories. The measure will evaluate uniqueness of stories taking into account party walls and may add additional stories to accommodate this. Note that while the size of space types on a story with a multiplier greater than 1 may appear smaller, they may be larger once the multiplier is applied. More options may be added in the future, specifically vacations of something like `Basements Ground Midx5 Top` that for very tall buildings would and multiple mid-stories vs. a single mid-story.
180
372
 
181
373
  - `Make Mid Story Floor Surfaces Adiabatic` determines of surface intersection and surface matching should be applied between stories (when they are adjacent and capable of being matched e.g. story multiplier not used). Setting this to true can reduce the number of surfaces in the model
182
374
 
183
- - `Division Method for Bar Space Types` is used to determine how the internal zoning and space type division of the bar(s) is approached. The default vaue of `Multiple Space Types - Individual Stories Sliced` is the primary method that should be used. It creates what looks like a core and perimeter model, but slices it up by space type, with large space types moving towards the upper stories. There is some basic logic to minimize small slivers of a space type being createe that would create thermal zones with small volumes that may not simulate well. The two largest space types will be at the ends of the bars to minimize having excessive exterior exosure on a zone with a small floor area. `Multiple Space Types - Simple Sliced` is an earlier method that pre-dates the indivdual sliced stories. The logic is similar but it puts all space types on every building story and creates multiple stories with the exact same slicing logic. `Single Space Type - Core and Perimeter` is not sliced up by space type and isn't relevant for building types with multiple space types. If you do have a building type with only a single space type, like small or medium office, the multiple space type methods will still work. The single space type method will eventually be deprecated.
375
+ - `Division Method for Bar Space Types` is used to determine how the internal zoning and space type division of the bar(s) is approached. The default value of `Multiple Space Types - Individual Stories Sliced` is the primary method that should be used. It creates what looks like a core and perimeter model, but slices it up by space type, with large space types moving towards the upper stories. There is some basic logic to minimize small slivers of a space type being created that would create thermal zones with small volumes that may not simulate well. The two largest space types will be at the ends of the bars to minimize having excessive exterior exposure on a zone with a small floor area. `Multiple Space Types - Simple Sliced` is an earlier method that pre-dates the individual sliced stories. The logic is similar but it puts all space types on every building story and creates multiple stories with the exact same slicing logic. `Single Space Type - Core and Perimeter` is not sliced up by space type and isn't relevant for building types with multiple space types. If you do have a building type with only a single space type, like small or medium office, the multiple space type methods will still work. The single space type method will eventually be deprecated.
184
376
 
185
377
  ![Individualy Sliced](./docs/bar_sliced_indiv.png?raw=true)
186
378
  *Multiple Space Types - Individual Stories Slice method that has been used through the examples above*
@@ -191,23 +383,21 @@ The ability to model what is essence party floor/ceilings in your model are cont
191
383
  ![Single Core Perimeter](./docs/bar_single_core_perim.png?raw=true)
192
384
  *Single Space Type - Core and Perimeter, should not be a reason to use this*
193
385
 
194
- - The `Double Loaded Corridor` arguemtn when enabled, take a circulation space type, when it exists, and pair it with the default space type, and will create a double loaded corridor for the space division and theral zoning, instead of the typical sliced core and perimeter zoning. This not only alters the geometry of the internal division, but creates a hybrid slice that instead of being a single space type, contains a circulation space type running down the center of the bar, surrounded by spaces of another space type. For an example, with a primary school the corridor will be paired with the classrooms. The width of the corridor is determined to achive the proper space type ratios of the two space types.
386
+ - The `Double Loaded Corridor` argument when enabled, take a circulation space type, when it exists, and pair it with the default space type, and will create a double loaded corridor for the space division and thermal zoning, instead of the typical sliced core and perimeter zoning. This not only alters the geometry of the internal division, but creates a hybrid slice that instead of being a single space type, contains a circulation space type running down the center of the bar, surrounded by spaces of another space type. For an example, with a primary school the corridor will be paired with the classrooms. The width of the corridor is determined to achieve the proper space type ratios of the two space types.
195
387
 
196
388
  ![Double Loaded Corridor](./docs/bar_double_loaded.png?raw=true)
197
389
  *Double Loaded Corridor with classroom and corridor for secondary school.*
198
390
 
199
- - The `Choose Space Type Sorting Method` only comes into play when you are modeling a building with more than one building type. With `Size` selected the space types are organized by size, independent of the building type, with smaller space types on lower stories and larger space types on higher stories. `Building Type > Size` is a newer method that first sorts by buidling type, putting smaller building types on lower stories, and then within a buildng type will sort by size. An exmaple use case for this method is when modeling a 4 story building with 25% office and 75% large hotel. With the `Building Type > Size` value the first story will be entirly office, with the rest of the stories large hotel. If the `Size` value is selected, building types wll be mixed together.
391
+ - The `Choose Space Type Sorting Method` only comes into play when you are modeling a building with more than one building type. With `Size` selected the space types are organized by size, independent of the building type, with smaller space types on lower stories and larger space types on higher stories. `Building Type > Size` is a newer method that first sorts by building type, putting smaller building types on lower stories, and then within a building type will sort by size. An example use case for this method is when modeling a 4 story building with 25% office and 75% large hotel. With the `Building Type > Size` value the first story will be entirely office, with the rest of the stories large hotel. If the `Size` value is selected, building types wll be mixed together.
200
392
 
201
393
  ![Sort Space Types by Building Types](./docs/story_sort.png?raw=true)
202
394
  *Building Type > Size used to sort by buiding types, and then by space types.*
203
395
 
204
- - `Use Upstream Argument Values` can be left at the default value of true for most cases. This argument shows up in a number of measures, and then intent is to enable the synchronization of arguments that may be used as a variable in a parametric study across multiple measures. Generally measure ahve uqniue argument names that don't exist, but some such ase `template` are used frequently. This argument, when set to true, will use the value of `Template` from an earlier measure in the workflow, if found, in place of what is entered as the value for this measure.
205
-
206
- - `Climate Zone` is not used at all by this measure but is necessary for an obscure reason
396
+ - `Use Upstream Argument Values` can be left at the default value of true for most cases. This argument shows up in a number of measures, and then intent is to enable the synchronization of arguments that may be used as a variable in a parametric study across multiple measures. Generally a measures has unique argument names that don't exist in other measures, but some such ase `template` are used frequently. This argument, when set to true, will use the value of `template` from an earlier measure in the workflow, if found, in place of what is entered as the argument value for this measure.
207
397
 
208
398
  ## Development Comments
209
399
 
210
- This measure relies on the openstudio-standards gem which is included in the OpenStudio CLI as well as a number of resources files listed below that are contained in the measure's `resources` directory. Other than the arguments almost none of the measure code is in the measure.rb file. The resource files are used by a number of measures and should be udpated from the shared library and not within this measure.
400
+ This measure relies on the openstudio-standards gem which is included in the OpenStudio CLI as well as a number of resources files listed below that are contained in the openstudio-extension gem which is also included in the OpenStudio CLI. Other than the arguments almost none of the measure code is in the measure.rb file. The resource files are used by a number of measures and should be updated from the shared library and not within this measure.
211
401
  - os_lib_model_generation.rb
212
402
  - os_lib_model_simplification.rb
213
403
  - os_lib_geometry.rb
@@ -228,6 +418,9 @@ ___
228
418
  **Required:** true,
229
419
  **Model Dependent:** false
230
420
 
421
+ **Choice Display Names** ["SecondarySchool", "PrimarySchool", "SmallOffice", "MediumOffice", "LargeOffice", "SmallHotel", "LargeHotel", "Warehouse", "RetailStandalone", "RetailStripmall", "QuickServiceRestaurant", "FullServiceRestaurant", "MidriseApartment", "HighriseApartment", "Hospital", "Outpatient", "SuperMarket", "Laboratory", "LargeDataCenterLowITE", "LargeDataCenterHighITE", "SmallDataCenterLowITE", "SmallDataCenterHighITE"]
422
+
423
+
231
424
  ### Building Type B
232
425
 
233
426
  **Name:** bldg_type_b,
@@ -236,6 +429,9 @@ ___
236
429
  **Required:** true,
237
430
  **Model Dependent:** false
238
431
 
432
+ **Choice Display Names** ["SecondarySchool", "PrimarySchool", "SmallOffice", "MediumOffice", "LargeOffice", "SmallHotel", "LargeHotel", "Warehouse", "RetailStandalone", "RetailStripmall", "QuickServiceRestaurant", "FullServiceRestaurant", "MidriseApartment", "HighriseApartment", "Hospital", "Outpatient", "SuperMarket", "Laboratory", "LargeDataCenterLowITE", "LargeDataCenterHighITE", "SmallDataCenterLowITE", "SmallDataCenterHighITE"]
433
+
434
+
239
435
  ### Building Type B Fraction of Building Floor Area
240
436
 
241
437
  **Name:** bldg_type_b_fract_bldg_area,
@@ -244,6 +440,7 @@ ___
244
440
  **Required:** true,
245
441
  **Model Dependent:** false
246
442
 
443
+
247
444
  ### Building Type C
248
445
 
249
446
  **Name:** bldg_type_c,
@@ -252,6 +449,9 @@ ___
252
449
  **Required:** true,
253
450
  **Model Dependent:** false
254
451
 
452
+ **Choice Display Names** ["SecondarySchool", "PrimarySchool", "SmallOffice", "MediumOffice", "LargeOffice", "SmallHotel", "LargeHotel", "Warehouse", "RetailStandalone", "RetailStripmall", "QuickServiceRestaurant", "FullServiceRestaurant", "MidriseApartment", "HighriseApartment", "Hospital", "Outpatient", "SuperMarket", "Laboratory", "LargeDataCenterLowITE", "LargeDataCenterHighITE", "SmallDataCenterLowITE", "SmallDataCenterHighITE"]
453
+
454
+
255
455
  ### Building Type C Fraction of Building Floor Area
256
456
 
257
457
  **Name:** bldg_type_c_fract_bldg_area,
@@ -260,6 +460,7 @@ ___
260
460
  **Required:** true,
261
461
  **Model Dependent:** false
262
462
 
463
+
263
464
  ### Building Type D
264
465
 
265
466
  **Name:** bldg_type_d,
@@ -268,6 +469,9 @@ ___
268
469
  **Required:** true,
269
470
  **Model Dependent:** false
270
471
 
472
+ **Choice Display Names** ["SecondarySchool", "PrimarySchool", "SmallOffice", "MediumOffice", "LargeOffice", "SmallHotel", "LargeHotel", "Warehouse", "RetailStandalone", "RetailStripmall", "QuickServiceRestaurant", "FullServiceRestaurant", "MidriseApartment", "HighriseApartment", "Hospital", "Outpatient", "SuperMarket", "Laboratory", "LargeDataCenterLowITE", "LargeDataCenterHighITE", "SmallDataCenterLowITE", "SmallDataCenterHighITE"]
473
+
474
+
271
475
  ### Building Type D Fraction of Building Floor Area
272
476
 
273
477
  **Name:** bldg_type_d_fract_bldg_area,
@@ -276,6 +480,7 @@ ___
276
480
  **Required:** true,
277
481
  **Model Dependent:** false
278
482
 
483
+
279
484
  ### Total Building Floor Area
280
485
 
281
486
  **Name:** total_bldg_floor_area,
@@ -284,6 +489,7 @@ ___
284
489
  **Required:** true,
285
490
  **Model Dependent:** false
286
491
 
492
+
287
493
  ### Single Floor Area
288
494
  Non-zero value will fix the single floor area, overriding a user entry for Total Building Floor Area
289
495
  **Name:** single_floor_area,
@@ -292,6 +498,7 @@ Non-zero value will fix the single floor area, overriding a user entry for Total
292
498
  **Required:** true,
293
499
  **Model Dependent:** false
294
500
 
501
+
295
502
  ### Typical Floor to FLoor Height
296
503
  Selecting a typical floor height of 0 will trigger a smart building type default.
297
504
  **Name:** floor_height,
@@ -300,6 +507,7 @@ Selecting a typical floor height of 0 will trigger a smart building type default
300
507
  **Required:** true,
301
508
  **Model Dependent:** false
302
509
 
510
+
303
511
  ### Enable Custom Height Bar Application
304
512
  This is argument value is only relevant when smart default floor to floor height is used for a building type that has spaces with custom heights.
305
513
  **Name:** custom_height_bar,
@@ -308,6 +516,7 @@ This is argument value is only relevant when smart default floor to floor height
308
516
  **Required:** true,
309
517
  **Model Dependent:** false
310
518
 
519
+
311
520
  ### Number of Stories Above Grade
312
521
 
313
522
  **Name:** num_stories_above_grade,
@@ -316,6 +525,7 @@ This is argument value is only relevant when smart default floor to floor height
316
525
  **Required:** true,
317
526
  **Model Dependent:** false
318
527
 
528
+
319
529
  ### Number of Stories Below Grade
320
530
 
321
531
  **Name:** num_stories_below_grade,
@@ -324,6 +534,7 @@ This is argument value is only relevant when smart default floor to floor height
324
534
  **Required:** true,
325
535
  **Model Dependent:** false
326
536
 
537
+
327
538
  ### Building Rotation
328
539
  Set Building Rotation off of North (positive value is clockwise). Rotation applied after geometry generation. Values greater than +/- 45 will result in aspect ratio and party wall orientations that do not match cardinal directions of the inputs.
329
540
  **Name:** building_rotation,
@@ -332,6 +543,7 @@ Set Building Rotation off of North (positive value is clockwise). Rotation appli
332
543
  **Required:** true,
333
544
  **Model Dependent:** false
334
545
 
546
+
335
547
  ### Target Standard
336
548
 
337
549
  **Name:** template,
@@ -340,6 +552,9 @@ Set Building Rotation off of North (positive value is clockwise). Rotation appli
340
552
  **Required:** true,
341
553
  **Model Dependent:** false
342
554
 
555
+ **Choice Display Names** ["DOE Ref Pre-1980", "DOE Ref 1980-2004", "90.1-2004", "90.1-2007", "90.1-2010", "90.1-2013", "90.1-2016", "90.1-2019", "ComStock DOE Ref Pre-1980", "ComStock DOE Ref 1980-2004", "ComStock 90.1-2004", "ComStock 90.1-2007", "ComStock 90.1-2010", "ComStock 90.1-2013"]
556
+
557
+
343
558
  ### Ratio of North/South Facade Length Relative to East/West Facade Length
344
559
  Selecting an aspect ratio of 0 will trigger a smart building type default. Aspect ratios less than one are not recommended for sliced bar geometry, instead rotate building and use a greater than 1 aspect ratio.
345
560
  **Name:** ns_to_ew_ratio,
@@ -348,6 +563,7 @@ Selecting an aspect ratio of 0 will trigger a smart building type default. Aspec
348
563
  **Required:** true,
349
564
  **Model Dependent:** false
350
565
 
566
+
351
567
  ### Perimeter Multiplier
352
568
  Selecting a value of 0 will trigger a smart building type default. This represents a multiplier for the building perimeter relative to the perimeter of a rectangular building that meets the area and aspect ratio inputs. Other than the smart default of 0.0 this argument should have a value of 1.0 or higher and is only applicable Multiple Space Types - Individual Stories Sliced division method.
353
569
  **Name:** perim_mult,
@@ -356,6 +572,7 @@ Selecting a value of 0 will trigger a smart building type default. This represen
356
572
  **Required:** true,
357
573
  **Model Dependent:** false
358
574
 
575
+
359
576
  ### Bar Width
360
577
  Non-zero value will fix the building width, overriding user entry for Perimeter Multiplier. NS/EW Aspect Ratio may be limited based on target width.
361
578
  **Name:** bar_width,
@@ -364,6 +581,7 @@ Non-zero value will fix the building width, overriding user entry for Perimeter
364
581
  **Required:** true,
365
582
  **Model Dependent:** false
366
583
 
584
+
367
585
  ### Bar Separation Distance Multiplier
368
586
  Multiplier of separation between bar elements relative to building height.
369
587
  **Name:** bar_sep_dist_mult,
@@ -372,6 +590,7 @@ Multiplier of separation between bar elements relative to building height.
372
590
  **Required:** true,
373
591
  **Model Dependent:** false
374
592
 
593
+
375
594
  ### Window to Wall Ratio
376
595
  Selecting a window to wall ratio of 0 will trigger a smart building type default.
377
596
  **Name:** wwr,
@@ -380,6 +599,7 @@ Selecting a window to wall ratio of 0 will trigger a smart building type default
380
599
  **Required:** true,
381
600
  **Model Dependent:** false
382
601
 
602
+
383
603
  ### Fraction of Exterior Wall Area with Adjacent Structure
384
604
  This will impact how many above grade exterior walls are modeled with adiabatic boundary condition.
385
605
  **Name:** party_wall_fraction,
@@ -388,6 +608,7 @@ This will impact how many above grade exterior walls are modeled with adiabatic
388
608
  **Required:** true,
389
609
  **Model Dependent:** false
390
610
 
611
+
391
612
  ### Number of North facing stories with party wall
392
613
  This will impact how many above grade exterior north walls are modeled with adiabatic boundary condition. If this is less than the number of above grade stoes, upper flor will reamin exterior
393
614
  **Name:** party_wall_stories_north,
@@ -396,6 +617,7 @@ This will impact how many above grade exterior north walls are modeled with adia
396
617
  **Required:** true,
397
618
  **Model Dependent:** false
398
619
 
620
+
399
621
  ### Number of South facing stories with party wall
400
622
  This will impact how many above grade exterior south walls are modeled with adiabatic boundary condition. If this is less than the number of above grade stoes, upper flor will reamin exterior
401
623
  **Name:** party_wall_stories_south,
@@ -404,6 +626,7 @@ This will impact how many above grade exterior south walls are modeled with adia
404
626
  **Required:** true,
405
627
  **Model Dependent:** false
406
628
 
629
+
407
630
  ### Number of East facing stories with party wall
408
631
  This will impact how many above grade exterior east walls are modeled with adiabatic boundary condition. If this is less than the number of above grade stoes, upper flor will reamin exterior
409
632
  **Name:** party_wall_stories_east,
@@ -412,6 +635,7 @@ This will impact how many above grade exterior east walls are modeled with adiab
412
635
  **Required:** true,
413
636
  **Model Dependent:** false
414
637
 
638
+
415
639
  ### Number of West facing stories with party wall
416
640
  This will impact how many above grade exterior west walls are modeled with adiabatic boundary condition. If this is less than the number of above grade stoes, upper flor will reamin exterior
417
641
  **Name:** party_wall_stories_west,
@@ -420,6 +644,7 @@ This will impact how many above grade exterior west walls are modeled with adiab
420
644
  **Required:** true,
421
645
  **Model Dependent:** false
422
646
 
647
+
423
648
  ### Is the Bottom Story Exposed to Ground
424
649
  This should be true unless you are modeling a partial building which doesn't include the lowest story. The bottom story floor will have an adiabatic boundary condition when false.
425
650
  **Name:** bottom_story_ground_exposed_floor,
@@ -428,6 +653,7 @@ This should be true unless you are modeling a partial building which doesn't inc
428
653
  **Required:** true,
429
654
  **Model Dependent:** false
430
655
 
656
+
431
657
  ### Is the Top Story an Exterior Roof
432
658
  This should be true unless you are modeling a partial building which doesn't include the highest story. The top story ceiling will have an adiabatic boundary condition when false.
433
659
  **Name:** top_story_exterior_exposed_roof,
@@ -436,6 +662,7 @@ This should be true unless you are modeling a partial building which doesn't inc
436
662
  **Required:** true,
437
663
  **Model Dependent:** false
438
664
 
665
+
439
666
  ### Calculation Method for Story Multiplier
440
667
 
441
668
  **Name:** story_multiplier,
@@ -444,6 +671,9 @@ This should be true unless you are modeling a partial building which doesn't inc
444
671
  **Required:** true,
445
672
  **Model Dependent:** false
446
673
 
674
+ **Choice Display Names** ["None", "Basements Ground Mid Top"]
675
+
676
+
447
677
  ### Make Mid Story Floor Surfaces Adiabatic
448
678
  If set to true, this will skip surface intersection and make mid story floors and celings adiabatic, not just at multiplied gaps.
449
679
  **Name:** make_mid_story_surfaces_adiabatic,
@@ -452,6 +682,7 @@ If set to true, this will skip surface intersection and make mid story floors an
452
682
  **Required:** true,
453
683
  **Model Dependent:** false
454
684
 
685
+
455
686
  ### Division Method for Bar Space Types
456
687
  To use perimeter multiplier greater than 1 selected Multiple Space Types - Individual Stories Sliced.
457
688
  **Name:** bar_division_method,
@@ -460,6 +691,9 @@ To use perimeter multiplier greater than 1 selected Multiple Space Types - Indiv
460
691
  **Required:** true,
461
692
  **Model Dependent:** false
462
693
 
694
+ **Choice Display Names** ["Multiple Space Types - Simple Sliced", "Multiple Space Types - Individual Stories Sliced", "Single Space Type - Core and Perimeter"]
695
+
696
+
463
697
  ### Double Loaded Corridor
464
698
  Add double loaded corridor for building types that have a defined circulation space type, to the selected space types.
465
699
  **Name:** double_loaded_corridor,
@@ -468,6 +702,9 @@ Add double loaded corridor for building types that have a defined circulation sp
468
702
  **Required:** true,
469
703
  **Model Dependent:** false
470
704
 
705
+ **Choice Display Names** ["None", "Primary Space Type"]
706
+
707
+
471
708
  ### Choose Space Type Sorting Method
472
709
 
473
710
  **Name:** space_type_sort_logic,
@@ -476,6 +713,9 @@ Add double loaded corridor for building types that have a defined circulation sp
476
713
  **Required:** true,
477
714
  **Model Dependent:** false
478
715
 
716
+ **Choice Display Names** ["Size", "Building Type > Size"]
717
+
718
+
479
719
  ### Use Upstream Argument Values
480
720
  When true this will look for arguments or registerValues in upstream measures that match arguments from this measure, and will use the value from the upstream measure in place of what is entered for this measure.
481
721
  **Name:** use_upstream_args,
@@ -487,3 +727,4 @@ When true this will look for arguments or registerValues in upstream measures th
487
727
 
488
728
 
489
729
 
730
+