honeybee-openstudio 1.8.1 → 2.0.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/.coveralls.yml +1 -1
- data/.gitignore +32 -32
- data/.releaserc.json +7 -7
- data/.travis.yml +44 -41
- data/Gemfile +18 -18
- data/LICENSE.md +23 -23
- data/README.md +95 -95
- data/Rakefile +20 -20
- data/doc_templates/LICENSE.md +23 -23
- data/doc_templates/copyright_erb.txt +31 -31
- data/doc_templates/copyright_js.txt +4 -4
- data/doc_templates/copyright_ruby.txt +29 -29
- data/honeybee-openstudio.gemspec +34 -35
- data/lib/files/Honeybee.rb +112 -112
- data/lib/files/honeybee_workflow.osw +47 -47
- data/lib/files/urbanopt_Gemfile +32 -32
- data/lib/from_honeybee.rb +85 -86
- data/lib/from_honeybee/_openapi/model.json +8691 -8126
- data/lib/from_honeybee/_openapi/simulation-parameter.json +983 -842
- data/lib/from_honeybee/construction/air.rb +64 -64
- data/lib/from_honeybee/construction/opaque.rb +76 -76
- data/lib/from_honeybee/construction/shade.rb +107 -107
- data/lib/from_honeybee/construction/window.rb +80 -80
- data/lib/from_honeybee/construction_set.rb +278 -278
- data/lib/from_honeybee/extension.rb +109 -109
- data/lib/from_honeybee/geometry/aperture.rb +167 -167
- data/lib/from_honeybee/geometry/door.rb +160 -160
- data/lib/from_honeybee/geometry/face.rb +163 -163
- data/lib/from_honeybee/geometry/room.rb +392 -392
- data/lib/from_honeybee/geometry/shade.rb +89 -89
- data/lib/from_honeybee/hvac/ideal_air.rb +150 -150
- data/lib/from_honeybee/load/electric_equipment.rb +95 -95
- data/lib/from_honeybee/load/gas_equipment.rb +97 -97
- data/lib/from_honeybee/load/infiltration.rb +94 -94
- data/lib/from_honeybee/load/lighting.rb +98 -98
- data/lib/from_honeybee/load/people.rb +99 -99
- data/lib/from_honeybee/load/setpoint_humidistat.rb +74 -74
- data/lib/from_honeybee/load/setpoint_thermostat.rb +71 -71
- data/lib/from_honeybee/load/ventilation.rb +95 -95
- data/lib/from_honeybee/material/opaque.rb +94 -94
- data/lib/from_honeybee/material/opaque_no_mass.rb +94 -94
- data/lib/from_honeybee/material/window_blind.rb +238 -238
- data/lib/from_honeybee/material/window_gas.rb +76 -76
- data/lib/from_honeybee/material/window_gas_custom.rb +118 -118
- data/lib/from_honeybee/material/window_gas_mixture.rb +79 -79
- data/lib/from_honeybee/material/window_glazing.rb +166 -166
- data/lib/from_honeybee/material/window_shade.rb +160 -160
- data/lib/from_honeybee/material/window_simpleglazsys.rb +73 -73
- data/lib/from_honeybee/model.rb +434 -434
- data/lib/from_honeybee/model_object.rb +110 -110
- data/lib/from_honeybee/program_type.rb +124 -124
- data/lib/from_honeybee/schedule/fixed_interval.rb +115 -115
- data/lib/from_honeybee/schedule/ruleset.rb +164 -164
- data/lib/from_honeybee/schedule/type_limit.rb +88 -88
- data/lib/from_honeybee/simulation/designday.rb +105 -105
- data/lib/from_honeybee/simulation/extension.rb +46 -46
- data/lib/from_honeybee/simulation/parameter.rb +316 -277
- data/lib/measures/from_honeybee_model/LICENSE.md +26 -26
- data/lib/measures/from_honeybee_model/README.md +32 -32
- data/lib/measures/from_honeybee_model/measure.rb +91 -91
- data/lib/measures/from_honeybee_model/measure.xml +103 -103
- data/lib/measures/from_honeybee_model/tests/from_honeybee_model_test.rb +126 -126
- data/lib/measures/from_honeybee_simulation_parameter/LICENSE.md +26 -26
- data/lib/measures/from_honeybee_simulation_parameter/README.md +32 -32
- data/lib/measures/from_honeybee_simulation_parameter/measure.rb +95 -95
- data/lib/measures/from_honeybee_simulation_parameter/measure.xml +91 -91
- data/lib/measures/from_honeybee_simulation_parameter/tests/from_honeybee_simulation_parameter_test.rb +109 -109
- metadata +13 -15
- data/lib/from_honeybee/version.rb +0 -34
@@ -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 Door < ModelObject
|
38
|
-
attr_reader :errors, :warnings
|
39
|
-
|
40
|
-
def initialize(hash)
|
41
|
-
super(hash)
|
42
|
-
raise "Incorrect model type '#{@type}'" unless @type == 'Door'
|
43
|
-
end
|
44
|
-
|
45
|
-
def defaults
|
46
|
-
@@schema[:components][:schemas][:DoorEnergyPropertiesAbridged][:properties]
|
47
|
-
end
|
48
|
-
|
49
|
-
def find_existing_openstudio_object(openstudio_model)
|
50
|
-
object = openstudio_model.getSubSurfaceByName(@hash[:identifier])
|
51
|
-
return object.get if object.is_initialized
|
52
|
-
nil
|
53
|
-
end
|
54
|
-
|
55
|
-
def to_openstudio(openstudio_model)
|
56
|
-
# create the OpenStudio door object
|
57
|
-
os_vertices = OpenStudio::Point3dVector.new
|
58
|
-
@hash[:geometry][:boundary].each do |vertex|
|
59
|
-
os_vertices << OpenStudio::Point3d.new(vertex[0], vertex[1], vertex[2])
|
60
|
-
end
|
61
|
-
reordered_vertices = OpenStudio.reorderULC(os_vertices)
|
62
|
-
|
63
|
-
# triangulate subsurface if neccesary
|
64
|
-
triangulated = false
|
65
|
-
final_vertices_list = []
|
66
|
-
matching_os_subsurfaces = []
|
67
|
-
matching_os_subsurface_indices = []
|
68
|
-
if reordered_vertices.size > 4
|
69
|
-
|
70
|
-
# if this door has a matched door, see if the other one has already been created
|
71
|
-
# the matched door should have been converted to multiple subsurfaces
|
72
|
-
if @hash[:boundary_condition][:type] == 'Surface'
|
73
|
-
adj_srf_identifier = @hash[:boundary_condition][:boundary_condition_objects][0]
|
74
|
-
regex = Regexp.new("#{adj_srf_identifier}\.\.(\\d+)")
|
75
|
-
openstudio_model.getSubSurfaces.each do |subsurface|
|
76
|
-
if md = regex.match(subsurface.nameString)
|
77
|
-
final_vertices_list << OpenStudio.reorderULC(OpenStudio::reverse(subsurface.vertices))
|
78
|
-
matching_os_subsurfaces << subsurface
|
79
|
-
matching_os_subsurface_indices << md[1]
|
80
|
-
end
|
81
|
-
end
|
82
|
-
end
|
83
|
-
|
84
|
-
# if other door is not already created, do the triangulation
|
85
|
-
if final_vertices_list.empty?
|
86
|
-
|
87
|
-
# transform to face coordinates
|
88
|
-
t = OpenStudio::Transformation::alignFace(reordered_vertices)
|
89
|
-
tInv = t.inverse
|
90
|
-
face_vertices = OpenStudio::reverse(tInv*reordered_vertices)
|
91
|
-
|
92
|
-
# no holes in the subsurface
|
93
|
-
holes = OpenStudio::Point3dVectorVector.new
|
94
|
-
|
95
|
-
# triangulate surface
|
96
|
-
triangles = OpenStudio::computeTriangulation(face_vertices, holes)
|
97
|
-
if triangles.empty?
|
98
|
-
raise "Failed to triangulate door #{@hash[:identifier]} with #{reordered_vertices.size} vertices"
|
99
|
-
end
|
100
|
-
|
101
|
-
# create new list of surfaces
|
102
|
-
triangles.each do |vertices|
|
103
|
-
final_vertices_list << OpenStudio.reorderULC(OpenStudio::reverse(t*vertices))
|
104
|
-
end
|
105
|
-
|
106
|
-
triangulated = true
|
107
|
-
|
108
|
-
end
|
109
|
-
|
110
|
-
else
|
111
|
-
# reordered_vertices are good as is
|
112
|
-
final_vertices_list << reordered_vertices
|
113
|
-
end
|
114
|
-
|
115
|
-
result = []
|
116
|
-
final_vertices_list.each_with_index do |reordered_vertices, index|
|
117
|
-
os_subsurface = OpenStudio::Model::SubSurface.new(reordered_vertices, openstudio_model)
|
118
|
-
|
119
|
-
if !matching_os_subsurfaces.empty?
|
120
|
-
os_subsurface.setName(@hash[:identifier] + "..#{matching_os_subsurface_indices[index]}")
|
121
|
-
elsif triangulated
|
122
|
-
os_subsurface.setName(@hash[:identifier] + "..#{index}")
|
123
|
-
else
|
124
|
-
os_subsurface.setName(@hash[:identifier])
|
125
|
-
end
|
126
|
-
|
127
|
-
# assign the construction if it exists
|
128
|
-
if @hash[:properties][:energy][:construction]
|
129
|
-
construction_identifier = @hash[:properties][:energy][:construction]
|
130
|
-
construction = openstudio_model.getConstructionByName(construction_identifier)
|
131
|
-
unless construction.empty?
|
132
|
-
os_construction = construction.get
|
133
|
-
os_subsurface.setConstruction(os_construction)
|
134
|
-
end
|
135
|
-
end
|
136
|
-
|
137
|
-
# assign the boundary condition object if it's a Surface
|
138
|
-
if @hash[:boundary_condition][:type] == 'Surface'
|
139
|
-
if !matching_os_subsurfaces.empty?
|
140
|
-
# we already have the match because this was created from the matching_os_subsurfaces
|
141
|
-
# setAdjacentSubSurface will fail at this point because sub surface is not assigned to surface yet, store data for later
|
142
|
-
adj_srf_identifier = matching_os_subsurfaces[index].nameString
|
143
|
-
os_subsurface.additionalProperties.setFeature("AdjacentSubSurfaceName", adj_srf_identifier)
|
144
|
-
elsif triangulated
|
145
|
-
# other subsurfaces haven't been created yet, no-op
|
146
|
-
else
|
147
|
-
# get adjacent sub surface by identifier from openstudio model
|
148
|
-
# setAdjacentSubSurface will fail at this point because sub surface is not assigned to surface yet, store data for later
|
149
|
-
adj_srf_identifier = @hash[:boundary_condition][:boundary_condition_objects][0]
|
150
|
-
os_subsurface.additionalProperties.setFeature("AdjacentSubSurfaceName", adj_srf_identifier)
|
151
|
-
end
|
152
|
-
end
|
153
|
-
|
154
|
-
result << os_subsurface
|
155
|
-
end
|
156
|
-
|
157
|
-
return result
|
158
|
-
end
|
159
|
-
end # Door
|
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 Door < ModelObject
|
38
|
+
attr_reader :errors, :warnings
|
39
|
+
|
40
|
+
def initialize(hash)
|
41
|
+
super(hash)
|
42
|
+
raise "Incorrect model type '#{@type}'" unless @type == 'Door'
|
43
|
+
end
|
44
|
+
|
45
|
+
def defaults
|
46
|
+
@@schema[:components][:schemas][:DoorEnergyPropertiesAbridged][:properties]
|
47
|
+
end
|
48
|
+
|
49
|
+
def find_existing_openstudio_object(openstudio_model)
|
50
|
+
object = openstudio_model.getSubSurfaceByName(@hash[:identifier])
|
51
|
+
return object.get if object.is_initialized
|
52
|
+
nil
|
53
|
+
end
|
54
|
+
|
55
|
+
def to_openstudio(openstudio_model)
|
56
|
+
# create the OpenStudio door object
|
57
|
+
os_vertices = OpenStudio::Point3dVector.new
|
58
|
+
@hash[:geometry][:boundary].each do |vertex|
|
59
|
+
os_vertices << OpenStudio::Point3d.new(vertex[0], vertex[1], vertex[2])
|
60
|
+
end
|
61
|
+
reordered_vertices = OpenStudio.reorderULC(os_vertices)
|
62
|
+
|
63
|
+
# triangulate subsurface if neccesary
|
64
|
+
triangulated = false
|
65
|
+
final_vertices_list = []
|
66
|
+
matching_os_subsurfaces = []
|
67
|
+
matching_os_subsurface_indices = []
|
68
|
+
if reordered_vertices.size > 4
|
69
|
+
|
70
|
+
# if this door has a matched door, see if the other one has already been created
|
71
|
+
# the matched door should have been converted to multiple subsurfaces
|
72
|
+
if @hash[:boundary_condition][:type] == 'Surface'
|
73
|
+
adj_srf_identifier = @hash[:boundary_condition][:boundary_condition_objects][0]
|
74
|
+
regex = Regexp.new("#{adj_srf_identifier}\.\.(\\d+)")
|
75
|
+
openstudio_model.getSubSurfaces.each do |subsurface|
|
76
|
+
if md = regex.match(subsurface.nameString)
|
77
|
+
final_vertices_list << OpenStudio.reorderULC(OpenStudio::reverse(subsurface.vertices))
|
78
|
+
matching_os_subsurfaces << subsurface
|
79
|
+
matching_os_subsurface_indices << md[1]
|
80
|
+
end
|
81
|
+
end
|
82
|
+
end
|
83
|
+
|
84
|
+
# if other door is not already created, do the triangulation
|
85
|
+
if final_vertices_list.empty?
|
86
|
+
|
87
|
+
# transform to face coordinates
|
88
|
+
t = OpenStudio::Transformation::alignFace(reordered_vertices)
|
89
|
+
tInv = t.inverse
|
90
|
+
face_vertices = OpenStudio::reverse(tInv*reordered_vertices)
|
91
|
+
|
92
|
+
# no holes in the subsurface
|
93
|
+
holes = OpenStudio::Point3dVectorVector.new
|
94
|
+
|
95
|
+
# triangulate surface
|
96
|
+
triangles = OpenStudio::computeTriangulation(face_vertices, holes)
|
97
|
+
if triangles.empty?
|
98
|
+
raise "Failed to triangulate door #{@hash[:identifier]} with #{reordered_vertices.size} vertices"
|
99
|
+
end
|
100
|
+
|
101
|
+
# create new list of surfaces
|
102
|
+
triangles.each do |vertices|
|
103
|
+
final_vertices_list << OpenStudio.reorderULC(OpenStudio::reverse(t*vertices))
|
104
|
+
end
|
105
|
+
|
106
|
+
triangulated = true
|
107
|
+
|
108
|
+
end
|
109
|
+
|
110
|
+
else
|
111
|
+
# reordered_vertices are good as is
|
112
|
+
final_vertices_list << reordered_vertices
|
113
|
+
end
|
114
|
+
|
115
|
+
result = []
|
116
|
+
final_vertices_list.each_with_index do |reordered_vertices, index|
|
117
|
+
os_subsurface = OpenStudio::Model::SubSurface.new(reordered_vertices, openstudio_model)
|
118
|
+
|
119
|
+
if !matching_os_subsurfaces.empty?
|
120
|
+
os_subsurface.setName(@hash[:identifier] + "..#{matching_os_subsurface_indices[index]}")
|
121
|
+
elsif triangulated
|
122
|
+
os_subsurface.setName(@hash[:identifier] + "..#{index}")
|
123
|
+
else
|
124
|
+
os_subsurface.setName(@hash[:identifier])
|
125
|
+
end
|
126
|
+
|
127
|
+
# assign the construction if it exists
|
128
|
+
if @hash[:properties][:energy][:construction]
|
129
|
+
construction_identifier = @hash[:properties][:energy][:construction]
|
130
|
+
construction = openstudio_model.getConstructionByName(construction_identifier)
|
131
|
+
unless construction.empty?
|
132
|
+
os_construction = construction.get
|
133
|
+
os_subsurface.setConstruction(os_construction)
|
134
|
+
end
|
135
|
+
end
|
136
|
+
|
137
|
+
# assign the boundary condition object if it's a Surface
|
138
|
+
if @hash[:boundary_condition][:type] == 'Surface'
|
139
|
+
if !matching_os_subsurfaces.empty?
|
140
|
+
# we already have the match because this was created from the matching_os_subsurfaces
|
141
|
+
# setAdjacentSubSurface will fail at this point because sub surface is not assigned to surface yet, store data for later
|
142
|
+
adj_srf_identifier = matching_os_subsurfaces[index].nameString
|
143
|
+
os_subsurface.additionalProperties.setFeature("AdjacentSubSurfaceName", adj_srf_identifier)
|
144
|
+
elsif triangulated
|
145
|
+
# other subsurfaces haven't been created yet, no-op
|
146
|
+
else
|
147
|
+
# get adjacent sub surface by identifier from openstudio model
|
148
|
+
# setAdjacentSubSurface will fail at this point because sub surface is not assigned to surface yet, store data for later
|
149
|
+
adj_srf_identifier = @hash[:boundary_condition][:boundary_condition_objects][0]
|
150
|
+
os_subsurface.additionalProperties.setFeature("AdjacentSubSurfaceName", adj_srf_identifier)
|
151
|
+
end
|
152
|
+
end
|
153
|
+
|
154
|
+
result << os_subsurface
|
155
|
+
end
|
156
|
+
|
157
|
+
return result
|
158
|
+
end
|
159
|
+
end # Door
|
160
|
+
end # FromHoneybee
|
@@ -1,163 +1,163 @@
|
|
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
|
-
require 'from_honeybee/geometry/aperture'
|
34
|
-
require 'from_honeybee/geometry/door'
|
35
|
-
|
36
|
-
require 'openstudio'
|
37
|
-
|
38
|
-
module FromHoneybee
|
39
|
-
class Face < ModelObject
|
40
|
-
attr_reader :errors, :warnings
|
41
|
-
|
42
|
-
def initialize(hash = {})
|
43
|
-
super(hash)
|
44
|
-
|
45
|
-
raise "Incorrect model type '#{@type}'" unless @type == 'Face'
|
46
|
-
end
|
47
|
-
|
48
|
-
def defaults
|
49
|
-
@@schema[:components][:schemas][:FaceEnergyPropertiesAbridged][:properties]
|
50
|
-
end
|
51
|
-
|
52
|
-
def find_existing_openstudio_object(openstudio_model)
|
53
|
-
model_surf = openstudio_model.getSurfaceByName(@hash[:identifier])
|
54
|
-
return model_surf.get unless model_surf.empty?
|
55
|
-
nil
|
56
|
-
end
|
57
|
-
|
58
|
-
def to_openstudio(openstudio_model)
|
59
|
-
# create the openstudio surface
|
60
|
-
os_vertices = OpenStudio::Point3dVector.new
|
61
|
-
@hash[:geometry][:boundary].each do |vertex|
|
62
|
-
os_vertices << OpenStudio::Point3d.new(vertex[0], vertex[1], vertex[2])
|
63
|
-
end
|
64
|
-
reordered_vertices = OpenStudio.reorderULC(os_vertices)
|
65
|
-
|
66
|
-
os_surface = OpenStudio::Model::Surface.new(reordered_vertices, openstudio_model)
|
67
|
-
os_surface.setName(@hash[:identifier])
|
68
|
-
os_surface.setSurfaceType(@hash[:face_type])
|
69
|
-
# assign the construction if it is present
|
70
|
-
if @hash[:properties][:energy][:construction]
|
71
|
-
construction_identifier = @hash[:properties][:energy][:construction]
|
72
|
-
construction = openstudio_model.getConstructionByName(construction_identifier)
|
73
|
-
unless construction.empty?
|
74
|
-
os_construction = construction.get
|
75
|
-
os_surface.setConstruction(os_construction)
|
76
|
-
end
|
77
|
-
end
|
78
|
-
|
79
|
-
# assign the boundary condition
|
80
|
-
boundary_condition = (@hash[:boundary_condition][:type])
|
81
|
-
case boundary_condition
|
82
|
-
when 'Outdoors'
|
83
|
-
if @hash[:boundary_condition][:sun_exposure] == false
|
84
|
-
os_surface.setSunExposure('NoSun')
|
85
|
-
else
|
86
|
-
os_surface.setSunExposure('SunExposed')
|
87
|
-
end
|
88
|
-
if @hash[:boundary_condition][:wind_exposure] == false
|
89
|
-
os_surface.setWindExposure('NoWind')
|
90
|
-
else
|
91
|
-
os_surface.setWindExposure('WindExposed')
|
92
|
-
end
|
93
|
-
if @hash[:boundary_condition][:view_factor].is_a? Numeric
|
94
|
-
os_surface.setViewFactortoGround(@hash[:boundary_condition][:view_factor])
|
95
|
-
else
|
96
|
-
os_surface.autocalculateViewFactortoGround
|
97
|
-
end
|
98
|
-
when 'Surface'
|
99
|
-
# get adjacent surface by identifier from openstudio model
|
100
|
-
adj_srf_identifier = @hash[:boundary_condition][:boundary_condition_objects][0]
|
101
|
-
surface_object = openstudio_model.getSurfaceByName(adj_srf_identifier)
|
102
|
-
unless surface_object.empty?
|
103
|
-
surface = surface_object.get
|
104
|
-
os_surface.setAdjacentSurface(surface)
|
105
|
-
end
|
106
|
-
end
|
107
|
-
unless @hash[:boundary_condition][:type] == 'Surface'
|
108
|
-
os_surface.setOutsideBoundaryCondition(@hash[:boundary_condition][:type])
|
109
|
-
end
|
110
|
-
|
111
|
-
# assign apertures if they exist
|
112
|
-
if @hash[:apertures]
|
113
|
-
@hash[:apertures].each do |aperture|
|
114
|
-
ladybug_aperture = Aperture.new(aperture)
|
115
|
-
os_subsurface_apertures = ladybug_aperture.to_openstudio(openstudio_model)
|
116
|
-
os_subsurface_apertures.each do |os_subsurface_aperture|
|
117
|
-
if @hash[:face_type] == 'RoofCeiling' or @hash[:face_type] == 'Floor'
|
118
|
-
if @hash[:boundary_condition][:type] == 'Outdoors' && aperture[:is_operable] == false
|
119
|
-
os_subsurface_aperture.setSubSurfaceType('Skylight')
|
120
|
-
end
|
121
|
-
end
|
122
|
-
os_subsurface_aperture.setSurface(os_surface)
|
123
|
-
end
|
124
|
-
end
|
125
|
-
end
|
126
|
-
|
127
|
-
# assign doors if they exist
|
128
|
-
if @hash[:doors]
|
129
|
-
@hash[:doors].each do |door|
|
130
|
-
honeybee_door = Door.new(door)
|
131
|
-
os_subsurface_doors = honeybee_door.to_openstudio(openstudio_model)
|
132
|
-
os_subsurface_doors.each do |os_subsurface_door|
|
133
|
-
os_subsurface_door.setSurface(os_surface)
|
134
|
-
if door[:is_glass] == true
|
135
|
-
os_subsurface_door.setSubSurfaceType('GlassDoor')
|
136
|
-
elsif (@hash[:face_type] == 'RoofCeiling' or @hash[:face_type] == 'Floor') && @hash[:boundary_condition][:type] == 'Outdoors'
|
137
|
-
os_subsurface_door.setSubSurfaceType('OverheadDoor')
|
138
|
-
elsif door[:is_glass] == false or door[:is_glass].nil?
|
139
|
-
os_subsurface_door.setSubSurfaceType('Door')
|
140
|
-
end
|
141
|
-
end
|
142
|
-
end
|
143
|
-
end
|
144
|
-
|
145
|
-
os_surface.subSurfaces.each do |os_subsurface|
|
146
|
-
if os_subsurface.hasAdditionalProperties
|
147
|
-
adj_sub_srf_identifier = os_subsurface.additionalProperties.getFeatureAsString("AdjacentSubSurfaceName")
|
148
|
-
unless adj_sub_srf_identifier.empty?
|
149
|
-
adj_sub_srf = openstudio_model.getSubSurfaceByName(adj_sub_srf_identifier.get)
|
150
|
-
unless adj_sub_srf.empty?
|
151
|
-
os_subsurface.setAdjacentSubSurface(adj_sub_srf.get)
|
152
|
-
end
|
153
|
-
end
|
154
|
-
|
155
|
-
# clean up, we don't need this object any more
|
156
|
-
os_subsurface.removeAdditionalProperties
|
157
|
-
end
|
158
|
-
end
|
159
|
-
|
160
|
-
os_surface
|
161
|
-
end
|
162
|
-
end # Face
|
163
|
-
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
|
+
require 'from_honeybee/geometry/aperture'
|
34
|
+
require 'from_honeybee/geometry/door'
|
35
|
+
|
36
|
+
require 'openstudio'
|
37
|
+
|
38
|
+
module FromHoneybee
|
39
|
+
class Face < ModelObject
|
40
|
+
attr_reader :errors, :warnings
|
41
|
+
|
42
|
+
def initialize(hash = {})
|
43
|
+
super(hash)
|
44
|
+
|
45
|
+
raise "Incorrect model type '#{@type}'" unless @type == 'Face'
|
46
|
+
end
|
47
|
+
|
48
|
+
def defaults
|
49
|
+
@@schema[:components][:schemas][:FaceEnergyPropertiesAbridged][:properties]
|
50
|
+
end
|
51
|
+
|
52
|
+
def find_existing_openstudio_object(openstudio_model)
|
53
|
+
model_surf = openstudio_model.getSurfaceByName(@hash[:identifier])
|
54
|
+
return model_surf.get unless model_surf.empty?
|
55
|
+
nil
|
56
|
+
end
|
57
|
+
|
58
|
+
def to_openstudio(openstudio_model)
|
59
|
+
# create the openstudio surface
|
60
|
+
os_vertices = OpenStudio::Point3dVector.new
|
61
|
+
@hash[:geometry][:boundary].each do |vertex|
|
62
|
+
os_vertices << OpenStudio::Point3d.new(vertex[0], vertex[1], vertex[2])
|
63
|
+
end
|
64
|
+
reordered_vertices = OpenStudio.reorderULC(os_vertices)
|
65
|
+
|
66
|
+
os_surface = OpenStudio::Model::Surface.new(reordered_vertices, openstudio_model)
|
67
|
+
os_surface.setName(@hash[:identifier])
|
68
|
+
os_surface.setSurfaceType(@hash[:face_type])
|
69
|
+
# assign the construction if it is present
|
70
|
+
if @hash[:properties][:energy][:construction]
|
71
|
+
construction_identifier = @hash[:properties][:energy][:construction]
|
72
|
+
construction = openstudio_model.getConstructionByName(construction_identifier)
|
73
|
+
unless construction.empty?
|
74
|
+
os_construction = construction.get
|
75
|
+
os_surface.setConstruction(os_construction)
|
76
|
+
end
|
77
|
+
end
|
78
|
+
|
79
|
+
# assign the boundary condition
|
80
|
+
boundary_condition = (@hash[:boundary_condition][:type])
|
81
|
+
case boundary_condition
|
82
|
+
when 'Outdoors'
|
83
|
+
if @hash[:boundary_condition][:sun_exposure] == false
|
84
|
+
os_surface.setSunExposure('NoSun')
|
85
|
+
else
|
86
|
+
os_surface.setSunExposure('SunExposed')
|
87
|
+
end
|
88
|
+
if @hash[:boundary_condition][:wind_exposure] == false
|
89
|
+
os_surface.setWindExposure('NoWind')
|
90
|
+
else
|
91
|
+
os_surface.setWindExposure('WindExposed')
|
92
|
+
end
|
93
|
+
if @hash[:boundary_condition][:view_factor].is_a? Numeric
|
94
|
+
os_surface.setViewFactortoGround(@hash[:boundary_condition][:view_factor])
|
95
|
+
else
|
96
|
+
os_surface.autocalculateViewFactortoGround
|
97
|
+
end
|
98
|
+
when 'Surface'
|
99
|
+
# get adjacent surface by identifier from openstudio model
|
100
|
+
adj_srf_identifier = @hash[:boundary_condition][:boundary_condition_objects][0]
|
101
|
+
surface_object = openstudio_model.getSurfaceByName(adj_srf_identifier)
|
102
|
+
unless surface_object.empty?
|
103
|
+
surface = surface_object.get
|
104
|
+
os_surface.setAdjacentSurface(surface)
|
105
|
+
end
|
106
|
+
end
|
107
|
+
unless @hash[:boundary_condition][:type] == 'Surface'
|
108
|
+
os_surface.setOutsideBoundaryCondition(@hash[:boundary_condition][:type])
|
109
|
+
end
|
110
|
+
|
111
|
+
# assign apertures if they exist
|
112
|
+
if @hash[:apertures]
|
113
|
+
@hash[:apertures].each do |aperture|
|
114
|
+
ladybug_aperture = Aperture.new(aperture)
|
115
|
+
os_subsurface_apertures = ladybug_aperture.to_openstudio(openstudio_model)
|
116
|
+
os_subsurface_apertures.each do |os_subsurface_aperture|
|
117
|
+
if @hash[:face_type] == 'RoofCeiling' or @hash[:face_type] == 'Floor'
|
118
|
+
if @hash[:boundary_condition][:type] == 'Outdoors' && aperture[:is_operable] == false
|
119
|
+
os_subsurface_aperture.setSubSurfaceType('Skylight')
|
120
|
+
end
|
121
|
+
end
|
122
|
+
os_subsurface_aperture.setSurface(os_surface)
|
123
|
+
end
|
124
|
+
end
|
125
|
+
end
|
126
|
+
|
127
|
+
# assign doors if they exist
|
128
|
+
if @hash[:doors]
|
129
|
+
@hash[:doors].each do |door|
|
130
|
+
honeybee_door = Door.new(door)
|
131
|
+
os_subsurface_doors = honeybee_door.to_openstudio(openstudio_model)
|
132
|
+
os_subsurface_doors.each do |os_subsurface_door|
|
133
|
+
os_subsurface_door.setSurface(os_surface)
|
134
|
+
if door[:is_glass] == true
|
135
|
+
os_subsurface_door.setSubSurfaceType('GlassDoor')
|
136
|
+
elsif (@hash[:face_type] == 'RoofCeiling' or @hash[:face_type] == 'Floor') && @hash[:boundary_condition][:type] == 'Outdoors'
|
137
|
+
os_subsurface_door.setSubSurfaceType('OverheadDoor')
|
138
|
+
elsif door[:is_glass] == false or door[:is_glass].nil?
|
139
|
+
os_subsurface_door.setSubSurfaceType('Door')
|
140
|
+
end
|
141
|
+
end
|
142
|
+
end
|
143
|
+
end
|
144
|
+
|
145
|
+
os_surface.subSurfaces.each do |os_subsurface|
|
146
|
+
if os_subsurface.hasAdditionalProperties
|
147
|
+
adj_sub_srf_identifier = os_subsurface.additionalProperties.getFeatureAsString("AdjacentSubSurfaceName")
|
148
|
+
unless adj_sub_srf_identifier.empty?
|
149
|
+
adj_sub_srf = openstudio_model.getSubSurfaceByName(adj_sub_srf_identifier.get)
|
150
|
+
unless adj_sub_srf.empty?
|
151
|
+
os_subsurface.setAdjacentSubSurface(adj_sub_srf.get)
|
152
|
+
end
|
153
|
+
end
|
154
|
+
|
155
|
+
# clean up, we don't need this object any more
|
156
|
+
os_subsurface.removeAdditionalProperties
|
157
|
+
end
|
158
|
+
end
|
159
|
+
|
160
|
+
os_surface
|
161
|
+
end
|
162
|
+
end # Face
|
163
|
+
end # FromHoneybee
|