honeybee-openstudio 1.8.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (71) hide show
  1. checksums.yaml +7 -0
  2. data/.coveralls.yml +1 -0
  3. data/.gitignore +32 -0
  4. data/.releaserc.json +7 -0
  5. data/.travis.yml +41 -0
  6. data/Gemfile +18 -0
  7. data/LICENSE.md +23 -0
  8. data/README.md +95 -0
  9. data/Rakefile +21 -0
  10. data/doc_templates/LICENSE.md +23 -0
  11. data/doc_templates/copyright_erb.txt +32 -0
  12. data/doc_templates/copyright_js.txt +5 -0
  13. data/doc_templates/copyright_ruby.txt +30 -0
  14. data/honeybee-openstudio.gemspec +35 -0
  15. data/lib/files/Honeybee.rb +113 -0
  16. data/lib/files/honeybee_workflow.osw +48 -0
  17. data/lib/files/urbanopt_Gemfile +32 -0
  18. data/lib/from_honeybee.rb +86 -0
  19. data/lib/from_honeybee/_openapi/model.json +8127 -0
  20. data/lib/from_honeybee/_openapi/simulation-parameter.json +843 -0
  21. data/lib/from_honeybee/construction/air.rb +65 -0
  22. data/lib/from_honeybee/construction/opaque.rb +77 -0
  23. data/lib/from_honeybee/construction/shade.rb +108 -0
  24. data/lib/from_honeybee/construction/window.rb +80 -0
  25. data/lib/from_honeybee/construction_set.rb +278 -0
  26. data/lib/from_honeybee/extension.rb +109 -0
  27. data/lib/from_honeybee/geometry/aperture.rb +167 -0
  28. data/lib/from_honeybee/geometry/door.rb +160 -0
  29. data/lib/from_honeybee/geometry/face.rb +163 -0
  30. data/lib/from_honeybee/geometry/room.rb +392 -0
  31. data/lib/from_honeybee/geometry/shade.rb +89 -0
  32. data/lib/from_honeybee/hvac/ideal_air.rb +150 -0
  33. data/lib/from_honeybee/load/electric_equipment.rb +96 -0
  34. data/lib/from_honeybee/load/gas_equipment.rb +97 -0
  35. data/lib/from_honeybee/load/infiltration.rb +95 -0
  36. data/lib/from_honeybee/load/lighting.rb +98 -0
  37. data/lib/from_honeybee/load/people.rb +100 -0
  38. data/lib/from_honeybee/load/setpoint_humidistat.rb +75 -0
  39. data/lib/from_honeybee/load/setpoint_thermostat.rb +71 -0
  40. data/lib/from_honeybee/load/ventilation.rb +96 -0
  41. data/lib/from_honeybee/material/opaque.rb +94 -0
  42. data/lib/from_honeybee/material/opaque_no_mass.rb +94 -0
  43. data/lib/from_honeybee/material/window_blind.rb +238 -0
  44. data/lib/from_honeybee/material/window_gas.rb +76 -0
  45. data/lib/from_honeybee/material/window_gas_custom.rb +118 -0
  46. data/lib/from_honeybee/material/window_gas_mixture.rb +79 -0
  47. data/lib/from_honeybee/material/window_glazing.rb +166 -0
  48. data/lib/from_honeybee/material/window_shade.rb +160 -0
  49. data/lib/from_honeybee/material/window_simpleglazsys.rb +73 -0
  50. data/lib/from_honeybee/model.rb +434 -0
  51. data/lib/from_honeybee/model_object.rb +110 -0
  52. data/lib/from_honeybee/program_type.rb +124 -0
  53. data/lib/from_honeybee/schedule/fixed_interval.rb +115 -0
  54. data/lib/from_honeybee/schedule/ruleset.rb +164 -0
  55. data/lib/from_honeybee/schedule/type_limit.rb +88 -0
  56. data/lib/from_honeybee/simulation/designday.rb +105 -0
  57. data/lib/from_honeybee/simulation/extension.rb +46 -0
  58. data/lib/from_honeybee/simulation/parameter.rb +277 -0
  59. data/lib/from_honeybee/version.rb +34 -0
  60. data/lib/measures/.gitkeep +0 -0
  61. data/lib/measures/from_honeybee_model/LICENSE.md +27 -0
  62. data/lib/measures/from_honeybee_model/README.md +32 -0
  63. data/lib/measures/from_honeybee_model/measure.rb +91 -0
  64. data/lib/measures/from_honeybee_model/measure.xml +103 -0
  65. data/lib/measures/from_honeybee_model/tests/from_honeybee_model_test.rb +126 -0
  66. data/lib/measures/from_honeybee_simulation_parameter/LICENSE.md +27 -0
  67. data/lib/measures/from_honeybee_simulation_parameter/README.md +32 -0
  68. data/lib/measures/from_honeybee_simulation_parameter/measure.rb +95 -0
  69. data/lib/measures/from_honeybee_simulation_parameter/measure.xml +91 -0
  70. data/lib/measures/from_honeybee_simulation_parameter/tests/from_honeybee_simulation_parameter_test.rb +109 -0
  71. metadata +243 -0
