pyidf.water_heaters_and_thermal_storage module

Data objects in group “Water Heaters and Thermal Storage”

class pyidf.water_heaters_and_thermal_storage.ThermalStorageChilledWaterMixed

Bases: pyidf.helper.DataObject

Corresponds to IDD object ThermalStorage:ChilledWater:Mixed Chilled water storage with a well-mixed, single-node tank. The chilled water is “used” by drawing from the “Use Side” of the water tank. The tank is indirectly charged by circulating cold water through the “Source Side” of the water tank.

ambient_temperature_indicator

field Ambient Temperature Indicator

Parameters:value (str) – value for IDD Field Ambient Temperature Indicator Raises:ValueError – if value is not a valid value Returns:the value of ambient_temperature_indicator or None if not set Return type:str

ambient_temperature_outdoor_air_node_name

field Ambient Temperature Outdoor Air Node Name

required when field Ambient Temperature Indicator=Outdoors

Parameters:value (str) – value for IDD Field Ambient Temperature Outdoor Air Node Name Raises:ValueError – if value is not a valid value Returns:the value of ambient_temperature_outdoor_air_node_name or None if not set Return type:str

ambient_temperature_schedule_name

field Ambient Temperature Schedule Name

Parameters:value (str) – value for IDD Field Ambient Temperature Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of ambient_temperature_schedule_name or None if not set Return type:str

ambient_temperature_zone_name

field Ambient Temperature Zone Name

Parameters:value (str) – value for IDD Field Ambient Temperature Zone Name Raises:ValueError – if value is not a valid value Returns:the value of ambient_temperature_zone_name or None if not set Return type:str

deadband_temperature_difference

field Deadband Temperature Difference

Units: deltaC

Default value: 0.5

Parameters:value (float) – value for IDD Field Deadband Temperature Difference Raises:ValueError – if value is not a valid value Returns:the value of deadband_temperature_difference or None if not set Return type:float

heat_gain_coefficient_from_ambient_temperature

field Heat Gain Coefficient from Ambient Temperature

Units: W/K

Parameters:value (float) – value for IDD Field Heat Gain Coefficient from Ambient Temperature Raises:ValueError – if value is not a valid value Returns:the value of heat_gain_coefficient_from_ambient_temperature or None if not set Return type:float

minimum_temperature_limit

field Minimum Temperature Limit

Units: C

Parameters:value (float) – value for IDD Field Minimum Temperature Limit Raises:ValueError – if value is not a valid value Returns:the value of minimum_temperature_limit or None if not set Return type:float

name

field Name

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

nominal_cooling_capacity

field Nominal Cooling Capacity

Units: W

Parameters:value (float) – value for IDD Field Nominal Cooling Capacity Raises:ValueError – if value is not a valid value Returns:the value of nominal_cooling_capacity or None if not set Return type:float

setpoint_temperature_schedule_name

field Setpoint Temperature Schedule Name

Parameters:value (str) – value for IDD Field Setpoint Temperature Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of setpoint_temperature_schedule_name or None if not set Return type:str

source_side_availability_schedule_name

field Source Side Availability Schedule Name

Availability schedule name for source side. Schedule value > 0 means the system is available.

If this field is blank, the system is always available.

Parameters:value (str) – value for IDD Field Source Side Availability Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of source_side_availability_schedule_name or None if not set Return type:str

source_side_design_flow_rate

field Source Side Design Flow Rate

Units: m3/s

IP-Units: gal/min

Default value: “autosize”

Parameters:value (float or “Autosize”) – value for IDD Field Source Side Design Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of source_side_design_flow_rate or None if not set Return type:float or “Autosize”

source_side_heat_transfer_effectiveness

field Source Side Heat Transfer Effectiveness

Default value: 1.0

value <= 1.0

Parameters:value (float) – value for IDD Field Source Side Heat Transfer Effectiveness Raises:ValueError – if value is not a valid value Returns:the value of source_side_heat_transfer_effectiveness or None if not set Return type:float

source_side_inlet_node_name

field Source Side Inlet Node Name

Parameters:value (str) – value for IDD Field Source Side Inlet Node Name Raises:ValueError – if value is not a valid value Returns:the value of source_side_inlet_node_name or None if not set Return type:str

source_side_outlet_node_name

field Source Side Outlet Node Name

Parameters:value (str) – value for IDD Field Source Side Outlet Node Name Raises:ValueError – if value is not a valid value Returns:the value of source_side_outlet_node_name or None if not set Return type:str

tank_recovery_time

field Tank Recovery Time

Parameter for autosizing design flow rates for indirectly cooled water tanks

time required to lower temperature of entire tank from 14.4C to 9.0C

Units: hr

Default value: 4.0

Parameters:value (float) – value for IDD Field Tank Recovery Time Raises:ValueError – if value is not a valid value Returns:the value of tank_recovery_time or None if not set Return type:float

tank_volume

field Tank Volume

Units: m3

IP-Units: gal

Default value: 0.1

Parameters:value (float) – value for IDD Field Tank Volume Raises:ValueError – if value is not a valid value Returns:the value of tank_volume or None if not set Return type:float

use_side_availability_schedule_name

field Use Side Availability Schedule Name

Availability schedule name for use side. Schedule value > 0 means the system is available.

If this field is blank, the system is always available.

Parameters:value (str) – value for IDD Field Use Side Availability Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of use_side_availability_schedule_name or None if not set Return type:str

use_side_design_flow_rate

field Use Side Design Flow Rate

Units: m3/s

IP-Units: gal/min

Default value: “autosize”

Parameters:value (float or “Autosize”) – value for IDD Field Use Side Design Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of use_side_design_flow_rate or None if not set Return type:float or “Autosize”

use_side_heat_transfer_effectiveness

field Use Side Heat Transfer Effectiveness

Default value: 1.0

value <= 1.0

Parameters:value (float) – value for IDD Field Use Side Heat Transfer Effectiveness Raises:ValueError – if value is not a valid value Returns:the value of use_side_heat_transfer_effectiveness or None if not set Return type:float

use_side_inlet_node_name

field Use Side Inlet Node Name

Parameters:value (str) – value for IDD Field Use Side Inlet Node Name Raises:ValueError – if value is not a valid value Returns:the value of use_side_inlet_node_name or None if not set Return type:str

use_side_outlet_node_name

field Use Side Outlet Node Name

Parameters:value (str) – value for IDD Field Use Side Outlet Node Name Raises:ValueError – if value is not a valid value Returns:the value of use_side_outlet_node_name or None if not set Return type:str

class pyidf.water_heaters_and_thermal_storage.ThermalStorageChilledWaterStratified

Bases: pyidf.helper.DataObject

Corresponds to IDD object ThermalStorage:ChilledWater:Stratified Chilled water storage with a stratified, multi-node tank. The chilled water is “used” by drawing from the “Use Side” of the water tank. The tank is indirectly charged by circulating cold water through the “Source Side” of the water tank.

additional_destratification_conductivity

field Additional Destratification Conductivity

Units: W/m-K

Parameters:value (float) – value for IDD Field Additional Destratification Conductivity Raises:ValueError – if value is not a valid value Returns:the value of additional_destratification_conductivity or None if not set Return type:float

ambient_temperature_indicator

field Ambient Temperature Indicator

Parameters:value (str) – value for IDD Field Ambient Temperature Indicator Raises:ValueError – if value is not a valid value Returns:the value of ambient_temperature_indicator or None if not set Return type:str

ambient_temperature_outdoor_air_node_name

field Ambient Temperature Outdoor Air Node Name

required for Ambient Temperature Indicator=Outdoors

Parameters:value (str) – value for IDD Field Ambient Temperature Outdoor Air Node Name Raises:ValueError – if value is not a valid value Returns:the value of ambient_temperature_outdoor_air_node_name or None if not set Return type:str

ambient_temperature_schedule_name

field Ambient Temperature Schedule Name

Parameters:value (str) – value for IDD Field Ambient Temperature Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of ambient_temperature_schedule_name or None if not set Return type:str

ambient_temperature_zone_name

field Ambient Temperature Zone Name

Parameters:value (str) – value for IDD Field Ambient Temperature Zone Name Raises:ValueError – if value is not a valid value Returns:the value of ambient_temperature_zone_name or None if not set Return type:str

deadband_temperature_difference

field Deadband Temperature Difference

Units: deltaC

Parameters:value (float) – value for IDD Field Deadband Temperature Difference Raises:ValueError – if value is not a valid value Returns:the value of deadband_temperature_difference or None if not set Return type:float

inlet_mode

field Inlet Mode

Default value: Fixed

Parameters:value (str) – value for IDD Field Inlet Mode Raises:ValueError – if value is not a valid value Returns:the value of inlet_mode or None if not set Return type:str

minimum_temperature_limit

field Minimum Temperature Limit

Units: C

Parameters:value (float) – value for IDD Field Minimum Temperature Limit Raises:ValueError – if value is not a valid value Returns:the value of minimum_temperature_limit or None if not set Return type:float

name

field Name

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

node_10_additional_loss_coefficient

field Node 10 Additional Loss Coefficient

Units: W/K

Parameters:value (float) – value for IDD Field Node 10 Additional Loss Coefficient Raises:ValueError – if value is not a valid value Returns:the value of node_10_additional_loss_coefficient or None if not set Return type:float

node_1_additional_loss_coefficient

field Node 1 Additional Loss Coefficient

Units: W/K

Parameters:value (float) – value for IDD Field Node 1 Additional Loss Coefficient Raises:ValueError – if value is not a valid value Returns:the value of node_1_additional_loss_coefficient or None if not set Return type:float

node_2_additional_loss_coefficient

field Node 2 Additional Loss Coefficient

Units: W/K

Parameters:value (float) – value for IDD Field Node 2 Additional Loss Coefficient Raises:ValueError – if value is not a valid value Returns:the value of node_2_additional_loss_coefficient or None if not set Return type:float

node_3_additional_loss_coefficient

field Node 3 Additional Loss Coefficient

Units: W/K

Parameters:value (float) – value for IDD Field Node 3 Additional Loss Coefficient Raises:ValueError – if value is not a valid value Returns:the value of node_3_additional_loss_coefficient or None if not set Return type:float

node_4_additional_loss_coefficient

field Node 4 Additional Loss Coefficient

Units: W/K

Parameters:value (float) – value for IDD Field Node 4 Additional Loss Coefficient Raises:ValueError – if value is not a valid value Returns:the value of node_4_additional_loss_coefficient or None if not set Return type:float

node_5_additional_loss_coefficient

field Node 5 Additional Loss Coefficient

Units: W/K

Parameters:value (float) – value for IDD Field Node 5 Additional Loss Coefficient Raises:ValueError – if value is not a valid value Returns:the value of node_5_additional_loss_coefficient or None if not set Return type:float

node_6_additional_loss_coefficient

field Node 6 Additional Loss Coefficient

Units: W/K

Parameters:value (float) – value for IDD Field Node 6 Additional Loss Coefficient Raises:ValueError – if value is not a valid value Returns:the value of node_6_additional_loss_coefficient or None if not set Return type:float

node_7_additional_loss_coefficient

field Node 7 Additional Loss Coefficient

Units: W/K

Parameters:value (float) – value for IDD Field Node 7 Additional Loss Coefficient Raises:ValueError – if value is not a valid value Returns:the value of node_7_additional_loss_coefficient or None if not set Return type:float

node_8_additional_loss_coefficient

field Node 8 Additional Loss Coefficient

Units: W/K

Parameters:value (float) – value for IDD Field Node 8 Additional Loss Coefficient Raises:ValueError – if value is not a valid value Returns:the value of node_8_additional_loss_coefficient or None if not set Return type:float

node_9_additional_loss_coefficient

field Node 9 Additional Loss Coefficient

Units: W/K

Parameters:value (float) – value for IDD Field Node 9 Additional Loss Coefficient Raises:ValueError – if value is not a valid value Returns:the value of node_9_additional_loss_coefficient or None if not set Return type:float

