Water Heaters and Thermal Storage¶

12 object types from idfpy.models.water_heaters · EnergyPlus 26.2

Object	Summary
ThermalStorage:ChilledWater:Mixed	Chilled water storage with a well-mixed, single-node tank.
ThermalStorage:ChilledWater:Stratified	Chilled water storage with a stratified, multi-node tank.
ThermalStorage:HotWater:Stratified
ThermalStorage:Ice:Detailed	This input syntax is intended to describe a thermal storage system that includes smaller containers filled …
ThermalStorage:Ice:Simple	This ice storage model is a simplified model It requires a setpoint placed on the Chilled Water Side Outlet …
ThermalStorage:PCM	This thermal storage model is PCM-based It requires PCM material property connection In addition to the …
ThermalStorage:Sizing	Sizing information for thermal energy stoarge capacity.
WaterHeater:HeatPump:PumpedCondenser	This object models an air-source heat pump for water heating where the water is pumped out of the tank, …
WaterHeater:HeatPump:WrappedCondenser	This object models an air-source heat pump for water heating where the heating coil is wrapped around the …
WaterHeater:Mixed	Water heater with well-mixed, single-node water tank.
WaterHeater:Sizing	This input object is used with WaterHeater:Mixed or with WaterHeater:Stratified to autosize tank volume and …
WaterHeater:Stratified	Water heater with stratified, multi-node water tank.

ThermalStorage:ChilledWater:Mixed¶

from idfpy.models import ThermalStorageChilledWaterMixed

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.

Field	Type	Default	Details
`name` Name required	string
`tank_volume` Tank Volume	number m3	`0.1`	Range: > 0
`setpoint_temperature_schedule_name` Setpoint Temperature Schedule Name	reference		Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`deadband_temperature_difference` Deadband Temperature Difference	number deltaC	`0.5`	Range: > 0
`minimum_temperature_limit` Minimum Temperature Limit	number C
`nominal_cooling_capacity` Nominal Cooling Capacity	number W
`ambient_temperature_indicator` Ambient Temperature Indicator required	choice		One of `Outdoors`, `Schedule`, `Zone`
`ambient_temperature_schedule_name` Ambient Temperature Schedule Name	reference		Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`ambient_temperature_zone_name` Ambient Temperature Zone Name	reference		Names a Zone
`ambient_temperature_outdoor_air_node_name` Ambient Temperature Outdoor Air Node Name	string		required when field Ambient Temperature Indicator=Outdoors
`heat_gain_coefficient_from_ambient_temperature` Heat Gain Coefficient from Ambient Temperature	number W/K		Range: ≥ 0
`use_side_inlet_node_name` Use Side Inlet Node Name	string
`use_side_outlet_node_name` Use Side Outlet Node Name	string
`use_side_heat_transfer_effectiveness` Use Side Heat Transfer Effectiveness	number	`1.0`	Range: ≥ 0, ≤ 1
`use_side_availability_schedule_name` Use Side Availability Schedule Name	reference		Availability schedule name for use side. Schedule value > 0 means the system is available. If this field is blank, the system is always available. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`use_side_design_flow_rate` Use Side Design Flow Rate	number or `Autosize` m3/s	`Autosize`
`source_side_inlet_node_name` Source Side Inlet Node Name	string
`source_side_outlet_node_name` Source Side Outlet Node Name	string
`source_side_heat_transfer_effectiveness` Source Side Heat Transfer Effectiveness	number	`1.0`	Range: > 0, ≤ 1
`source_side_availability_schedule_name` Source Side Availability Schedule Name	reference		Availability schedule name for source side. Schedule value > 0 means the system is available. If this field is blank, the system is always available. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`source_side_design_flow_rate` Source Side Design Flow Rate	number or `Autosize` m3/s	`Autosize`
`tank_recovery_time` Tank Recovery Time	number hr	`4.0`	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 Range: > 0

Referenced by 5 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, Branch, CondenserEquipmentList, PlantEquipmentList, WaterHeater:Sizing

ThermalStorage:ChilledWater:Stratified¶

from idfpy.models import ThermalStorageChilledWaterStratified

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.

