openstudio-calibration 0.1.2

data/lib/measures/ConstructionLayerZeroMaterialProperties/README.md

@@ -0,0 +1,88 @@
+
+
+###### (Automatically generated documentation)
+
+# Change Parameters Of Material (Layer 0 of Construction)
+
+## Description
+This measure changes properties of Layer 0 for a specific construction.
+
+## Modeler Description
+This measure changes the Layer 0 properties of Thickness, Density, Thermal Absorptance, Solar Absorptance, Visible Absoptance, Thermal Conductivity, Specific Heat.
+
+## Measure Type
+ModelMeasure
+
+## Taxonomy
+
+
+## Arguments
+
+
+### Choose a Construction to Alter.
+
+**Name:** construction,
+**Type:** Choice,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+
+### Thickness of Layer 0
+Set Thickness of Layer 0. 0 value means do not change from default.
+**Name:** thickness,
+**Type:** Double,
+**Units:** m,
+**Required:** true,
+**Model Dependent:** false
+
+### Density of Layer 0
+Set Density of Layer 0. 0 value means do not change from default.
+**Name:** density,
+**Type:** Double,
+**Units:** kg/m^3,
+**Required:** true,
+**Model Dependent:** false
+
+### Thermal Absorptance of Layer 0
+Set Thermal Absorptance of Layer 0. 0 value means do not change from default.
+**Name:** thermal_absorptance,
+**Type:** Double,
+**Units:** fraction,
+**Required:** true,
+**Model Dependent:** false
+
+### Solar Absorptance of Layer 0
+Set Solar Absorptance of Layer 0. 0 value means do not change from default.
+**Name:** solar_absorptance,
+**Type:** Double,
+**Units:** fraction,
+**Required:** true,
+**Model Dependent:** false
+
+### Visible Absorptance of Layer 0
+Set Visible Absorptance of Layer 0. 0 value means do not change from default.
+**Name:** visible_absorptance,
+**Type:** Double,
+**Units:** fraction,
+**Required:** true,
+**Model Dependent:** false
+
+### Thermal Conductivity of Layer 0
+Set Thermal Conductivity of Layer 0. 0 value means do not change from default.
+**Name:** thermal_conductivity,
+**Type:** Double,
+**Units:** W/(m*K),
+**Required:** true,
+**Model Dependent:** false
+
+### Specific Heat of Layer 0
+Set Specific Heat of Layer 0. 0 value means do not change from default.
+**Name:** specific_heat,
+**Type:** Double,
+**Units:** J/(kg*K),
+**Required:** true,
+**Model Dependent:** false
+
+
+
+

data/lib/measures/ConstructionLayerZeroMaterialProperties/README.md.erb

@@ -0,0 +1,42 @@
+<%#= README.md.erb is used to auto-generate README.md. %>
+<%#= To manually maintain README.md throw away README.md.erb and manually edit README.md %>
+###### (Automatically generated documentation)
+
+# <%= name %>
+
+## Description
+<%= description %>
+
+## Modeler Description
+<%= modelerDescription %>
+
+## Measure Type
+<%= measureType %>
+
+## Taxonomy
+<%= taxonomy %>
+
+## Arguments
+
+<% arguments.each do |argument| %>
+### <%= argument[:display_name] %>
+<%= argument[:description] %>
+**Name:** <%= argument[:name] %>,
+**Type:** <%= argument[:type] %>,
+**Units:** <%= argument[:units] %>,
+**Required:** <%= argument[:required] %>,
+**Model Dependent:** <%= argument[:model_dependent] %>
+<% end %>
+
+<% if arguments.size == 0 %>
+<%= "This measure does not have any user arguments" %>
+<% end %>
+
+<% if outputs.size > 0 %>
+## Outputs
+<% output_names = [] %>
+<% outputs.each do |output| %>
+<% output_names << output[:display_name] %>
+<% end %>
+<%= output_names.join(", ") %>
+<% end %>

data/lib/measures/ConstructionLayerZeroMaterialProperties/measure.rb

