Skip to content

Commit

Permalink
Update the docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
@joseph-robertson
joseph-robertson committed Nov 30, 2023
1 parent 8e27f7c commit c1f802a
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 12 deletions.
6 changes: 3 additions & 3 deletions HPXMLtoOpenStudio/measure.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
<schema_version>3.1</schema_version>
<name>hpxm_lto_openstudio</name>
<uid>b1543b30-9465-45ff-ba04-1d1f85e763bc</uid>
<version_id>bbae7f1a-0062-44da-ab99-8b324164259d</version_id>
<version_modified>2023-11-30T17:45:43Z</version_modified>
<version_id>48f64f49-2808-48e0-b993-4f0cf62cf607</version_id>
<version_modified>2023-11-30T18:08:06Z</version_modified>
<xml_checksum>D8922A73</xml_checksum>
<class_name>HPXMLtoOpenStudio</class_name>
<display_name>HPXML to OpenStudio Translator</display_name>
Expand Down Expand Up @@ -298,7 +298,7 @@
<filename>hvac_sizing.rb</filename>
<filetype>rb</filetype>
<usage_type>resource</usage_type>
<checksum>3C5BDC5B</checksum>
<checksum>70CCB359</checksum>
</file>
<file>
<filename>lighting.rb</filename>
Expand Down
4 changes: 2 additions & 2 deletions HPXMLtoOpenStudio/resources/hvac_sizing.rb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ def self.calculate(weather, hpxml_bldg, cfa, hvac_systems)
apply_hvac_installation_quality(hvac_sizing_values, hvac_heating, hvac_cooling)
apply_hvac_maximum_airflows(hvac_sizing_values, hvac_heating, hvac_cooling)
apply_hvac_fixed_capacities(hvac_sizing_values, hvac_heating, hvac_cooling)
apply_hvac_blower_fan_adjustments(hvac_sizing_values, hvac_heating, hvac_cooling)
apply_hvac_blower_fan_adjustment(hvac_sizing_values, hvac_heating, hvac_cooling)
apply_hvac_ground_loop(hvac_sizing_values, weather, hvac_cooling)
apply_hvac_finalize_airflows(hvac_sizing_values, hvac_heating, hvac_cooling)