nominal_cooling_capacity

field Nominal Cooling Capacity

Units: W

Parameters:value (float) – value for IDD Field Nominal Cooling Capacity Raises:ValueError – if value is not a valid value Returns:the value of nominal_cooling_capacity or None if not set Return type:float

number_of_nodes

field Number of Nodes

Default value: 1

value >= 1

value <= 10

Parameters:value (int) – value for IDD Field Number of Nodes Raises:ValueError – if value is not a valid value Returns:the value of number_of_nodes or None if not set Return type:int

setpoint_temperature_schedule_name

field Setpoint Temperature Schedule Name

Parameters:value (str) – value for IDD Field Setpoint Temperature Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of setpoint_temperature_schedule_name or None if not set Return type:str

source_side_availability_schedule_name

field Source Side Availability Schedule Name

Availability schedule name for use side. Schedule value > 0 means the system is available.

If this field is blank, the system is always available.

Parameters:value (str) – value for IDD Field Source Side Availability Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of source_side_availability_schedule_name or None if not set Return type:str

source_side_design_flow_rate

field Source Side Design Flow Rate

Units: m3/s

IP-Units: gal/min

Default value: “autosize”

Parameters:value (float or “Autosize”) – value for IDD Field Source Side Design Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of source_side_design_flow_rate or None if not set Return type:float or “Autosize”

source_side_heat_transfer_effectiveness

field Source Side Heat Transfer Effectiveness

The source side effectiveness in the stratified tank model is a simplified analogy of

a heat exchanger’s effectiveness. This effectiveness is equal to the fraction of

source mass flow rate that directly mixes with the tank fluid. And one minus the

effectiveness is the fraction that bypasses the tank. The source side mass flow rate

that bypasses the tank is mixed with the fluid or water leaving the stratified tank.

Default value: 1.0

value <= 1.0

Parameters:value (float) – value for IDD Field Source Side Heat Transfer Effectiveness Raises:ValueError – if value is not a valid value Returns:the value of source_side_heat_transfer_effectiveness or None if not set Return type:float

source_side_inlet_height

field Source Side Inlet Height

Defaults to bottom of tank

Units: m

Parameters:value (float) – value for IDD Field Source Side Inlet Height Raises:ValueError – if value is not a valid value Returns:the value of source_side_inlet_height or None if not set Return type:float

source_side_inlet_node_name

field Source Side Inlet Node Name

Parameters:value (str) – value for IDD Field Source Side Inlet Node Name Raises:ValueError – if value is not a valid value Returns:the value of source_side_inlet_node_name or None if not set Return type:str

source_side_outlet_height

field Source Side Outlet Height

Defaults to top of tank

Units: m

Default value: “autocalculate”

Parameters:value (float or “Autocalculate”) – value for IDD Field Source Side Outlet Height Raises:ValueError – if value is not a valid value Returns:the value of source_side_outlet_height or None if not set Return type:float or “Autocalculate”

source_side_outlet_node_name

field Source Side Outlet Node Name

Parameters:value (str) – value for IDD Field Source Side Outlet Node Name Raises:ValueError – if value is not a valid value Returns:the value of source_side_outlet_node_name or None if not set Return type:str

tank_height

field Tank Height

Height is measured in the axial direction for horizontal cylinders

Units: m

Parameters:value (float) – value for IDD Field Tank Height Raises:ValueError – if value is not a valid value Returns:the value of tank_height or None if not set Return type:float

tank_perimeter

field Tank Perimeter

Only used if Tank Shape is Other

Units: m

Parameters:value (float) – value for IDD Field Tank Perimeter Raises:ValueError – if value is not a valid value Returns:the value of tank_perimeter or None if not set Return type:float

tank_recovery_time

field Tank Recovery Time

Parameter for autosizing design flow rates for indirectly cooled water tanks

time required to lower temperature of entire tank from 14.4C to 9.0C

Units: hr

Default value: 4.0

Parameters:value (float) – value for IDD Field Tank Recovery Time Raises:ValueError – if value is not a valid value Returns:the value of tank_recovery_time or None if not set Return type:float

tank_shape

field Tank Shape

Default value: VerticalCylinder

Parameters:value (str) – value for IDD Field Tank Shape Raises:ValueError – if value is not a valid value Returns:the value of tank_shape or None if not set Return type:str

tank_volume

field Tank Volume

Units: m3

IP-Units: gal

Parameters:value (float) – value for IDD Field Tank Volume Raises:ValueError – if value is not a valid value Returns:the value of tank_volume or None if not set Return type:float

temperature_sensor_height

field Temperature Sensor Height

Units: m

Parameters:value (float) – value for IDD Field Temperature Sensor Height Raises:ValueError – if value is not a valid value Returns:the value of temperature_sensor_height or None if not set Return type:float

uniform_skin_loss_coefficient_per_unit_area_to_ambient_temperature

field Uniform Skin Loss Coefficient per Unit Area to Ambient Temperature

Units: W/m2-K

Parameters:value (float) – value for IDD Field Uniform Skin Loss Coefficient per Unit Area to Ambient Temperature Raises:ValueError – if value is not a valid value Returns:the value of uniform_skin_loss_coefficient_per_unit_area_to_ambient_temperature or None if not set Return type:float

use_side_availability_schedule_name

field Use Side Availability Schedule Name

Availability schedule name for use side. Schedule value > 0 means the system is available.

If this field is blank, the system is always available.

Parameters:value (str) – value for IDD Field Use Side Availability Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of use_side_availability_schedule_name or None if not set Return type:str

use_side_design_flow_rate

field Use Side Design Flow Rate

Units: m3/s

IP-Units: gal/min

Default value: “autosize”

Parameters:value (float or “Autosize”) – value for IDD Field Use Side Design Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of use_side_design_flow_rate or None if not set Return type:float or “Autosize”

use_side_heat_transfer_effectiveness

field Use Side Heat Transfer Effectiveness

The use side effectiveness in the stratified tank model is a simplified analogy of

a heat exchanger’s effectiveness. This effectiveness is equal to the fraction of

use mass flow rate that directly mixes with the tank fluid. And one minus the

effectiveness is the fraction that bypasses the tank. The use side mass flow rate

that bypasses the tank is mixed with the fluid or water leaving the stratified tank.

Default value: 1.0

value <= 1.0

Parameters:value (float) – value for IDD Field Use Side Heat Transfer Effectiveness Raises:ValueError – if value is not a valid value Returns:the value of use_side_heat_transfer_effectiveness or None if not set Return type:float

use_side_inlet_height

field Use Side Inlet Height

Defaults to top of tank

Units: m

Default value: “autocalculate”

Parameters:value (float or “Autocalculate”) – value for IDD Field Use Side Inlet Height Raises:ValueError – if value is not a valid value Returns:the value of use_side_inlet_height or None if not set Return type:float or “Autocalculate”

use_side_inlet_node_name

field Use Side Inlet Node Name

Parameters:value (str) – value for IDD Field Use Side Inlet Node Name Raises:ValueError – if value is not a valid value Returns:the value of use_side_inlet_node_name or None if not set Return type:str

use_side_outlet_height

field Use Side Outlet Height

Defaults to bottom of tank

Units: m

Parameters:value (float) – value for IDD Field Use Side Outlet Height Raises:ValueError – if value is not a valid value Returns:the value of use_side_outlet_height or None if not set Return type:float

use_side_outlet_node_name

field Use Side Outlet Node Name

Parameters:value (str) – value for IDD Field Use Side Outlet Node Name Raises:ValueError – if value is not a valid value Returns:the value of use_side_outlet_node_name or None if not set Return type:str

class pyidf.water_heaters_and_thermal_storage.ThermalStorageIceDetailed

Bases: pyidf.helper.DataObject

Corresponds to IDD object ThermalStorage:Ice:Detailed This input syntax is intended to describe a thermal storage system that includes smaller containers filled with water that are placed in a larger tank or series of tanks. The model uses polynomial equations to describe the system performance.

availability_schedule_name

field Availability Schedule Name

Availability schedule name for this system. Schedule value > 0 means the system is available.

If this field is blank, the system is always available.

Parameters:value (str) – value for IDD Field Availability Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of availability_schedule_name or None if not set Return type:str

capacity

field Capacity

This includes only the latent storage capacity

Units: GJ

Parameters:value (float) – value for IDD Field Capacity Raises:ValueError – if value is not a valid value Returns:the value of capacity or None if not set Return type:float

charging_curve_name

field Charging Curve Name

Parameters:value (str) – value for IDD Field Charging Curve Name Raises:ValueError – if value is not a valid value Returns:the value of charging_curve_name or None if not set Return type:str

charging_curve_object_type

field Charging Curve Object Type

Parameters:value (str) – value for IDD Field Charging Curve Object Type Raises:ValueError – if value is not a valid value Returns:the value of charging_curve_object_type or None if not set Return type:str

discharging_curve_name

field Discharging Curve Name

Parameters:value (str) – value for IDD Field Discharging Curve Name Raises:ValueError – if value is not a valid value Returns:the value of discharging_curve_name or None if not set Return type:str

discharging_curve_object_type

field Discharging Curve Object Type

Parameters:value (str) – value for IDD Field Discharging Curve Object Type Raises:ValueError – if value is not a valid value Returns:the value of discharging_curve_object_type or None if not set Return type:str

freezing_temperature_of_storage_medium

field Freezing Temperature of Storage Medium

This temperature is typically 0C for water.

Simply changing this temperature without adjusting the performance

parameters input above is inappropriate and not advised.

Units: C

Parameters:value (float) – value for IDD Field Freezing Temperature of Storage Medium Raises:ValueError – if value is not a valid value Returns:the value of freezing_temperature_of_storage_medium or None if not set Return type:float

inlet_node_name

field Inlet Node Name

Parameters:value (str) – value for IDD Field Inlet Node Name Raises:ValueError – if value is not a valid value Returns:the value of inlet_node_name or None if not set Return type:str

name

field Name

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

outlet_node_name

field Outlet Node Name

Parameters:value (str) – value for IDD Field Outlet Node Name Raises:ValueError – if value is not a valid value Returns:the value of outlet_node_name or None if not set Return type:str

parasitic_electric_load_during_charging

field Parasitic Electric Load During Charging

Units: dimensionless

Parameters:value (float) – value for IDD Field Parasitic Electric Load During Charging Raises:ValueError – if value is not a valid value Returns:the value of parasitic_electric_load_during_charging or None if not set Return type:float

parasitic_electric_load_during_discharging

field Parasitic Electric Load During Discharging

Units: dimensionless

Parameters:value (float) – value for IDD Field Parasitic Electric Load During Discharging Raises:ValueError – if value is not a valid value Returns:the value of parasitic_electric_load_during_discharging or None if not set Return type:float

tank_loss_coefficient

field Tank Loss Coefficient

This is the fraction the total storage capacity that is lost or melts

each hour

Units: dimensionless

Parameters:value (float) – value for IDD Field Tank Loss Coefficient Raises:ValueError – if value is not a valid value Returns:the value of tank_loss_coefficient or None if not set Return type:float

thaw_process_indicator

field Thaw Process Indicator

This field determines whether the system uses internal or external melt

during discharging. This will then have an impact on charging performance.

Default value: OutsideMelt

Parameters:value (str) – value for IDD Field Thaw Process Indicator Raises:ValueError – if value is not a valid value Returns:the value of thaw_process_indicator or None if not set Return type:str

timestep_of_the_curve_data

field Timestep of the Curve Data

Units: hr

Parameters:value (float) – value for IDD Field Timestep of the Curve Data Raises:ValueError – if value is not a valid value Returns:the value of timestep_of_the_curve_data or None if not set Return type:float

class pyidf.water_heaters_and_thermal_storage.ThermalStorageIceSimple

Bases: pyidf.helper.DataObject

