honeybee-openstudio 1.8.1

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 (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,150 @@
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 IdealAirSystemAbridged < ModelObject
37
+ attr_reader :errors, :warnings
38
+
39
+ def initialize(hash = {})
40
+ super(hash)
41
+ raise "Incorrect model type '#{@type}'" unless @type == 'IdealAirSystemAbridged'
42
+ end
43
+
44
+ def defaults
45
+ @@schema[:components][:schemas][:IdealAirSystemAbridged][:properties]
46
+ end
47
+
48
+ def to_openstudio(openstudio_model)
49
+ # create the ideal air system and set the identifier
50
+ os_ideal_air = OpenStudio::Model::ZoneHVACIdealLoadsAirSystem.new(openstudio_model)
51
+ os_ideal_air.setName(@hash[:identifier])
52
+
53
+ # assign the economizer type
54
+ if @hash[:economizer_type]
55
+ os_ideal_air.setOutdoorAirEconomizerType(@hash[:economizer_type])
56
+ else
57
+ os_ideal_air.setOutdoorAirEconomizerType(
58
+ defaults[:economizer_type][:default])
59
+ end
60
+
61
+ # set the sensible heat recovery
62
+ if @hash[:sensible_heat_recovery] != 0
63
+ os_ideal_air.setSensibleHeatRecoveryEffectiveness(@hash[:sensible_heat_recovery])
64
+ os_ideal_air.setHeatRecoveryType('Sensible')
65
+ else
66
+ os_ideal_air.setSensibleHeatRecoveryEffectiveness(
67
+ defaults[:sensible_heat_recovery][:default])
68
+ end
69
+
70
+ # set the latent heat recovery
71
+ if @hash[:latent_heat_recovery] != 0
72
+ os_ideal_air.setLatentHeatRecoveryEffectiveness(@hash[:latent_heat_recovery])
73
+ os_ideal_air.setHeatRecoveryType('Enthalpy')
74
+ else
75
+ os_ideal_air.setLatentHeatRecoveryEffectiveness(
76
+ defaults[:latent_heat_recovery][:default])
77
+ end
78
+
79
+ # assign the demand controlled ventilation
80
+ if @hash[:demand_controlled_ventilation]
81
+ os_ideal_air.setDemandControlledVentilationType('OccupancySchedule')
82
+ else
83
+ os_ideal_air.setDemandControlledVentilationType('None')
84
+ end
85
+
86
+ # set the maximum heating supply air temperature
87
+ if @hash[:heating_air_temperature]
88
+ os_ideal_air.setMaximumHeatingSupplyAirTemperature(@hash[:heating_air_temperature])
89
+ else
90
+ os_ideal_air.setMaximumHeatingSupplyAirTemperature(
91
+ defaults[:heating_air_temperature][:default])
92
+ end
93
+
94
+ # set the maximum cooling supply air temperature
95
+ if @hash[:cooling_air_temperature]
96
+ os_ideal_air.setMinimumCoolingSupplyAirTemperature(@hash[:cooling_air_temperature])
97
+ else
98
+ os_ideal_air.setMinimumCoolingSupplyAirTemperature(
99
+ defaults[:cooling_air_temperature][:default])
100
+ end
101
+
102
+ # assign limits to the system's heating capacity
103
+ if @hash[:heating_limit] == {'type': 'NoLimit'}
104
+ os_ideal_air.setHeatingLimit('NoLimit')
105
+ else
106
+ os_ideal_air.setHeatingLimit('LimitCapacity')
107
+ if @hash[:heating_limit].is_a? Numeric
108
+ os_ideal_air.setMaximumSensibleHeatingCapacity(@hash[:heating_limit])
109
+ else
110
+ os_ideal_air.autosizeMaximumSensibleHeatingCapacity()
111
+ end
112
+ end
113
+
114
+ # assign limits to the system's cooling capacity
115
+ if @hash[:cooling_limit] == {'type': 'NoLimit'}
116
+ os_ideal_air.setCoolingLimit('NoLimit')
117
+ else
118
+ os_ideal_air.setCoolingLimit('LimitFlowRateAndCapacity')
119
+ if @hash[:cooling_limit].is_a? Numeric
120
+ os_ideal_air.setMaximumTotalCoolingCapacity(@hash[:cooling_limit])
121
+ os_ideal_air.autosizeMaximumCoolingAirFlowRate()
122
+ else
123
+ os_ideal_air.autosizeMaximumTotalCoolingCapacity()
124
+ os_ideal_air.autosizeMaximumCoolingAirFlowRate()
125
+ end
126
+ end
127
+
128
+ # assign heating availability schedules
129
+ if @hash[:heating_availability]
130
+ schedule = openstudio_model.getScheduleByName(@hash[:heating_availability])
131
+ unless schedule.empty?
132
+ os_schedule = schedule.get
133
+ os_ideal_air.setHeatingAvailabilitySchedule(os_schedule)
134
+ end
135
+ end
136
+
137
+ # assign cooling availability schedules
138
+ if @hash[:cooling_availability]
139
+ schedule = openstudio_model.getScheduleByName(@hash[:cooling_availability])
140
+ unless schedule.empty?
141
+ os_schedule = schedule.get
142
+ os_ideal_air.setCoolingAvailabilitySchedule(os_schedule)
143
+ end
144
+ end
145
+
146
+ os_ideal_air
147
+ end
148
+
149
+ end #IdealAirSystemAbridged
150
+ 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 ElectricEquipmentAbridged < ModelObject
37
+ attr_reader :errors, :warnings
38
+
39
+ def initialize(hash = {})
40
+ super(hash)
41
+ raise "Incorrect model type '#{@type}'" unless @type == 'ElectricEquipmentAbridged'
42
+ end
43
+
44
+ def defaults
45
+ @@schema[:components][:schemas][:ElectricEquipmentAbridged][:properties]
46
+ end
47
+
48
+ def find_existing_openstudio_object(openstudio_model)
49
+ model_electric_equipment = openstudio_model.getElectricEquipmentDefinitionByName(@hash[:identifier])
50
+ return model_electric_equipment.get unless model_electric_equipment.empty?
51
+ nil
52
+ end
53
+
54
+ def to_openstudio(openstudio_model)
55
+ # create electrical equipment and set identifier
56
+ os_electric_equip_def = OpenStudio::Model::ElectricEquipmentDefinition.new(openstudio_model)
57
+ os_electric_equip = OpenStudio::Model::ElectricEquipment.new(os_electric_equip_def)
58
+ os_electric_equip_def.setName(@hash[:identifier])
59
+ os_electric_equip.setName(@hash[:identifier])
60
+
61
+ # assign watts per area
62
+ os_electric_equip_def.setWattsperSpaceFloorArea(@hash[:watts_per_area])
63
+
64
+ # assign schedule
65
+ electric_equipment_schedule = openstudio_model.getScheduleByName(@hash[:schedule])
66
+ unless electric_equipment_schedule.empty?
67
+ electric_equipment_schedule_object = electric_equipment_schedule.get
68
+ os_electric_equip.setSchedule(electric_equipment_schedule_object)
69
+ end
70
+
71
+ # assign radiant fraction if it exists
72
+ if @hash[:radiant_fraction]
73
+ os_electric_equip_def.setFractionRadiant(@hash[:radiant_fraction])
74
+ else
75
+ os_electric_equip_def.setFractionRadiant(defaults[:radiant_fraction][:default])
76
+ end
77
+
78
+ # assign latent fraction if it exists
79
+ if @hash[:latent_fraction]
80
+ os_electric_equip_def.setFractionLatent(@hash[:latent_fraction])
81
+ else
82
+ os_electric_equip_def.setFractionLatent(defaults[:latent_fraction][:default])
83
+ end
84
+
85
+ # assign lost fraction if it exists
86
+ if @hash[:lost_fraction]
87
+ os_electric_equip_def.setFractionLost(@hash[:lost_fraction])
88
+ else
89
+ os_electric_equip_def.setFractionLost(defaults[:lost_fraction][:default])
90
+ end
91
+
92
+ os_electric_equip
93
+ end
94
+
95
+ end #ElectricEquipmentAbridged
96
+ end #FromHoneybee
@@ -0,0 +1,97 @@
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 GasEquipmentAbridged < ModelObject
37
+ attr_reader :errors, :warnings
38
+
39
+ def initialize(hash = {})
40
+ super(hash)
41
+ raise "Incorrect model type '#{@type}'" unless @type == 'GasEquipmentAbridged'
42
+ end
43
+
44
+ def defaults
45
+ @@schema[:components][:schemas][:GasEquipmentAbridged][:properties]
46
+ end
47
+
48
+ def find_existing_openstudio_object(openstudio_model)
49
+ model_gas_equipment = openstudio_model.getGasEquipmentDefinitionByName(@hash[:identifier])
50
+ return model_gas_equipment.get unless model_gas_equipment.empty?
51
+ nil
52
+ end
53
+
54
+ def to_openstudio(openstudio_model)
55
+
56
+ # create gas equipment and set identifier
57
+ os_gas_equip_def = OpenStudio::Model::GasEquipmentDefinition.new(openstudio_model)
58
+ os_gas_equip = OpenStudio::Model::GasEquipment.new(os_gas_equip_def)
59
+ os_gas_equip_def.setName(@hash[:identifier])
60
+ os_gas_equip.setName(@hash[:identifier])
61
+
62
+ # assign watts per space floor area
63
+ os_gas_equip_def.setWattsperSpaceFloorArea(@hash[:watts_per_area])
64
+
65
+ # assign schedule
66
+ gas_equipment_schedule = openstudio_model.getScheduleByName(@hash[:schedule])
67
+ unless gas_equipment_schedule.empty?
68
+ gas_equipment_schedule_object = gas_equipment_schedule.get
69
+ os_gas_equip.setSchedule(gas_equipment_schedule_object)
70
+ end
71
+
72
+ # assign radiant fraction if it exists
73
+ if @hash[:radiant_fraction]
74
+ os_gas_equip_def.setFractionRadiant(@hash[:radiant_fraction])
75
+ else
76
+ os_gas_equip_def.setFractionRadiant(defaults[:radiant_fraction][:default])
77
+ end
78
+
79
+ # assign latent fraction if it exists
80
+ if @hash[:latent_fraction]
81
+ os_gas_equip_def.setFractionLatent(@hash[:latent_fraction])
82
+ else
83
+ os_gas_equip_def.setFractionLatent(defaults[:latent_fraction][:default])
84
+ end
85
+
86
+ # assign lost fraction if it exists
87
+ if @hash[:lost_fraction]
88
+ os_gas_equip_def.setFractionLost(@hash[:lost_fraction])
89
+ else
90
+ os_gas_equip_def.setFractionLost(defaults[:lost_fraction][:default])
91
+ end
92
+
93
+ os_gas_equip
94
+ end
95
+
96
+ end #GasEquipmentAbridged
97
+ end #FromHoneybee
@@ -0,0 +1,95 @@
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 InfiltrationAbridged < ModelObject
37
+ attr_reader :errors, :warnings
38
+
39
+ def initialize(hash = {})
40
+ super(hash)
41
+ raise "Incorrect model type '#{@type}'" unless @type == 'InfiltrationAbridged'
42
+ end
43
+
44
+ def defaults
45
+ @@schema[:components][:schemas][:InfiltrationAbridged][:properties]
46
+ end
47
+
48
+ def find_existing_openstudio_object(openstudio_model)
49
+ model_infiltration = openstudio_model.getSpaceInfiltrationDesignFlowRateByName(@hash[:identifier])
50
+ return model_infiltration.get unless model_infiltration.empty?
51
+ nil
52
+ end
53
+
54
+ def to_openstudio(openstudio_model)
55
+
56
+ # create infiltration OpenStudio object and set identifier
57
+ os_infilt = OpenStudio::Model::SpaceInfiltrationDesignFlowRate.new(openstudio_model)
58
+ os_infilt.setName(@hash[:identifier])
59
+
60
+ # assign flow per surface
61
+ os_infilt.setFlowperExteriorSurfaceArea(@hash[:flow_per_exterior_area])
62
+
63
+ # assign schedule
64
+ infiltration_schedule = openstudio_model.getScheduleByName(@hash[:schedule])
65
+ unless infiltration_schedule.empty?
66
+ infiltration_schedule_object = infiltration_schedule.get
67
+ os_infilt.setSchedule(infiltration_schedule_object)
68
+ end
69
+
70
+ # assign constant coefficient if it exists
71
+ if @hash[:constant_coefficient]
72
+ os_infilt.setConstantTermCoefficient(@hash[:constant_coefficient])
73
+ else
74
+ os_infilt.setConstantTermCoefficient(defaults[:constant_coefficient][:default])
75
+ end
76
+
77
+ # assign temperature coefficient
78
+ if @hash[:temperature_coefficient]
79
+ os_infilt.setTemperatureTermCoefficient(@hash[:temperature_coefficient])
80
+ else
81
+ os_infilt.setTemperatureTermCoefficient(defaults[:temperature_coefficient][:default])
82
+ end
83
+
84
+ # assign velocity coefficient
85
+ if @hash[:velocity_coefficient]
86
+ os_infilt.setVelocityTermCoefficient(@hash[:velocity_coefficient])
87
+ else
88
+ os_infilt.setVelocityTermCoefficient(defaults[:velocity_coefficient][:default])
89
+ end
90
+
91
+ os_infilt
92
+ end
93
+
94
+ end #InfiltrationAbridged
95
+ end #Ladybug
@@ -0,0 +1,98 @@
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 LightingAbridged < ModelObject
37
+ attr_reader :errors, :warnings
38
+
39
+ def initialize(hash = {})
40
+ super(hash)
41
+ raise "Incorrect model type '#{@type}'" unless @type == 'LightingAbridged'
42
+ end
43
+
44
+ def defaults
45
+ @@schema[:components][:schemas][:LightingAbridged][:properties]
46
+ end
47
+
48
+ def find_existing_openstudio_object(openstudio_model)
49
+ model_lights = openstudio_model.getLightsDefinitionByName(@hash[:identifier])
50
+ return model_lights.get unless model_lights.empty?
51
+ nil
52
+ end
53
+
54
+ def to_openstudio(openstudio_model)
55
+
56
+ # create lights OpenStudio object and set identifier
57
+ os_lights_def = OpenStudio::Model::LightsDefinition.new(openstudio_model)
58
+ os_lights = OpenStudio::Model::Lights.new(os_lights_def)
59
+ os_lights_def.setName(@hash[:identifier])
60
+ os_lights.setName(@hash[:identifier])
61
+
62
+ # assign watts per space floor area
63
+ os_lights_def.setWattsperSpaceFloorArea(@hash[:watts_per_area])
64
+
65
+ # assign lighting schedule
66
+ lighting_schedule = openstudio_model.getScheduleByName(@hash[:schedule])
67
+ unless lighting_schedule.empty?
68
+ lighting_schedule_object = lighting_schedule.get
69
+ os_lights.setSchedule(lighting_schedule_object)
70
+ end
71
+
72
+ # assign visible fraction if it exists
73
+ if @hash[:visible_fraction]
74
+ os_lights_def.setFractionVisible(@hash[:visible_fraction])
75
+ else
76
+ os_lights_def.setFractionVisible(defaults[:visible_fraction][:default])
77
+ end
78
+
79
+ # assign radiant fraction if it exists
80
+ if @hash[:radiant_fraction]
81
+ os_lights_def.setFractionRadiant(@hash[:radiant_fraction])
82
+ else
83
+ os_lights_def.setFractionRadiant(defaults[:radiant_fraction][:default])
84
+ end
85
+
86
+ # assign return air fraction if it exists
87
+ if @hash[:return_air_fraction]
88
+ os_lights_def.setReturnAirFraction(@hash[:return_air_fraction])
89
+ else
90
+ os_lights_def.setReturnAirFraction(defaults[:return_air_fraction][:default])
91
+ end
92
+
93
+ os_lights
94
+ end
95
+
96
+ end #LightingAbridged
97
+ end #FromHoneybee
98
+