Field	Type	Default	Details
`name` Name required	string
`tank_volume` Tank Volume required	number m3		Range: > 0
`tank_height` Tank Height required	number m		Height is measured in the axial direction for horizontal cylinders Range: > 0
`tank_shape` Tank Shape	choice	`VerticalCylinder`	One of `HorizontalCylinder`, `Other`, `VerticalCylinder`
`tank_perimeter` Tank Perimeter	number m		Only used if Tank Shape is Other Range: ≥ 0
`setpoint_temperature_schedule_name` Setpoint Temperature Schedule Name	reference		Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`deadband_temperature_difference` Deadband Temperature Difference	number deltaC	`0.0001`	Range: ≥ 0.0001
`temperature_sensor_height` Temperature Sensor Height	number m		Range: ≥ 0
`minimum_temperature_limit` Minimum Temperature Limit	number C
`nominal_cooling_capacity` Nominal Cooling Capacity	number or `Autosize` W	`Autosize`
`ambient_temperature_indicator` Ambient Temperature Indicator required	choice		One of `Outdoors`, `Schedule`, `Zone`
`ambient_temperature_schedule_name` Ambient Temperature Schedule Name	reference		Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`ambient_temperature_zone_name` Ambient Temperature Zone Name	reference		Names a Zone
`ambient_temperature_outdoor_air_node_name` Ambient Temperature Outdoor Air Node Name	string		required for Ambient Temperature Indicator=Outdoors
`uniform_skin_loss_coefficient_per_unit_area_to_ambient_temperature` Uniform Skin Loss Coefficient per Unit Area to Ambient Temperature	number W/m2-K		Range: ≥ 0
`use_side_inlet_node_name` Use Side Inlet Node Name	string
`use_side_outlet_node_name` Use Side Outlet Node Name	string
`use_side_heat_transfer_effectiveness` Use Side Heat Transfer Effectiveness	number	`1.0`	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. Range: ≥ 0, ≤ 1
`use_side_availability_schedule_name` Use Side Availability Schedule Name	reference		Availability schedule name for use side. Schedule value > 0 means the system is available. If this field is blank, the system is always available. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`use_side_inlet_height` Use Side Inlet Height	number or `Autocalculate` m	`Autocalculate`	Defaults to top of tank
`use_side_outlet_height` Use Side Outlet Height	number m	`0.0`	Defaults to bottom of tank Range: ≥ 0
`use_side_design_flow_rate` Use Side Design Flow Rate	number or `Autosize` m3/s	`Autosize`
`source_side_inlet_node_name` Source Side Inlet Node Name	string
`source_side_outlet_node_name` Source Side Outlet Node Name	string
`source_side_heat_transfer_effectiveness` Source Side Heat Transfer Effectiveness	number	`1.0`	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. Range: > 0, ≤ 1
`source_side_availability_schedule_name` Source Side Availability Schedule Name	reference		Availability schedule name for use side. Schedule value > 0 means the system is available. If this field is blank, the system is always available. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`source_side_inlet_height` Source Side Inlet Height	number m	`0.0`	Defaults to bottom of tank Range: ≥ 0
`source_side_outlet_height` Source Side Outlet Height	number or `Autocalculate` m	`Autocalculate`	Defaults to top of tank
`source_side_design_flow_rate` Source Side Design Flow Rate	number or `Autosize` m3/s	`Autosize`
`tank_recovery_time` Tank Recovery Time	number hr	`4.0`	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 Range: > 0
`inlet_mode` Inlet Mode	choice	`Fixed`	One of `Fixed`, `Seeking`
`number_of_nodes` Number of Nodes	integer	`1`	Range: ≥ 1, ≤ 10
`additional_destratification_conductivity` Additional Destratification Conductivity	number W/m-K	`0.0`	Range: ≥ 0
`node_1_additional_loss_coefficient` Node 1 Additional Loss Coefficient	number W/K	`0.0`
`node_2_additional_loss_coefficient` Node 2 Additional Loss Coefficient	number W/K	`0.0`
`node_3_additional_loss_coefficient` Node 3 Additional Loss Coefficient	number W/K	`0.0`
`node_4_additional_loss_coefficient` Node 4 Additional Loss Coefficient	number W/K	`0.0`
`node_5_additional_loss_coefficient` Node 5 Additional Loss Coefficient	number W/K	`0.0`
`node_6_additional_loss_coefficient` Node 6 Additional Loss Coefficient	number W/K	`0.0`
`node_7_additional_loss_coefficient` Node 7 Additional Loss Coefficient	number W/K	`0.0`
`node_8_additional_loss_coefficient` Node 8 Additional Loss Coefficient	number W/K	`0.0`
`node_9_additional_loss_coefficient` Node 9 Additional Loss Coefficient	number W/K	`0.0`
`node_10_additional_loss_coefficient` Node 10 Additional Loss Coefficient	number W/K	`0.0`

Referenced by 5 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, Branch, CondenserEquipmentList, PlantEquipmentList, WaterHeater:Sizing

ThermalStorage:HotWater:Stratified¶

from idfpy.models import ThermalStorageHotWaterStratified

Field	Type	Default	Details
`name` Name required	string
`tank_volume` Tank Volume required	number m3		Range: > 0
`tank_height` Tank Height required	number m		Height is measured in the axial direction for horizontal cylinders Range: > 0
`tank_shape` Tank Shape	choice	`VerticalCylinder`	One of `HorizontalCylinder`, `Other`, `VerticalCylinder`
`tank_perimeter` Tank Perimeter	number m		Only used if Tank Shape is Other Range: ≥ 0
`top_setpoint_temperature_schedule_name` Top Setpoint Temperature Schedule Name	reference		Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`bottom_setpoint_temperature_schedule_name` Bottom Setpoint Temperature Schedule Name	reference		Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`deadband_temperature_difference` Deadband Temperature Difference	number deltaC	`0.0001`	Range: ≥ 0.0001
`top_temperature_sensor_height` Top Temperature Sensor Height	number m		Range: ≥ 0
`bottom_temperature_sensor_height` Bottom Temperature Sensor Height	number m		Range: ≥ 0
`maximum_temperature_limit` Maximum Temperature Limit	number C
`nominal_heating_capacity` Nominal Heating Capacity	number or `Autosize` W	`Autosize`
`ambient_temperature_indicator` Ambient Temperature Indicator required	choice		One of `Outdoors`, `Schedule`, `Zone`
`ambient_temperature_schedule_name` Ambient Temperature Schedule Name	reference		Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`ambient_temperature_zone_name` Ambient Temperature Zone Name	reference		Names a Zone
`ambient_temperature_outdoor_air_node_name` Ambient Temperature Outdoor Air Node Name	string		required for Ambient Temperature Indicator=Outdoors
`uniform_skin_loss_coefficient_per_unit_area_to_ambient_temperature` Uniform Skin Loss Coefficient per Unit Area to Ambient Temperature	number W/m2-K		Range: ≥ 0
`use_side_inlet_node_name` Use Side Inlet Node Name	string
`use_side_outlet_node_name` Use Side Outlet Node Name	string
`use_side_flow_direction_schedule` Use Side Flow Direction Schedule	string		allowed value is -1 and 1. When the value is 1, water flows in from the inlet and flows out from the outlet node. When the value is -1, water flows in from the outlet node and flows out from the inlet node (i.e. the flow direction is reversed)
`use_side_heat_transfer_effectiveness` Use Side Heat Transfer Effectiveness	number	`1.0`	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. Range: ≥ 0, ≤ 1
`use_side_availability_schedule_name` Use Side Availability Schedule Name	reference		Availability schedule name for use side. Schedule value > 0 means the system is available. If this field is blank, the system is always available. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`use_side_inlet_height` Use Side Inlet Height	number or `Autocalculate` m	`Autocalculate`	Defaults to top of tank
`use_side_outlet_height` Use Side Outlet Height	number m	`0.0`	Defaults to bottom of tank Range: ≥ 0
`use_side_design_flow_rate` Use Side Design Flow Rate	number or `Autosize` m3/s	`Autosize`
`source_side_inlet_node_name` Source Side Inlet Node Name	string
`source_side_outlet_node_name` Source Side Outlet Node Name	string
`source_side_flow_direction_schedule` Source Side Flow Direction Schedule	string		allowed value is -1 and 1. When the value is 1, water flows in from the inlet and flows out from the outlet node. When the value is -1, water flows in from the outlet node and flows out from the inlet node (i.e. the flow direction is reversed)
`source_side_heat_transfer_effectiveness` Source Side Heat Transfer Effectiveness	number	`1.0`	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. Range: > 0, ≤ 1
`source_side_availability_schedule_name` Source Side Availability Schedule Name	reference		Availability schedule name for use side. Schedule value > 0 means the system is available. If this field is blank, the system is always available. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`source_side_inlet_height` Source Side Inlet Height	number m	`0.0`	Defaults to bottom of tank Range: ≥ 0
`source_side_outlet_height` Source Side Outlet Height	number or `Autocalculate` m	`Autocalculate`	Defaults to top of tank
`source_side_design_flow_rate` Source Side Design Flow Rate	number or `Autosize` m3/s	`Autosize`
`tank_recovery_time` Tank Recovery Time	number hr	`4.0`	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 Range: > 0
`inlet_mode` Inlet Mode	choice	`Fixed`	One of `Fixed`, `Seeking`
`number_of_nodes` Number of Nodes	integer	`1`	Range: ≥ 1, ≤ 10
`additional_destratification_conductivity` Additional Destratification Conductivity	number W/m-K	`0.0`	Range: ≥ 0
`node_1_additional_loss_coefficient` Node 1 Additional Loss Coefficient	number W/K	`0.0`
`node_2_additional_loss_coefficient` Node 2 Additional Loss Coefficient	number W/K	`0.0`
`node_3_additional_loss_coefficient` Node 3 Additional Loss Coefficient	number W/K	`0.0`
`node_4_additional_loss_coefficient` Node 4 Additional Loss Coefficient	number W/K	`0.0`
`node_5_additional_loss_coefficient` Node 5 Additional Loss Coefficient	number W/K	`0.0`
`node_6_additional_loss_coefficient` Node 6 Additional Loss Coefficient	number W/K	`0.0`
`node_7_additional_loss_coefficient` Node 7 Additional Loss Coefficient	number W/K	`0.0`
`node_8_additional_loss_coefficient` Node 8 Additional Loss Coefficient	number W/K	`0.0`
`node_9_additional_loss_coefficient` Node 9 Additional Loss Coefficient	number W/K	`0.0`
`node_10_additional_loss_coefficient` Node 10 Additional Loss Coefficient	number W/K	`0.0`