Corresponds to IDD object ThermalStorage:Ice:Simple This ice storage model is a simplified model It requires a setpoint placed on the Chilled Water Side Outlet Node It should be placed in the chilled water supply side outlet branch followed by a pipe. Use the PlantEquipmentOperation:ComponentSetpoint plant operation scheme.

capacity

field Capacity

Units: GJ

IP-Units: ton-hrs

Parameters:value (float) – value for IDD Field Capacity Raises:ValueError – if value is not a valid value Returns:the value of capacity or None if not set Return type:float

ice_storage_type

field Ice Storage Type

IceOnCoilInternal = Ice-on-Coil, internal melt

IceOnCoilExternal = Ice-on-Coil, external melt

Parameters:value (str) – value for IDD Field Ice Storage Type Raises:ValueError – if value is not a valid value Returns:the value of ice_storage_type or None if not set Return type:str

inlet_node_name

field Inlet Node Name

Parameters:value (str) – value for IDD Field Inlet Node Name Raises:ValueError – if value is not a valid value Returns:the value of inlet_node_name or None if not set Return type:str

name

field Name

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

outlet_node_name

field Outlet Node Name

Parameters:value (str) – value for IDD Field Outlet Node Name Raises:ValueError – if value is not a valid value Returns:the value of outlet_node_name or None if not set Return type:str

class pyidf.water_heaters_and_thermal_storage.WaterHeaterHeatPumpPumpedCondenser

Bases: pyidf.helper.DataObject

Corresponds to IDD object WaterHeater:HeatPump:PumpedCondenser This object models an air-source heat pump for water heating where the water is pumped out of the tank, through a heating coil and returned to the tank. For wrapped condenser HPWHs, see WaterHeater:HeatPump:WrappedCondenser. WaterHeater:HeatPump:PumpedCondenser is a compound object that references other component objects - Coil:WaterHeating:AirToWaterHeatPump:*, Fan:OnOff, WaterHeater:Mixed or WaterHeater:Stratified

air_inlet_node_name

field Air Inlet Node Name

Zone air exhaust node name if Inlet Air Configuration is ZoneAirOnly or

ZoneAndOutdoorAir.

Simply a unique Node Name if Inlet Air Configuration is Schedule.

Otherwise, leave field blank.

Parameters:value (str) – value for IDD Field Air Inlet Node Name Raises:ValueError – if value is not a valid value Returns:the value of air_inlet_node_name or None if not set Return type:str

air_outlet_node_name

field Air Outlet Node Name

Zone Air Inlet Node Name if Inlet Air Configuration is ZoneAirOnly or

ZoneAndOutdoorAir.

Simply a unique Node Name if Inlet Air Configuration is Schedule.

Otherwise, leave field blank.

Parameters:value (str) – value for IDD Field Air Outlet Node Name Raises:ValueError – if value is not a valid value Returns:the value of air_outlet_node_name or None if not set Return type:str

availability_schedule_name

field Availability Schedule Name

Availability schedule name for this system. Schedule value > 0 means the system is available.

If this field is blank, the system is always available.

Schedule values of 0 denote the heat pump compressor is off and the parasitic electric

energy is also off.

Parameters:value (str) – value for IDD Field Availability Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of availability_schedule_name or None if not set Return type:str

compressor_ambient_temperature_schedule_name

field Compressor Ambient Temperature Schedule Name

Used only if Compressor Location is Schedule, otherwise leave field blank.

Parameters:value (str) – value for IDD Field Compressor Ambient Temperature Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of compressor_ambient_temperature_schedule_name or None if not set Return type:str

compressor_location

field Compressor Location

If Zone is selected, Inlet Air Configuration must be ZoneAirOnly or

ZoneAndOutdoorAir. If Schedule is selected, then you must provide a

Compressor Ambient Temperature Schedule Name below.

Parameters:value (str) – value for IDD Field Compressor Location Raises:ValueError – if value is not a valid value Returns:the value of compressor_location or None if not set Return type:str

compressor_setpoint_temperature_schedule_name

field Compressor Setpoint Temperature Schedule Name

Defines the cut-out temperature where the heat pump compressor turns off.

The heat pump compressor setpoint temperature should always be greater

than the water tank’s heater (element or burner) setpoint temperature.

Parameters:value (str) – value for IDD Field Compressor Setpoint Temperature Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of compressor_setpoint_temperature_schedule_name or None if not set Return type:str

condenser_water_flow_rate

field Condenser Water Flow Rate

Actual water flow rate through the heat pump’s water coil (condenser).

If autocalculated, the water flow rate is set equal to 4.487E-8 m3/s/W times

the rated heating capacity of the heat pump’s DX coil.

Units: m3/s

Parameters:value (float or “Autocalculate”) – value for IDD Field Condenser Water Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of condenser_water_flow_rate or None if not set Return type:float or “Autocalculate”

condenser_water_inlet_node_name

field Condenser Water Inlet Node Name

Should match the field Source Outlet Node Name in the water heater tank object.

Should also match the Condenser Water Inlet Node Name in the associated

DX coil object.

Parameters:value (str) – value for IDD Field Condenser Water Inlet Node Name Raises:ValueError – if value is not a valid value Returns:the value of condenser_water_inlet_node_name or None if not set Return type:str

condenser_water_outlet_node_name

field Condenser Water Outlet Node Name

Should match the field Source Inlet Node Name in water heater tank object.

Should also match the Condenser Water Outlet Node Name in the associated

DX Coil object.

Parameters:value (str) – value for IDD Field Condenser Water Outlet Node Name Raises:ValueError – if value is not a valid value Returns:the value of condenser_water_outlet_node_name or None if not set Return type:str

control_sensor_1_height_in_stratified_tank

field Control Sensor 1 Height In Stratified Tank

Used to indicate height of control sensor for Tank Object Type = WaterHeater:Stratified

If left blank, it will default to the height of Heater1

Units: m

Parameters:value (float) – value for IDD Field Control Sensor 1 Height In Stratified Tank Raises:ValueError – if value is not a valid value Returns:the value of control_sensor_1_height_in_stratified_tank or None if not set Return type:float

control_sensor_1_weight

field Control Sensor 1 Weight

Weight to give Control Sensor 1 temperature

The weight of Control Sensor 2 will be 1 - (wt. of control sensor 1)

Units: dimensionless

Default value: 1.0

value <= 1.0

Parameters:value (float) – value for IDD Field Control Sensor 1 Weight Raises:ValueError – if value is not a valid value Returns:the value of control_sensor_1_weight or None if not set Return type:float

control_sensor_2_height_in_stratified_tank

field Control Sensor 2 Height In Stratified Tank

Used to indicate height of control sensor for Tank Object Type = WaterHeater:Stratified

If left blank, it will default to the height of Heater2

Units: m

Parameters:value (float) – value for IDD Field Control Sensor 2 Height In Stratified Tank Raises:ValueError – if value is not a valid value Returns:the value of control_sensor_2_height_in_stratified_tank or None if not set Return type:float

dead_band_temperature_difference

field Dead Band Temperature Difference

Setpoint temperature minus the dead band temperature difference defines

the cut-in temperature where the heat pump compressor turns on.

The water tank’s heater (element or burner) setpoint temperature

should always be less than the heat pump compressor cut-in temperature.

Units: deltaC

Default value: 5.0

value <= 20.0

Parameters:value (float) – value for IDD Field Dead Band Temperature Difference Raises:ValueError – if value is not a valid value Returns:the value of dead_band_temperature_difference or None if not set Return type:float

dx_coil_name

field DX Coil Name

Must match the name used in the corresponding Coil:WaterHeating:AirToWaterHeatPump:* object.

Parameters:value (str) – value for IDD Field DX Coil Name Raises:ValueError – if value is not a valid value Returns:the value of dx_coil_name or None if not set Return type:str

dx_coil_object_type

field DX Coil Object Type

Specify the type of DX coil used by this heat pump water heater. The only

valid choice is Coil:WaterHeating:AirToWaterHeatPump:Pumped and Coil:WaterHeating:AirToWaterHeatPump:VariableSpeed.

Default value: Coil:WaterHeating:AirToWaterHeatPump:Pumped

Parameters:value (str) – value for IDD Field DX Coil Object Type Raises:ValueError – if value is not a valid value Returns:the value of dx_coil_object_type or None if not set Return type:str

evaporator_air_flow_rate

field Evaporator Air Flow Rate

Actual air flow rate across the heat pump’s air coil (evaporator).

If autocalculated, the air flow rate is set equal to 5.035E-5 m3/s/W times

the rated heating capacity of the heat pump’s DX coil.

Units: m3/s

Parameters:value (float or “Autocalculate”) – value for IDD Field Evaporator Air Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of evaporator_air_flow_rate or None if not set Return type:float or “Autocalculate”

exhaust_air_node_name

field Exhaust Air Node Name

Simply a unique Node Name if Inlet Air Configuration is ZoneAndOutdoorAir

or OutdoorAirOnly, otherwise leave field blank.

Parameters:value (str) – value for IDD Field Exhaust Air Node Name Raises:ValueError – if value is not a valid value Returns:the value of exhaust_air_node_name or None if not set Return type:str

fan_name

field Fan Name

Needs to match the name used in the corresponding Fan:OnOff object.

Parameters:value (str) – value for IDD Field Fan Name Raises:ValueError – if value is not a valid value Returns:the value of fan_name or None if not set Return type:str

fan_object_type

field Fan Object Type

Specify the type of fan used by this heat pump water heater. The only

valid choice is Fan:OnOff.

Default value: Fan:OnOff

Parameters:value (str) – value for IDD Field Fan Object Type Raises:ValueError – if value is not a valid value Returns:the value of fan_object_type or None if not set Return type:str

fan_placement

field Fan Placement

BlowThrough means the fan is located before the air coil (upstream).

DrawThrough means the fan is located after the air coil (downstream).

Default value: DrawThrough

Parameters:value (str) – value for IDD Field Fan Placement Raises:ValueError – if value is not a valid value Returns:the value of fan_placement or None if not set Return type:str

inlet_air_configuration

field Inlet Air Configuration

Defines the configuration of the airflow path through the air coil and fan section.

Parameters:value (str) – value for IDD Field Inlet Air Configuration Raises:ValueError – if value is not a valid value Returns:the value of inlet_air_configuration or None if not set Return type:str

inlet_air_humidity_schedule_name

field Inlet Air Humidity Schedule Name

Used only if Inlet Air Configuration is Schedule, otherwise leave blank.

Schedule values are entered as a fraction (e.g. 0.5 is equal to 50%RH)

Parameters:value (str) – value for IDD Field Inlet Air Humidity Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of inlet_air_humidity_schedule_name or None if not set Return type:str

inlet_air_mixer_node_name

field Inlet Air Mixer Node Name

Required only if Inlet Air Configuration is ZoneAndOutdoorAir, otherwise

leave field blank.

Parameters:value (str) – value for IDD Field Inlet Air Mixer Node Name Raises:ValueError – if value is not a valid value Returns:the value of inlet_air_mixer_node_name or None if not set Return type:str

inlet_air_mixer_schedule_name

field Inlet Air Mixer Schedule Name

Required only if Inlet Air Configuration is ZoneAndOutdoorAir, otherwise

leave field blank. Schedule values define whether the heat pump draws its

inlet air from the zone, outdoors or a combination of zone and outdoor air.

A schedule value of 0 denotes inlet air is drawn only from the zone.

A schedule value of 1 denotes inlet air is drawn only from outdoors.

Schedule values between 0 and 1 denote a mixture of zone and outdoor air

proportional to the schedule value (i.e. 0.4 = 40% outdoor air, 60% zone air).

Parameters:value (str) – value for IDD Field Inlet Air Mixer Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of inlet_air_mixer_schedule_name or None if not set Return type:str

inlet_air_temperature_schedule_name

field Inlet Air Temperature Schedule Name

