honeybee-openstudio 1.8.1 → 1.8.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (70) hide show
  1. checksums.yaml +5 -5
  2. data/.coveralls.yml +1 -1
  3. data/.gitignore +32 -32
  4. data/.releaserc.json +7 -7
  5. data/.travis.yml +42 -41
  6. data/Gemfile +18 -18
  7. data/LICENSE.md +23 -23
  8. data/README.md +95 -95
  9. data/Rakefile +20 -20
  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 -35
  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/from_honeybee.rb +86 -86
  19. data/lib/from_honeybee/_openapi/model.json +8126 -8126
  20. data/lib/from_honeybee/_openapi/simulation-parameter.json +842 -842
  21. data/lib/from_honeybee/construction/air.rb +64 -64
  22. data/lib/from_honeybee/construction/opaque.rb +76 -76
  23. data/lib/from_honeybee/construction/shade.rb +107 -107
  24. data/lib/from_honeybee/construction/window.rb +80 -80
  25. data/lib/from_honeybee/construction_set.rb +278 -278
  26. data/lib/from_honeybee/extension.rb +109 -109
  27. data/lib/from_honeybee/geometry/aperture.rb +167 -167
  28. data/lib/from_honeybee/geometry/door.rb +160 -160
  29. data/lib/from_honeybee/geometry/face.rb +163 -163
  30. data/lib/from_honeybee/geometry/room.rb +392 -392
  31. data/lib/from_honeybee/geometry/shade.rb +89 -89
  32. data/lib/from_honeybee/hvac/ideal_air.rb +150 -150
  33. data/lib/from_honeybee/load/electric_equipment.rb +95 -95
  34. data/lib/from_honeybee/load/gas_equipment.rb +97 -97
  35. data/lib/from_honeybee/load/infiltration.rb +94 -94
  36. data/lib/from_honeybee/load/lighting.rb +98 -98
  37. data/lib/from_honeybee/load/people.rb +99 -99
  38. data/lib/from_honeybee/load/setpoint_humidistat.rb +74 -74
  39. data/lib/from_honeybee/load/setpoint_thermostat.rb +71 -71
  40. data/lib/from_honeybee/load/ventilation.rb +95 -95
  41. data/lib/from_honeybee/material/opaque.rb +94 -94
  42. data/lib/from_honeybee/material/opaque_no_mass.rb +94 -94
  43. data/lib/from_honeybee/material/window_blind.rb +238 -238
  44. data/lib/from_honeybee/material/window_gas.rb +76 -76
  45. data/lib/from_honeybee/material/window_gas_custom.rb +118 -118
  46. data/lib/from_honeybee/material/window_gas_mixture.rb +79 -79
  47. data/lib/from_honeybee/material/window_glazing.rb +166 -166
  48. data/lib/from_honeybee/material/window_shade.rb +160 -160
  49. data/lib/from_honeybee/material/window_simpleglazsys.rb +73 -73
  50. data/lib/from_honeybee/model.rb +434 -434
  51. data/lib/from_honeybee/model_object.rb +110 -110
  52. data/lib/from_honeybee/program_type.rb +124 -124
  53. data/lib/from_honeybee/schedule/fixed_interval.rb +115 -115
  54. data/lib/from_honeybee/schedule/ruleset.rb +164 -164
  55. data/lib/from_honeybee/schedule/type_limit.rb +88 -88
  56. data/lib/from_honeybee/simulation/designday.rb +105 -105
  57. data/lib/from_honeybee/simulation/extension.rb +46 -46
  58. data/lib/from_honeybee/simulation/parameter.rb +277 -277
  59. data/lib/from_honeybee/version.rb +34 -34
  60. data/lib/measures/from_honeybee_model/LICENSE.md +26 -26
  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 -103
  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 +26 -26
  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 -91
  69. data/lib/measures/from_honeybee_simulation_parameter/tests/from_honeybee_simulation_parameter_test.rb +109 -109
  70. metadata +2 -2