Referenced by 5 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, Branch, CondenserEquipmentList, PlantEquipmentList, WaterHeater:Sizing

ThermalStorage:Ice:Detailed¶

from idfpy.models import ThermalStorageIceDetailed

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.

Field	Type	Default	Details
`name` Name required	string
`availability_schedule_name` Availability Schedule Name	reference		Availability schedule name for this system. Schedule value > 0 means the system is available. If this field is blank, the system is always available. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`capacity` Capacity required	number or `Autosize` GJ		This includes only the latent storage capacity
`inlet_node_name` Inlet Node Name required	string
`outlet_node_name` Outlet Node Name required	string
`discharging_curve_variable_specifications` Discharging Curve Variable Specifications required	choice		One of `FractionChargedLMTD`, `FractionDischargedLMTD`, `LMTDFractionCharged`, `LMTDMassFlow`
`discharging_curve_name` Discharging Curve Name required	reference		Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup
`charging_curve_variable_specifications` Charging Curve Variable Specifications required	choice		One of `FractionChargedLMTD`, `FractionDischargedLMTD`, `LMTDFractionCharged`, `LMTDMassFlow`
`charging_curve_name` Charging Curve Name required	reference		Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup
`timestep_of_the_curve_data` Timestep of the Curve Data	number hr
`parasitic_electric_load_during_discharging` Parasitic Electric Load During Discharging	number dimensionless
`parasitic_electric_load_during_charging` Parasitic Electric Load During Charging	number dimensionless
`tank_loss_coefficient` Tank Loss Coefficient	number dimensionless		This is the fraction the total storage capacity that is lost or melts each hour
`freezing_temperature_of_storage_medium` Freezing Temperature of Storage Medium	number C	`0.0`	This temperature is typically 0C for water. Simply changing this temperature without adjusting the performance parameters input above is inappropriate and not advised.
`thaw_process_indicator` Thaw Process Indicator	choice	`OutsideMelt`	This field determines whether the system uses internal or external melt during discharging. This will then have an impact on charging performance. One of `InsideMelt`, `OutsideMelt`
`thermal_storage_sizing_object_name` Thermal Storage Sizing Object Name	reference		used only when tank capacity is autosized Names a ThermalStorage:Sizing

Referenced by 4 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, Branch, PlantEquipmentList, PlantEquipmentOperation:ThermalEnergyStorage

ThermalStorage:Ice:Simple¶

from idfpy.models import ThermalStorageIceSimple

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.

Field	Type	Details
`name` Name required	string
`ice_storage_type` Ice Storage Type required	choice	IceOnCoilInternal = Ice-on-Coil, internal melt IceOnCoilExternal = Ice-on-Coil, external melt One of `IceOnCoilExternal`, `IceOnCoilInternal`
`capacity` Capacity required	number or `Autosize` GJ
`inlet_node_name` Inlet Node Name required	string
`outlet_node_name` Outlet Node Name required	string
`thermal_storage_sizing_object_name` Thermal Storage Sizing Object Name	reference	used only when tank capacity is autosized Names a ThermalStorage:Sizing

Referenced by 3 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, Branch, PlantEquipmentOperation:ThermalEnergyStorage

ThermalStorage:PCM¶

from idfpy.models import ThermalStoragePCM

This thermal storage model is PCM-based It requires PCM material property connection In addition to the object linking, this object needs PCM Latent heat storage capacity and Heat Loss Rate This model needs 4 nodes: 2 plant side nodes and 2 use side nodes.

Field	Type	Default	Details
`name` Name required	string
`availability_schedule_name` Availability Schedule Name required	reference		Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`plant_side_inlet_node_name` Plant Side Inlet Node Name required	string
`plant_side_outlet_node_name` Plant Side Outlet Node Name required	string
`use_side_inlet_node_name` Use Side Inlet Node Name required	string
`use_side_outlet_node_name` Use Side Outlet Node Name required	string
`pcm_material_name` PCM Material Name required	reference		Names a Material, Material:AirGap, Material:InfraredTransparent, Material:NoMass, Material:RoofVegetation, WindowMaterial:Blind, WindowMaterial:Gas, WindowMaterial:GasMixture, WindowMaterial:Glazing, WindowMaterial:Glazing:RefractionExtinctionMethod, WindowMaterial:GlazingGroup:Thermochromic, WindowMaterial:Screen and 2 more
`tank_capacity` Tank Capacity required	number or `Autosize` kg
`heat_loss_rate` Heat Loss Rate	number W	`0.0`
`use_side_design_flow_rate` Use Side Design Flow Rate required	number or `Autosize` m3/s
`plant_side_design_flow_rate` Plant Side Design Flow Rate required	number or `Autosize` m3/s

Referenced by 3 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, Branch, PlantEquipmentList

