honeybee-openstudio 0 → 1.8.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (132) hide show
  1. checksums.yaml +5 -5
  2. data/.coveralls.yml +1 -0
  3. data/.gitignore +32 -33
  4. data/.releaserc.json +7 -7
  5. data/.travis.yml +41 -0
  6. data/Gemfile +18 -14
  7. data/LICENSE.md +23 -23
  8. data/README.md +95 -95
  9. data/Rakefile +21 -16
  10. data/doc_templates/LICENSE.md +23 -23
  11. data/doc_templates/copyright_erb.txt +31 -31
  12. data/doc_templates/copyright_js.txt +4 -4
  13. data/doc_templates/copyright_ruby.txt +29 -29
  14. data/honeybee-openstudio.gemspec +35 -38
  15. data/lib/files/Honeybee.rb +112 -112
  16. data/lib/files/honeybee_workflow.osw +47 -47
  17. data/lib/files/urbanopt_Gemfile +32 -32
  18. data/lib/{honeybee/_defaults → from_honeybee/_openapi}/model.json +8126 -11310
  19. data/lib/{honeybee/_defaults → from_honeybee/_openapi}/simulation-parameter.json +842 -972
  20. data/lib/{to_openstudio → from_honeybee}/construction/air.rb +65 -56
  21. data/lib/{to_openstudio → from_honeybee}/construction/opaque.rb +77 -67
  22. data/lib/{to_openstudio → from_honeybee}/construction/shade.rb +108 -99
  23. data/lib/{to_openstudio → from_honeybee}/construction/window.rb +80 -70
  24. data/lib/{to_openstudio → from_honeybee}/construction_set.rb +278 -266
  25. data/lib/{honeybee → from_honeybee}/extension.rb +109 -129
  26. data/lib/{to_openstudio → from_honeybee}/geometry/aperture.rb +167 -157
  27. data/lib/{to_openstudio → from_honeybee}/geometry/door.rb +160 -150
  28. data/lib/{to_openstudio → from_honeybee}/geometry/face.rb +163 -178
  29. data/lib/{to_openstudio → from_honeybee}/geometry/room.rb +392 -442
  30. data/lib/{to_openstudio → from_honeybee}/geometry/shade.rb +89 -79
  31. data/lib/{to_openstudio → from_honeybee}/hvac/ideal_air.rb +150 -141
  32. data/lib/{to_openstudio → from_honeybee}/load/electric_equipment.rb +96 -87
  33. data/lib/{to_openstudio → from_honeybee}/load/gas_equipment.rb +97 -88
  34. data/lib/{to_openstudio → from_honeybee}/load/infiltration.rb +94 -85
  35. data/lib/{to_openstudio → from_honeybee}/load/lighting.rb +98 -89
  36. data/lib/{to_openstudio → from_honeybee}/load/people.rb +100 -91
  37. data/lib/{to_openstudio → from_honeybee}/load/setpoint_humidistat.rb +75 -66
  38. data/lib/{to_openstudio → from_honeybee}/load/setpoint_thermostat.rb +71 -62
  39. data/lib/{to_openstudio → from_honeybee}/load/ventilation.rb +96 -87
  40. data/lib/{to_openstudio → from_honeybee}/material/opaque.rb +94 -85
  41. data/lib/{to_openstudio → from_honeybee}/material/opaque_no_mass.rb +94 -85
  42. data/lib/{to_openstudio → from_honeybee}/material/window_blind.rb +238 -229
  43. data/lib/{to_openstudio → from_honeybee}/material/window_gas.rb +76 -67
  44. data/lib/{to_openstudio → from_honeybee}/material/window_gas_custom.rb +118 -108
  45. data/lib/{to_openstudio → from_honeybee}/material/window_gas_mixture.rb +79 -70
  46. data/lib/{to_openstudio → from_honeybee}/material/window_glazing.rb +166 -157
  47. data/lib/{to_openstudio → from_honeybee}/material/window_shade.rb +160 -151
  48. data/lib/{to_openstudio → from_honeybee}/material/window_simpleglazsys.rb +73 -64
  49. data/lib/from_honeybee/model.rb +434 -0
  50. data/lib/{honeybee → from_honeybee}/model_object.rb +110 -108
  51. data/lib/{to_openstudio → from_honeybee}/program_type.rb +124 -104
  52. data/lib/{to_openstudio → from_honeybee}/schedule/fixed_interval.rb +115 -105
  53. data/lib/{to_openstudio → from_honeybee}/schedule/ruleset.rb +164 -164
  54. data/lib/{to_openstudio → from_honeybee}/schedule/type_limit.rb +88 -76
  55. data/lib/{to_openstudio/simulation/design_day.rb → from_honeybee/simulation/designday.rb} +105 -96
  56. data/lib/{honeybee/load/lighting.rb → from_honeybee/simulation/extension.rb} +46 -43
  57. data/lib/{to_openstudio/simulation/parameter_model.rb → from_honeybee/simulation/parameter.rb} +277 -243
  58. data/lib/{honeybee/simulation/design_day.rb → from_honeybee/version.rb} +34 -42
  59. data/lib/{honeybee.rb → from_honeybee.rb} +86 -93
  60. data/lib/measures/from_honeybee_model/LICENSE.md +27 -23
  61. data/lib/measures/from_honeybee_model/README.md +32 -32
  62. data/lib/measures/from_honeybee_model/measure.rb +91 -91
  63. data/lib/measures/from_honeybee_model/measure.xml +103 -80
  64. data/lib/measures/from_honeybee_model/tests/from_honeybee_model_test.rb +126 -126
  65. data/lib/measures/from_honeybee_simulation_parameter/LICENSE.md +27 -23
  66. data/lib/measures/from_honeybee_simulation_parameter/README.md +32 -32
  67. data/lib/measures/from_honeybee_simulation_parameter/measure.rb +95 -95
  68. data/lib/measures/from_honeybee_simulation_parameter/measure.xml +91 -86
  69. data/lib/measures/from_honeybee_simulation_parameter/tests/from_honeybee_simulation_parameter_test.rb +109 -109
  70. metadata +89 -147
  71. data/.github/workflows/ci.yaml +0 -88
  72. data/doc_templates/README.md.erb +0 -42
  73. data/lib/from_openstudio/geometry/aperture.rb +0 -136
  74. data/lib/from_openstudio/geometry/door.rb +0 -136
  75. data/lib/from_openstudio/geometry/face.rb +0 -174
  76. data/lib/from_openstudio/geometry/room.rb +0 -121
  77. data/lib/from_openstudio/geometry/shade.rb +0 -87
  78. data/lib/from_openstudio/model.rb +0 -123
  79. data/lib/from_openstudio/model_object.rb +0 -43
  80. data/lib/from_openstudio/simulation/design_day.rb +0 -123
  81. data/lib/from_openstudio/simulation/parameter_model.rb +0 -93
  82. data/lib/from_openstudio/simulation/simulation_output.rb +0 -67
  83. data/lib/from_openstudio.rb +0 -49
  84. data/lib/honeybee/_defaults/energy_default.json +0 -1682
  85. data/lib/honeybee/construction/air.rb +0 -42
  86. data/lib/honeybee/construction/opaque.rb +0 -42
  87. data/lib/honeybee/construction/shade.rb +0 -42
  88. data/lib/honeybee/construction/window.rb +0 -51
  89. data/lib/honeybee/construction/windowshade.rb +0 -43
  90. data/lib/honeybee/construction_set.rb +0 -42
  91. data/lib/honeybee/geometry/aperture.rb +0 -42
  92. data/lib/honeybee/geometry/door.rb +0 -42
  93. data/lib/honeybee/geometry/face.rb +0 -48
  94. data/lib/honeybee/geometry/room.rb +0 -56
  95. data/lib/honeybee/geometry/shade.rb +0 -42
  96. data/lib/honeybee/hvac/ideal_air.rb +0 -42
  97. data/lib/honeybee/hvac/template.rb +0 -73
  98. data/lib/honeybee/load/electric_equipment.rb +0 -42
  99. data/lib/honeybee/load/gas_equipment.rb +0 -42
  100. data/lib/honeybee/load/infiltration.rb +0 -42
  101. data/lib/honeybee/load/people.rb +0 -42
  102. data/lib/honeybee/load/setpoint_humidistat.rb +0 -46
  103. data/lib/honeybee/load/setpoint_thermostat.rb +0 -46
  104. data/lib/honeybee/load/ventilation.rb +0 -42
  105. data/lib/honeybee/material/opaque.rb +0 -42
  106. data/lib/honeybee/material/opaque_no_mass.rb +0 -42
  107. data/lib/honeybee/material/window_blind.rb +0 -42
  108. data/lib/honeybee/material/window_gas.rb +0 -42
  109. data/lib/honeybee/material/window_gas_custom.rb +0 -42
  110. data/lib/honeybee/material/window_gas_mixture.rb +0 -42
  111. data/lib/honeybee/material/window_glazing.rb +0 -42
  112. data/lib/honeybee/material/window_shade.rb +0 -42
  113. data/lib/honeybee/material/window_simpleglazsys.rb +0 -42
  114. data/lib/honeybee/model.rb +0 -87
  115. data/lib/honeybee/program_type.rb +0 -56
  116. data/lib/honeybee/schedule/fixed_interval.rb +0 -42
  117. data/lib/honeybee/schedule/ruleset.rb +0 -42
  118. data/lib/honeybee/schedule/type_limit.rb +0 -42
  119. data/lib/honeybee/simulation/parameter_model.rb +0 -86
  120. data/lib/honeybee/simulation/simulation_output.rb +0 -42
  121. data/lib/honeybee/ventcool/control.rb +0 -42
  122. data/lib/honeybee/ventcool/opening.rb +0 -46
  123. data/lib/honeybee/ventcool/simulation.rb +0 -42
  124. data/lib/to_openstudio/construction/windowshade.rb +0 -196
  125. data/lib/to_openstudio/hvac/Model.hvac.rb +0 -641
  126. data/lib/to_openstudio/hvac/template.rb +0 -169
  127. data/lib/to_openstudio/model.rb +0 -497
  128. data/lib/to_openstudio/model_object.rb +0 -52
  129. data/lib/to_openstudio/ventcool/control.rb +0 -185
  130. data/lib/to_openstudio/ventcool/opening.rb +0 -189
  131. data/lib/to_openstudio/ventcool/simulation.rb +0 -101
  132. data/lib/to_openstudio.rb +0 -92