Used only if Inlet Air Configuration is Schedule, otherwise leave blank.

Schedule values should be degrees C.

Parameters:value (str) – value for IDD Field Inlet Air Temperature Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of inlet_air_temperature_schedule_name or None if not set Return type:str

inlet_air_zone_name

field Inlet Air Zone Name

Used only if Inlet Air Configuration is ZoneAirOnly or ZoneAndOutdoorAir.

Otherwise, leave field blank.

Parameters:value (str) – value for IDD Field Inlet Air Zone Name Raises:ValueError – if value is not a valid value Returns:the value of inlet_air_zone_name or None if not set Return type:str

maximum_inlet_air_temperature_for_compressor_operation

field Maximum Inlet Air Temperature for Compressor Operation

Heat pump compressor will not operate when the inlet air dry-bulb temperature

is above this value.

Units: C

Default value: 48.8888888889

value >= 26.0

value <= 94.0

Parameters:value (float) – value for IDD Field Maximum Inlet Air Temperature for Compressor Operation Raises:ValueError – if value is not a valid value Returns:the value of maximum_inlet_air_temperature_for_compressor_operation or None if not set Return type:float

minimum_inlet_air_temperature_for_compressor_operation

field Minimum Inlet Air Temperature for Compressor Operation

Heat pump compressor will not operate when the inlet air dry-bulb temperature

is below this value.

Units: C

Default value: 10.0

value >= -5.0

Parameters:value (float) – value for IDD Field Minimum Inlet Air Temperature for Compressor Operation Raises:ValueError – if value is not a valid value Returns:the value of minimum_inlet_air_temperature_for_compressor_operation or None if not set Return type:float

name

field Name

Unique name for this instance of a heat pump water heater.

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

off_cycle_parasitic_electric_load

field Off Cycle Parasitic Electric Load

Parasitic electric power consumed when the heat pump compressor is off.

Does not contribute to water heating but can impact the zone air heat balance.

Off-cycle parasitic power is 0 when the availability schedule is 0.

Units: W

Parameters:value (float) – value for IDD Field Off Cycle Parasitic Electric Load Raises:ValueError – if value is not a valid value Returns:the value of off_cycle_parasitic_electric_load or None if not set Return type:float

on_cycle_parasitic_electric_load

field On Cycle Parasitic Electric Load

Parasitic electric power consumed when the heat pump compressor operates.

Does not contribute to water heating but can impact the zone air heat balance.

Units: W

Parameters:value (float) – value for IDD Field On Cycle Parasitic Electric Load Raises:ValueError – if value is not a valid value Returns:the value of on_cycle_parasitic_electric_load or None if not set Return type:float

outdoor_air_node_name

field Outdoor Air Node Name

Outdoor air node name if inlet air configuration is ZoneAndOutdoorAir

or OutdoorAirOnly, otherwise leave field blank.

Parameters:value (str) – value for IDD Field Outdoor Air Node Name Raises:ValueError – if value is not a valid value Returns:the value of outdoor_air_node_name or None if not set Return type:str

outlet_air_splitter_node_name

field Outlet Air Splitter Node Name

Required only if Inlet Air Configuration is ZoneAndOutdoorAir, otherwise

leave field blank.

Parameters:value (str) – value for IDD Field Outlet Air Splitter Node Name Raises:ValueError – if value is not a valid value Returns:the value of outlet_air_splitter_node_name or None if not set Return type:str

parasitic_heat_rejection_location

field Parasitic Heat Rejection Location

This field determines if the parasitic electric load impacts the zone air

heat balance. If Zone is selected, Inlet Air Configuration must be

ZoneAirOnly or ZoneAndOutdoorAir.

Default value: Outdoors

Parameters:value (str) – value for IDD Field Parasitic Heat Rejection Location Raises:ValueError – if value is not a valid value Returns:the value of parasitic_heat_rejection_location or None if not set Return type:str

tank_element_control_logic

field Tank Element Control Logic

MutuallyExclusive means that once the tank heating element is active the

heat pump is shut down until setpoint is reached.

Simultaneous (default) means that both the tank heating element and

heat pump are used at the same time recover the tank temperature.

Default value: Simultaneous

Parameters:value (str) – value for IDD Field Tank Element Control Logic Raises:ValueError – if value is not a valid value Returns:the value of tank_element_control_logic or None if not set Return type:str

tank_name

field Tank Name

Needs to match the name used in the corresponding Water Heater object.

Parameters:value (str) – value for IDD Field Tank Name Raises:ValueError – if value is not a valid value Returns:the value of tank_name or None if not set Return type:str

tank_object_type

field Tank Object Type

Specify the type of water heater tank used by this heat pump water heater.

Default value: WaterHeater:Mixed

Parameters:value (str) – value for IDD Field Tank Object Type Raises:ValueError – if value is not a valid value Returns:the value of tank_object_type or None if not set Return type:str

tank_use_side_inlet_node_name

field Tank Use Side Inlet Node Name

Used only when the heat pump water heater is connected to a plant loop,

otherwise leave blank. Needs to match the name used in the corresponding

Water Heater object when connected to a plant loop.

Parameters:value (str) – value for IDD Field Tank Use Side Inlet Node Name Raises:ValueError – if value is not a valid value Returns:the value of tank_use_side_inlet_node_name or None if not set Return type:str

tank_use_side_outlet_node_name

field Tank Use Side Outlet Node Name

Used only when the heat pump water heater is connected to a plant loop,

otherwise leave blank. Needs to match the name used in the corresponding

Water Heater object when connected to a plant loop.

Parameters:value (str) – value for IDD Field Tank Use Side Outlet Node Name Raises:ValueError – if value is not a valid value Returns:the value of tank_use_side_outlet_node_name or None if not set Return type:str

class pyidf.water_heaters_and_thermal_storage.WaterHeaterHeatPumpWrappedCondenser

Bases: pyidf.helper.DataObject

Corresponds to IDD object WaterHeater:HeatPump:WrappedCondenser This object models an air-source heat pump for water heating where the heating coil is wrapped around the tank, which is typical of residential HPWHs. For pumped condenser HPWHs, see WaterHeater:HeatPump:PumpedCondenser. WaterHeater:HeatPump:WrappedCondenser is a compound object that references other component objects - Coil:WaterHeating:AirToWaterHeatPump:Pumped, Fan:OnOff, WaterHeater:Mixed

air_inlet_node_name

field Air Inlet Node Name

Zone air exhaust node name if Inlet Air Configuration is ZoneAirOnly or

ZoneAndOutdoorAir.

Simply a unique Node Name if Inlet Air Configuration is Schedule.

Otherwise, leave field blank.

Parameters:value (str) – value for IDD Field Air Inlet Node Name Raises:ValueError – if value is not a valid value Returns:the value of air_inlet_node_name or None if not set Return type:str

air_outlet_node_name

field Air Outlet Node Name

Zone Air Inlet Node Name if Inlet Air Configuration is ZoneAirOnly or

ZoneAndOutdoorAir.

Simply a unique Node Name if Inlet Air Configuration is Schedule.

Otherwise, leave field blank.

Parameters:value (str) – value for IDD Field Air Outlet Node Name Raises:ValueError – if value is not a valid value Returns:the value of air_outlet_node_name or None if not set Return type:str

availability_schedule_name

field Availability Schedule Name

Availability schedule name for this system. Schedule value > 0 means the system is available.

If this field is blank, the system is always available.

Schedule values of 0 denote the heat pump compressor is off and the parasitic electric

energy is also off.

Parameters:value (str) – value for IDD Field Availability Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of availability_schedule_name or None if not set Return type:str

compressor_ambient_temperature_schedule_name

field Compressor Ambient Temperature Schedule Name

Used only if Compressor Location is Schedule, otherwise leave field blank.

Parameters:value (str) – value for IDD Field Compressor Ambient Temperature Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of compressor_ambient_temperature_schedule_name or None if not set Return type:str

compressor_location

field Compressor Location

If Zone is selected, Inlet Air Configuration must be ZoneAirOnly or

ZoneAndOutdoorAir. If Schedule is selected, then you must provide a

Compressor Ambient Temperature Schedule Name below.

Parameters:value (str) – value for IDD Field Compressor Location Raises:ValueError – if value is not a valid value Returns:the value of compressor_location or None if not set Return type:str

compressor_setpoint_temperature_schedule_name

field Compressor Setpoint Temperature Schedule Name

Defines the cut-out temperature where the heat pump compressor turns off.

The heat pump compressor setpoint temperature should always be greater

than the water tank’s heater (element or burner) setpoint temperature.

Parameters:value (str) – value for IDD Field Compressor Setpoint Temperature Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of compressor_setpoint_temperature_schedule_name or None if not set Return type:str

condenser_bottom_location

field Condenser Bottom Location

Distance from the bottom of the tank to the bottom of the wrapped condenser.

Units: m

Parameters:value (float) – value for IDD Field Condenser Bottom Location Raises:ValueError – if value is not a valid value Returns:the value of condenser_bottom_location or None if not set Return type:float

condenser_top_location

field Condenser Top Location

Distance from the bottom of the tank to the top of the wrapped condenser.

Units: m

Parameters:value (float) – value for IDD Field Condenser Top Location Raises:ValueError – if value is not a valid value Returns:the value of condenser_top_location or None if not set Return type:float

control_sensor_1_height_in_stratified_tank

field Control Sensor 1 Height In Stratified Tank

Used to indicate height of control sensor if Tank Object Type is WaterHeater:Stratified

If left blank, it will default to the height of Heater1

Units: m

Parameters:value (float) – value for IDD Field Control Sensor 1 Height In Stratified Tank Raises:ValueError – if value is not a valid value Returns:the value of control_sensor_1_height_in_stratified_tank or None if not set Return type:float

control_sensor_1_weight

field Control Sensor 1 Weight

Weight to give Control Sensor 1 temperature

Units: dimensionless

Default value: 1.0

value <= 1.0

Parameters:value (float) – value for IDD Field Control Sensor 1 Weight Raises:ValueError – if value is not a valid value Returns:the value of control_sensor_1_weight or None if not set Return type:float

control_sensor_2_height_in_stratified_tank

field Control Sensor 2 Height In Stratified Tank

Used to indicate height of control sensor if Tank Object Type is WaterHeater:Stratified

If left blank, it will default to the height of Heater2

The weight of this control sensor will be 1 - (wt. of control sensor 1)

Units: m

Parameters:value (float) – value for IDD Field Control Sensor 2 Height In Stratified Tank Raises:ValueError – if value is not a valid value Returns:the value of control_sensor_2_height_in_stratified_tank or None if not set Return type:float

dead_band_temperature_difference

field Dead Band Temperature Difference

Setpoint temperature minus the dead band temperature difference defines

the cut-in temperature where the heat pump compressor turns on.

The water tank’s heater (element or burner) setpoint temperature

should always be less than the heat pump compressor cut-in temperature.

Units: deltaC

Default value: 5.0

value <= 20.0

Parameters:value (float) – value for IDD Field Dead Band Temperature Difference Raises:ValueError – if value is not a valid value Returns:the value of dead_band_temperature_difference or None if not set Return type:float

dx_coil_name

field DX Coil Name

Must match the name used in the corresponding Coil:WaterHeating:AirToWaterHeatPump:Wrapped object.

Parameters:value (str) – value for IDD Field DX Coil Name Raises:ValueError – if value is not a valid value Returns:the value of dx_coil_name or None if not set Return type:str

dx_coil_object_type

field DX Coil Object Type

Specify the type of DX coil used by this heat pump water heater. The only

valid choice is Coil:WaterHeating:AirToWaterHeatPump:Wrapped

Default value: Coil:WaterHeating:AirToWaterHeatPump:Wrapped

Parameters:value (str) – value for IDD Field DX Coil Object Type Raises:ValueError – if value is not a valid value Returns:the value of dx_coil_object_type or None if not set Return type:str