ThermalStorage:Sizing¶

from idfpy.models import ThermalStorageSizing

Sizing information for thermal energy stoarge capacity.

Field	Type	Default	Details
`name` Name required	string
`on_peak_period_start_time` On Peak Period Start Time required	number hr		Start time of on peak period in hours
`on_peak_period_end_time` On Peak Period End Time required	number hr		End time of on peak period in hours
`sizing_factor` Sizing Factor	number	`1.0`	Range: > 0

Referenced by 2 object types

ThermalStorage:Ice:Detailed, ThermalStorage:Ice:Simple

WaterHeater:HeatPump:PumpedCondenser¶

from idfpy.models import WaterHeaterHeatPumpPumpedCondenser

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

Field	Type	Default	Details
`name` Name required	string		Unique name for this instance of a heat pump water heater.
`availability_schedule_name` Availability Schedule Name	reference		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. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`compressor_setpoint_temperature_schedule_name` Compressor Setpoint Temperature Schedule Name required	reference		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. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`dead_band_temperature_difference` Dead Band Temperature Difference	number deltaC	`5.0`	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. Range: > 0, ≤ 20
`condenser_water_inlet_node_name` Condenser Water Inlet Node Name required	string		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.
`condenser_water_outlet_node_name` Condenser Water Outlet Node Name required	string		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.
`condenser_water_flow_rate` Condenser Water Flow Rate	number or `Autocalculate` m3/s		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.
`evaporator_air_flow_rate` Evaporator Air Flow Rate	number or `Autocalculate` m3/s		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.
`inlet_air_configuration` Inlet Air Configuration required	choice		Defines the configuration of the airflow path through the air coil and fan section. One of `OutdoorAirOnly`, `Schedule`, `ZoneAirOnly`, `ZoneAndOutdoorAir`
`air_inlet_node_name` Air Inlet Node Name	string		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.
`air_outlet_node_name` Air Outlet Node Name	string		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.
`outdoor_air_node_name` Outdoor Air Node Name	string		Outdoor air node name if inlet air configuration is ZoneAndOutdoorAir or OutdoorAirOnly, otherwise leave field blank.
`exhaust_air_node_name` Exhaust Air Node Name	string		Simply a unique Node Name if Inlet Air Configuration is ZoneAndOutdoorAir or OutdoorAirOnly, otherwise leave field blank.
`inlet_air_temperature_schedule_name` Inlet Air Temperature Schedule Name	reference		Used only if Inlet Air Configuration is Schedule, otherwise leave blank. Schedule values should be degrees C. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`inlet_air_humidity_schedule_name` Inlet Air Humidity Schedule Name	reference		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) Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`inlet_air_zone_name` Inlet Air Zone Name	reference		Used only if Inlet Air Configuration is ZoneAirOnly or ZoneAndOutdoorAir. Otherwise, leave field blank. Names a Zone
`tank_object_type` Tank Object Type	choice	`WaterHeater:Mixed`	Specify the type of water heater tank used by this heat pump water heater. One of `WaterHeater:Mixed`, `WaterHeater:Stratified`
`tank_name` Tank Name required	reference		Needs to match the name used in the corresponding Water Heater object. Names a WaterHeater:Mixed, WaterHeater:Stratified
`tank_use_side_inlet_node_name` Tank Use Side Inlet Node Name	string		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.
`tank_use_side_outlet_node_name` Tank Use Side Outlet Node Name	string		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.
`dx_coil_object_type` DX Coil Object Type	choice	`Coil:WaterHeating:AirToWaterHeatPump:Pumped`	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, and CoilSystem:IntegratedHeatPump:AirSource One of `Coil:WaterHeating:AirToWaterHeatPump:Pumped`, `Coil:WaterHeating:AirToWaterHeatPump:VariableSpeed`, `CoilSystem:IntegratedHeatPump:AirSource`
`dx_coil_name` DX Coil Name required	reference		Must match the name used in the corresponding Coil:WaterHeating:AirToWaterHeatPump:* object, or CoilSystem:IntegratedHeatPump:AirSource Names a Coil:WaterHeating:AirToWaterHeatPump:Pumped, Coil:WaterHeating:AirToWaterHeatPump:VariableSpeed, CoilSystem:IntegratedHeatPump:AirSource
`minimum_inlet_air_temperature_for_compressor_operation` Minimum Inlet Air Temperature for Compressor Operation	number C	`10.0`	Heat pump compressor will not operate when the inlet air dry-bulb temperature is below this value.
`maximum_inlet_air_temperature_for_compressor_operation` Maximum Inlet Air Temperature for Compressor Operation	number C	`48.88888888889`	Heat pump compressor will not operate when the inlet air dry-bulb temperature is above this value. Range: ≥ 26, ≤ 94
`compressor_location` Compressor Location required	choice		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. One of `Outdoors`, `Schedule`, `Zone`
`compressor_ambient_temperature_schedule_name` Compressor Ambient Temperature Schedule Name	reference		Used only if Compressor Location is Schedule, otherwise leave field blank. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`fan_object_type` Fan Object Type	choice	`Fan:OnOff`	Specify the type of fan used by this heat pump water heater. The only valid choices are Fan:SystemModel or Fan:OnOff. One of `Fan:OnOff`, `Fan:SystemModel`
`fan_name` Fan Name required	reference		Needs to match the name used in the corresponding Fan:SystemModel or Fan:OnOff object. Names a Fan:OnOff, Fan:SystemModel
`fan_placement` Fan Placement	choice	`DrawThrough`	BlowThrough means the fan is located before the air coil (upstream). DrawThrough means the fan is located after the air coil (downstream). One of `BlowThrough`, `DrawThrough`
`on_cycle_parasitic_electric_load` On Cycle Parasitic Electric Load	number W	`0.0`	Parasitic electric power consumed when the heat pump compressor operates. Does not contribute to water heating but can impact the zone air heat balance. Range: ≥ 0
`off_cycle_parasitic_electric_load` Off Cycle Parasitic Electric Load	number W	`0.0`	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. Range: ≥ 0
`parasitic_heat_rejection_location` Parasitic Heat Rejection Location	choice	`Outdoors`	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. One of `Outdoors`, `Zone`
`inlet_air_mixer_node_name` Inlet Air Mixer Node Name	string		Required only if Inlet Air Configuration is ZoneAndOutdoorAir, otherwise leave field blank.
`outlet_air_splitter_node_name` Outlet Air Splitter Node Name	string		Required only if Inlet Air Configuration is ZoneAndOutdoorAir, otherwise leave field blank.
`inlet_air_mixer_schedule_name` Inlet Air Mixer Schedule Name	reference		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). Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`tank_element_control_logic` Tank Element Control Logic	choice	`Simultaneous`	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. One of `MutuallyExclusive`, `Simultaneous`
`control_sensor_1_height_in_stratified_tank` Control Sensor 1 Height In Stratified Tank	number m		Used to indicate height of control sensor for Tank Object Type = WaterHeater:Stratified If left blank, it will default to the height of Heater1 Range: ≥ 0
`control_sensor_1_weight` Control Sensor 1 Weight	number dimensionless	`1.0`	Weight to give Control Sensor 1 temperature The weight of Control Sensor 2 will be 1 - (wt. of control sensor 1) Range: ≥ 0, ≤ 1
`control_sensor_2_height_in_stratified_tank` Control Sensor 2 Height In Stratified Tank	number m		Used to indicate height of control sensor for Tank Object Type = WaterHeater:Stratified If left blank, it will default to the height of Heater2 Range: ≥ 0