@@ -1,266 +1,278 @@
1
- # *******************************************************************************
2
- # Honeybee OpenStudio Gem, Copyright (c) 2020, Alliance for Sustainable
3
- # Energy, LLC, Ladybug Tools LLC and other contributors. All rights reserved.
4
- #
5
- # Redistribution and use in source and binary forms, with or without
6
- # modification, are permitted provided that the following conditions are met:
7
- #
8
- # (1) Redistributions of source code must retain the above copyright notice,
9
- # this list of conditions and the following disclaimer.
10
- #
11
- # (2) Redistributions in binary form must reproduce the above copyright notice,
12
- # this list of conditions and the following disclaimer in the documentation
13
- # and/or other materials provided with the distribution.
14
- #
15
- # (3) Neither the name of the copyright holder nor the names of any contributors
16
- # may be used to endorse or promote products derived from this software without
17
- # specific prior written permission from the respective party.
18
- #
19
- # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) AND ANY CONTRIBUTORS
20
- # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
21
- # THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22
- # ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S), ANY CONTRIBUTORS, THE
23
- # UNITED STATES GOVERNMENT, OR THE UNITED STATES DEPARTMENT OF ENERGY, NOR ANY OF
24
- # THEIR EMPLOYEES, BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25
- # EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
26
- # OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27
- # INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
28
- # STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29
- # OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30
- # *******************************************************************************
31
-
32
- require 'honeybee/construction_set'
33
-
34
- require 'to_openstudio/model_object'
35
-
36
- module Honeybee
37
- class ConstructionSetAbridged
38
-
39
- def find_existing_openstudio_object(openstudio_model)
40
- object = openstudio_model.getDefaultConstructionSetByName(@hash[:identifier])
41
- return object.get if object.is_initialized
42
- nil
43
- end
44
-
45
- def to_openstudio(openstudio_model)
46
- # create the constructionset object
47
- os_constr_set = OpenStudio::Model::DefaultConstructionSet.new(openstudio_model)
48
- os_constr_set.setName(@hash[:identifier])
49
-
50
- int_surf_const = OpenStudio::Model::DefaultSurfaceConstructions.new(openstudio_model)
51
- ext_surf_const = OpenStudio::Model::DefaultSurfaceConstructions.new(openstudio_model)
52
- grnd_surf_const = OpenStudio::Model::DefaultSurfaceConstructions.new(openstudio_model)
53
- int_subsurf_const = OpenStudio::Model::DefaultSubSurfaceConstructions.new(openstudio_model)
54
- ext_subsurf_const = OpenStudio::Model::DefaultSubSurfaceConstructions.new(openstudio_model)
55
-
56
- os_constr_set.setDefaultInteriorSurfaceConstructions(int_surf_const)
57
- os_constr_set.setDefaultExteriorSurfaceConstructions(ext_surf_const)
58
- os_constr_set.setDefaultGroundContactSurfaceConstructions(grnd_surf_const)
59
- os_constr_set.setDefaultInteriorSubSurfaceConstructions(int_subsurf_const)
60
- os_constr_set.setDefaultExteriorSubSurfaceConstructions(ext_subsurf_const)
61
-
62
- # assign any constructions in the wall set
63
- if @hash[:wall_set]
64
- if @hash[:wall_set][:interior_construction]
65
- int_wall_ref = openstudio_model.getConstructionByName(@hash[:wall_set][:interior_construction])
66
- unless int_wall_ref.empty?
67
- interior_wall = int_wall_ref.get
68
- int_surf_const.setWallConstruction(interior_wall)
69
- os_constr_set.setAdiabaticSurfaceConstruction(interior_wall)
70
- end
71
- end
72
- if @hash[:wall_set][:exterior_construction]
73
- ext_wall_ref = openstudio_model.getConstructionByName(@hash[:wall_set][:exterior_construction])
74
- unless ext_wall_ref.empty?
75
- exterior_wall = ext_wall_ref.get
76
- ext_surf_const.setWallConstruction(exterior_wall)
77
- end
78
- end
79
- if @hash[:wall_set][:ground_construction]
80
- grd_wall_ref = openstudio_model.getConstructionByName(@hash[:wall_set][:ground_construction])
81
- unless grd_wall_ref.empty?
82
- ground_wall = grd_wall_ref.get
83
- grnd_surf_const.setWallConstruction(ground_wall)
84
- end
85
- end
86
- end
87
-
88
- # assign any constructions in the floor set
89
- if @hash[:floor_set]
90
- if @hash[:floor_set][:interior_construction]
91
- constr_id_int = openstudio_model.getConstructionByName(@hash[:floor_set][:interior_construction])
92
- assign_constr_to_set_int(openstudio_model, int_surf_const, 'Floor',
93
- constr_id_int)
94
- end
95
- if @hash[:floor_set][:exterior_construction]
96
- constr_id_ext = openstudio_model.getConstructionByName(@hash[:floor_set][:exterior_construction])
97
- assign_constr_to_set_ext(openstudio_model, ext_surf_const, 'Floor',
98
- constr_id_ext
99
- )
100
- end
101
- if @hash[:floor_set][:ground_construction]
102
- constr_id_grd = openstudio_model.getConstructionByName(@hash[:floor_set][:ground_construction])
103
- assign_constr_to_set_grd(openstudio_model, grnd_surf_const, 'Floor',
104
- constr_id_grd)
105
- end
106
- end
107
-
108
- # assign any constructions in the roof ceiling set
109
- if @hash[:roof_ceiling_set]
110
- if @hash[:roof_ceiling_set][:interior_construction]
111
- constr_id_int = openstudio_model.getConstructionByName(@hash[:roof_ceiling_set][:interior_construction])
112
- assign_constr_to_set_int(openstudio_model, int_surf_const, 'Roof',
113
- constr_id_int)
114
- end
115
- if @hash[:roof_ceiling_set][:exterior_construction]
116
- constr_id_ext = openstudio_model.getConstructionByName(@hash[:roof_ceiling_set][:exterior_construction])
117
- assign_constr_to_set_ext(openstudio_model, ext_surf_const, 'Roof',
118
- constr_id_ext)
119
- end
120
- if @hash[:roof_ceiling_set][:ground_construction]
121
- constr_id_grd = openstudio_model.getConstructionByName(@hash[:roof_ceiling_set][:ground_construction])
122
- assign_constr_to_set_grd(openstudio_model, grnd_surf_const, 'Roof',
123
- constr_id_grd)
124
- end
125
- end
126
-
127
- # assign any constructions in the aperture set
128
- if @hash[:aperture_set]
129
- if @hash[:aperture_set][:interior_construction]
130
- int_ap_ref = openstudio_model.getConstructionByName(
131
- @hash[:aperture_set][:interior_construction])
132
- unless int_ap_ref.empty?
133
- interior_aperture = int_ap_ref.get
134
- int_subsurf_const.setFixedWindowConstruction(interior_aperture)
135
- int_subsurf_const.setOperableWindowConstruction(interior_aperture)
136
- end
137
- end
138
- if @hash[:aperture_set][:window_construction]
139
- window_ref = openstudio_model.getConstructionByName(
140
- @hash[:aperture_set][:window_construction])
141
- unless window_ref.empty?
142
- window_aperture = window_ref.get
143
- ext_subsurf_const.setFixedWindowConstruction(window_aperture)
144
- end
145
- end
146
- if @hash[:aperture_set][:skylight_construction]
147
- skylight_ref = openstudio_model.getConstructionByName(
148
- @hash[:aperture_set][:skylight_construction])
149
- unless skylight_ref.empty?
150
- skylight_aperture = skylight_ref.get
151
- ext_subsurf_const.setSkylightConstruction(skylight_aperture)
152
- end
153
- end
154
- if @hash[:aperture_set][:operable_construction]
155
- operable_ref = openstudio_model.getConstructionByName(
156
- @hash[:aperture_set][:operable_construction])
157
- unless operable_ref.empty?
158
- operable_aperture = operable_ref.get
159
- ext_subsurf_const.setOperableWindowConstruction(operable_aperture)
160
- end
161
- end
162
- end
163
-
164
- # assign any constructions in the door set
165
- if @hash[:door_set]
166
- if @hash[:door_set][:interior_construction]
167
- int_door_ref = openstudio_model.getConstructionByName(
168
- @hash[:door_set][:interior_construction])
169
- unless int_door_ref.empty?
170
- interior_door = int_door_ref.get
171
- int_subsurf_const.setDoorConstruction(interior_door)
172
- end
173
- end
174
- if @hash[:door_set][:exterior_construction]
175
- ext_door_ref = openstudio_model.getConstructionByName(
176
- @hash[:door_set][:exterior_construction])
177
- unless ext_door_ref.empty?
178
- exterior_door = ext_door_ref.get
179
- ext_subsurf_const.setDoorConstruction(exterior_door)
180
- end
181
- end
182
- if @hash[:door_set][:overhead_construction]
183
- overhead_door_ref = openstudio_model.getConstructionByName(
184
- @hash[:door_set][:overhead_construction])
185
- unless overhead_door_ref.empty?
186
- overhead_door = overhead_door_ref.get
187
- ext_subsurf_const.setOverheadDoorConstruction(overhead_door)
188
- end
189
- end
190
- if @hash[:door_set][:exterior_glass_construction]
191
- ext_glz_door_ref = openstudio_model.getConstructionByName(
192
- @hash[:door_set][:exterior_glass_construction])
193
- unless ext_glz_door_ref.empty?
194
- exterior_glass_door = ext_glz_door_ref.get
195
- ext_subsurf_const.setGlassDoorConstruction(exterior_glass_door)
196
- end
197
- end
198
- if @hash[:door_set][:interior_glass_construction]
199
- int_glz_door_ref = openstudio_model.getConstructionByName(
200
- @hash[:door_set][:interior_glass_construction])
201
- unless int_glz_door_ref.empty?
202
- interior_glass_door = int_glz_door_ref.get
203
- int_subsurf_const.setGlassDoorConstruction(interior_glass_door)
204
- end
205
- end
206
- end
207
-
208
- # assign any shading constructions to construction set
209
- if @hash[:shade_construction]
210
- shade_ref = openstudio_model.getConstructionByName(@hash[:shade_construction])
211
- unless shade_ref.empty?
212
- shade_construction = shade_ref.get
213
- os_constr_set.setSpaceShadingConstruction(shade_construction)
214
- end
215
- end
216
-
217
- # assign any air boundary constructions to construction set
218
- if @hash[:air_boundary_construction]
219
- air_ref = openstudio_model.getConstructionAirBoundaryByName(
220
- @hash[:air_boundary_construction])
221
- unless air_ref.empty?
222
- air_construction = air_ref.get
223
- os_constr_set.setInteriorPartitionConstruction(air_construction)
224
- end
225
- end
226
-
227
- os_constr_set
228
- end
229
-
230
- # get interior construction subset
231
- def assign_constr_to_set_int(openstudio_model, constr_subset, face_type, constr_id_int)
232
- unless constr_id_int.empty?
233
- constr_id = constr_id_int.get
234
- check_constr_type(constr_id, face_type, constr_subset)
235
- end
236
- end
237
-
238
- # get exterior construction subset
239
- def assign_constr_to_set_ext(openstudio_model, constr_subset, face_type, constr_id_ext)
240
- unless constr_id_ext.empty?
241
- constr_id = constr_id_ext.get
242
- check_constr_type(constr_id, face_type, constr_subset)
243
- end
244
- end
245
-
246
- # get ground construction subset
247
- def assign_constr_to_set_grd(openstudio_model, constr_subset, face_type, constr_id_grd)
248
- unless constr_id_grd.empty?
249
- constr_id = constr_id_grd.get
250
- check_constr_type(constr_id, face_type, constr_subset)
251
- end
252
- end
253
-
254
- # check face type and assign to construction subset
255
- def check_constr_type(constr_id, face_type, constr_subset)
256
- if face_type == 'Wall'
257
- constr_subset.setWallConstruction(constr_id)
258
- elsif face_type == 'Floor'
259
- constr_subset.setFloorConstruction(constr_id)
260
- else
261
- constr_subset.setRoofCeilingConstruction(constr_id)
262
- end
263
- end
264
-
265
- end #ConstructionSetAbridged
266
- end #Honeybee
1
+ # *******************************************************************************
2
+ # Honeybee OpenStudio Gem, Copyright (c) 2020, Alliance for Sustainable
3
+ # Energy, LLC, Ladybug Tools LLC and other contributors. All rights reserved.
4
+ #
5
+ # Redistribution and use in source and binary forms, with or without
6
+ # modification, are permitted provided that the following conditions are met:
7
+ #
8
+ # (1) Redistributions of source code must retain the above copyright notice,
9
+ # this list of conditions and the following disclaimer.
10
+ #
11
+ # (2) Redistributions in binary form must reproduce the above copyright notice,
12
+ # this list of conditions and the following disclaimer in the documentation
13
+ # and/or other materials provided with the distribution.
14
+ #
15
+ # (3) Neither the name of the copyright holder nor the names of any contributors
16
+ # may be used to endorse or promote products derived from this software without
17
+ # specific prior written permission from the respective party.
18
+ #
19
+ # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) AND ANY CONTRIBUTORS
20
+ # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
21
+ # THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22
+ # ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S), ANY CONTRIBUTORS, THE
23
+ # UNITED STATES GOVERNMENT, OR THE UNITED STATES DEPARTMENT OF ENERGY, NOR ANY OF
24
+ # THEIR EMPLOYEES, BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25
+ # EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
26
+ # OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27
+ # INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
28
+ # STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29
+ # OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30
+ # *******************************************************************************
31
+
32
+ require 'from_honeybee/model_object'
33
+
34
+ require 'openstudio'
35
+
36
+
37
+ module FromHoneybee
38
+ class ConstructionSetAbridged < ModelObject
39
+ attr_reader :errors, :warnings
40
+
41
+ def initialize(hash = {})
42
+ super(hash)
43
+
44
+ raise "Incorrect model type '#{@type}'" unless @type == 'ConstructionSetAbridged'
45
+ end
46
+
47
+ def defaults
48
+ @@schema[:components][:schemas][:ConstructionSetAbridged][:properties]
49
+ end
50
+
51
+ def find_existing_openstudio_object(openstudio_model)
52
+ object = openstudio_model.getDefaultConstructionSetByName(@hash[:identifier])
53
+ return object.get if object.is_initialized
54
+ nil
55
+ end
56
+
57
+ def to_openstudio(openstudio_model)
58
+ # create the constructionset object
59
+ os_constr_set = OpenStudio::Model::DefaultConstructionSet.new(openstudio_model)
60
+ os_constr_set.setName(@hash[:identifier])
61
+
62
+ int_surf_const = OpenStudio::Model::DefaultSurfaceConstructions.new(openstudio_model)
63
+ ext_surf_const = OpenStudio::Model::DefaultSurfaceConstructions.new(openstudio_model)
64
+ grnd_surf_const = OpenStudio::Model::DefaultSurfaceConstructions.new(openstudio_model)
65
+ int_subsurf_const = OpenStudio::Model::DefaultSubSurfaceConstructions.new(openstudio_model)
66
+ ext_subsurf_const = OpenStudio::Model::DefaultSubSurfaceConstructions.new(openstudio_model)
67
+
68
+ os_constr_set.setDefaultInteriorSurfaceConstructions(int_surf_const)
69
+ os_constr_set.setDefaultExteriorSurfaceConstructions(ext_surf_const)
70
+ os_constr_set.setDefaultGroundContactSurfaceConstructions(grnd_surf_const)
71
+ os_constr_set.setDefaultInteriorSubSurfaceConstructions(int_subsurf_const)
72
+ os_constr_set.setDefaultExteriorSubSurfaceConstructions(ext_subsurf_const)
73
+
74
+ # assign any constructions in the wall set
75
+ if @hash[:wall_set]
76
+ if @hash[:wall_set][:interior_construction]
77
+ int_wall_ref = openstudio_model.getConstructionByName(@hash[:wall_set][:interior_construction])
78
+ unless int_wall_ref.empty?
79
+ interior_wall = int_wall_ref.get
80
+ int_surf_const.setWallConstruction(interior_wall)
81
+ os_constr_set.setAdiabaticSurfaceConstruction(interior_wall)
82
+ end
83
+ end
84
+ if @hash[:wall_set][:exterior_construction]
85
+ ext_wall_ref = openstudio_model.getConstructionByName(@hash[:wall_set][:exterior_construction])
86
+ unless ext_wall_ref.empty?
87
+ exterior_wall = ext_wall_ref.get
88
+ ext_surf_const.setWallConstruction(exterior_wall)
89
+ end
90
+ end
91
+ if @hash[:wall_set][:ground_construction]
92
+ grd_wall_ref = openstudio_model.getConstructionByName(@hash[:wall_set][:ground_construction])
93
+ unless grd_wall_ref.empty?
94
+ ground_wall = grd_wall_ref.get
95
+ grnd_surf_const.setWallConstruction(ground_wall)
96
+ end
97
+ end
98
+ end
99
+
100
+ # assign any constructions in the floor set
101
+ if @hash[:floor_set]
102
+ if @hash[:floor_set][:interior_construction]
103
+ constr_id_int = openstudio_model.getConstructionByName(@hash[:floor_set][:interior_construction])
104
+ assign_constr_to_set_int(openstudio_model, int_surf_const, 'Floor',
105
+ constr_id_int)
106
+ end
107
+ if @hash[:floor_set][:exterior_construction]
108
+ constr_id_ext = openstudio_model.getConstructionByName(@hash[:floor_set][:exterior_construction])
109
+ assign_constr_to_set_ext(openstudio_model, ext_surf_const, 'Floor',
110
+ constr_id_ext
111
+ )
112
+ end
113
+ if @hash[:floor_set][:ground_construction]
114
+ constr_id_grd = openstudio_model.getConstructionByName(@hash[:floor_set][:ground_construction])
115
+ assign_constr_to_set_grd(openstudio_model, grnd_surf_const, 'Floor',
116
+ constr_id_grd)
117
+ end
118
+ end
119
+
120
+ # assign any constructions in the roof ceiling set
121
+ if @hash[:roof_ceiling_set]
122
+ if @hash[:roof_ceiling_set][:interior_construction]
123
+ constr_id_int = openstudio_model.getConstructionByName(@hash[:roof_ceiling_set][:interior_construction])
124
+ assign_constr_to_set_int(openstudio_model, int_surf_const, 'Roof',
125
+ constr_id_int)
126
+ end
127
+ if @hash[:roof_ceiling_set][:exterior_construction]
128
+ constr_id_ext = openstudio_model.getConstructionByName(@hash[:roof_ceiling_set][:exterior_construction])
129
+ assign_constr_to_set_ext(openstudio_model, ext_surf_const, 'Roof',
130
+ constr_id_ext)
131
+ end
132
+ if @hash[:roof_ceiling_set][:ground_construction]
133
+ constr_id_grd = openstudio_model.getConstructionByName(@hash[:roof_ceiling_set][:ground_construction])
134
+ assign_constr_to_set_grd(openstudio_model, grnd_surf_const, 'Roof',
135
+ constr_id_grd)
136
+ end
137
+ end
138
+
139
+ # assign any constructions in the aperture set
140
+ if @hash[:aperture_set]
141
+ if @hash[:aperture_set][:interior_construction]
142
+ int_ap_ref = openstudio_model.getConstructionByName(
143
+ @hash[:aperture_set][:interior_construction])
144
+ unless int_ap_ref.empty?
145
+ interior_aperture = int_ap_ref.get
146
+ int_subsurf_const.setFixedWindowConstruction(interior_aperture)
147
+ int_subsurf_const.setOperableWindowConstruction(interior_aperture)
148
+ end
149
+ end
150
+ if @hash[:aperture_set][:window_construction]
151
+ window_ref = openstudio_model.getConstructionByName(
152
+ @hash[:aperture_set][:window_construction])
153
+ unless window_ref.empty?
154
+ window_aperture = window_ref.get
155
+ ext_subsurf_const.setFixedWindowConstruction(window_aperture)
156
+ end
157
+ end
158
+ if @hash[:aperture_set][:skylight_construction]
159
+ skylight_ref = openstudio_model.getConstructionByName(
160
+ @hash[:aperture_set][:skylight_construction])
161
+ unless skylight_ref.empty?
162
+ skylight_aperture = skylight_ref.get
163
+ ext_subsurf_const.setSkylightConstruction(skylight_aperture)
164
+ end
165
+ end
166
+ if @hash[:aperture_set][:operable_construction]
167
+ operable_ref = openstudio_model.getConstructionByName(
168
+ @hash[:aperture_set][:operable_construction])
169
+ unless operable_ref.empty?
170
+ operable_aperture = operable_ref.get
171
+ ext_subsurf_const.setOperableWindowConstruction(operable_aperture)
172
+ end
173
+ end
174
+ end
175
+
176
+ # assign any constructions in the door set
177
+ if @hash[:door_set]
178
+ if @hash[:door_set][:interior_construction]
179
+ int_door_ref = openstudio_model.getConstructionByName(
180
+ @hash[:door_set][:interior_construction])
181
+ unless int_door_ref.empty?
182
+ interior_door = int_door_ref.get
183
+ int_subsurf_const.setDoorConstruction(interior_door)
184
+ end
185
+ end
186
+ if @hash[:door_set][:exterior_construction]
187
+ ext_door_ref = openstudio_model.getConstructionByName(
188
+ @hash[:door_set][:exterior_construction])
189
+ unless ext_door_ref.empty?
190
+ exterior_door = ext_door_ref.get
191
+ ext_subsurf_const.setDoorConstruction(exterior_door)
192
+ end
193
+ end
194
+ if @hash[:door_set][:overhead_construction]
195
+ overhead_door_ref = openstudio_model.getConstructionByName(
196
+ @hash[:door_set][:overhead_construction])
197
+ unless overhead_door_ref.empty?
198
+ overhead_door = overhead_door_ref.get
199
+ ext_subsurf_const.setOverheadDoorConstruction(overhead_door)
200
+ end
201
+ end
202
+ if @hash[:door_set][:exterior_glass_construction]
203
+ ext_glz_door_ref = openstudio_model.getConstructionByName(
204
+ @hash[:door_set][:exterior_glass_construction])
205
+ unless ext_glz_door_ref.empty?
206
+ exterior_glass_door = ext_glz_door_ref.get
207
+ ext_subsurf_const.setGlassDoorConstruction(exterior_glass_door)
208
+ end
209
+ end
210
+ if @hash[:door_set][:interior_glass_construction]
211
+ int_glz_door_ref = openstudio_model.getConstructionByName(
212
+ @hash[:door_set][:interior_glass_construction])
213
+ unless int_glz_door_ref.empty?
214
+ interior_glass_door = int_glz_door_ref.get
215
+ int_subsurf_const.setGlassDoorConstruction(interior_glass_door)
216
+ end
217
+ end
218
+ end
219
+
220
+ # assign any shading constructions to construction set
221
+ if @hash[:shade_construction]
222
+ shade_ref = openstudio_model.getConstructionByName(@hash[:shade_construction])
223
+ unless shade_ref.empty?
224
+ shade_construction = shade_ref.get
225
+ os_constr_set.setSpaceShadingConstruction(shade_construction)
226
+ end
227
+ end
228
+
229
+ # assign any air boundary constructions to construction set
230
+ if @hash[:air_boundary_construction]
231
+ air_ref = openstudio_model.getConstructionAirBoundaryByName(
232
+ @hash[:air_boundary_construction])
233
+ unless air_ref.empty?
234
+ air_construction = air_ref.get
235
+ os_constr_set.setInteriorPartitionConstruction(air_construction)
236
+ end
237
+ end
238
+
239
+ os_constr_set
240
+ end
241
+
242
+ # get interior construction subset
243
+ def assign_constr_to_set_int(openstudio_model, constr_subset, face_type, constr_id_int)
244
+ unless constr_id_int.empty?
245
+ constr_id = constr_id_int.get
246
+ check_constr_type(constr_id, face_type, constr_subset)
247
+ end
248
+ end
249
+
250
+ # get exterior construction subset
251
+ def assign_constr_to_set_ext(openstudio_model, constr_subset, face_type, constr_id_ext)
252
+ unless constr_id_ext.empty?
253
+ constr_id = constr_id_ext.get
254
+ check_constr_type(constr_id, face_type, constr_subset)
255
+ end
256
+ end
257
+
258
+ # get ground construction subset
259
+ def assign_constr_to_set_grd(openstudio_model, constr_subset, face_type, constr_id_grd)
260
+ unless constr_id_grd.empty?
261
+ constr_id = constr_id_grd.get
262
+ check_constr_type(constr_id, face_type, constr_subset)
263
+ end
264
+ end
265
+
266
+ # check face type and assign to construction subset
267
+ def check_constr_type(constr_id, face_type, constr_subset)
268
+ if face_type == 'Wall'
269
+ constr_subset.setWallConstruction(constr_id)
270
+ elsif face_type == 'Floor'
271
+ constr_subset.setFloorConstruction(constr_id)
272
+ else
273
+ constr_subset.setRoofCeilingConstruction(constr_id)
274
+ end
275
+ end
276
+
277
+ end #ConstructionSetAbridged
278
+ end #FromHoneybee