evaporator_air_flow_rate

field Evaporator Air Flow Rate

Actual air flow rate across the heat pump’s air coil (evaporator).

If autocalculated, the air flow rate is set equal to 5.035E-5 m3/s/W times

the rated heating capacity of the heat pump’s DX coil.

Units: m3/s

Parameters:value (float or “Autocalculate”) – value for IDD Field Evaporator Air Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of evaporator_air_flow_rate or None if not set Return type:float or “Autocalculate”

exhaust_air_node_name

field Exhaust Air Node Name

Simply a unique Node Name if Inlet Air Configuration is ZoneAndOutdoorAir

or OutdoorAirOnly, otherwise leave field blank.

Parameters:value (str) – value for IDD Field Exhaust Air Node Name Raises:ValueError – if value is not a valid value Returns:the value of exhaust_air_node_name or None if not set Return type:str

fan_name

field Fan Name

Needs to match the name used in the corresponding Fan:OnOff object.

Parameters:value (str) – value for IDD Field Fan Name Raises:ValueError – if value is not a valid value Returns:the value of fan_name or None if not set Return type:str

fan_object_type

field Fan Object Type

Specify the type of fan used by this heat pump water heater. The only

valid choice is Fan:OnOff.

Default value: Fan:OnOff

Parameters:value (str) – value for IDD Field Fan Object Type Raises:ValueError – if value is not a valid value Returns:the value of fan_object_type or None if not set Return type:str

fan_placement

field Fan Placement

BlowThrough means the fan is located before the air coil (upstream).

DrawThrough means the fan is located after the air coil (downstream).

Default value: DrawThrough

Parameters:value (str) – value for IDD Field Fan Placement Raises:ValueError – if value is not a valid value Returns:the value of fan_placement or None if not set Return type:str

inlet_air_configuration

field Inlet Air Configuration

Defines the configuration of the airflow path through the air coil and fan section.

Parameters:value (str) – value for IDD Field Inlet Air Configuration Raises:ValueError – if value is not a valid value Returns:the value of inlet_air_configuration or None if not set Return type:str

inlet_air_humidity_schedule_name

field Inlet Air Humidity Schedule Name

Used only if Inlet Air Configuration is Schedule, otherwise leave blank.

Schedule values are entered as a fraction (e.g. 0.5 is equal to 50%RH)

Parameters:value (str) – value for IDD Field Inlet Air Humidity Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of inlet_air_humidity_schedule_name or None if not set Return type:str

inlet_air_mixer_node_name

field Inlet Air Mixer Node Name

Required only if Inlet Air Configuration is ZoneAndOutdoorAir, otherwise

leave field blank.

Parameters:value (str) – value for IDD Field Inlet Air Mixer Node Name Raises:ValueError – if value is not a valid value Returns:the value of inlet_air_mixer_node_name or None if not set Return type:str

inlet_air_mixer_schedule_name

field Inlet Air Mixer Schedule Name

Required only if Inlet Air Configuration is ZoneAndOutdoorAir, otherwise

leave field blank. Schedule values define whether the heat pump draws its

inlet air from the zone, outdoors or a combination of zone and outdoor air.

A schedule value of 0 denotes inlet air is drawn only from the zone.

A schedule value of 1 denotes inlet air is drawn only from outdoors.

Schedule values between 0 and 1 denote a mixture of zone and outdoor air

proportional to the schedule value.

Parameters:value (str) – value for IDD Field Inlet Air Mixer Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of inlet_air_mixer_schedule_name or None if not set Return type:str

inlet_air_temperature_schedule_name

field Inlet Air Temperature Schedule Name

Used only if Inlet Air Configuration is Schedule, otherwise leave blank.

Schedule values should be degrees C.

Parameters:value (str) – value for IDD Field Inlet Air Temperature Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of inlet_air_temperature_schedule_name or None if not set Return type:str

inlet_air_zone_name

field Inlet Air Zone Name

Used only if Inlet Air Configuration is ZoneAirOnly or ZoneAndOutdoorAir.

Otherwise, leave field blank.

Parameters:value (str) – value for IDD Field Inlet Air Zone Name Raises:ValueError – if value is not a valid value Returns:the value of inlet_air_zone_name or None if not set Return type:str

maximum_inlet_air_temperature_for_compressor_operation

field Maximum Inlet Air Temperature for Compressor Operation

Heat pump compressor will not operate when the inlet air dry-bulb temperature

is above this value.

Units: C

Default value: 48.8888888889

value >= 26.0

value <= 94.0

Parameters:value (float) – value for IDD Field Maximum Inlet Air Temperature for Compressor Operation Raises:ValueError – if value is not a valid value Returns:the value of maximum_inlet_air_temperature_for_compressor_operation or None if not set Return type:float

minimum_inlet_air_temperature_for_compressor_operation

field Minimum Inlet Air Temperature for Compressor Operation

Heat pump compressor will not operate when the inlet air dry-bulb temperature

is below this value.

Units: C

Default value: 10.0

value >= -5.0

Parameters:value (float) – value for IDD Field Minimum Inlet Air Temperature for Compressor Operation Raises:ValueError – if value is not a valid value Returns:the value of minimum_inlet_air_temperature_for_compressor_operation or None if not set Return type:float

name

field Name

Unique name for this instance of a heat pump water heater.

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

off_cycle_parasitic_electric_load

field Off Cycle Parasitic Electric Load

Parasitic electric power consumed when the heat pump compressor is off.

Does not contribute to water heating but can impact the zone air heat balance.

Off-cycle parasitic power is 0 when the availability schedule is 0.

Units: W

Parameters:value (float) – value for IDD Field Off Cycle Parasitic Electric Load Raises:ValueError – if value is not a valid value Returns:the value of off_cycle_parasitic_electric_load or None if not set Return type:float

on_cycle_parasitic_electric_load

field On Cycle Parasitic Electric Load

Parasitic electric power consumed when the heat pump compressor operates.

Does not contribute to water heating but can impact the zone air heat balance.

Units: W

Parameters:value (float) – value for IDD Field On Cycle Parasitic Electric Load Raises:ValueError – if value is not a valid value Returns:the value of on_cycle_parasitic_electric_load or None if not set Return type:float

outdoor_air_node_name

field Outdoor Air Node Name

Outdoor air node name if inlet air configuration is ZoneAndOutdoorAir

or OutdoorAirOnly, otherwise leave field blank.

Parameters:value (str) – value for IDD Field Outdoor Air Node Name Raises:ValueError – if value is not a valid value Returns:the value of outdoor_air_node_name or None if not set Return type:str

outlet_air_splitter_node_name

field Outlet Air Splitter Node Name

Required only if Inlet Air Configuration is ZoneAndOutdoorAir, otherwise

leave field blank.

Parameters:value (str) – value for IDD Field Outlet Air Splitter Node Name Raises:ValueError – if value is not a valid value Returns:the value of outlet_air_splitter_node_name or None if not set Return type:str

parasitic_heat_rejection_location

field Parasitic Heat Rejection Location

This field determines if the parasitic electric load impacts the zone air

heat balance. If Zone is selected, Inlet Air Configuration must be

ZoneAirOnly or ZoneAndOutdoorAir.

Default value: Outdoors

Parameters:value (str) – value for IDD Field Parasitic Heat Rejection Location Raises:ValueError – if value is not a valid value Returns:the value of parasitic_heat_rejection_location or None if not set Return type:str

tank_element_control_logic

field Tank Element Control Logic

MutuallyExclusive means that once the tank heating element is active the

heat pump is shut down until setpoint is reached.

Simultaneous (default) means that both the tank heating element and

heat pump are used at the same time recover the tank temperature.

Default value: Simultaneous

Parameters:value (str) – value for IDD Field Tank Element Control Logic Raises:ValueError – if value is not a valid value Returns:the value of tank_element_control_logic or None if not set Return type:str

tank_name

field Tank Name

Needs to match the name used in the corresponding Water Heater object.

Must be a WaterHeater:Stratified tank.

Parameters:value (str) – value for IDD Field Tank Name Raises:ValueError – if value is not a valid value Returns:the value of tank_name or None if not set Return type:str

tank_object_type

field Tank Object Type

Specify the type of water heater tank used by this heat pump water heater.

Default value: WaterHeater:Stratified

Parameters:value (str) – value for IDD Field Tank Object Type Raises:ValueError – if value is not a valid value Returns:the value of tank_object_type or None if not set Return type:str

tank_use_side_inlet_node_name

field Tank Use Side Inlet Node Name

Used only when the heat pump water heater is connected to a plant loop,

otherwise leave blank. Needs to match the name used in the corresponding

Water Heater object when connected to a plant loop.

Parameters:value (str) – value for IDD Field Tank Use Side Inlet Node Name Raises:ValueError – if value is not a valid value Returns:the value of tank_use_side_inlet_node_name or None if not set Return type:str

tank_use_side_outlet_node_name

field Tank Use Side Outlet Node Name

Used only when the heat pump water heater is connected to a plant loop,

otherwise leave blank. Needs to match the name used in the corresponding

Water Heater object when connected to a plant loop.

Parameters:value (str) – value for IDD Field Tank Use Side Outlet Node Name Raises:ValueError – if value is not a valid value Returns:the value of tank_use_side_outlet_node_name or None if not set Return type:str

class pyidf.water_heaters_and_thermal_storage.WaterHeaterMixed

Bases: pyidf.helper.DataObject

Corresponds to IDD object WaterHeater:Mixed Water heater with well-mixed, single-node water tank. May be used to model a tankless water heater (small tank volume), a hot water storage tank (zero heater capacity), or a heat pump water heater (see WaterHeater:HeatPump:PumpedCondenser.)

ambient_temperature_indicator

field Ambient Temperature Indicator

Parameters:value (str) – value for IDD Field Ambient Temperature Indicator Raises:ValueError – if value is not a valid value Returns:the value of ambient_temperature_indicator or None if not set Return type:str

ambient_temperature_outdoor_air_node_name

field Ambient Temperature Outdoor Air Node Name

required for Ambient Temperature Indicator=Outdoors

Parameters:value (str) – value for IDD Field Ambient Temperature Outdoor Air Node Name Raises:ValueError – if value is not a valid value Returns:the value of ambient_temperature_outdoor_air_node_name or None if not set Return type:str

ambient_temperature_schedule_name

field Ambient Temperature Schedule Name

Parameters:value (str) – value for IDD Field Ambient Temperature Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of ambient_temperature_schedule_name or None if not set Return type:str

ambient_temperature_zone_name

field Ambient Temperature Zone Name

Parameters:value (str) – value for IDD Field Ambient Temperature Zone Name Raises:ValueError – if value is not a valid value Returns:the value of ambient_temperature_zone_name or None if not set Return type:str

cold_water_supply_temperature_schedule_name

field Cold Water Supply Temperature Schedule Name

Only used if Use Side Node connections are blank

Defaults to water temperatures calculated by Site:WaterMainsTemperature object

Parameters:value (str) – value for IDD Field Cold Water Supply Temperature Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of cold_water_supply_temperature_schedule_name or None if not set Return type:str

deadband_temperature_difference

field Deadband Temperature Difference

Units: deltaC

Parameters:value (float) – value for IDD Field Deadband Temperature Difference Raises:ValueError – if value is not a valid value Returns:the value of deadband_temperature_difference or None if not set Return type:float

heater_control_type

field Heater Control Type

Default value: Cycle

Parameters:value (str) – value for IDD Field Heater Control Type Raises:ValueError – if value is not a valid value Returns:the value of heater_control_type or None if not set Return type:str

heater_fuel_type

field Heater Fuel Type

Parameters:value (str) – value for IDD Field Heater Fuel Type Raises:ValueError – if value is not a valid value Returns:the value of heater_fuel_type or None if not set Return type:str

heater_ignition_delay

field Heater Ignition Delay

Not yet implemented

Units: s