Referenced by 5 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, Branch, PlantEquipmentList, SpaceHVAC:ZoneEquipmentSplitter, ZoneHVAC:EquipmentList

WaterHeater:HeatPump:WrappedCondenser¶

from idfpy.models import WaterHeaterHeatPumpWrappedCondenser

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

Field	Type	Default	Details
`name` Name required	string		Unique name for this instance of a heat pump water heater.
`availability_schedule_name` Availability Schedule Name	reference		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. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`compressor_setpoint_temperature_schedule_name` Compressor Setpoint Temperature Schedule Name required	reference		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. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`dead_band_temperature_difference` Dead Band Temperature Difference	number deltaC	`5.0`	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. Range: > 0, ≤ 20
`condenser_bottom_location` Condenser Bottom Location	number m	`0.0`	Distance from the bottom of the tank to the bottom of the wrapped condenser. Range: ≥ 0
`condenser_top_location` Condenser Top Location required	number m		Distance from the bottom of the tank to the top of the wrapped condenser. Range: ≥ 0
`evaporator_air_flow_rate` Evaporator Air Flow Rate	number or `Autocalculate` m3/s		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.
`inlet_air_configuration` Inlet Air Configuration required	choice		Defines the configuration of the airflow path through the air coil and fan section. One of `OutdoorAirOnly`, `Schedule`, `ZoneAirOnly`, `ZoneAndOutdoorAir`
`air_inlet_node_name` Air Inlet Node Name	string		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.
`air_outlet_node_name` Air Outlet Node Name	string		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.
`outdoor_air_node_name` Outdoor Air Node Name	string		Outdoor air node name if inlet air configuration is ZoneAndOutdoorAir or OutdoorAirOnly, otherwise leave field blank.
`exhaust_air_node_name` Exhaust Air Node Name	string		Simply a unique Node Name if Inlet Air Configuration is ZoneAndOutdoorAir or OutdoorAirOnly, otherwise leave field blank.
`inlet_air_temperature_schedule_name` Inlet Air Temperature Schedule Name	reference		Used only if Inlet Air Configuration is Schedule, otherwise leave blank. Schedule values should be degrees C. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`inlet_air_humidity_schedule_name` Inlet Air Humidity Schedule Name	reference		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) Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`inlet_air_zone_name` Inlet Air Zone Name	reference		Used only if Inlet Air Configuration is ZoneAirOnly or ZoneAndOutdoorAir. Otherwise, leave field blank. Names a Zone
`tank_object_type` Tank Object Type	choice	`WaterHeater:Stratified`	Specify the type of water heater tank used by this heat pump water heater. One of `WaterHeater:Stratified`
`tank_name` Tank Name required	reference		Needs to match the name used in the corresponding Water Heater object. Must be a WaterHeater:Stratified tank. Names a WaterHeater:Stratified
`tank_use_side_inlet_node_name` Tank Use Side Inlet Node Name	string		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.
`tank_use_side_outlet_node_name` Tank Use Side Outlet Node Name	string		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.
`dx_coil_object_type` DX Coil Object Type	choice	`Coil:WaterHeating:AirToWaterHeatPump:Wrapped`	Specify the type of DX coil used by this heat pump water heater. The only valid choice is Coil:WaterHeating:AirToWaterHeatPump:Wrapped One of `Coil:WaterHeating:AirToWaterHeatPump:Wrapped`
`dx_coil_name` DX Coil Name required	reference		Must match the name used in the corresponding Coil:WaterHeating:AirToWaterHeatPump:Wrapped object. Names a Coil:WaterHeating:AirToWaterHeatPump:Wrapped
`minimum_inlet_air_temperature_for_compressor_operation` Minimum Inlet Air Temperature for Compressor Operation	number C	`10.0`	Heat pump compressor will not operate when the inlet air dry-bulb temperature is below this value.
`maximum_inlet_air_temperature_for_compressor_operation` Maximum Inlet Air Temperature for Compressor Operation	number C	`48.88888888889`	Heat pump compressor will not operate when the inlet air dry-bulb temperature is above this value. Range: ≥ 26, ≤ 94
`compressor_location` Compressor Location required	choice		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. One of `Outdoors`, `Schedule`, `Zone`
`compressor_ambient_temperature_schedule_name` Compressor Ambient Temperature Schedule Name	reference		Used only if Compressor Location is Schedule, otherwise leave field blank. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`fan_object_type` Fan Object Type	choice	`Fan:OnOff`	Specify the type of fan used by this heat pump water heater. The only valid choices are Fan:SystemModel or Fan:OnOff. One of `Fan:OnOff`, `Fan:SystemModel`
`fan_name` Fan Name required	reference		Needs to match the name used in the corresponding Fan:SystemModel or Fan:OnOff object. Names a Fan:OnOff, Fan:SystemModel
`fan_placement` Fan Placement	choice	`DrawThrough`	BlowThrough means the fan is located before the air coil (upstream). DrawThrough means the fan is located after the air coil (downstream). One of `BlowThrough`, `DrawThrough`
`on_cycle_parasitic_electric_load` On Cycle Parasitic Electric Load	number W	`0.0`	Parasitic electric power consumed when the heat pump compressor operates. Does not contribute to water heating but can impact the zone air heat balance. Range: ≥ 0
`off_cycle_parasitic_electric_load` Off Cycle Parasitic Electric Load	number W	`0.0`	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. Range: ≥ 0
`parasitic_heat_rejection_location` Parasitic Heat Rejection Location	choice	`Outdoors`	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. One of `Outdoors`, `Zone`
`inlet_air_mixer_node_name` Inlet Air Mixer Node Name	string		Required only if Inlet Air Configuration is ZoneAndOutdoorAir, otherwise leave field blank.
`outlet_air_splitter_node_name` Outlet Air Splitter Node Name	string		Required only if Inlet Air Configuration is ZoneAndOutdoorAir, otherwise leave field blank.
`inlet_air_mixer_schedule_name` Inlet Air Mixer Schedule Name	reference		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. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`tank_element_control_logic` Tank Element Control Logic	choice	`Simultaneous`	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. One of `MutuallyExclusive`, `Simultaneous`
`control_sensor_1_height_in_stratified_tank` Control Sensor 1 Height In Stratified Tank	number m		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 Range: ≥ 0
`control_sensor_1_weight` Control Sensor 1 Weight	number dimensionless	`1.0`	Weight to give Control Sensor 1 temperature Range: ≥ 0, ≤ 1
`control_sensor_2_height_in_stratified_tank` Control Sensor 2 Height In Stratified Tank	number m		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) Range: ≥ 0

