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,71 +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
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
@@ -1,96 +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
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
96
  end #FromHoneybee
@@ -1,94 +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
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