@@ -0,0 +1,221 @@
+# *******************************************************************************
+# OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
+# All rights reserved.
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# (1) Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+#
+# (2) Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation
+# and/or other materials provided with the distribution.
+#
+# (3) Neither the name of the copyright holder nor the names of any contributors
+# may be used to endorse or promote products derived from this software without
+# specific prior written permission from the respective party.
+#
+# (4) Other than as required in clauses (1) and (2), distributions in any form
+# of modifications or other derivative works may not use the "OpenStudio"
+# trademark, "OS", "os", or any other confusingly similar designation without
+# specific prior written permission from Alliance for Sustainable Energy, LLC.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) AND ANY CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S), ANY CONTRIBUTORS, THE
+# UNITED STATES GOVERNMENT, OR THE UNITED STATES DEPARTMENT OF ENERGY, NOR ANY OF
+# THEIR EMPLOYEES, BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
+# OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+# STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+# *******************************************************************************
+
+# start the measure
+class ConstructionLayerZeroMaterialProperties < OpenStudio::Measure::ModelMeasure
+  # define the name that a user will see
+  def name
+    'Change Parameters Of Material (Layer 0 of Construction)'
+  end
+
+  # human readable description
+  def description
+    'This measure changes properties of Layer 0 for a specific construction.'
+  end
+
+  # human readable description of modeling approach
+  def modeler_description
+    'This measure changes the Layer 0 properties of Thickness, Density, Thermal Absorptance, Solar Absorptance, Visible Absoptance, Thermal Conductivity, Specific Heat.'
+  end
+
+  # define the arguments that the user will input
+  def arguments(model)
+    args = OpenStudio::Measure::OSArgumentVector.new
+
+    # populate choice argument for constructions that are applied to surfaces in the model
+    construction_handles = OpenStudio::StringVector.new
+    construction_display_names = OpenStudio::StringVector.new
+
+    # putting space types and names into hash
+    construction_args = model.getConstructions
+    construction_args_hash = {}
+    construction_args.each do |construction_arg|
+      construction_args_hash[construction_arg.name.to_s] = construction_arg
+    end
+
+    # looping through sorted hash of constructions
+    construction_args_hash.sort.map do |key, value|
+      # only include if construction is used on surface
+      if value.getNetArea > 0
+        construction_handles << value.handle.to_s
+        construction_display_names << key
+      end
+    end
+
+    # make an argument for construction
+    construction = OpenStudio::Measure::OSArgument.makeChoiceArgument('construction', construction_handles, construction_display_names, true)
+    construction.setDisplayName('Choose a Construction to Alter.')
+    args << construction
+
+    # make an argument thickness
+    thickness = OpenStudio::Measure::OSArgument.makeDoubleArgument('thickness', true)
+    thickness.setDisplayName('Thickness of Layer 0')
+    thickness.setDescription('Set Thickness of Layer 0. 0 value means do not change from default.')
+    thickness.setDefaultValue(0)
+    thickness.setUnits('m')
+    args << thickness
+
+    # make an argument density
+    density = OpenStudio::Measure::OSArgument.makeDoubleArgument('density', true)
+    density.setDisplayName('Density of Layer 0')
+    density.setDescription('Set Density of Layer 0. 0 value means do not change from default.')
+    density.setUnits('kg/m^3')
+    density.setDefaultValue(0)
+    args << density
+
+    # make an argument thermal_absorptance
+    thermal_absorptance = OpenStudio::Measure::OSArgument.makeDoubleArgument('thermal_absorptance', true)
+    thermal_absorptance.setDisplayName('Thermal Absorptance of Layer 0')
+    thermal_absorptance.setDescription('Set Thermal Absorptance of Layer 0. 0 value means do not change from default.')
+    thermal_absorptance.setUnits('fraction')
+    thermal_absorptance.setDefaultValue(0)
+    args << thermal_absorptance
+
+    # make an argument solar_absorptance
+    solar_absorptance = OpenStudio::Measure::OSArgument.makeDoubleArgument('solar_absorptance', true)
+    solar_absorptance.setDisplayName('Solar Absorptance of Layer 0')
+    solar_absorptance.setDescription('Set Solar Absorptance of Layer 0. 0 value means do not change from default.')
+    solar_absorptance.setUnits('fraction')
+    solar_absorptance.setDefaultValue(0)
+    args << solar_absorptance
+
+    # make an argument visible_absorptance
+    visible_absorptance = OpenStudio::Measure::OSArgument.makeDoubleArgument('visible_absorptance', true)
+    visible_absorptance.setDisplayName('Visible Absorptance of Layer 0')
+    visible_absorptance.setDescription('Set Visible Absorptance of Layer 0. 0 value means do not change from default.')
+    visible_absorptance.setUnits('fraction')
+    visible_absorptance.setDefaultValue(0)
+    args << visible_absorptance
+
+    # make an argument conductivity
+    thermal_conductivity = OpenStudio::Measure::OSArgument.makeDoubleArgument('thermal_conductivity', true)
+    thermal_conductivity.setDisplayName('Thermal Conductivity of Layer 0')
+    thermal_conductivity.setDescription('Set Thermal Conductivity of Layer 0. 0 value means do not change from default.')
+    thermal_conductivity.setDefaultValue(0)
+    thermal_conductivity.setUnits('W/(m*K)')
+    args << thermal_conductivity
+
+    # make an argument specific_heat
+    specific_heat = OpenStudio::Measure::OSArgument.makeDoubleArgument('specific_heat', true)
+    specific_heat.setDisplayName('Specific Heat of Layer 0')
+    specific_heat.setDescription('Set Specific Heat of Layer 0. 0 value means do not change from default.')
+    specific_heat.setUnits('J/(kg*K)')
+    specific_heat.setDefaultValue(0)
+    args << specific_heat
+
+    args
+  end # end the arguments method
+
+  # define what happens when the measure is run
+  def run(model, runner, user_arguments)
+    super(model, runner, user_arguments)
+
+    # use the built-in error checking
+    unless runner.validateUserArguments(arguments(model), user_arguments)
+      return false
+    end
+
+    # assign the user inputs to variables
+    construction = runner.getOptionalWorkspaceObjectChoiceValue('construction', user_arguments, model) # model is passed in because of argument type
+    thermal_absorptance = runner.getDoubleArgumentValue('thermal_absorptance', user_arguments)
+    solar_absorptance = runner.getDoubleArgumentValue('solar_absorptance', user_arguments)
+    visible_absorptance = runner.getDoubleArgumentValue('visible_absorptance', user_arguments)
+    thermal_conductivity = runner.getDoubleArgumentValue('thermal_conductivity', user_arguments)
+    specific_heat = runner.getDoubleArgumentValue('specific_heat', user_arguments)
+    thickness = runner.getDoubleArgumentValue('thickness', user_arguments)
+    density = runner.getDoubleArgumentValue('density', user_arguments)
+
+    # check the construction for reasonableness
+    if construction.empty?
+      handle = runner.getStringArgumentValue('construction', user_arguments)
+      if handle.empty?
+        runner.registerError('No construction was chosen.')
+      else
+        runner.registerError("The selected construction with handle '#{handle}' was not found in the model. It may have been removed by another measure.")
+      end
+      return false
+    else
+      if !construction.get.to_Construction.empty?
+        construction = construction.get.to_Construction.get
+      else
+        runner.registerError('Script Error - argument not showing up as construction.')
+        return false
+      end
+    end # end of if construction.empty?
+
+    initial_r_value_ip = OpenStudio.convert(1.0 / construction.thermalConductance.to_f, 'm^2*K/W', 'ft^2*h*R/Btu')
+    runner.registerInitialCondition("The Initial R-value of #{construction.name} is #{initial_r_value_ip} (ft^2*h*R/Btu).")
+    runner.registerValue('initial_r_value_ip', initial_r_value_ip.to_f, 'ft^2*h*R/Btu')
+    # get layers
+    layers = construction.layers
+
+    # steel layer is always first layer
+    layer = layers[0].to_StandardOpaqueMaterial.get
+    runner.registerInfo("Initial thermal_absorptance: #{layer.thermalAbsorptance}")
+    runner.registerInfo("Initial solar_absorptance: #{layer.solarAbsorptance}")
+    runner.registerInfo("Initial visible_absorptance: #{layer.visibleAbsorptance}")
+    runner.registerInfo("Initial thermal_conductivity: #{layer.thermalConductivity}")
+    runner.registerInfo("Initial specific_heat: #{layer.specificHeat}")
+    runner.registerInfo("Initial thickness: #{layer.thickness}")
+    runner.registerInfo("Initial density: #{layer.density}")
+
+    # set layer properties
+    layer.setThermalAbsorptance(thermal_absorptance) if thermal_absorptance != 0
+    layer.setSolarAbsorptance(solar_absorptance) if solar_absorptance != 0
+    layer.setVisibleAbsorptance(visible_absorptance) if visible_absorptance != 0
+    layer.setThermalConductivity(thermal_conductivity) if thermal_conductivity != 0
+    layer.setSpecificHeat(specific_heat) if specific_heat != 0
+    layer.setThickness(thickness) if thickness != 0
+    layer.setDensity(density) if density != 0
+
+    runner.registerInfo("Final thermal_absorptance: #{layer.thermalAbsorptance}")
+    runner.registerInfo("Final solar_absorptance: #{layer.solarAbsorptance}")
+    runner.registerInfo("Final visible_absorptance: #{layer.visibleAbsorptance}")
+    runner.registerInfo("Final thermal_conductivity: #{layer.thermalConductivity}")
+    runner.registerInfo("Final specific_heat: #{layer.specificHeat}")
+    runner.registerInfo("Final thickness: #{layer.thickness}")
+    runner.registerInfo("Final density: #{layer.density}")
+
+    # report initial condition
+    final_r_value_ip = OpenStudio.convert(1 / construction.thermalConductance.to_f, 'm^2*K/W', 'ft^2*h*R/Btu')
+    runner.registerFinalCondition("The Final R-value of #{construction.name} is #{final_r_value_ip} (ft^2*h*R/Btu).")
+    runner.registerValue('final_r_value_ip', final_r_value_ip.to_f, 'ft^2*h*R/Btu')
+
+    true
+  end # end the run method
+end # end the measure
+
+# this allows the measure to be used by the application
+ConstructionLayerZeroMaterialProperties.new.registerWithApplication