Referenced by 5 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, Branch, PlantEquipmentList, SpaceHVAC:ZoneEquipmentSplitter, ZoneHVAC:EquipmentList

WaterHeater:Mixed¶

from idfpy.models import WaterHeaterMixed

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.)

Field	Type	Default	Details
`name` Name required	string
`tank_volume` Tank Volume	number or `Autosize` m3	`0.0`
`setpoint_temperature_schedule_name` Setpoint Temperature Schedule Name required	reference		Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`deadband_temperature_difference` Deadband Temperature Difference	number deltaC	`0.0`	Range: ≥ 0
`maximum_temperature_limit` Maximum Temperature Limit	number C
`heater_control_type` Heater Control Type	choice	`Cycle`	One of `Cycle`, `Modulate`
`heater_maximum_capacity` Heater Maximum Capacity	number or `Autosize` W
`heater_minimum_capacity` Heater Minimum Capacity	number W		Only used when Heater Control Type is set to Modulate Range: ≥ 0
`heater_ignition_minimum_flow_rate` Heater Ignition Minimum Flow Rate	number m3/s	`0.0`	Not yet implemented Range: ≥ 0
`heater_ignition_delay` Heater Ignition Delay	number s	`0.0`	Not yet implemented Range: ≥ 0
`heater_fuel_type` Heater Fuel Type required	choice		One of `Coal`, `Diesel`, `DistrictHeatingSteam`, `DistrictHeatingWater`, `Electricity`, `FuelOilNo1`, `FuelOilNo2`, `Gasoline`, `NaturalGas`, `OtherFuel1`, `OtherFuel2`, `Propane`
`heater_thermal_efficiency` Heater Thermal Efficiency required	number		Range: > 0
`part_load_factor_curve_name` Part Load Factor Curve Name	reference		Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more
`off_cycle_parasitic_fuel_consumption_rate` Off Cycle Parasitic Fuel Consumption Rate	number W	`0.0`	Range: ≥ 0
`off_cycle_parasitic_fuel_type` Off Cycle Parasitic Fuel Type	choice		One of `Coal`, `Diesel`, `DistrictHeatingSteam`, `DistrictHeatingWater`, `Electricity`, `FuelOilNo1`, `FuelOilNo2`, `Gasoline`, `NaturalGas`, `OtherFuel1`, `OtherFuel2`, `Propane`
`off_cycle_parasitic_heat_fraction_to_tank` Off Cycle Parasitic Heat Fraction to Tank	number	`0.0`	Range: ≥ 0, ≤ 1
`on_cycle_parasitic_fuel_consumption_rate` On Cycle Parasitic Fuel Consumption Rate	number W	`0.0`	Range: ≥ 0
`on_cycle_parasitic_fuel_type` On Cycle Parasitic Fuel Type	choice		One of `Coal`, `Diesel`, `DistrictHeatingSteam`, `DistrictHeatingWater`, `Electricity`, `FuelOilNo1`, `FuelOilNo2`, `Gasoline`, `NaturalGas`, `OtherFuel1`, `OtherFuel2`, `Propane`
`on_cycle_parasitic_heat_fraction_to_tank` On Cycle Parasitic Heat Fraction to Tank	number	`0.0`	Range: ≥ 0, ≤ 1
`ambient_temperature_indicator` Ambient Temperature Indicator required	choice		One of `Outdoors`, `Schedule`, `Zone`
`ambient_temperature_schedule_name` Ambient Temperature Schedule Name	reference		Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`ambient_temperature_zone_name` Ambient Temperature Zone Name	reference		Names a Zone
`ambient_temperature_outdoor_air_node_name` Ambient Temperature Outdoor Air Node Name	string		required for Ambient Temperature Indicator=Outdoors
`off_cycle_loss_coefficient_to_ambient_temperature` Off Cycle Loss Coefficient to Ambient Temperature	number W/K		Range: ≥ 0
`off_cycle_loss_fraction_to_zone` Off Cycle Loss Fraction to Zone	number	`1.0`	Range: ≥ 0, ≤ 1
`on_cycle_loss_coefficient_to_ambient_temperature` On Cycle Loss Coefficient to Ambient Temperature	number W/K		Range: ≥ 0
`on_cycle_loss_fraction_to_zone` On Cycle Loss Fraction to Zone	number	`1.0`	Range: ≥ 0, ≤ 1
`peak_use_flow_rate` Peak Use Flow Rate	number m3/s		Only used if Use Side Node connections are blank Range: ≥ 0
`use_flow_rate_fraction_schedule_name` Use Flow Rate Fraction Schedule Name	reference		Only used if Use Side Node connections are blank Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`cold_water_supply_temperature_schedule_name` Cold Water Supply Temperature Schedule Name	reference		Only used if Use Side Node connections are blank Defaults to water temperatures calculated by Site:WaterMainsTemperature object Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`use_side_inlet_node_name` Use Side Inlet Node Name	string
`use_side_outlet_node_name` Use Side Outlet Node Name	string
`use_side_effectiveness` Use Side Effectiveness	number	`1.0`	Range: ≥ 0, ≤ 1
`source_side_inlet_node_name` Source Side Inlet Node Name	string
`source_side_outlet_node_name` Source Side Outlet Node Name	string
`source_side_effectiveness` Source Side Effectiveness	number	`1.0`	Range: > 0, ≤ 1
`use_side_design_flow_rate` Use Side Design Flow Rate	number or `Autosize` m3/s	`Autosize`
`source_side_design_flow_rate` Source Side Design Flow Rate	number or `Autosize` m3/s	`Autosize`
`indirect_water_heating_recovery_time` Indirect Water Heating Recovery Time	number hr	`1.5`	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 Range: > 0
`source_side_flow_control_mode` Source Side Flow Control Mode	choice	`IndirectHeatPrimarySetpoint`	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 One of `IndirectHeatAlternateSetpoint`, `IndirectHeatPrimarySetpoint`, `StorageTank`
`indirect_alternate_setpoint_temperature_schedule_name` Indirect Alternate Setpoint Temperature Schedule Name	reference		This field is only used if the previous is set to IndirectHeatAlternateSetpoint Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`end_use_subcategory` End-Use Subcategory	string	`General`	Any text may be used here to categorize the end-uses in the ABUPS End Uses by Subcategory table.