@@ -0,0 +1,100 @@
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/extension'
33
+ require 'from_honeybee/model_object'
34
+
35
+ module FromHoneybee
36
+ class PeopleAbridged < ModelObject
37
+ attr_reader :errors, :warnings
38
+
39
+ def initialize(hash = {})
40
+ super(hash)
41
+ raise "Incorrect model type '#{@type}'" unless @type == 'PeopleAbridged'
42
+ end
43
+
44
+ def defaults
45
+ @@schema[:components][:schemas][:PeopleAbridged][:properties]
46
+ end
47
+
48
+ def find_existing_openstudio_object(openstudio_model)
49
+ model_people = openstudio_model.getPeopleDefinitionByName(@hash[:identifier])
50
+ return model_people.get unless model_people.empty?
51
+ nil
52
+ end
53
+
54
+ def to_openstudio(openstudio_model)
55
+
56
+ # create people OpenStudio object and set identifier
57
+ os_people_def = OpenStudio::Model::PeopleDefinition.new(openstudio_model)
58
+ os_people = OpenStudio::Model::People.new(os_people_def)
59
+ os_people_def.setName(@hash[:identifier])
60
+ os_people.setName(@hash[:identifier])
61
+
62
+ # assign people per space floor area
63
+ os_people_def.setPeopleperSpaceFloorArea(@hash[:people_per_area])
64
+
65
+ # assign activity schedule
66
+ activity_sch = openstudio_model.getScheduleByName(@hash[:activity_schedule])
67
+ unless activity_sch.empty?
68
+ activity_sch_object = activity_sch.get
69
+ os_people.setActivityLevelSchedule(activity_sch_object)
70
+ end
71
+
72
+ # assign occupancy schedule
73
+ occupancy_sch = openstudio_model.getScheduleByName(@hash[:occupancy_schedule])
74
+ unless occupancy_sch.empty?
75
+ occupancy_sch_object = occupancy_sch.get
76
+ os_people.setNumberofPeopleSchedule(occupancy_sch_object)
77
+ end
78
+
79
+ # assign radiant fraction if it exists
80
+ if @hash[:radiant_fraction]
81
+ os_people_def.setFractionRadiant(@hash[:radiant_fraction])
82
+ else
83
+ os_people_def.setFractionRadiant(defaults[:radiant_fraction][:default])
84
+ end
85
+
86
+ # assign latent fraction if it exists
87
+ if @hash[:latent_fraction]
88
+ if @hash[:latent_fraction].is_a? Numeric
89
+ sensible_fraction = 1 - (@hash[:latent_fraction])
90
+ os_people_def.setSensibleHeatFraction(sensible_fraction)
91
+ else
92
+ os_people_def.autocalculateSensibleHeatFraction()
93
+ end
94
+ end
95
+
96
+ os_people
97
+ end
98
+
99
+ end #PeopleAbridged
100
+ end #FromHoneybee
@@ -0,0 +1,75 @@
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/extension'
33
+ require 'from_honeybee/model_object'
34
+
35
+ module FromHoneybee
36
+ class SetpointHumidistat < ModelObject
37
+ attr_reader :errors, :warnings
38
+
39
+ def initialize(hash = {})
40
+ super(hash)
41
+ raise "Incorrect model type '#{@type}'" unless @type == 'SetpointAbridged'
42
+ end
43
+
44
+ def defaults
45
+ @@schema[:components][:schemas][:SetpointAbridged][:properties]
46
+ end
47
+
48
+ def to_openstudio(openstudio_model)
49
+
50
+ # create humidistat openstudio object
51
+ os_humidistat = OpenStudio::Model::ZoneControlHumidistat.new(openstudio_model)
52
+
53
+ # assign humidifying schedule if it exists
54
+ if @hash[:humidifying_schedule]
55
+ humid_sch = openstudio_model.getScheduleByName(@hash[:humidifying_schedule])
56
+ unless humid_sch.empty?
57
+ humid_sch_object = humid_sch.get
58
+ os_humidistat.setHumidifyingRelativeHumiditySetpointSchedule(humid_sch_object)
59
+ end
60
+ end
61
+
62
+ # assign dehumidifying schedule if it exists
63
+ if @hash[:dehumidifying_schedule]
64
+ dehumid_sch = openstudio_model.getScheduleByName(@hash[:dehumidifying_schedule])
65
+ unless dehumid_sch.empty?
66
+ dehumid_sch_object = dehumid_sch.get
67
+ os_humidistat.setDehumidifyingRelativeHumiditySetpointSchedule(dehumid_sch_object)
68
+ end
69
+ end
70
+
71
+ os_humidistat
72
+ end
73
+
74
+ end #SetpointHumidistat
75
+ end #FromHoneybee
@@ -0,0 +1,71 @@
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/extension'
33
+ require 'from_honeybee/model_object'
34
+
35
+ module FromHoneybee
36
+ class SetpointThermostat < ModelObject
37
+ attr_reader :errors, :warnings
38
+
39
+ def initialize(hash = {})
40
+ super(hash)
41
+ raise "Incorrect model type '#{@type}'" unless @type == 'SetpointAbridged'
42
+ end
43
+
44
+ def defaults
45
+ @@schema[:components][:schemas][:SetpointAbridged][:properties]
46
+ end
47
+
48
+ def to_openstudio(openstudio_model)
49
+
50
+ # create thermostat openstudio object
51
+ os_thermostat = OpenStudio::Model::ThermostatSetpointDualSetpoint.new(openstudio_model)
52
+
53
+ # assign heating setpoint temperature schedule
54
+ heat_sch = openstudio_model.getScheduleByName(@hash[:heating_schedule])
55
+ unless heat_sch.empty?
56
+ heat_sch_object = heat_sch.get
57
+ os_thermostat.setHeatingSetpointTemperatureSchedule(heat_sch_object)
58
+ end
59
+
60
+ # assign cooling setpoint schedule
61
+ cool_sch = openstudio_model.getScheduleByName(@hash[:cooling_schedule])
62
+ unless cool_sch.empty?
63
+ cool_sch_object = cool_sch.get
64
+ os_thermostat.setCoolingSetpointTemperatureSchedule(cool_sch_object)
65
+ end
66
+
67
+ os_thermostat
68
+ end
69
+
70
+ end #SetpointThermostat
71
+ end #FromHoneybee
@@ -0,0 +1,96 @@
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/extension'
33
+ require 'from_honeybee/model_object'
34
+
35
+ module FromHoneybee
36
+ class VentilationAbridged < ModelObject
37
+ attr_reader :errors, :warnings
38
+
39
+ def initialize(hash = {})
40
+ super(hash)
41
+ raise "Incorrect model type '#{@type}'" unless @type == 'VentilationAbridged'
42
+ end
43
+
44
+ def defaults
45
+ @@schema[:components][:schemas][:VentilationAbridged][:properties]
46
+ end
47
+
48
+ def find_existing_openstudio_object(openstudio_model)
49
+ model_vent = openstudio_model.getDesignSpecificationOutdoorAirByName(@hash[:identifier])
50
+ return model_vent.get unless model_vent.empty?
51
+ nil
52
+ end
53
+
54
+ def to_openstudio(openstudio_model)
55
+ # create ventilation openstudio object and set identifier
56
+ os_vent = OpenStudio::Model::DesignSpecificationOutdoorAir.new(openstudio_model)
57
+ os_vent.setName(@hash[:identifier])
58
+
59
+ # assign air changes per hour if it exists
60
+ if @hash[:air_changes_per_hour]
61
+ os_vent.setOutdoorAirFlowAirChangesperHour(@hash[:air_changes_per_hour])
62
+ else
63
+ os_vent.setOutdoorAirFlowAirChangesperHour(defaults[:air_changes_per_hour][:default])
64
+ end
65
+
66
+ # assign flow per zone if it exists
67
+ if @hash[:flow_per_zone]
68
+ os_vent.setOutdoorAirFlowRate(@hash[:flow_per_zone])
69
+ else
70
+ os_vent.setOutdoorAirFlowRate(defaults[:flow_per_zone][:default])
71
+ end
72
+
73
+ # assign flow per person if it exists
74
+ if @hash[:flow_per_person]
75
+ os_vent.setOutdoorAirFlowperPerson(@hash[:flow_per_person])
76
+ end
77
+
78
+ # assign flow per area if it exists
79
+ if @hash[:flow_per_area]
80
+ os_vent.setOutdoorAirFlowperFloorArea(@hash[:flow_per_area])
81
+ end
82
+
83
+ # assign schedule if it exists
84
+ if @hash[:schedule]
85
+ vent_sch = openstudio_model.getScheduleByName(@hash[:schedule])
86
+ unless vent_sch.empty?
87
+ vent_sch_object = vent_sch.get
88
+ os_vent.setOutdoorAirFlowRateFractionSchedule(vent_sch_object)
89
+ end
90
+ end
91
+
92
+ os_vent
93
+ end
94
+
95
+ end #VentilationAbridged
96
+ end #FromHoneybee
@@ -0,0 +1,94 @@
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 EnergyMaterial < ModelObject
38
+ attr_reader :errors, :warnings
39
+
40
+ def initialize(hash = {})
41
+ super(hash)
42
+ end
43
+
44
+ def defaults
45
+ @@schema[:components][:schemas][:EnergyMaterial][:properties]
46
+ end
47
+
48
+ def find_existing_openstudio_object(openstudio_model)
49
+ object = openstudio_model.getStandardOpaqueMaterialByName(@hash[:identifier])
50
+ return object.get if object.is_initialized
51
+ nil
52
+ end
53
+
54
+ def to_openstudio(openstudio_model)
55
+ # create standard opaque OpenStudio material
56
+ os_opaque_mat = OpenStudio::Model::StandardOpaqueMaterial.new(openstudio_model)
57
+ os_opaque_mat.setName(@hash[:identifier])
58
+ os_opaque_mat.setThickness(@hash[:thickness])
59
+ os_opaque_mat.setConductivity(@hash[:conductivity])
60
+ os_opaque_mat.setDensity(@hash[:density])
61
+ os_opaque_mat.setSpecificHeat(@hash[:specific_heat])
62
+
63
+ # assign roughness if it exists
64
+ if @hash[:roughness]
65
+ os_opaque_mat.setRoughness(@hash[:roughness])
66
+ else
67
+ os_opaque_mat.setRoughness(defaults[:roughness][:default])
68
+ end
69
+
70
+ # assign thermal absorptance if it exists
71
+ if @hash[:thermal_absorptance]
72
+ os_opaque_mat.setThermalAbsorptance(@hash[:thermal_absorptance])
73
+ else
74
+ os_opaque_mat.setThermalAbsorptance(defaults[:thermal_absorptance][:default])
75
+ end
76
+
77
+ # assign solar absorptance if it exists
78
+ if @hash[:solar_absorptance]
79
+ os_opaque_mat.setSolarAbsorptance(@hash[:solar_absorptance])
80
+ else
81
+ os_opaque_mat.setSolarAbsorptance(defaults[:solar_absorptance][:default])
82
+ end
83
+
84
+ # assign visible absorptance if it exists
85
+ if @hash[:visible_absorptance]
86
+ os_opaque_mat.setVisibleAbsorptance(@hash[:visible_absorptance])
87
+ else
88
+ os_opaque_mat.setVisibleAbsorptance(defaults[:visible_absorptance][:default])
89
+ end
90
+
91
+ os_opaque_mat
92
+ end
93
+ end # EnergyEnergyMaterial
94
+ end # FromHoneybee
@@ -0,0 +1,94 @@
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 EnergyMaterialNoMass < ModelObject
38
+ attr_reader :errors, :warnings
39
+
40
+ def initialize(hash = {})
41
+ super(hash)
42
+ end
43
+
44
+ def defaults
45
+ @@schema[:components][:schemas][:EnergyMaterialNoMass][:properties]
46
+ end
47
+
48
+ def find_existing_openstudio_object(openstudio_model)
49
+ object = openstudio_model.getMasslessOpaqueMaterialByName(@hash[:identifier])
50
+ return object.get if object.is_initialized
51
+ nil
52
+ end
53
+
54
+ def to_openstudio(openstudio_model)
55
+
56
+ # create no mass material OpenStudio object and set identifier
57
+ os_nomass_mat = OpenStudio::Model::MasslessOpaqueMaterial.new(openstudio_model)
58
+ os_nomass_mat.setName(@hash[:identifier])
59
+
60
+ # assign thermal resistance
61
+ os_nomass_mat.setThermalResistance(@hash[:r_value])
62
+
63
+ # assign roughness if it exists
64
+ if @hash[:roughness]
65
+ os_nomass_mat.setRoughness(@hash[:roughness])
66
+ else
67
+ os_nomass_mat.setRoughness(defaults[:roughness][:default])
68
+ end
69
+
70
+ # assign thermal absorptance if it exists
71
+ if @hash[:thermal_absorptance]
72
+ os_nomass_mat.setThermalAbsorptance(@hash[:thermal_absorptance])
73
+ else
74
+ os_nomass_mat.setThermalAbsorptance(defaults[:thermal_absorptance][:default])
75
+ end
76
+
77
+ # assign solar absorptance if it exists
78
+ if @hash[:solar_absorptance]
79
+ os_nomass_mat.setSolarAbsorptance(@hash[:solar_absorptance])
80
+ else
81
+ os_nomass_mat.setSolarAbsorptance(defaults[:solar_absorptance][:default])
82
+ end
83
+
84
+ # assign visible absorptance if it exists
85
+ if @hash[:visible_absorptance]
86
+ os_nomass_mat.setVisibleAbsorptance(@hash[:visible_absorptance])
87
+ else
88
+ os_nomass_mat.setVisibleAbsorptance(defaults[:visible_absorptance][:default])
89
+ end
90
+
91
+ os_nomass_mat
92
+ end
93
+ end # EnergyMaterialNoMass
94
+ end # FromHoneybee