@@ -1,166 +1,166 @@
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
- module FromHoneybee
37
- class EnergyWindowMaterialGlazing < ModelObject
38
- attr_reader :errors, :warnings
39
-
40
- def initialize(hash = {})
41
- super(hash)
42
- end
43
-
44
- def defaults
45
- @@schema[:components][:schemas][:EnergyWindowMaterialGlazing][:properties]
46
- end
47
-
48
- def find_existing_openstudio_object(openstudio_model)
49
- object = openstudio_model.getStandardGlazingByName(@hash[:identifier])
50
- return object.get if object.is_initialized
51
- nil
52
- end
53
-
54
- def to_openstudio(openstudio_model)
55
- # create openstudio standard glazing object and set identifier
56
- os_glazing = OpenStudio::Model::StandardGlazing.new(openstudio_model)
57
- os_glazing.setName(@hash[:identifier])
58
-
59
- # assign thickness
60
- if @hash[:thickness]
61
- os_glazing.setThickness(@hash[:thickness])
62
- else
63
- os_glazing.setThickness(defaults[:thickness][:default])
64
- end
65
-
66
- # assign solar transmittance
67
- if @hash[:solar_transmittance]
68
- os_glazing.setSolarTransmittanceatNormalIncidence(@hash[:solar_transmittance])
69
- else
70
- os_glazing.setSolarTransmittanceatNormalIncidence(
71
- defaults[:solar_transmittance][:default])
72
- end
73
-
74
- # assign front solar reflectance
75
- if @hash[:solar_reflectance]
76
- os_glazing.setFrontSideSolarReflectanceatNormalIncidence(@hash[:solar_reflectance])
77
- else
78
- os_glazing.setFrontSideSolarReflectanceatNormalIncidence(
79
- defaults[:solar_reflectance][:default])
80
- end
81
-
82
- # assign back solar reflectance
83
- if @hash[:solar_reflectance_back]
84
- os_glazing.setBackSideSolarReflectanceatNormalIncidence(@hash[:solar_reflectance_back])
85
- else
86
- os_glazing.setBackSideSolarReflectanceatNormalIncidence(
87
- defaults[:solar_reflectance_back][:default])
88
- end
89
-
90
- # assign visible transmittance at normal incidence
91
- if @hash[:visible_transmittance]
92
- os_glazing.setVisibleTransmittanceatNormalIncidence(@hash[:visible_transmittance])
93
- else
94
- os_glazing.setVisibleTransmittanceatNormalIncidence(
95
- defaults[:visible_transmittance][:default])
96
- end
97
-
98
- # assign front side visible reflectance
99
- if @hash[:visible_reflectance]
100
- os_glazing.setFrontSideVisibleReflectanceatNormalIncidence(@hash[:visible_reflectance])
101
- else
102
- os_glazing.setFrontSideVisibleReflectanceatNormalIncidence(
103
- defaults[:visible_reflectance][:default])
104
- end
105
-
106
- # assign back side visible reflectance
107
- if @hash[:visible_reflectance_back]
108
- os_glazing.setBackSideVisibleReflectanceatNormalIncidence(@hash[:visible_reflectance_back])
109
- else
110
- os_glazing.setBackSideVisibleReflectanceatNormalIncidence(
111
- defaults[:visible_reflectance_back][:default])
112
- end
113
-
114
- # assign infrared transmittance
115
- if @hash[:infrared_transmittance]
116
- os_glazing.setInfraredTransmittanceatNormalIncidence(@hash[:infrared_transmittance])
117
- else
118
- os_glazing.setInfraredTransmittanceatNormalIncidence(
119
- defaults[:infrared_transmittance][:default])
120
- end
121
-
122
- # assign front side emissivity
123
- if @hash[:emissivity]
124
- os_glazing.setFrontSideInfraredHemisphericalEmissivity(@hash[:emissivity])
125
- else
126
- os_glazing.setFrontSideInfraredHemisphericalEmissivity(
127
- defaults[:emissivity][:default])
128
- end
129
-
130
- # assign back side emissivity
131
- if @hash[:emissivity_back]
132
- os_glazing.setBackSideInfraredHemisphericalEmissivity(@hash[:emissivity_back])
133
- else
134
- os_glazing.setBackSideInfraredHemisphericalEmissivity(
135
- defaults[:emissivity_back][:default])
136
- end
137
-
138
- # assign conductivity
139
- if @hash[:conductivity]
140
- os_glazing.setThermalConductivity(@hash[:conductivity])
141
- else
142
- os_glazing.setThermalConductivity(
143
- defaults[:conductivity_glass][:default])
144
- end
145
-
146
- # assign dirt correction
147
- if @hash[:dirt_correction]
148
- os_glazing.setDirtCorrectionFactorforSolarandVisibleTransmittance(@hash[:dirt_correction])
149
- else
150
- os_glazing.setDirtCorrectionFactorforSolarandVisibleTransmittance(
151
- defaults[:dirt_correction][:default])
152
- end
153
-
154
- # assign solar diffusing
155
- if @hash[:solar_diffusing] == false
156
- os_glazing.setSolarDiffusing(false)
157
- elsif @hash[:solar_diffusing] == true
158
- os_glazing.setSolarDiffusing(true)
159
- else
160
- os_glazing.setSolarDiffusing(defaults[:solar_diffusing][:default])
161
- end
162
-
163
- os_glazing
164
- end
165
- end # EnergyWindowMaterialGlazing
166
- end # FromHoneybee
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
+ module FromHoneybee
37
+ class EnergyWindowMaterialGlazing < ModelObject
38
+ attr_reader :errors, :warnings
39
+
40
+ def initialize(hash = {})
41
+ super(hash)
42
+ end
43
+
44
+ def defaults
45
+ @@schema[:components][:schemas][:EnergyWindowMaterialGlazing][:properties]
46
+ end
47
+
48
+ def find_existing_openstudio_object(openstudio_model)
49
+ object = openstudio_model.getStandardGlazingByName(@hash[:identifier])
50
+ return object.get if object.is_initialized
51
+ nil
52
+ end
53
+
54
+ def to_openstudio(openstudio_model)
55
+ # create openstudio standard glazing object and set identifier
56
+ os_glazing = OpenStudio::Model::StandardGlazing.new(openstudio_model)
57
+ os_glazing.setName(@hash[:identifier])
58
+
59
+ # assign thickness
60
+ if @hash[:thickness]
61
+ os_glazing.setThickness(@hash[:thickness])
62
+ else
63
+ os_glazing.setThickness(defaults[:thickness][:default])
64
+ end
65
+
66
+ # assign solar transmittance
67
+ if @hash[:solar_transmittance]
68
+ os_glazing.setSolarTransmittanceatNormalIncidence(@hash[:solar_transmittance])
69
+ else
70
+ os_glazing.setSolarTransmittanceatNormalIncidence(
71
+ defaults[:solar_transmittance][:default])
72
+ end
73
+
74
+ # assign front solar reflectance
75
+ if @hash[:solar_reflectance]
76
+ os_glazing.setFrontSideSolarReflectanceatNormalIncidence(@hash[:solar_reflectance])
77
+ else
78
+ os_glazing.setFrontSideSolarReflectanceatNormalIncidence(
79
+ defaults[:solar_reflectance][:default])
80
+ end
81
+
82
+ # assign back solar reflectance
83
+ if @hash[:solar_reflectance_back]
84
+ os_glazing.setBackSideSolarReflectanceatNormalIncidence(@hash[:solar_reflectance_back])
85
+ else
86
+ os_glazing.setBackSideSolarReflectanceatNormalIncidence(
87
+ defaults[:solar_reflectance_back][:default])
88
+ end
89
+
90
+ # assign visible transmittance at normal incidence
91
+ if @hash[:visible_transmittance]
92
+ os_glazing.setVisibleTransmittanceatNormalIncidence(@hash[:visible_transmittance])
93
+ else
94
+ os_glazing.setVisibleTransmittanceatNormalIncidence(
95
+ defaults[:visible_transmittance][:default])
96
+ end
97
+
98
+ # assign front side visible reflectance
99
+ if @hash[:visible_reflectance]
100
+ os_glazing.setFrontSideVisibleReflectanceatNormalIncidence(@hash[:visible_reflectance])
101
+ else
102
+ os_glazing.setFrontSideVisibleReflectanceatNormalIncidence(
103
+ defaults[:visible_reflectance][:default])
104
+ end
105
+
106
+ # assign back side visible reflectance
107
+ if @hash[:visible_reflectance_back]
108
+ os_glazing.setBackSideVisibleReflectanceatNormalIncidence(@hash[:visible_reflectance_back])
109
+ else
110
+ os_glazing.setBackSideVisibleReflectanceatNormalIncidence(
111
+ defaults[:visible_reflectance_back][:default])
112
+ end
113
+
114
+ # assign infrared transmittance
115
+ if @hash[:infrared_transmittance]
116
+ os_glazing.setInfraredTransmittanceatNormalIncidence(@hash[:infrared_transmittance])
117
+ else
118
+ os_glazing.setInfraredTransmittanceatNormalIncidence(
119
+ defaults[:infrared_transmittance][:default])
120
+ end
121
+
122
+ # assign front side emissivity
123
+ if @hash[:emissivity]
124
+ os_glazing.setFrontSideInfraredHemisphericalEmissivity(@hash[:emissivity])
125
+ else
126
+ os_glazing.setFrontSideInfraredHemisphericalEmissivity(
127
+ defaults[:emissivity][:default])
128
+ end
129
+
130
+ # assign back side emissivity
131
+ if @hash[:emissivity_back]
132
+ os_glazing.setBackSideInfraredHemisphericalEmissivity(@hash[:emissivity_back])
133
+ else
134
+ os_glazing.setBackSideInfraredHemisphericalEmissivity(
135
+ defaults[:emissivity_back][:default])
136
+ end
137
+
138
+ # assign conductivity
139
+ if @hash[:conductivity]
140
+ os_glazing.setThermalConductivity(@hash[:conductivity])
141
+ else
142
+ os_glazing.setThermalConductivity(
143
+ defaults[:conductivity_glass][:default])
144
+ end
145
+
146
+ # assign dirt correction
147
+ if @hash[:dirt_correction]
148
+ os_glazing.setDirtCorrectionFactorforSolarandVisibleTransmittance(@hash[:dirt_correction])
149
+ else
150
+ os_glazing.setDirtCorrectionFactorforSolarandVisibleTransmittance(
151
+ defaults[:dirt_correction][:default])
152
+ end
153
+
154
+ # assign solar diffusing
155
+ if @hash[:solar_diffusing] == false
156
+ os_glazing.setSolarDiffusing(false)
157
+ elsif @hash[:solar_diffusing] == true
158
+ os_glazing.setSolarDiffusing(true)
159
+ else
160
+ os_glazing.setSolarDiffusing(defaults[:solar_diffusing][:default])
161
+ end
162
+
163
+ os_glazing
164
+ end
165
+ end # EnergyWindowMaterialGlazing
166
+ end # FromHoneybee
@@ -1,160 +1,160 @@
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
- module FromHoneybee
37
- class EnergyWindowMaterialShade < ModelObject
38
- attr_reader :errors, :warnings
39
-
40
- def initialize(hash)
41
- super(hash)
42
- end
43
-
44
- def defaults
45
- @@schema[:components][:schemas][:EnergyWindowMaterialShade][:properties]
46
- end
47
-
48
- def find_existing_openstudio_object(openstudio_model)
49
- object = openstudio_model.getShadeByName(@hash[:identifier])
50
- return object.get if object.is_initialized
51
- nil
52
- end
53
-
54
- def to_openstudio(openstudio_model)
55
- # create openstudio shade object
56
- os_shade_mat = OpenStudio::Model::Shade.new(openstudio_model)
57
- os_shade_mat.setName(@hash[:identifier])
58
-
59
- # assign solar transmittance
60
- if @hash[:solar_transmittance]
61
- os_shade_mat.setSolarTransmittance(@hash[:solar_transmittance])
62
- else
63
- os_shade_mat.setSolarTransmittance(defaults[:solar_transmittance][:default])
64
- end
65
-
66
- # assign solar reflectance
67
- if @hash[:solar_reflectance]
68
- os_shade_mat.setSolarReflectance(@hash[:solar_reflectance])
69
- else
70
- os_shade_mat.setSolarReflectance(defaults[:solar_reflectance][:default])
71
- end
72
-
73
- # assign visible transmittance
74
- if @hash[:visible_transmittance]
75
- os_shade_mat.setVisibleTransmittance(@hash[:visible_transmittance])
76
- else
77
- os_shade_mat.setVisibleTransmittance(defaults[:visible_transmittance][:default])
78
- end
79
-
80
- # assign visible reflectance
81
- if @hash[:visible_reflectance]
82
- os_shade_mat.setVisibleReflectance(@hash[:visible_reflectance])
83
- else
84
- os_shade_mat.setVisibleReflectance(defaults[:visible_reflectance][:default])
85
- end
86
-
87
- # assign emissivity
88
- if @hash[:emissivity]
89
- os_shade_mat.setThermalHemisphericalEmissivity(@hash[:emissivity])
90
- else
91
- os_shade_mat.setThermalHemisphericalEmissivity(defaults[:emissivity][:default])
92
- end
93
-
94
- # assign infrared transmittance
95
- if @hash[:infrared_transmittance]
96
- os_shade_mat.setThermalTransmittance(@hash[:infrared_transmittance])
97
- else
98
- os_shade_mat.setThermalTransmittance(defaults[:infrared_transmittance][:default])
99
- end
100
-
101
- # assign thickness
102
- if @hash[:thickness]
103
- os_shade_mat.setThickness(@hash[:thickness])
104
- else
105
- os_shade_mat.setThickness(defaults[:thickness][:default])
106
- end
107
-
108
- # assign conductivity
109
- if @hash[:conductivity]
110
- os_shade_mat.setConductivity(@hash[:conductivity])
111
- else
112
- os_shade_mat.setConductivity(defaults[:conductivity][:default])
113
- end
114
-
115
- # assign distance to glass
116
- if @hash[:distance_to_glass]
117
- os_shade_mat.setShadetoGlassDistance(@hash[:distance_to_glass])
118
- else
119
- os_shade_mat.setShadetoGlassDistance(defaults[:distance_to_glass][:default])
120
- end
121
-
122
- # assign top opening multiplier
123
- if @hash[:top_opening_multiplier]
124
- os_shade_mat.setTopOpeningMultiplier(@hash[:top_opening_multiplier])
125
- else
126
- os_shade_mat.setTopOpeningMultiplier(defaults[:top_opening_multiplier][:default])
127
- end
128
-
129
- # assign bottom opening multiplier
130
- if @hash[:bottom_opening_multiplier]
131
- os_shade_mat.setBottomOpeningMultiplier(@hash[:bottom_opening_multiplier])
132
- else
133
- os_shade_mat.setBottomOpeningMultiplier(defaults[:bottom_opening_multiplier][:default])
134
- end
135
-
136
- # assign left opening multiplier
137
- if @hash[:left_opening_multiplier]
138
- os_shade_mat.setLeftSideOpeningMultiplier(@hash[:left_opening_multiplier])
139
- else
140
- os_shade_mat.setLeftSideOpeningMultiplier(defaults[:left_opening_multiplier][:default])
141
- end
142
-
143
- # assign right opening muliplier
144
- if @hash[:right_opening_multiplier]
145
- os_shade_mat.setRightSideOpeningMultiplier(@hash[:right_opening_multiplier])
146
- else
147
- os_shade_mat.setRightSideOpeningMultiplier(defaults[:right_opening_multiplier][:default])
148
- end
149
-
150
- # assign airflow permeability
151
- if @hash[:airflow_permeability]
152
- os_shade_mat.setAirflowPermeability(@hash[:airflow_permeability])
153
- else
154
- os_shade_mat.setAirflowPermeability(defaults[:airflow_permeability][:default])
155
- end
156
-
157
- os_shade_mat
158
- end
159
- end # EnergyWindowMaterialShade
160
- end # FromHoneybee
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
+ module FromHoneybee
37
+ class EnergyWindowMaterialShade < ModelObject
38
+ attr_reader :errors, :warnings
39
+
40
+ def initialize(hash)
41
+ super(hash)
42
+ end
43
+
44
+ def defaults
45
+ @@schema[:components][:schemas][:EnergyWindowMaterialShade][:properties]
46
+ end
47
+
48
+ def find_existing_openstudio_object(openstudio_model)
49
+ object = openstudio_model.getShadeByName(@hash[:identifier])
50
+ return object.get if object.is_initialized
51
+ nil
52
+ end
53
+
54
+ def to_openstudio(openstudio_model)
55
+ # create openstudio shade object
56
+ os_shade_mat = OpenStudio::Model::Shade.new(openstudio_model)
57
+ os_shade_mat.setName(@hash[:identifier])
58
+
59
+ # assign solar transmittance
60
+ if @hash[:solar_transmittance]
61
+ os_shade_mat.setSolarTransmittance(@hash[:solar_transmittance])
62
+ else
63
+ os_shade_mat.setSolarTransmittance(defaults[:solar_transmittance][:default])
64
+ end
65
+
66
+ # assign solar reflectance
67
+ if @hash[:solar_reflectance]
68
+ os_shade_mat.setSolarReflectance(@hash[:solar_reflectance])
69
+ else
70
+ os_shade_mat.setSolarReflectance(defaults[:solar_reflectance][:default])
71
+ end
72
+
73
+ # assign visible transmittance
74
+ if @hash[:visible_transmittance]
75
+ os_shade_mat.setVisibleTransmittance(@hash[:visible_transmittance])
76
+ else
77
+ os_shade_mat.setVisibleTransmittance(defaults[:visible_transmittance][:default])
78
+ end
79
+
80
+ # assign visible reflectance
81
+ if @hash[:visible_reflectance]
82
+ os_shade_mat.setVisibleReflectance(@hash[:visible_reflectance])
83
+ else
84
+ os_shade_mat.setVisibleReflectance(defaults[:visible_reflectance][:default])
85
+ end
86
+
87
+ # assign emissivity
88
+ if @hash[:emissivity]
89
+ os_shade_mat.setThermalHemisphericalEmissivity(@hash[:emissivity])
90
+ else
91
+ os_shade_mat.setThermalHemisphericalEmissivity(defaults[:emissivity][:default])
92
+ end
93
+
94
+ # assign infrared transmittance
95
+ if @hash[:infrared_transmittance]
96
+ os_shade_mat.setThermalTransmittance(@hash[:infrared_transmittance])
97
+ else
98
+ os_shade_mat.setThermalTransmittance(defaults[:infrared_transmittance][:default])
99
+ end
100
+
101
+ # assign thickness
102
+ if @hash[:thickness]
103
+ os_shade_mat.setThickness(@hash[:thickness])
104
+ else
105
+ os_shade_mat.setThickness(defaults[:thickness][:default])
106
+ end
107
+
108
+ # assign conductivity
109
+ if @hash[:conductivity]
110
+ os_shade_mat.setConductivity(@hash[:conductivity])
111
+ else
112
+ os_shade_mat.setConductivity(defaults[:conductivity][:default])
113
+ end
114
+
115
+ # assign distance to glass
116
+ if @hash[:distance_to_glass]
117
+ os_shade_mat.setShadetoGlassDistance(@hash[:distance_to_glass])
118
+ else
119
+ os_shade_mat.setShadetoGlassDistance(defaults[:distance_to_glass][:default])
120
+ end
121
+
122
+ # assign top opening multiplier
123
+ if @hash[:top_opening_multiplier]
124
+ os_shade_mat.setTopOpeningMultiplier(@hash[:top_opening_multiplier])
125
+ else
126
+ os_shade_mat.setTopOpeningMultiplier(defaults[:top_opening_multiplier][:default])
127
+ end
128
+
129
+ # assign bottom opening multiplier
130
+ if @hash[:bottom_opening_multiplier]
131
+ os_shade_mat.setBottomOpeningMultiplier(@hash[:bottom_opening_multiplier])
132
+ else
133
+ os_shade_mat.setBottomOpeningMultiplier(defaults[:bottom_opening_multiplier][:default])
134
+ end
135
+
136
+ # assign left opening multiplier
137
+ if @hash[:left_opening_multiplier]
138
+ os_shade_mat.setLeftSideOpeningMultiplier(@hash[:left_opening_multiplier])
139
+ else
140
+ os_shade_mat.setLeftSideOpeningMultiplier(defaults[:left_opening_multiplier][:default])
141
+ end
142
+
143
+ # assign right opening muliplier
144
+ if @hash[:right_opening_multiplier]
145
+ os_shade_mat.setRightSideOpeningMultiplier(@hash[:right_opening_multiplier])
146
+ else
147
+ os_shade_mat.setRightSideOpeningMultiplier(defaults[:right_opening_multiplier][:default])
148
+ end
149
+
150
+ # assign airflow permeability
151
+ if @hash[:airflow_permeability]
152
+ os_shade_mat.setAirflowPermeability(@hash[:airflow_permeability])
153
+ else
154
+ os_shade_mat.setAirflowPermeability(defaults[:airflow_permeability][:default])
155
+ end
156
+
157
+ os_shade_mat
158
+ end
159
+ end # EnergyWindowMaterialShade
160
+ end # FromHoneybee