Referenced by 7 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, Branch, Coil:WaterHeating:Desuperheater, CondenserEquipmentList, PlantEquipmentList, WaterHeater:HeatPump:PumpedCondenser, WaterHeater:Sizing

WaterHeater:Sizing¶

from idfpy.models import WaterHeaterSizing

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.

Field	Type	Details
`waterheater_name` WaterHeater Name required	reference	Names a ThermalStorage:ChilledWater:Mixed, ThermalStorage:ChilledWater:Stratified, ThermalStorage:HotWater:Stratified, WaterHeater:Mixed, WaterHeater:Stratified
`design_mode` Design Mode	choice	One of `PeakDraw`, `PerFloorArea`, `PerPerson`, `PerSolarCollectorArea`, `PerUnit`, `ResidentialHUD-FHAMinimum`
`time_storage_can_meet_peak_draw` Time Storage Can Meet Peak Draw	number hr	Only used for Design Mode = PeakDraw Range: ≥ 0
`time_for_tank_recovery` Time for Tank Recovery	number hr	Only used for Design Mode = PeakDraw Range: ≥ 0
`nominal_tank_volume_for_autosizing_plant_connections` Nominal Tank Volume for Autosizing Plant Connections	number m3	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
`number_of_bedrooms` Number of Bedrooms	integer	Only used for Design Mode = ResidentialHUD-FHAMinimum Range: ≥ 1
`number_of_bathrooms` Number of Bathrooms	integer	Only used for Design Mode = ResidentialHUD-FHAMinimum Range: ≥ 1
`storage_capacity_per_person` Storage Capacity per Person	number m3/person	Only used for Design Mode = PerPerson Range: ≥ 0
`recovery_capacity_per_person` Recovery Capacity per Person	number m3/hr-person	Only used for Design Mode = PerPerson Range: ≥ 0
`storage_capacity_per_floor_area` Storage Capacity per Floor Area	number m3/m2	Only used for Design Mode = PerFloorArea Range: ≥ 0
`recovery_capacity_per_floor_area` Recovery Capacity per Floor Area	number m3/hr-m2	Only used for Design Mode = PerFloorArea Range: ≥ 0
`number_of_units` Number of Units	number	Only used for Design Mode = PerUnit
`storage_capacity_per_unit` Storage Capacity per Unit	number m3	Only used for Design Mode = PerUnit Range: ≥ 0
`recovery_capacity_perunit` Recovery Capacity PerUnit	number m3/hr	Only used for Design Mode = PerUnit Range: ≥ 0
`storage_capacity_per_collector_area` Storage Capacity per Collector Area	number m3/m2	Only used for Design Mode = PerSolarCollectorArea Range: ≥ 0
`height_aspect_ratio` Height Aspect Ratio	number	only used if for WaterHeater:Stratified Range: ≥ 0

WaterHeater:Stratified¶

from idfpy.models import WaterHeaterStratified

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:*.)