data/lib/measures/ConstructionLayerZeroMaterialProperties/measure.xml

@@ -0,0 +1,194 @@
+<measure>
+  <schema_version>3.0</schema_version>
+  <name>construction_layer_zero_material_properties</name>
+  <uid>3c7a6751-bb54-4600-9410-8f042e1a413b</uid>
+  <version_id>14b11c2b-63aa-4064-835f-fb57bb4a7af5</version_id>
+  <version_modified>20200325T030943Z</version_modified>
+  <xml_checksum>0BF71A3E</xml_checksum>
+  <class_name>ConstructionLayerZeroMaterialProperties</class_name>
+  <display_name>Change Parameters Of Material (Layer 0 of Construction)</display_name>
+  <description>This measure changes properties of Layer 0 for a specific construction.</description>
+  <modeler_description>This measure changes the Layer 0 properties of Thickness, Density, Thermal Absorptance, Solar Absorptance, Visible Absoptance, Thermal Conductivity, Specific Heat.</modeler_description>
+  <arguments>
+    <argument>
+      <name>construction</name>
+      <display_name>Choose a Construction to Alter.</display_name>
+      <type>Choice</type>
+      <required>true</required>
+      <model_dependent>false</model_dependent>
+    </argument>
+    <argument>
+      <name>thickness</name>
+      <display_name>Thickness of Layer 0</display_name>
+      <description>Set Thickness of Layer 0. 0 value means do not change from default.</description>
+      <type>Double</type>
+      <units>m</units>
+      <required>true</required>
+      <model_dependent>false</model_dependent>
+      <default_value>0</default_value>
+    </argument>
+    <argument>
+      <name>density</name>
+      <display_name>Density of Layer 0</display_name>
+      <description>Set Density of Layer 0. 0 value means do not change from default.</description>
+      <type>Double</type>
+      <units>kg/m^3</units>
+      <required>true</required>
+      <model_dependent>false</model_dependent>
+      <default_value>0</default_value>
+    </argument>
+    <argument>
+      <name>thermal_absorptance</name>
+      <display_name>Thermal Absorptance of Layer 0</display_name>
+      <description>Set Thermal Absorptance of Layer 0. 0 value means do not change from default.</description>
+      <type>Double</type>
+      <units>fraction</units>
+      <required>true</required>
+      <model_dependent>false</model_dependent>
+      <default_value>0</default_value>
+    </argument>
+    <argument>
+      <name>solar_absorptance</name>
+      <display_name>Solar Absorptance of Layer 0</display_name>
+      <description>Set Solar Absorptance of Layer 0. 0 value means do not change from default.</description>
+      <type>Double</type>
+      <units>fraction</units>
+      <required>true</required>
+      <model_dependent>false</model_dependent>
+      <default_value>0</default_value>
+    </argument>
+    <argument>
+      <name>visible_absorptance</name>
+      <display_name>Visible Absorptance of Layer 0</display_name>
+      <description>Set Visible Absorptance of Layer 0. 0 value means do not change from default.</description>
+      <type>Double</type>
+      <units>fraction</units>
+      <required>true</required>
+      <model_dependent>false</model_dependent>
+      <default_value>0</default_value>
+    </argument>
+    <argument>
+      <name>thermal_conductivity</name>
+      <display_name>Thermal Conductivity of Layer 0</display_name>
+      <description>Set Thermal Conductivity of Layer 0. 0 value means do not change from default.</description>
+      <type>Double</type>
+      <units>W/(m*K)</units>
+      <required>true</required>
+      <model_dependent>false</model_dependent>
+      <default_value>0</default_value>
+    </argument>
+    <argument>
+      <name>specific_heat</name>
+      <display_name>Specific Heat of Layer 0</display_name>
+      <description>Set Specific Heat of Layer 0. 0 value means do not change from default.</description>
+      <type>Double</type>
+      <units>J/(kg*K)</units>
+      <required>true</required>
+      <model_dependent>false</model_dependent>
+      <default_value>0</default_value>
+    </argument>
+  </arguments>
+  <outputs/>
+  <provenances/>
+  <tags>
+    <tag>Envelope.Opaque</tag>
+  </tags>
+  <attributes>
+    <attribute>
+      <name>Measure Function</name>
+      <value>Measure</value>
+      <datatype>string</datatype>
+    </attribute>
+    <attribute>
+      <name>Requires EnergyPlus Results</name>
+      <value>false</value>
+      <datatype>boolean</datatype>
+    </attribute>
+    <attribute>
+      <name>Uses SketchUp API</name>
+      <value>false</value>
+      <datatype>boolean</datatype>
+    </attribute>
+    <attribute>
+      <name>Measure Type</name>
+      <value>ModelMeasure</value>
+      <datatype>string</datatype>
+    </attribute>
+    <attribute>
+      <name>Intended Software Tool</name>
+      <value>Apply Measure Now</value>
+      <datatype>string</datatype>
+    </attribute>
+    <attribute>
+      <name>Intended Software Tool</name>
+      <value>OpenStudio Application</value>
+      <datatype>string</datatype>
+    </attribute>
+    <attribute>
+      <name>Intended Software Tool</name>
+      <value>Parametric Analysis Tool</value>
+      <datatype>string</datatype>
+    </attribute>
+    <attribute>
+      <name>Intended Software Tool</name>
+      <value>Analysis Spreadsheet</value>
+      <datatype>string</datatype>
+    </attribute>
+    <attribute>
+      <name>Intended Use Case</name>
+      <value>Model Articulation</value>
+      <datatype>string</datatype>
+    </attribute>
+    <attribute>
+      <name>Intended Use Case</name>
+      <value>Calibration</value>
+      <datatype>string</datatype>
+    </attribute>
+    <attribute>
+      <name>Intended Use Case</name>
+      <value>Sensitivity Analysis</value>
+      <datatype>string</datatype>
+    </attribute>
+    <attribute>
+      <name>Intended Use Case</name>
+      <value>New Construction EE</value>
+      <datatype>string</datatype>
+    </attribute>
+    <attribute>
+      <name>Intended Use Case</name>
+      <value>Retrofit EE</value>
+      <datatype>string</datatype>
+    </attribute>
+  </attributes>
+  <files>
+    <file>
+      <filename>LICENSE.md</filename>
+      <filetype>md</filetype>
+      <usage_type>license</usage_type>
+      <checksum>E0468DD6</checksum>
+    </file>
+    <file>
+      <filename>README.md.erb</filename>
+      <filetype>erb</filetype>
+      <usage_type>readmeerb</usage_type>
+      <checksum>703C9964</checksum>
+    </file>
+    <file>
+      <filename>README.md</filename>
+      <filetype>md</filetype>
+      <usage_type>readme</usage_type>
+      <checksum>7D40EF5C</checksum>
+    </file>
+    <file>
+      <version>
+        <software_program>OpenStudio</software_program>
+        <identifier>2.1.0</identifier>
+        <min_compatible>2.1.0</min_compatible>
+      </version>
+      <filename>measure.rb</filename>
+      <filetype>rb</filetype>
+      <usage_type>script</usage_type>
+      <checksum>B8221E83</checksum>
+    </file>
+  </files>
+</measure>