Parameters:value (float) – value for IDD Field Heater Ignition Delay Raises:ValueError – if value is not a valid value Returns:the value of heater_ignition_delay or None if not set Return type:float

heater_ignition_minimum_flow_rate

field Heater Ignition Minimum Flow Rate

Not yet implemented

Units: m3/s

Parameters:value (float) – value for IDD Field Heater Ignition Minimum Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of heater_ignition_minimum_flow_rate or None if not set Return type:float

heater_maximum_capacity

field Heater Maximum Capacity

Units: W

Parameters:value (float or “Autosize”) – value for IDD Field Heater Maximum Capacity Raises:ValueError – if value is not a valid value Returns:the value of heater_maximum_capacity or None if not set Return type:float or “Autosize”

heater_minimum_capacity

field Heater Minimum Capacity

Only used when Heater Control Type is set to Modulate

Units: W

Parameters:value (float) – value for IDD Field Heater Minimum Capacity Raises:ValueError – if value is not a valid value Returns:the value of heater_minimum_capacity or None if not set Return type:float

heater_thermal_efficiency

field Heater Thermal Efficiency

value <= 1.0

Parameters:value (float) – value for IDD Field Heater Thermal Efficiency Raises:ValueError – if value is not a valid value Returns:the value of heater_thermal_efficiency or None if not set Return type:float

indirect_alternate_setpoint_temperature_schedule_name

field Indirect Alternate Setpoint Temperature Schedule Name

This field is only used if the previous is set to IndirectHeatAlternateSetpoint

Parameters:value (str) – value for IDD Field Indirect Alternate Setpoint Temperature Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of indirect_alternate_setpoint_temperature_schedule_name or None if not set Return type:str

indirect_water_heating_recovery_time

field Indirect Water Heating Recovery Time

Parameter for autosizing design flow rates for indirectly heated water tanks

Time required to raise temperature of entire tank from 14.4C to 57.2C

Units: hr

Default value: 1.5

Parameters:value (float) – value for IDD Field Indirect Water Heating Recovery Time Raises:ValueError – if value is not a valid value Returns:the value of indirect_water_heating_recovery_time or None if not set Return type:float

maximum_temperature_limit

field Maximum Temperature Limit

Units: C

Parameters:value (float) – value for IDD Field Maximum Temperature Limit Raises:ValueError – if value is not a valid value Returns:the value of maximum_temperature_limit or None if not set Return type:float

name

field Name

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

off_cycle_loss_coefficient_to_ambient_temperature

field Off Cycle Loss Coefficient to Ambient Temperature

Units: W/K

Parameters:value (float) – value for IDD Field Off Cycle Loss Coefficient to Ambient Temperature Raises:ValueError – if value is not a valid value Returns:the value of off_cycle_loss_coefficient_to_ambient_temperature or None if not set Return type:float

off_cycle_loss_fraction_to_zone

field Off Cycle Loss Fraction to Zone

Default value: 1.0

value <= 1.0

Parameters:value (float) – value for IDD Field Off Cycle Loss Fraction to Zone Raises:ValueError – if value is not a valid value Returns:the value of off_cycle_loss_fraction_to_zone or None if not set Return type:float

off_cycle_parasitic_fuel_consumption_rate

field Off Cycle Parasitic Fuel Consumption Rate

Units: W

Parameters:value (float) – value for IDD Field Off Cycle Parasitic Fuel Consumption Rate Raises:ValueError – if value is not a valid value Returns:the value of off_cycle_parasitic_fuel_consumption_rate or None if not set Return type:float

off_cycle_parasitic_fuel_type

field Off Cycle Parasitic Fuel Type

Parameters:value (str) – value for IDD Field Off Cycle Parasitic Fuel Type Raises:ValueError – if value is not a valid value Returns:the value of off_cycle_parasitic_fuel_type or None if not set Return type:str

off_cycle_parasitic_heat_fraction_to_tank

field Off Cycle Parasitic Heat Fraction to Tank

value <= 1.0

Parameters:value (float) – value for IDD Field Off Cycle Parasitic Heat Fraction to Tank Raises:ValueError – if value is not a valid value Returns:the value of off_cycle_parasitic_heat_fraction_to_tank or None if not set Return type:float

on_cycle_loss_coefficient_to_ambient_temperature

field On Cycle Loss Coefficient to Ambient Temperature

Units: W/K

Parameters:value (float) – value for IDD Field On Cycle Loss Coefficient to Ambient Temperature Raises:ValueError – if value is not a valid value Returns:the value of on_cycle_loss_coefficient_to_ambient_temperature or None if not set Return type:float

on_cycle_loss_fraction_to_zone

field On Cycle Loss Fraction to Zone

Default value: 1.0

value <= 1.0

Parameters:value (float) – value for IDD Field On Cycle Loss Fraction to Zone Raises:ValueError – if value is not a valid value Returns:the value of on_cycle_loss_fraction_to_zone or None if not set Return type:float

on_cycle_parasitic_fuel_consumption_rate

field On Cycle Parasitic Fuel Consumption Rate

Units: W

Parameters:value (float) – value for IDD Field On Cycle Parasitic Fuel Consumption Rate Raises:ValueError – if value is not a valid value Returns:the value of on_cycle_parasitic_fuel_consumption_rate or None if not set Return type:float

on_cycle_parasitic_fuel_type

field On Cycle Parasitic Fuel Type

Parameters:value (str) – value for IDD Field On Cycle Parasitic Fuel Type Raises:ValueError – if value is not a valid value Returns:the value of on_cycle_parasitic_fuel_type or None if not set Return type:str

on_cycle_parasitic_heat_fraction_to_tank

field On Cycle Parasitic Heat Fraction to Tank

value <= 1.0

Parameters:value (float) – value for IDD Field On Cycle Parasitic Heat Fraction to Tank Raises:ValueError – if value is not a valid value Returns:the value of on_cycle_parasitic_heat_fraction_to_tank or None if not set Return type:float

part_load_factor_curve_name

field Part Load Factor Curve Name

Parameters:value (str) – value for IDD Field Part Load Factor Curve Name Raises:ValueError – if value is not a valid value Returns:the value of part_load_factor_curve_name or None if not set Return type:str

peak_use_flow_rate

field Peak Use Flow Rate

Only used if Use Side Node connections are blank

Units: m3/s

IP-Units: gal/min

Parameters:value (float) – value for IDD Field Peak Use Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of peak_use_flow_rate or None if not set Return type:float

setpoint_temperature_schedule_name

field Setpoint Temperature Schedule Name

Parameters:value (str) – value for IDD Field Setpoint Temperature Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of setpoint_temperature_schedule_name or None if not set Return type:str

source_side_design_flow_rate

field Source Side Design Flow Rate

Units: m3/s

IP-Units: gal/min

Default value: “autosize”

Parameters:value (float or “Autosize”) – value for IDD Field Source Side Design Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of source_side_design_flow_rate or None if not set Return type:float or “Autosize”

source_side_effectiveness

field Source Side Effectiveness

Default value: 1.0

value <= 1.0

Parameters:value (float) – value for IDD Field Source Side Effectiveness Raises:ValueError – if value is not a valid value Returns:the value of source_side_effectiveness or None if not set Return type:float

source_side_flow_control_mode

field Source Side Flow Control Mode

StorageTank mode always requests flow unless tank is at its Maximum Temperature Limit

IndirectHeatPrimarySetpoint mode requests flow whenever primary setpoint calls for heat

IndirectHeatAlternateSetpoint mode requests flow whenever alternate indirect setpoint calls for heat

Default value: IndirectHeatPrimarySetpoint

Parameters:value (str) – value for IDD Field Source Side Flow Control Mode Raises:ValueError – if value is not a valid value Returns:the value of source_side_flow_control_mode or None if not set Return type:str

source_side_inlet_node_name

field Source Side Inlet Node Name

Parameters:value (str) – value for IDD Field Source Side Inlet Node Name Raises:ValueError – if value is not a valid value Returns:the value of source_side_inlet_node_name or None if not set Return type:str

source_side_outlet_node_name

field Source Side Outlet Node Name

Parameters:value (str) – value for IDD Field Source Side Outlet Node Name Raises:ValueError – if value is not a valid value Returns:the value of source_side_outlet_node_name or None if not set Return type:str

tank_volume

field Tank Volume

Units: m3

IP-Units: gal

Parameters:value (float or “Autosize”) – value for IDD Field Tank Volume Raises:ValueError – if value is not a valid value Returns:the value of tank_volume or None if not set Return type:float or “Autosize”

use_flow_rate_fraction_schedule_name

field Use Flow Rate Fraction Schedule Name

Only used if Use Side Node connections are blank

Parameters:value (str) – value for IDD Field Use Flow Rate Fraction Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of use_flow_rate_fraction_schedule_name or None if not set Return type:str

use_side_design_flow_rate

field Use Side Design Flow Rate

Units: m3/s

IP-Units: gal/min

Default value: “autosize”

Parameters:value (float or “Autosize”) – value for IDD Field Use Side Design Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of use_side_design_flow_rate or None if not set Return type:float or “Autosize”

use_side_effectiveness

field Use Side Effectiveness

Default value: 1.0

value <= 1.0

Parameters:value (float) – value for IDD Field Use Side Effectiveness Raises:ValueError – if value is not a valid value Returns:the value of use_side_effectiveness or None if not set Return type:float

use_side_inlet_node_name

field Use Side Inlet Node Name

Parameters:value (str) – value for IDD Field Use Side Inlet Node Name Raises:ValueError – if value is not a valid value Returns:the value of use_side_inlet_node_name or None if not set Return type:str

use_side_outlet_node_name

field Use Side Outlet Node Name

Parameters:value (str) – value for IDD Field Use Side Outlet Node Name Raises:ValueError – if value is not a valid value Returns:the value of use_side_outlet_node_name or None if not set Return type:str

class pyidf.water_heaters_and_thermal_storage.WaterHeaterSizing

Bases: pyidf.helper.DataObject

Corresponds to IDD object WaterHeater:Sizing This input object is used with WaterHeater:Mixed or with WaterHeater:Stratified to autosize tank volume and heater capacity This object is not needed if water heaters are not autosized.

design_mode

field Design Mode

Parameters:value (str) – value for IDD Field Design Mode Raises:ValueError – if value is not a valid value Returns:the value of design_mode or None if not set Return type:str

height_aspect_ratio

field Height Aspect Ratio

only used if for WaterHeater:Stratified

Parameters:value (float) – value for IDD Field Height Aspect Ratio Raises:ValueError – if value is not a valid value Returns:the value of height_aspect_ratio or None if not set Return type:float

nominal_tank_volume_for_autosizing_plant_connections

field Nominal Tank Volume for Autosizing Plant Connections

Only used if Design Mode = PeakDraw and the water heater also

has autosized flow rates for connections on the demand side of a plant loop

Units: m3

Parameters:value (float) – value for IDD Field Nominal Tank Volume for Autosizing Plant Connections Raises:ValueError – if value is not a valid value Returns:the value of nominal_tank_volume_for_autosizing_plant_connections or None if not set Return type:float

number_of_bathrooms

field Number of Bathrooms

Only used for Design Mode = ResidentialHUD-FHAMinimum

value >= 1

Parameters:value (int) – value for IDD Field Number of Bathrooms Raises:ValueError – if value is not a valid value Returns:the value of number_of_bathrooms or None if not set Return type:int

number_of_bedrooms

field Number of Bedrooms

Only used for Design Mode = ResidentialHUD-FHAMinimum

value >= 1

Parameters:value (int) – value for IDD Field Number of Bedrooms Raises:ValueError – if value is not a valid value Returns:the value of number_of_bedrooms or None if not set Return type:int

number_of_units

field Number of Units

Only used for Design Mode = PerUnit

Parameters:value (float) – value for IDD Field Number of Units Raises:ValueError – if value is not a valid value Returns:the value of number_of_units or None if not set Return type:float