Field	Type	Default	Details
`name` Name required	string
`end_use_subcategory` End-Use Subcategory	string	`General`	Any text may be used here to categorize the end-uses in the ABUPS End Uses by Subcategory table.
`tank_volume` Tank Volume required	number or `Autosize` m3
`tank_height` Tank Height required	number or `Autosize` m		Height is measured in the axial direction for horizontal cylinders
`tank_shape` Tank Shape	choice	`VerticalCylinder`	One of `HorizontalCylinder`, `Other`, `VerticalCylinder`
`tank_perimeter` Tank Perimeter	number m		Only used if Tank Shape is Other Range: ≥ 0
`maximum_temperature_limit` Maximum Temperature Limit	number C
`heater_priority_control` Heater Priority Control	choice	`MasterSlave`	One of `MasterSlave`, `Simultaneous`
`heater_1_setpoint_temperature_schedule_name` Heater 1 Setpoint Temperature Schedule Name required	reference		Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`heater_1_deadband_temperature_difference` Heater 1 Deadband Temperature Difference	number deltaC	`0.0`	Range: ≥ 0
`heater_1_capacity` Heater 1 Capacity	number or `Autosize` W
`heater_1_height` Heater 1 Height	number m		Range: ≥ 0
`heater_2_setpoint_temperature_schedule_name` Heater 2 Setpoint Temperature Schedule Name required	reference		Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`heater_2_deadband_temperature_difference` Heater 2 Deadband Temperature Difference	number deltaC	`0.0`	Range: ≥ 0
`heater_2_capacity` Heater 2 Capacity	number W		Range: ≥ 0
`heater_2_height` Heater 2 Height	number m		Range: ≥ 0
`heater_fuel_type` Heater Fuel Type required	choice		One of `Coal`, `Diesel`, `DistrictHeatingSteam`, `DistrictHeatingWater`, `Electricity`, `FuelOilNo1`, `FuelOilNo2`, `Gasoline`, `NaturalGas`, `OtherFuel1`, `OtherFuel2`, `Propane`
`heater_thermal_efficiency` Heater Thermal Efficiency required	number		Range: > 0
`off_cycle_parasitic_fuel_consumption_rate` Off Cycle Parasitic Fuel Consumption Rate	number W	`0.0`	Range: ≥ 0
`off_cycle_parasitic_fuel_type` Off Cycle Parasitic Fuel Type	choice		One of `Coal`, `Diesel`, `DistrictHeatingSteam`, `DistrictHeatingWater`, `Electricity`, `FuelOilNo1`, `FuelOilNo2`, `Gasoline`, `NaturalGas`, `OtherFuel1`, `OtherFuel2`, `Propane`
`off_cycle_parasitic_heat_fraction_to_tank` Off Cycle Parasitic Heat Fraction to Tank	number	`0.0`	Range: ≥ 0, ≤ 1
`off_cycle_parasitic_height` Off Cycle Parasitic Height	number m	`0.0`	Range: ≥ 0
`on_cycle_parasitic_fuel_consumption_rate` On Cycle Parasitic Fuel Consumption Rate	number W	`0.0`	Range: ≥ 0
`on_cycle_parasitic_fuel_type` On Cycle Parasitic Fuel Type	choice		One of `Coal`, `Diesel`, `DistrictHeatingSteam`, `DistrictHeatingWater`, `Electricity`, `FuelOilNo1`, `FuelOilNo2`, `Gasoline`, `NaturalGas`, `OtherFuel1`, `OtherFuel2`, `Propane`
`on_cycle_parasitic_heat_fraction_to_tank` On Cycle Parasitic Heat Fraction to Tank	number	`0.0`	Range: ≥ 0, ≤ 1
`on_cycle_parasitic_height` On Cycle Parasitic Height	number m	`0.0`	Range: ≥ 0
`ambient_temperature_indicator` Ambient Temperature Indicator required	choice		One of `Outdoors`, `Schedule`, `Zone`
`ambient_temperature_schedule_name` Ambient Temperature Schedule Name	reference		Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`ambient_temperature_zone_name` Ambient Temperature Zone Name	reference		Names a Zone
`ambient_temperature_outdoor_air_node_name` Ambient Temperature Outdoor Air Node Name	string		required for Ambient Temperature Indicator=Outdoors
`uniform_skin_loss_coefficient_per_unit_area_to_ambient_temperature` Uniform Skin Loss Coefficient per Unit Area to Ambient Temperature	number W/m2-K		Range: ≥ 0
`skin_loss_fraction_to_zone` Skin Loss Fraction to Zone	number	`1.0`	Range: ≥ 0, ≤ 1
`off_cycle_flue_loss_coefficient_to_ambient_temperature` Off Cycle Flue Loss Coefficient to Ambient Temperature	number W/K		Range: ≥ 0
`off_cycle_flue_loss_fraction_to_zone` Off Cycle Flue Loss Fraction to Zone	number	`1.0`	Range: ≥ 0, ≤ 1
`peak_use_flow_rate` Peak Use Flow Rate	number m3/s		Only used if Use Side Node connections are blank Range: ≥ 0
`use_flow_rate_fraction_schedule_name` Use Flow Rate Fraction Schedule Name	reference		If blank, defaults to 1.0 at all times Only used if use side node connections are blank Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`cold_water_supply_temperature_schedule_name` Cold Water Supply Temperature Schedule Name	reference		Only used if use side node connections are blank Defaults to water temperatures calculated by Site:WaterMainsTemperature object Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`use_side_inlet_node_name` Use Side Inlet Node Name	string
`use_side_outlet_node_name` Use Side Outlet Node Name	string
`use_side_effectiveness` Use Side Effectiveness	number	`1.0`	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. Range: ≥ 0, ≤ 1
`use_side_inlet_height` Use Side Inlet Height	number m	`0.0`	Defaults to bottom of tank Range: ≥ 0
`use_side_outlet_height` Use Side Outlet Height	number or `Autocalculate` m	`Autocalculate`	Defaults to top of tank
`source_side_inlet_node_name` Source Side Inlet Node Name	string
`source_side_outlet_node_name` Source Side Outlet Node Name	string
`source_side_effectiveness` Source Side Effectiveness	number	`1.0`	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. Range: > 0, ≤ 1
`source_side_inlet_height` Source Side Inlet Height	number or `Autocalculate` m	`Autocalculate`	Defaults to top of tank
`source_side_outlet_height` Source Side Outlet Height	number m	`0.0`	Defaults to bottom of tank Range: ≥ 0
`inlet_mode` Inlet Mode	choice	`Fixed`	One of `Fixed`, `Seeking`
`use_side_design_flow_rate` Use Side Design Flow Rate	number or `Autosize` m3/s	`Autosize`
`source_side_design_flow_rate` Source Side Design Flow Rate	number or `Autosize` m3/s	`Autosize`
`indirect_water_heating_recovery_time` Indirect Water Heating Recovery Time	number hr	`1.5`	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 Range: > 0
`number_of_nodes` Number of Nodes	integer	`1`	Range: ≥ 1, ≤ 12
`additional_destratification_conductivity` Additional Destratification Conductivity	number W/m-K	`0.0`	Range: ≥ 0
`node_1_additional_loss_coefficient` Node 1 Additional Loss Coefficient	number W/K	`0.0`
`node_2_additional_loss_coefficient` Node 2 Additional Loss Coefficient	number W/K	`0.0`
`node_3_additional_loss_coefficient` Node 3 Additional Loss Coefficient	number W/K	`0.0`
`node_4_additional_loss_coefficient` Node 4 Additional Loss Coefficient	number W/K	`0.0`
`node_5_additional_loss_coefficient` Node 5 Additional Loss Coefficient	number W/K	`0.0`
`node_6_additional_loss_coefficient` Node 6 Additional Loss Coefficient	number W/K	`0.0`
`node_7_additional_loss_coefficient` Node 7 Additional Loss Coefficient	number W/K	`0.0`
`node_8_additional_loss_coefficient` Node 8 Additional Loss Coefficient	number W/K	`0.0`
`node_9_additional_loss_coefficient` Node 9 Additional Loss Coefficient	number W/K	`0.0`
`node_10_additional_loss_coefficient` Node 10 Additional Loss Coefficient	number W/K	`0.0`
`node_11_additional_loss_coefficient` Node 11 Additional Loss Coefficient	number W/K	`0.0`
`node_12_additional_loss_coefficient` Node 12 Additional Loss Coefficient	number W/K	`0.0`
`source_side_flow_control_mode` Source Side Flow Control Mode	choice	`IndirectHeatPrimarySetpoint`	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 One of `IndirectHeatAlternateSetpoint`, `IndirectHeatPrimarySetpoint`, `StorageTank`
`indirect_alternate_setpoint_temperature_schedule_name` Indirect Alternate Setpoint Temperature Schedule Name	reference		This field is only used if the previous is set to IndirectHeatAlternateSetpoint Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules

Referenced by 8 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, Branch, Coil:WaterHeating:Desuperheater, CondenserEquipmentList, PlantEquipmentList, WaterHeater:HeatPump:PumpedCondenser, WaterHeater:HeatPump:WrappedCondenser, WaterHeater:Sizing