Expand Down Expand Up @@ -1906,7 +1906,7 @@ def self.apply_hvac_maximum_airflows(hvac_sizing_values, hvac_heating, hvac_cool
end
end

def self.apply_hvac_blower_fan_adjustments(hvac_sizing_values, hvac_heating, hvac_cooling)
def self.apply_hvac_blower_fan_adjustment(hvac_sizing_values, hvac_heating, hvac_cooling)
'''
Fan W/cfm adjustment
'''
Expand Down
18 changes: 11 additions & 7 deletions docs/source/workflow_inputs.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -607,19 +607,20 @@ HPXML HVAC Sizing Control

HVAC equipment sizing controls are entered in ``/HPXML/Building/BuildingDetails/BuildingSummary/extension/HVACSizingControl``.

================================= ======== ===== =========== ======== ======== ============================================
================================= ======== ===== =========== ======== ======== =====================================================
Element Type Units Constraints Required Default Description
================================= ======== ===== =========== ======== ======== ============================================
================================= ======== ===== =========== ======== ======== =====================================================
``AllowIncreasedFixedCapacities`` boolean No false Logic for fixed capacity HVAC equipment [#]_
``HeatPumpSizingMethodology`` string See [#]_ No HERS Logic for autosized heat pumps [#]_
``UseMaximumAirflowRates`` boolean No false Logic for TODO
================================= ======== ===== =========== ======== ======== ============================================
``UseMaximumAirflowRates`` boolean No false Logic for defining maximum allowed airflow rates [#]_
================================= ======== ===== =========== ======== ======== =====================================================

.. [#] If AllowIncreasedFixedCapacities is true, the larger of user-specified fixed capacity and design load will be used (to reduce potential for unmet loads); otherwise user-specified fixed capacity is used.
.. [#] HeatPumpSizingMethodology choices are 'ACCA', 'HERS', or 'MaxLoad'.
.. [#] If HeatPumpSizingMethodology is 'ACCA', autosized heat pumps have their nominal capacity sized per ACCA Manual J/S based on cooling design loads, with some oversizing allowances for larger heating design loads.
If HeatPumpSizingMethodology is 'HERS', autosized heat pumps have their nominal capacity sized equal to the larger of heating/cooling design loads.
If HeatPumpSizingMethodology is 'MaxLoad', autosized heat pumps have their nominal capacity sized based on the larger of heating/cooling design loads, while taking into account the heat pump's reduced capacity at the design temperature.
.. [#] If UseMaximumAirflowRates is true, the smaller of user-specified airflow rates and design load will be used.
If any HVAC equipment is being autosized (i.e., capacities are not provided), additional inputs for ACCA Manual J can be entered in ``/HPXML/Building/BuildingDetails/BuildingSummary/extension/HVACSizingControl/ManualJInputs``.

Expand Down Expand Up @@ -1901,9 +1902,9 @@ If an air-to-air heat pump is specified, additional information is entered in ``
``HeatingDetailedPerformanceData`` element No <none> Heating detailed performance data [#]_
``extension/HeatingCapacityRetention[Fraction | Temperature]`` double frac | F >= 0, < 1 | <= 17 No See [#]_ Heating output capacity retention at cold temperature [#]_
``extension/FanPowerWattsPerCFM`` double W/cfm >= 0 No See [#]_ Blower fan efficiency at maximum fan speed
``extension/AdjustFanPowerWattsPerCFM`` boolean No false
``extension/HeatingAirflowCFM`` double cfm >= 0 No autosized
``extension/CoolingAirflowCFM`` double cfm >= 0 No autosized
``extension/AdjustFanPowerWattsPerCFM`` boolean No false Whether to adjust blower fan efficiency [#]_
``extension/HeatingAirflowCFM`` double cfm >= 0 No autosized Heating airflow rate [#]_
``extension/CoolingAirflowCFM`` double cfm >= 0 No autosized Cooling airflow rate [#]_
``extension/AirflowDefectRatio`` double frac -0.9 - 9 No 0.0 Deviation between design/installed airflows [#]_
``extension/ChargeDefectRatio`` double frac -0.9 - 9 No 0.0 Deviation between design/installed refrigerant charges [#]_
``extension/CrankcaseHeaterPowerWatts`` double W No 50.0 Crankcase heater power
Expand Down Expand Up @@ -1933,6 +1934,9 @@ If an air-to-air heat pump is specified, additional information is entered in ``
.. [#] The extension/HeatingCapacityRetention input is a more flexible alternative to HeatingCapacity17F, as it can apply to autosized systems and allows the heating capacity retention to be defined at a user-specified temperature (instead of 17F).
Either input approach can be used, but not both.
.. [#] If FanPowerWattsPerCFM not provided, defaulted to 0.5 W/cfm if HSPF <= 8.75, else 0.375 W/cfm.
.. [#] If AdjustFanPowerWattsPerCFM is true, adjust the blower fan W/cfm using provided HeatingAirflowCFM and CoolingAirflowCFM.
.. [#] HeatingAirflowCFM can either be the maximum allowed heating airflow rate when UseMaximumAirflowRates is true in :ref:`hvac_sizing_control`, or can be used for blower fan efficiency adjustment.
.. [#] CoolingAirflowCFM can either be the maximum allowed cooling airflow rate when UseMaximumAirflowRates is true in :ref:`hvac_sizing_control`, or can be used for blower fan efficiency adjustment.
.. [#] AirflowDefectRatio is defined as (InstalledAirflow - DesignAirflow) / DesignAirflow; a value of zero means no airflow defect.
See ANSI/RESNET/ACCA 310-2020 Standard for Grading the Installation of HVAC Systems for more information.
.. [#] ChargeDefectRatio is defined as (InstalledCharge - DesignCharge) / DesignCharge; a value of zero means no refrigerant charge defect.
Expand Down

0 comments on commit c1f802a

Please sign in to comment.