recovery_capacity_per_floor_area

field Recovery Capacity per Floor Area

Only used for Design Mode = PerFloorArea

Units: m3/hr-m2

Parameters:value (float) – value for IDD Field Recovery Capacity per Floor Area Raises:ValueError – if value is not a valid value Returns:the value of recovery_capacity_per_floor_area or None if not set Return type:float

recovery_capacity_per_person

field Recovery Capacity per Person

Only used for Design Mode = PerPerson

Units: m3/hr-person

Parameters:value (float) – value for IDD Field Recovery Capacity per Person Raises:ValueError – if value is not a valid value Returns:the value of recovery_capacity_per_person or None if not set Return type:float

recovery_capacity_perunit

field Recovery Capacity PerUnit

Only used for Design Mode = PerUnit

Units: m3/hr

Parameters:value (float) – value for IDD Field Recovery Capacity PerUnit Raises:ValueError – if value is not a valid value Returns:the value of recovery_capacity_perunit or None if not set Return type:float

storage_capacity_per_collector_area

field Storage Capacity per Collector Area

Only used for Design Mode = PerSolarCollectorArea

Units: m3/m2

Parameters:value (float) – value for IDD Field Storage Capacity per Collector Area Raises:ValueError – if value is not a valid value Returns:the value of storage_capacity_per_collector_area or None if not set Return type:float

storage_capacity_per_floor_area

field Storage Capacity per Floor Area

Only used for Design Mode = PerFloorArea

Units: m3/m2

Parameters:value (float) – value for IDD Field Storage Capacity per Floor Area Raises:ValueError – if value is not a valid value Returns:the value of storage_capacity_per_floor_area or None if not set Return type:float

storage_capacity_per_person

field Storage Capacity per Person

Only used for Design Mode = PerPerson

Units: m3/Person

Parameters:value (float) – value for IDD Field Storage Capacity per Person Raises:ValueError – if value is not a valid value Returns:the value of storage_capacity_per_person or None if not set Return type:float

storage_capacity_per_unit

field Storage Capacity per Unit

Only used for Design Mode = PerUnit

Units: m3

Parameters:value (float) – value for IDD Field Storage Capacity per Unit Raises:ValueError – if value is not a valid value Returns:the value of storage_capacity_per_unit or None if not set Return type:float

time_for_tank_recovery

field Time for Tank Recovery

Only used for Design Mode = PeakDraw

Units: hr

Parameters:value (float) – value for IDD Field Time for Tank Recovery Raises:ValueError – if value is not a valid value Returns:the value of time_for_tank_recovery or None if not set Return type:float

time_storage_can_meet_peak_draw

field Time Storage Can Meet Peak Draw

Only used for Design Mode = PeakDraw

Units: hr

Parameters:value (float) – value for IDD Field Time Storage Can Meet Peak Draw Raises:ValueError – if value is not a valid value Returns:the value of time_storage_can_meet_peak_draw or None if not set Return type:float

waterheater_name

field WaterHeater Name

Parameters:value (str) – value for IDD Field WaterHeater Name Raises:ValueError – if value is not a valid value Returns:the value of waterheater_name or None if not set Return type:str

class pyidf.water_heaters_and_thermal_storage.WaterHeaterStratified

Bases: pyidf.helper.DataObject

Corresponds to IDD object WaterHeater:Stratified Water heater with stratified, multi-node water tank. May be used to model a tankless water heater (small tank volume), a hot water storage tank (zero heater capacity), or a heat pump water heater (see WaterHeater:HeatPump:*.)

additional_destratification_conductivity

field Additional Destratification Conductivity

Units: W/m-K

Parameters:value (float) – value for IDD Field Additional Destratification Conductivity Raises:ValueError – if value is not a valid value Returns:the value of additional_destratification_conductivity or None if not set Return type:float

ambient_temperature_indicator

field Ambient Temperature Indicator

Parameters:value (str) – value for IDD Field Ambient Temperature Indicator Raises:ValueError – if value is not a valid value Returns:the value of ambient_temperature_indicator or None if not set Return type:str

ambient_temperature_outdoor_air_node_name

field Ambient Temperature Outdoor Air Node Name

required for Ambient Temperature Indicator=Outdoors

Parameters:value (str) – value for IDD Field Ambient Temperature Outdoor Air Node Name Raises:ValueError – if value is not a valid value Returns:the value of ambient_temperature_outdoor_air_node_name or None if not set Return type:str

ambient_temperature_schedule_name

field Ambient Temperature Schedule Name

Parameters:value (str) – value for IDD Field Ambient Temperature Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of ambient_temperature_schedule_name or None if not set Return type:str

ambient_temperature_zone_name

field Ambient Temperature Zone Name

Parameters:value (str) – value for IDD Field Ambient Temperature Zone Name Raises:ValueError – if value is not a valid value Returns:the value of ambient_temperature_zone_name or None if not set Return type:str

cold_water_supply_temperature_schedule_name

field Cold Water Supply Temperature Schedule Name

Only used if use side node connections are blank

Defaults to water temperatures calculated by Site:WaterMainsTemperature object

Parameters:value (str) – value for IDD Field Cold Water Supply Temperature Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of cold_water_supply_temperature_schedule_name or None if not set Return type:str

enduse_subcategory

field End-Use Subcategory

Default value: General

Parameters:value (str) – value for IDD Field End-Use Subcategory Raises:ValueError – if value is not a valid value Returns:the value of enduse_subcategory or None if not set Return type:str

heater_1_capacity

field Heater 1 Capacity

Units: W

Parameters:value (float or “Autosize”) – value for IDD Field Heater 1 Capacity Raises:ValueError – if value is not a valid value Returns:the value of heater_1_capacity or None if not set Return type:float or “Autosize”

heater_1_deadband_temperature_difference

field Heater 1 Deadband Temperature Difference

Units: deltaC

Parameters:value (float) – value for IDD Field Heater 1 Deadband Temperature Difference Raises:ValueError – if value is not a valid value Returns:the value of heater_1_deadband_temperature_difference or None if not set Return type:float

heater_1_height

field Heater 1 Height

Units: m

Parameters:value (float) – value for IDD Field Heater 1 Height Raises:ValueError – if value is not a valid value Returns:the value of heater_1_height or None if not set Return type:float

heater_1_setpoint_temperature_schedule_name

field Heater 1 Setpoint Temperature Schedule Name

Parameters:value (str) – value for IDD Field Heater 1 Setpoint Temperature Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of heater_1_setpoint_temperature_schedule_name or None if not set Return type:str

heater_2_capacity

field Heater 2 Capacity

Units: W

Parameters:value (float) – value for IDD Field Heater 2 Capacity Raises:ValueError – if value is not a valid value Returns:the value of heater_2_capacity or None if not set Return type:float

heater_2_deadband_temperature_difference

field Heater 2 Deadband Temperature Difference

Units: deltaC

Parameters:value (float) – value for IDD Field Heater 2 Deadband Temperature Difference Raises:ValueError – if value is not a valid value Returns:the value of heater_2_deadband_temperature_difference or None if not set Return type:float

heater_2_height

field Heater 2 Height

Units: m

Parameters:value (float) – value for IDD Field Heater 2 Height Raises:ValueError – if value is not a valid value Returns:the value of heater_2_height or None if not set Return type:float

heater_2_setpoint_temperature_schedule_name

field Heater 2 Setpoint Temperature Schedule Name

Parameters:value (str) – value for IDD Field Heater 2 Setpoint Temperature Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of heater_2_setpoint_temperature_schedule_name or None if not set Return type:str

heater_fuel_type

field Heater Fuel Type

Parameters:value (str) – value for IDD Field Heater Fuel Type Raises:ValueError – if value is not a valid value Returns:the value of heater_fuel_type or None if not set Return type:str

heater_priority_control

field Heater Priority Control

Default value: MasterSlave

Parameters:value (str) – value for IDD Field Heater Priority Control Raises:ValueError – if value is not a valid value Returns:the value of heater_priority_control or None if not set Return type:str

heater_thermal_efficiency

field Heater Thermal Efficiency

value <= 1.0

Parameters:value (float) – value for IDD Field Heater Thermal Efficiency Raises:ValueError – if value is not a valid value Returns:the value of heater_thermal_efficiency or None if not set Return type:float

indirect_alternate_setpoint_temperature_schedule_name

field Indirect Alternate Setpoint Temperature Schedule Name

This field is only used if the previous is set to IndirectHeatAlternateSetpoint

Parameters:value (str) – value for IDD Field Indirect Alternate Setpoint Temperature Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of indirect_alternate_setpoint_temperature_schedule_name or None if not set Return type:str

indirect_water_heating_recovery_time

field Indirect Water Heating Recovery Time

Parameter for autosizing design flow rates for indirectly heated water tanks

time required to raise temperature of entire tank from 14.4C to 57.2C

Units: hr

Default value: 1.5

Parameters:value (float) – value for IDD Field Indirect Water Heating Recovery Time Raises:ValueError – if value is not a valid value Returns:the value of indirect_water_heating_recovery_time or None if not set Return type:float

inlet_mode

field Inlet Mode

Default value: Fixed

Parameters:value (str) – value for IDD Field Inlet Mode Raises:ValueError – if value is not a valid value Returns:the value of inlet_mode or None if not set Return type:str

maximum_temperature_limit

field Maximum Temperature Limit

Units: C

Parameters:value (float) – value for IDD Field Maximum Temperature Limit Raises:ValueError – if value is not a valid value Returns:the value of maximum_temperature_limit or None if not set Return type:float

name

field Name

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

node_10_additional_loss_coefficient

field Node 10 Additional Loss Coefficient

Units: W/K

Parameters:value (float) – value for IDD Field Node 10 Additional Loss Coefficient Raises:ValueError – if value is not a valid value Returns:the value of node_10_additional_loss_coefficient or None if not set Return type:float

node_11_additional_loss_coefficient

field Node 11 Additional Loss Coefficient

Units: W/K

Parameters:value (float) – value for IDD Field Node 11 Additional Loss Coefficient Raises:ValueError – if value is not a valid value Returns:the value of node_11_additional_loss_coefficient or None if not set Return type:float

node_12_additional_loss_coefficient

field Node 12 Additional Loss Coefficient

Units: W/K

Parameters:value (float) – value for IDD Field Node 12 Additional Loss Coefficient Raises:ValueError – if value is not a valid value Returns:the value of node_12_additional_loss_coefficient or None if not set Return type:float

node_1_additional_loss_coefficient

field Node 1 Additional Loss Coefficient

Units: W/K

Parameters:value (float) – value for IDD Field Node 1 Additional Loss Coefficient Raises:ValueError – if value is not a valid value Returns:the value of node_1_additional_loss_coefficient or None if not set Return type:float

node_2_additional_loss_coefficient

field Node 2 Additional Loss Coefficient

Units: W/K

Parameters:value (float) – value for IDD Field Node 2 Additional Loss Coefficient Raises:ValueError – if value is not a valid value Returns:the value of node_2_additional_loss_coefficient or None if not set Return type:float

node_3_additional_loss_coefficient

field Node 3 Additional Loss Coefficient

Units: W/K

Parameters:value (float) – value for IDD Field Node 3 Additional Loss Coefficient Raises:ValueError – if value is not a valid value Returns:the value of node_3_additional_loss_coefficient or None if not set Return type:float

node_4_additional_loss_coefficient

field Node 4 Additional Loss Coefficient

Units: W/K

Parameters:value (float) – value for IDD Field Node 4 Additional Loss Coefficient Raises:ValueError – if value is not a valid value Returns:the value of node_4_additional_loss_coefficient or None if not set Return type:float

node_5_additional_loss_coefficient

field Node 5 Additional Loss Coefficient

Units: W/K

Parameters:value (float) – value for IDD Field Node 5 Additional Loss Coefficient Raises:ValueError – if value is not a valid value Returns:the value of node_5_additional_loss_coefficient or None if not set Return type:float

node_6_additional_loss_coefficient

field Node 6 Additional Loss Coefficient

Units: W/K

Parameters:value (float) – value for IDD Field Node 6 Additional Loss Coefficient Raises:ValueError – if value is not a valid value Returns:the value of node_6_additional_loss_coefficient or None if not set Return type:float

node_7_additional_loss_coefficient

field Node 7 Additional Loss Coefficient

Units: W/K

Parameters:value (float) – value for IDD Field Node 7 Additional Loss Coefficient Raises:ValueError – if value is not a valid value Returns:the value of node_7_additional_loss_coefficient or None if not set Return type:float

node_8_additional_loss_coefficient

field Node 8 Additional Loss Coefficient

Units: W/K

Parameters:value (float) – value for IDD Field Node 8 Additional Loss Coefficient Raises:ValueError – if value is not a valid value Returns:the value of node_8_additional_loss_coefficient or None if not set Return type:float

node_9_additional_loss_coefficient

field Node 9 Additional Loss Coefficient

Units: W/K

Parameters:value (float) – value for IDD Field Node 9 Additional Loss Coefficient Raises:ValueError – if value is not a valid value Returns:the value of node_9_additional_loss_coefficient or None if not set Return type:float

number_of_nodes

field Number of Nodes

Default value: 1

value >= 1

value <= 12

Parameters:value (int) – value for IDD Field Number of Nodes Raises:ValueError – if value is not a valid value Returns:the value of number_of_nodes or None if not set Return type:int

off_cycle_flue_loss_coefficient_to_ambient_temperature

field Off Cycle Flue Loss Coefficient to Ambient Temperature

Units: W/K

Parameters:value (float) – value for IDD Field Off Cycle Flue Loss Coefficient to Ambient Temperature Raises:ValueError – if value is not a valid value Returns:the value of off_cycle_flue_loss_coefficient_to_ambient_temperature or None if not set Return type:float

off_cycle_flue_loss_fraction_to_zone

field Off Cycle Flue Loss Fraction to Zone

Default value: 1.0

value <= 1.0

Parameters:value (float) – value for IDD Field Off Cycle Flue Loss Fraction to Zone Raises:ValueError – if value is not a valid value Returns:the value of off_cycle_flue_loss_fraction_to_zone or None if not set Return type:float

off_cycle_parasitic_fuel_consumption_rate

field Off Cycle Parasitic Fuel Consumption Rate

Units: W

Parameters:value (float) – value for IDD Field Off Cycle Parasitic Fuel Consumption Rate Raises:ValueError – if value is not a valid value Returns:the value of off_cycle_parasitic_fuel_consumption_rate or None if not set Return type:float

off_cycle_parasitic_fuel_type

field Off Cycle Parasitic Fuel Type

Parameters:value (str) – value for IDD Field Off Cycle Parasitic Fuel Type Raises:ValueError – if value is not a valid value Returns:the value of off_cycle_parasitic_fuel_type or None if not set Return type:str

off_cycle_parasitic_heat_fraction_to_tank

field Off Cycle Parasitic Heat Fraction to Tank

value <= 1.0

Parameters:value (float) – value for IDD Field Off Cycle Parasitic Heat Fraction to Tank Raises:ValueError – if value is not a valid value Returns:the value of off_cycle_parasitic_heat_fraction_to_tank or None if not set Return type:float

off_cycle_parasitic_height

field Off Cycle Parasitic Height

Units: m

Parameters:value (float) – value for IDD Field Off Cycle Parasitic Height Raises:ValueError – if value is not a valid value Returns:the value of off_cycle_parasitic_height or None if not set Return type:float

on_cycle_parasitic_fuel_consumption_rate

field On Cycle Parasitic Fuel Consumption Rate

Units: W

Parameters:value (float) – value for IDD Field On Cycle Parasitic Fuel Consumption Rate Raises:ValueError – if value is not a valid value Returns:the value of on_cycle_parasitic_fuel_consumption_rate or None if not set Return type:float

on_cycle_parasitic_fuel_type

field On Cycle Parasitic Fuel Type

Parameters:value (str) – value for IDD Field On Cycle Parasitic Fuel Type Raises:ValueError – if value is not a valid value Returns:the value of on_cycle_parasitic_fuel_type or None if not set Return type:str

on_cycle_parasitic_heat_fraction_to_tank

field On Cycle Parasitic Heat Fraction to Tank

value <= 1.0

Parameters:value (float) – value for IDD Field On Cycle Parasitic Heat Fraction to Tank Raises:ValueError – if value is not a valid value Returns:the value of on_cycle_parasitic_heat_fraction_to_tank or None if not set Return type:float

on_cycle_parasitic_height

field On Cycle Parasitic Height

Units: m

Parameters:value (float) – value for IDD Field On Cycle Parasitic Height Raises:ValueError – if value is not a valid value Returns:the value of on_cycle_parasitic_height or None if not set Return type:float

peak_use_flow_rate

field Peak Use Flow Rate

Only used if Use Side Node connections are blank

Units: m3/s

IP-Units: gal/min

Parameters:value (float) – value for IDD Field Peak Use Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of peak_use_flow_rate or None if not set Return type:float

skin_loss_fraction_to_zone

field Skin Loss Fraction to Zone

Default value: 1.0

value <= 1.0

Parameters:value (float) – value for IDD Field Skin Loss Fraction to Zone Raises:ValueError – if value is not a valid value Returns:the value of skin_loss_fraction_to_zone or None if not set Return type:float

source_side_design_flow_rate

field Source Side Design Flow Rate

Units: m3/s

IP-Units: gal/min

Default value: “autosize”

Parameters:value (float or “Autosize”) – value for IDD Field Source Side Design Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of source_side_design_flow_rate or None if not set Return type:float or “Autosize”

source_side_effectiveness

field Source Side Effectiveness

The source side effectiveness in the stratified tank model is a simplified analogy of

a heat exchanger’s effectiveness. This effectiveness is equal to the fraction of

source mass flow rate that directly mixes with the tank fluid. And one minus the

effectiveness is the fraction that bypasses the tank. The source side mass flow rate

that bypasses the tank is mixed with the fluid or water leaving the stratified tank.

Default value: 1.0

value <= 1.0

Parameters:value (float) – value for IDD Field Source Side Effectiveness Raises:ValueError – if value is not a valid value Returns:the value of source_side_effectiveness or None if not set Return type:float

source_side_flow_control_mode

field Source Side Flow Control Mode

StorageTank mode always requests flow unless tank is at its Maximum Temperature Limit

IndirectHeatPrimarySetpoint mode requests flow whenever primary setpoint for heater 1 calls for heat

IndirectHeatAlternateSetpoint mode requests flow whenever alternate indirect setpoint calls for heat

Default value: IndirectHeatPrimarySetpoint

Parameters:value (str) – value for IDD Field Source Side Flow Control Mode Raises:ValueError – if value is not a valid value Returns:the value of source_side_flow_control_mode or None if not set Return type:str

source_side_inlet_height

field Source Side Inlet Height

Defaults to top of tank

Units: m

Default value: “Autocalculate”

Parameters:value (float or “Autocalculate”) – value for IDD Field Source Side Inlet Height Raises:ValueError – if value is not a valid value Returns:the value of source_side_inlet_height or None if not set Return type:float or “Autocalculate”

source_side_inlet_node_name

field Source Side Inlet Node Name

Parameters:value (str) – value for IDD Field Source Side Inlet Node Name Raises:ValueError – if value is not a valid value Returns:the value of source_side_inlet_node_name or None if not set Return type:str

source_side_outlet_height

field Source Side Outlet Height

Defaults to bottom of tank

Units: m

Parameters:value (float) – value for IDD Field Source Side Outlet Height Raises:ValueError – if value is not a valid value Returns:the value of source_side_outlet_height or None if not set Return type:float

source_side_outlet_node_name

field Source Side Outlet Node Name

Parameters:value (str) – value for IDD Field Source Side Outlet Node Name Raises:ValueError – if value is not a valid value Returns:the value of source_side_outlet_node_name or None if not set Return type:str

tank_height

field Tank Height

Height is measured in the axial direction for horizontal cylinders

Units: m

Parameters:value (float or “Autosize”) – value for IDD Field Tank Height Raises:ValueError – if value is not a valid value Returns:the value of tank_height or None if not set Return type:float or “Autosize”

tank_perimeter

field Tank Perimeter

Only used if Tank Shape is Other

Units: m

Parameters:value (float) – value for IDD Field Tank Perimeter Raises:ValueError – if value is not a valid value Returns:the value of tank_perimeter or None if not set Return type:float

tank_shape

field Tank Shape

Default value: VerticalCylinder

Parameters:value (str) – value for IDD Field Tank Shape Raises:ValueError – if value is not a valid value Returns:the value of tank_shape or None if not set Return type:str

tank_volume

field Tank Volume

Units: m3

IP-Units: gal

Parameters:value (float or “Autosize”) – value for IDD Field Tank Volume Raises:ValueError – if value is not a valid value Returns:the value of tank_volume or None if not set Return type:float or “Autosize”

uniform_skin_loss_coefficient_per_unit_area_to_ambient_temperature

field Uniform Skin Loss Coefficient per Unit Area to Ambient Temperature

Units: W/m2-K

Parameters:value (float) – value for IDD Field Uniform Skin Loss Coefficient per Unit Area to Ambient Temperature Raises:ValueError – if value is not a valid value Returns:the value of uniform_skin_loss_coefficient_per_unit_area_to_ambient_temperature or None if not set Return type:float

use_flow_rate_fraction_schedule_name

field Use Flow Rate Fraction Schedule Name

If blank, defaults to 1.0 at all times

Only used if use side node connections are blank

Parameters:value (str) – value for IDD Field Use Flow Rate Fraction Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of use_flow_rate_fraction_schedule_name or None if not set Return type:str

use_side_design_flow_rate

field Use Side Design Flow Rate

Units: m3/s

IP-Units: gal/min

Default value: “autosize”

Parameters:value (float or “Autosize”) – value for IDD Field Use Side Design Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of use_side_design_flow_rate or None if not set Return type:float or “Autosize”

use_side_effectiveness

field Use Side Effectiveness

The use side effectiveness in the stratified tank model is a simplified analogy of

a heat exchanger’s effectiveness. This effectiveness is equal to the fraction of

use mass flow rate that directly mixes with the tank fluid. And one minus the

effectiveness is the fraction that bypasses the tank. The use side mass flow rate

that bypasses the tank is mixed with the fluid or water leaving the stratified tank.

Default value: 1.0

value <= 1.0

Parameters:value (float) – value for IDD Field Use Side Effectiveness Raises:ValueError – if value is not a valid value Returns:the value of use_side_effectiveness or None if not set Return type:float

use_side_inlet_height

field Use Side Inlet Height

Defaults to bottom of tank

Units: m

Parameters:value (float) – value for IDD Field Use Side Inlet Height Raises:ValueError – if value is not a valid value Returns:the value of use_side_inlet_height or None if not set Return type:float

use_side_inlet_node_name

field Use Side Inlet Node Name

Parameters:value (str) – value for IDD Field Use Side Inlet Node Name Raises:ValueError – if value is not a valid value Returns:the value of use_side_inlet_node_name or None if not set Return type:str

use_side_outlet_height

field Use Side Outlet Height

Defaults to top of tank

Units: m

Default value: “Autocalculate”

Parameters:value (float or “Autocalculate”) – value for IDD Field Use Side Outlet Height Raises:ValueError – if value is not a valid value Returns:the value of use_side_outlet_height or None if not set Return type:float or “Autocalculate”

use_side_outlet_node_name

field Use Side Outlet Node Name

Parameters:value (str) – value for IDD Field Use Side Outlet Node Name Raises:ValueError – if value is not a valid value Returns:the value of use_side_outlet_node_name or None if not set Return type:str