pyidf.unitary_equipment module¶

Data objects in group “Unitary Equipment”

class pyidf.unitary_equipment.AirLoopHvacUnitaryFurnaceHeatCool¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object AirLoopHVAC:Unitary:Furnace:HeatCool Unitary system, heating and cooling with constant volume supply fan (continuous or cycling), direct expansion (DX) cooling coil, heating coil (gas, electric, hot water, or steam), and optional reheat coil for dehumidification control. Identical to AirLoopHVAC:UnitaryHeatCool.

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.
A schedule value greater than zero (usually 1 is used) indicates that the unit is
available to operate as needed. A value less than or equal to zero (usually zero
is used) denotes that the unit must be 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

controlling_zone_or_thermostat_location¶

field Controlling Zone or Thermostat Location

Parameters:	value (str) – value for IDD Field Controlling Zone or Thermostat Location
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of controlling_zone_or_thermostat_location or None if not set
Return type:	str

cooling_coil_name¶

field Cooling Coil Name

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

cooling_coil_object_type¶

field Cooling Coil Object Type

Only works with DX cooling coil types

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

cooling_supply_air_flow_rate¶

field Cooling Supply Air Flow Rate

Must be less than or equal to the fan’s maximum flow rate.

Units: m3/s

Parameters:	value (float or “Autosize”) – value for IDD Field Cooling Supply Air Flow Rate
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of cooling_supply_air_flow_rate or None if not set
Return type:	float or “Autosize”

dehumidification_control_type¶

field Dehumidification Control Type

None = meet sensible load only
Multimode = activate enhanced dehumidification mode
as needed and meet sensible load.  Valid only with
cooling coil type CoilSystem:Cooling:DX:HeatExchangerAssisted.
This control mode allows the heat exchanger to be turned
on and off based on the zone dehumidification requirements.
A ZoneControl:Humidistat object is also required.
CoolReheat = cool beyond the dry-bulb setpoint.
as required to meet the humidity setpoint.  Valid with all
cooling coil types. When a heat exchanger assisted cooling
coil is used, the heat exchanger is locked on at all times.
A ZoneControl:Humidistat object is also required.
Default value: None

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

fan_placement¶

field Fan Placement

Default value: BlowThrough

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

furnace_air_inlet_node_name¶

field Furnace Air Inlet Node Name

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

furnace_air_outlet_node_name¶

field Furnace Air Outlet Node Name

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

heating_coil_name¶

field Heating Coil Name

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

heating_coil_object_type¶

field Heating Coil Object Type

works with gas, electric, hot water and steam heating coils

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

heating_supply_air_flow_rate¶

field Heating Supply Air Flow Rate

Must be less than or equal to the fan’s maximum flow fate.

Units: m3/s

Parameters:	value (float or “Autosize”) – value for IDD Field Heating Supply Air Flow Rate
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of heating_supply_air_flow_rate or None if not set
Return type:	float or “Autosize”

maximum_supply_air_temperature¶

field Maximum Supply Air Temperature

Units: C

Default value: 80.0

Parameters:	value (float or “Autosize”) – value for IDD Field Maximum Supply Air Temperature
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of maximum_supply_air_temperature or None if not set
Return type:	float or “Autosize”

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

no_load_supply_air_flow_rate¶

field No Load Supply Air Flow Rate

Must be less than or equal to the fan’s maximum flow rate.
Only used when fan operating mode is continuous (disregarded for cycling fan mode).
This air flow rate is used when no heating or cooling is required (i.e., the DX coil
compressor and heating coil are off). If this field is left blank or zero, the supply
air flow rate from the previous on cycle (either cooling or heating) is used.
Units: m3/s

Parameters:	value (float or “Autosize”) – value for IDD Field No Load Supply Air Flow Rate
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of no_load_supply_air_flow_rate or None if not set
Return type:	float or “Autosize”

reheat_coil_name¶

field Reheat Coil Name

Only required if dehumidification control type is “CoolReheat”

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

reheat_coil_object_type¶

field Reheat Coil Object Type

Only required if dehumidification control type is “CoolReheat”

works with gas, electric, hot water and steam heating coils

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

supply_air_fan_operating_mode_schedule_name¶

field Supply Air Fan Operating Mode Schedule Name

A fan operating mode schedule value of 0 indicates cycling fan mode (supply air
fan cycles on and off in tandem with the cooling or heating coil).
Any other schedule value indicates continuous fan mode (supply air fan operates
continuously regardless of cooling or heating coil operation). Provide a schedule
with non-zero values when high humidity control is specified.
Leaving this schedule name blank will default to cycling fan mode for the
entire simulation period.

Parameters:	value (str) – value for IDD Field Supply Air Fan Operating Mode Schedule Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of supply_air_fan_operating_mode_schedule_name or None if not set
Return type:	str

supply_fan_name¶

field Supply Fan Name

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

supply_fan_object_type¶

field Supply Fan Object Type

Fan:ConstantVolume only works with continuous fan operating mode (i.e. supply

air fan operating mode schedule values not equal to 0).

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

class pyidf.unitary_equipment.AirLoopHvacUnitaryFurnaceHeatOnly¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object AirLoopHVAC:Unitary:Furnace:HeatOnly Unitary system, heating-only with constant volume supply fan (continuous or cycling) and heating coil (gas, electric, hot water, or steam). Identical to AirLoopHVAC:UnitaryHeatOnly.

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

controlling_zone_or_thermostat_location¶

field Controlling Zone or Thermostat Location

Parameters:	value (str) – value for IDD Field Controlling Zone or Thermostat Location
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of controlling_zone_or_thermostat_location or None if not set
Return type:	str

fan_placement¶

field Fan Placement

Default value: BlowThrough

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

furnace_air_inlet_node_name¶

field Furnace Air Inlet Node Name

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

furnace_air_outlet_node_name¶

field Furnace Air Outlet Node Name

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

heating_coil_name¶

field Heating Coil Name

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

heating_coil_object_type¶

field Heating Coil Object Type

works with gas, electric, hot water and steam heating coils

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

heating_supply_air_flow_rate¶

field Heating Supply Air Flow Rate

This value should be > 0 and <= than the fan air flow rate.

Units: m3/s

Parameters:	value (float or “Autosize”) – value for IDD Field Heating Supply Air Flow Rate
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of heating_supply_air_flow_rate or None if not set
Return type:	float or “Autosize”

maximum_supply_air_temperature¶

field Maximum Supply Air Temperature

Units: C

Default value: 80.0

Parameters:	value (float or “Autosize”) – value for IDD Field Maximum Supply Air Temperature
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of maximum_supply_air_temperature or None if not set
Return type:	float or “Autosize”

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

supply_air_fan_operating_mode_schedule_name¶

field Supply Air Fan Operating Mode Schedule Name

A fan operating mode schedule value of 0 indicates cycling fan mode (supply air
fan cycles on and off in tandem with the heating coil).
Any other schedule value indicates continuous fan mode (supply air fan operates
continuously regardless of heating coil operation).
Leaving this schedule name blank will default to cycling fan mode for the
entire simulation period.

Parameters:	value (str) – value for IDD Field Supply Air Fan Operating Mode Schedule Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of supply_air_fan_operating_mode_schedule_name or None if not set
Return type:	str

supply_fan_name¶

field Supply Fan Name

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

supply_fan_object_type¶

field Supply Fan Object Type

Fan:ConstantVolume only works with continuous fan operating mode (i.e. fan

operating mode schedule values are greater than 0).

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

class pyidf.unitary_equipment.AirLoopHvacUnitaryHeatCool¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object AirLoopHVAC:UnitaryHeatCool Unitary system, heating and cooling with constant volume supply fan (continuous or cycling), direct expansion (DX) cooling coil, heating coil (gas, electric, hot water, or steam), and optional reheat coil for dehumidification control. Identical to AirLoopHVAC:Unitary:Furnace:HeatCool.

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

controlling_zone_or_thermostat_location¶

field Controlling Zone or Thermostat Location

Parameters:	value (str) – value for IDD Field Controlling Zone or Thermostat Location
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of controlling_zone_or_thermostat_location or None if not set
Return type:	str

cooling_coil_name¶

field Cooling Coil Name

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

cooling_coil_object_type¶

field Cooling Coil Object Type

Only works with DX cooling coil types or

Coil:Cooling:DX:VariableSpeed.

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

cooling_supply_air_flow_rate¶

field Cooling Supply Air Flow Rate

Must be less than or equal to the fan’s maximum flow rate.

Units: m3/s

Parameters:	value (float or “Autosize”) – value for IDD Field Cooling Supply Air Flow Rate
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of cooling_supply_air_flow_rate or None if not set
Return type:	float or “Autosize”

dehumidification_control_type¶

field Dehumidification Control Type

None = meet sensible load only
Multimode = activate enhanced dehumidification mode
as needed and meet sensible load.  Valid only with
cooling coil type CoilSystem:Cooling:DX:HeatExchangerAssisted.
This control mode allows the heat exchanger to be turned
on and off based on the zone dehumidification requirements.
A ZoneControl:Humidistat object is also required.
CoolReheat = cool beyond the dry-bulb setpoint.
as required to meet the humidity setpoint.  Valid with all
cooling coil types. When a heat exchanger assisted Cooling
coil is used, the heat exchanger is locked on at all times.
A ZoneControl:Humidistat object is also required.
Default value: None

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

fan_placement¶

field Fan Placement

Default value: BlowThrough

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

heating_coil_name¶

field Heating Coil Name

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

heating_coil_object_type¶

field Heating Coil Object Type

works with gas, electric, hot water and steam heating coils

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

heating_supply_air_flow_rate¶

field Heating Supply Air Flow Rate

Must be less than or equal to the fan’s maximum flow rate.

Units: m3/s

Parameters:	value (float or “Autosize”) – value for IDD Field Heating Supply Air Flow Rate
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of heating_supply_air_flow_rate or None if not set
Return type:	float or “Autosize”

maximum_supply_air_temperature¶

field Maximum Supply Air Temperature

Units: C

Default value: 80.0

Parameters:	value (float or “Autosize”) – value for IDD Field Maximum Supply Air Temperature
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of maximum_supply_air_temperature or None if not set
Return type:	float or “Autosize”

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

no_load_supply_air_flow_rate¶

field No Load Supply Air Flow Rate

Must be less than or equal to the fan’s maximum flow rate.
Only used when fan operating mode is continuous (disregarded for cycling fan mode).
This air flow rate is used when no heating or cooling is required (i.e., the DX coil
compressor and heating coil are off). If this field is left blank or zero, the supply
air flow rate from the previous on cycle (either cooling or heating) is used.
Units: m3/s

Parameters:	value (float or “Autosize”) – value for IDD Field No Load Supply Air Flow Rate
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of no_load_supply_air_flow_rate or None if not set
Return type:	float or “Autosize”

reheat_coil_name¶

field Reheat Coil Name

Only required if dehumidification control type is “CoolReheat”

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

reheat_coil_object_type¶

field Reheat Coil Object Type

Only required if dehumidification control type is “CoolReheat”

works with gas, electric, desuperheating, hot water and steam heating coils

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

supply_air_fan_operating_mode_schedule_name¶

field Supply Air Fan Operating Mode Schedule Name

A fan operating mode schedule value of 0 indicates cycling fan mode (supply air
fan cycles on and off in tandem with the cooling or heating coil).
Any other schedule value indicates continuous fan mode (supply air fan operates
continuously regardless of cooling or heating coil operation). Provide a schedule
with non-zero values when high humidity control is specified.
Leaving this schedule name blank will default to cycling fan mode for the
entire simulation period.

Parameters:	value (str) – value for IDD Field Supply Air Fan Operating Mode Schedule Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of supply_air_fan_operating_mode_schedule_name or None if not set
Return type:	str

supply_fan_name¶

field Supply Fan Name

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

supply_fan_object_type¶

field Supply Fan Object Type

Fan:ConstantVolume only works with continuous fan operating mode (i.e. supply

air fan operating mode schedule values not equal to 0).

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

unitary_system_air_inlet_node_name¶

field Unitary System Air Inlet Node Name

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

unitary_system_air_outlet_node_name¶

field Unitary System Air Outlet Node Name

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

class pyidf.unitary_equipment.AirLoopHvacUnitaryHeatCoolVavchangeoverBypass¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object AirLoopHVAC:UnitaryHeatCool:VAVChangeoverBypass Unitary system, heating and cooling with constant volume supply fan (continuous or cycling), direct expansion (DX) cooling coil, heating coil (gas, electric, hot water, steam, or DX air-to-air heat pump) and bypass damper for variable volume flow to terminal units. Used with AirTerminal:SingleDuct:VAV:HeatAndCool:Reheat or AirTerminal:SingleDuct:VAV:HeatAndCool:NoReheat.

air_inlet_node_name¶

field Air Inlet Node Name

Enter the name of the unitary system’s air inlet node.

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

Enter the name of the unitary system’s air outlet node.

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.
Enter the availability schedule name. Schedule values of zero denote system
is Off. Non-zero schedule values denote system is available to operate.

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

bypass_duct_mixer_node_name¶

field Bypass Duct Mixer Node Name

Enter the name of the bypass duct mixer node. This name should be the name
of the return air node for the outdoor air mixer associated with this system.
This node name must be different from the air inlet node name.

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

bypass_duct_splitter_node_name¶

field Bypass Duct Splitter Node Name

Enter the name of the bypass duct splitter node.
This splitter air node is the outlet node of the last component in this unitary
system. For blow through fan placement, the splitter air node is the outlet
node of the heating coil. For draw through fan placement, the splitter node
is the outlet node of the supply air fan.

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

cooling_coil_name¶

field Cooling Coil Name

Enter the name of the cooling coil used in this unitary system.

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

cooling_coil_object_type¶

field Cooling Coil Object Type

Specify the type of cooling coil used in this unitary system.

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

cooling_outdoor_air_flow_rate¶

field Cooling Outdoor Air Flow Rate

Enter the outdoor air flow rate during
cooling operation or specify autosize.
Units: m3/s

Parameters:	value (float or “Autosize”) – value for IDD Field Cooling Outdoor Air Flow Rate
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of cooling_outdoor_air_flow_rate or None if not set
Return type:	float or “Autosize”

cooling_supply_air_flow_rate¶

field Cooling Supply Air Flow Rate

Enter the system air flow rate during cooling
operation or specify autosize.
Units: m3/s

Parameters:	value (float or “Autosize”) – value for IDD Field Cooling Supply Air Flow Rate
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of cooling_supply_air_flow_rate or None if not set
Return type:	float or “Autosize”

dehumidification_control_type¶

field Dehumidification Control Type

None = meet sensible load only.
Multimode = activate enhanced dehumidification mode
as needed and meet sensible load.  Valid only with
Coil:Cooling:DX:TwoStageWithHumidityControlMode.
CoolReheat = cool beyond the Dry-Bulb temperature setpoint
as required to meet the humidity setpoint.  Valid only with
Coil:Cooling:DX:TwoStageWithHumidityControlMode.
For all dehumidification controls, the max humidity setpoint
on this unitary system’s air outlet node is used.
This must be set using ZoneControl:Humidistat and
SetpointManager:SingleZone:Humidity:Maximum,
SetpointManager:MultiZone:Humidity:Maximum or
SetpointManager:MultiZone:MaximumHumidity:Average objects.
Default value: None

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

heating_coil_name¶

field Heating Coil Name

Enter the name of the heating coil used in this unitary system.

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

heating_coil_object_type¶

field Heating Coil Object Type

works with DX, gas, electric, hot water and steam heating coils

Specify the type of heating coil used in this unitary system.

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

heating_outdoor_air_flow_rate¶

field Heating Outdoor Air Flow Rate

Enter the outdoor air flow rate during
heating operation or specify autosize.
Units: m3/s

Parameters:	value (float or “Autosize”) – value for IDD Field Heating Outdoor Air Flow Rate
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of heating_outdoor_air_flow_rate or None if not set
Return type:	float or “Autosize”

heating_supply_air_flow_rate¶

field Heating Supply Air Flow Rate

Enter the system air flow rate during heating
operation or specify autosize.
Units: m3/s

Parameters:	value (float or “Autosize”) – value for IDD Field Heating Supply Air Flow Rate
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of heating_supply_air_flow_rate or None if not set
Return type:	float or “Autosize”

maximum_outlet_air_temperature_during_heating_operation¶

field Maximum Outlet Air Temperature During Heating Operation

Specify the maximum outlet air temperature allowed for this unitary system
during heating operation. This value should be greater than the minimum outlet
air temperature during cooling operation.
Units: C
Default value: 50.0

Parameters:	value (float) – value for IDD Field Maximum Outlet Air Temperature During Heating Operation
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of maximum_outlet_air_temperature_during_heating_operation or None if not set
Return type:	float

minimum_outlet_air_temperature_during_cooling_operation¶

field Minimum Outlet Air Temperature During Cooling Operation

Specify the minimum outlet air temperature allowed for this unitary system
during cooling operation. This value should be less than the maximum outlet
air temperature during heating operation.
Units: C
Default value: 8.0

Parameters:	value (float) – value for IDD Field Minimum Outlet Air Temperature During Cooling Operation
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of minimum_outlet_air_temperature_during_cooling_operation or None if not set
Return type:	float

name¶

field Name

Enter a unique name for this unitary system.

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

no_load_outdoor_air_flow_rate¶

field No Load Outdoor Air Flow Rate

Only used when the supply air fan operating mode is continuous (see field
Supply air fan operating mode schedule name). This outdoor air flow rate
is used when no heating or cooling is required and the coils are off.
If this field is left blank or zero, the outdoor air flow rate from the previous on cycle
(either cooling or heating) is used.
Units: m3/s

Parameters:	value (float or “Autosize”) – value for IDD Field No Load Outdoor Air Flow Rate
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of no_load_outdoor_air_flow_rate or None if not set
Return type:	float or “Autosize”

no_load_supply_air_flow_rate¶

field No Load Supply Air Flow Rate

Only used when the supply air fan operating mode is continuous (see field
Supply air fan operating mode schedule name). This system air flow rate
is used when no heating or cooling is required and the coils are off.
If this field is left blank or zero, the system air flow rate from the
previous on cycle (either cooling or heating) is used.
Units: m3/s

Parameters:	value (float or “Autosize”) – value for IDD Field No Load Supply Air Flow Rate
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of no_load_supply_air_flow_rate or None if not set
Return type:	float or “Autosize”

outdoor_air_flow_rate_multiplier_schedule_name¶

field Outdoor Air Flow Rate Multiplier Schedule Name

Enter the name of a schedule that contains multipliers for the outdoor air
flow rates. Schedule values must be from 0 to 1.
If field is left blank, model assumes multiplier is 1 for the entire simulation period.

Parameters:	value (str) – value for IDD Field Outdoor Air Flow Rate Multiplier Schedule Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of outdoor_air_flow_rate_multiplier_schedule_name or None if not set
Return type:	str

outdoor_air_mixer_name¶

field Outdoor Air Mixer Name

Enter the name of the outdoor air mixer used with this unitary system.

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

outdoor_air_mixer_object_type¶

field Outdoor Air Mixer Object Type

currently only one type OutdoorAir:Mixer object is available.

Parameters:	value (str) – value for IDD Field Outdoor Air Mixer Object Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of outdoor_air_mixer_object_type or None if not set
Return type:	str

priority_control_mode¶

field Priority Control Mode

CoolingPriority = system provides cooling if any zone requires cooling.
HeatingPriority = system provides heating if any zone requires heating.
ZonePriority = system controlled based on the total number of zones
requiring cooling or heating (highest number of zones
in cooling or heating determines the system’s operating mode).
Default value: ZonePriority

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

supply_air_fan_name¶

field Supply Air Fan Name

Enter the name of the supply air fan used in this unitary system.

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

supply_air_fan_object_type¶

field Supply Air Fan Object Type

Specify the type of supply air fan used in this unitary system.

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

supply_air_fan_operating_mode_schedule_name¶

field Supply Air Fan Operating Mode Schedule Name

Enter the name of a schedule to control the supply air fan. Schedule Name values of zero
mean that the supply air fan will cycle off if there is no cooling or heating load
in any of the zones being served by this system. Non-zero schedule values mean
that the supply air fan will operate continuously even if there is no cooling or
heating load in any of the zones being served. If this field is left blank,
the supply air fan will operate continuously for the entire simulation period.

Parameters:	value (str) – value for IDD Field Supply Air Fan Operating Mode Schedule Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of supply_air_fan_operating_mode_schedule_name or None if not set
Return type:	str

supply_air_fan_placement¶

field Supply Air Fan Placement

Specify supply air fan placement as either blow through or draw through.
BlowThrough means the supply air fan is located before the cooling
coil. DrawThrough means the supply air fan is located after the heating coil.

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

class pyidf.unitary_equipment.AirLoopHvacUnitaryHeatOnly¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object AirLoopHVAC:UnitaryHeatOnly Unitary system, heating-only with constant volume supply fan (continuous or cycling) and heating coil (gas, electric, hot water, or steam). Identical to AirLoopHVAC:Unitary:Furnace:HeatOnly.

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

controlling_zone_or_thermostat_location¶

field Controlling Zone or Thermostat Location

Parameters:	value (str) – value for IDD Field Controlling Zone or Thermostat Location
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of controlling_zone_or_thermostat_location or None if not set
Return type:	str

fan_placement¶

field Fan Placement

Default value: BlowThrough

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

heating_coil_name¶

field Heating Coil Name

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

heating_coil_object_type¶

field Heating Coil Object Type

works with gas, electric, hot water and steam heating coils

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

heating_supply_air_flow_rate¶

field Heating Supply Air Flow Rate

This value should be > 0 and <= than the fan air flow rate.

Units: m3/s

Parameters:	value (float or “Autosize”) – value for IDD Field Heating Supply Air Flow Rate
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of heating_supply_air_flow_rate or None if not set
Return type:	float or “Autosize”

maximum_supply_air_temperature¶

field Maximum Supply Air Temperature

Units: C

Default value: 80.0

Parameters:	value (float or “Autosize”) – value for IDD Field Maximum Supply Air Temperature
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of maximum_supply_air_temperature or None if not set
Return type:	float or “Autosize”

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

supply_air_fan_operating_mode_schedule_name¶

field Supply Air Fan Operating Mode Schedule Name

A fan operating mode schedule value of 0 indicates cycling fan mode (supply air
fan cycles on and off in tandem with the heating coil).
Any other schedule value indicates continuous fan mode (supply air fan operates
continuously regardless of heating coil operation).
Leaving this schedule name blank will default to cycling fan mode for the
entire simulation period.

Parameters:	value (str) – value for IDD Field Supply Air Fan Operating Mode Schedule Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of supply_air_fan_operating_mode_schedule_name or None if not set
Return type:	str

supply_fan_name¶

field Supply Fan Name

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

supply_fan_object_type¶

field Supply Fan Object Type

Fan:ConstantVolume only works with continuous fan operating mode (i.e. fan

operating mode schedule values are greater than 0).

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

unitary_system_air_inlet_node_name¶

field Unitary System Air Inlet Node Name

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

unitary_system_air_outlet_node_name¶

field Unitary System Air Outlet Node Name

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

class pyidf.unitary_equipment.AirLoopHvacUnitaryHeatPumpAirToAir¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object AirLoopHVAC:UnitaryHeatPump:AirToAir Unitary heat pump system, heating and cooling, single-speed with supply fan, direct expansion (DX) cooling coil, DX heating coil (air-to-air heat pump), and supplemental heating coil (gas, electric, hot water, or steam).

air_inlet_node_name¶

field Air Inlet Node Name

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

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.
A schedule value greater than zero (usually 1 is used) indicates that the unit is
available to operate as needed. A value less than or equal to zero (usually zero
is used) denotes that the unit must be 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

controlling_zone_or_thermostat_location¶

field Controlling Zone or Thermostat Location

Parameters:	value (str) – value for IDD Field Controlling Zone or Thermostat Location
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of controlling_zone_or_thermostat_location or None if not set
Return type:	str

cooling_coil_name¶

field Cooling Coil Name

Needs to match in the DX cooling coil object

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

cooling_coil_object_type¶

field Cooling Coil Object Type

Only works with Coil:Cooling:DX:SingleSpeed or
CoilSystem:Cooling:DX:HeatExchangerAssisted or
Coil:Cooling:DX:VariableSpeed

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

cooling_supply_air_flow_rate¶

field Cooling Supply Air Flow Rate

Must be less than or equal to the fan’s maximum flow rate.

Units: m3/s

Parameters:	value (float or “Autosize”) – value for IDD Field Cooling Supply Air Flow Rate
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of cooling_supply_air_flow_rate or None if not set
Return type:	float or “Autosize”

dehumidification_control_type¶

field Dehumidification Control Type

None = meet sensible load only
Multimode = activate enhanced dehumidification mode
as needed and meet sensible load.  Valid only with
cooling coil type CoilSystem:Cooling:DX:HeatExchangerAssisted.
This control mode allows the heat exchanger to be turned
on and off based on the zone dehumidification requirements.
A ZoneControl:Humidistat object is also required.
CoolReheat = cool beyond the dry-bulb setpoint.
as required to meet the humidity setpoint.  Valid with all
cooling coil types. When a heat exchanger assisted Cooling
coil is used, the heat exchanger is locked on at all times.
A ZoneControl:Humidistat object is also required.
Default value: None

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

fan_placement¶

field Fan Placement

Default value: BlowThrough

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

heating_coil_name¶

field Heating Coil Name

Needs to match in the DX heating coil object

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

heating_coil_object_type¶

field Heating Coil Object Type

Only works with Coil:Heating:DX:SingleSpeed or

Coil:Heating:DX:VariableSpeed

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

heating_supply_air_flow_rate¶

field Heating Supply Air Flow Rate

Must be less than or equal to the fan’s maximum flow rate.

Units: m3/s

Parameters:	value (float or “Autosize”) – value for IDD Field Heating Supply Air Flow Rate
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of heating_supply_air_flow_rate or None if not set
Return type:	float or “Autosize”

maximum_outdoor_drybulb_temperature_for_supplemental_heater_operation¶

field Maximum Outdoor Dry-Bulb Temperature for Supplemental Heater Operation

Units: C
Default value: 21.0
value <= 21.0

Parameters:	value (float) – value for IDD Field Maximum Outdoor Dry-Bulb Temperature for Supplemental Heater Operation
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of maximum_outdoor_drybulb_temperature_for_supplemental_heater_operation or None if not set
Return type:	float

maximum_supply_air_temperature_from_supplemental_heater¶

field Maximum Supply Air Temperature from Supplemental Heater

Units: C

Parameters:	value (float or “Autosize”) – value for IDD Field Maximum Supply Air Temperature from Supplemental Heater
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of maximum_supply_air_temperature_from_supplemental_heater or None if not set
Return type:	float or “Autosize”

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

no_load_supply_air_flow_rate¶

field No Load Supply Air Flow Rate

Must be less than or equal to the fan’s maximum flow rate.
Only used when fan operating mode is continuous (disregarded for cycling fan mode).
This air flow rate is used when no heating or cooling is required (i.e., the DX coil
compressor and supplemental heating coil are off). If this field is left blank or zero,
the supply air flow rate from the previous on cycle (either cooling or heating) is used.
Units: m3/s

Parameters:	value (float or “Autosize”) – value for IDD Field No Load Supply Air Flow Rate
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of no_load_supply_air_flow_rate or None if not set
Return type:	float or “Autosize”

supplemental_heating_coil_name¶

field Supplemental Heating Coil Name

Needs to match in the supplemental heating coil object

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

supplemental_heating_coil_object_type¶

field Supplemental Heating Coil Object Type

works with gas, electric, hot water and steam heating coils

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

supply_air_fan_name¶

field Supply Air Fan Name

Needs to match in the fan object

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

supply_air_fan_object_type¶

field Supply Air Fan Object Type

Fan:ConstantVolume only works with continuous fan operating mode (i.e. fan
operating mode schedule values are greater than 0 or the fan operating mode
schedule name field is left blank).

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

supply_air_fan_operating_mode_schedule_name¶

field Supply Air Fan Operating Mode Schedule Name

A fan operating mode schedule value of 0 indicates cycling fan mode (supply air
fan cycles on and off in tandem with the cooling or heating coil).
Any other schedule value indicates continuous fan mode (supply air fan operates
continuously regardless of cooling or heating coil operation).
Leaving this schedule name blank will default to cycling fan mode for the
entire simulation period.

Parameters:	value (str) – value for IDD Field Supply Air Fan Operating Mode Schedule Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of supply_air_fan_operating_mode_schedule_name or None if not set
Return type:	str

class pyidf.unitary_equipment.AirLoopHvacUnitaryHeatPumpAirToAirMultiSpeed¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object AirLoopHVAC:UnitaryHeatPump:AirToAir:MultiSpeed Unitary system, heating and cooling, multi-speed with constant volume supply fan (continuous or cycling), direct expansion (DX) cooling coil, heating coil (DX air-to-air heat pump, gas, electric, hot water, or steam), and supplemental heating coil (gas, electric, hot water, or steam).

air_inlet_node_name¶

field Air Inlet Node Name

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

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

auxiliary_offcycle_electric_power¶

field Auxiliary Off-Cycle Electric Power

Units: W

Parameters:	value (float) – value for IDD Field Auxiliary Off-Cycle Electric Power
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of auxiliary_offcycle_electric_power or None if not set
Return type:	float

auxiliary_oncycle_electric_power¶

field Auxiliary On-Cycle Electric Power

Units: W

Parameters:	value (float) – value for IDD Field Auxiliary On-Cycle Electric Power
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of auxiliary_oncycle_electric_power or None if not set
Return type:	float

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

controlling_zone_or_thermostat_location¶

field Controlling Zone or Thermostat Location

Parameters:	value (str) – value for IDD Field Controlling Zone or Thermostat Location
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of controlling_zone_or_thermostat_location or None if not set
Return type:	str

cooling_coil_name¶

field Cooling Coil Name

Needs to match in the DX Cooling Coil object

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

cooling_coil_object_type¶

field Cooling Coil Object Type

Only works with Coil:Cooling:DX:MultiSpeed

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

cooling_speed_1_supply_air_flow_rate¶

field Cooling Speed 1 Supply Air Flow Rate

Enter the operating supply air flow rate during cooling
operation or specify autosize.
Units: m3/s

Parameters:	value (float or “Autosize”) – value for IDD Field Cooling Speed 1 Supply Air Flow Rate
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of cooling_speed_1_supply_air_flow_rate or None if not set
Return type:	float or “Autosize”

cooling_speed_2_supply_air_flow_rate¶

field Cooling Speed 2 Supply Air Flow Rate

Enter the operating supply air flow rate during cooling
operation or specify autosize.
Units: m3/s

Parameters:	value (float or “Autosize”) – value for IDD Field Cooling Speed 2 Supply Air Flow Rate
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of cooling_speed_2_supply_air_flow_rate or None if not set
Return type:	float or “Autosize”

cooling_speed_3_supply_air_flow_rate¶

field Cooling Speed 3 Supply Air Flow Rate

Enter the operating supply air flow rate during cooling
operation or specify autosize.
Units: m3/s

Parameters:	value (float or “Autosize”) – value for IDD Field Cooling Speed 3 Supply Air Flow Rate
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of cooling_speed_3_supply_air_flow_rate or None if not set
Return type:	float or “Autosize”

cooling_speed_4_supply_air_flow_rate¶

field Cooling Speed 4 Supply Air Flow Rate

Enter the operating supply air flow rate during cooling
operation or specify autosize.
Units: m3/s

Parameters:	value (float or “Autosize”) – value for IDD Field Cooling Speed 4 Supply Air Flow Rate
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of cooling_speed_4_supply_air_flow_rate or None if not set
Return type:	float or “Autosize”

design_heat_recovery_water_flow_rate¶

field Design Heat Recovery Water Flow Rate

If non-zero, then the heat recovery inlet and outlet node names must be entered.
Used for heat recovery to an EnergyPlus plant loop.
Units: m3/s

Parameters:	value (float) – value for IDD Field Design Heat Recovery Water Flow Rate
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of design_heat_recovery_water_flow_rate or None if not set
Return type:	float

heat_recovery_water_inlet_node_name¶

field Heat Recovery Water Inlet Node Name

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

heat_recovery_water_outlet_node_name¶

field Heat Recovery Water Outlet Node Name

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

heating_coil_name¶

field Heating Coil Name

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

heating_coil_object_type¶

field Heating Coil Object Type

Multi Speed DX, Electric, Gas, and Single speed Water and Steam coils

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

heating_speed_1_supply_air_flow_rate¶

field Heating Speed 1 Supply Air Flow Rate

Enter the operating supply air flow rate during heating
operation or specify autosize.
Units: m3/s

Parameters:	value (float or “Autosize”) – value for IDD Field Heating Speed 1 Supply Air Flow Rate
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of heating_speed_1_supply_air_flow_rate or None if not set
Return type:	float or “Autosize”

heating_speed_2_supply_air_flow_rate¶

field Heating Speed 2 Supply Air Flow Rate

Enter the operating supply air flow rate during heating
operation or specify autosize.
Units: m3/s

Parameters:	value (float or “Autosize”) – value for IDD Field Heating Speed 2 Supply Air Flow Rate
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of heating_speed_2_supply_air_flow_rate or None if not set
Return type:	float or “Autosize”

heating_speed_3_supply_air_flow_rate¶

field Heating Speed 3 Supply Air Flow Rate

Enter the operating supply air flow rate during heating
operation or specify autosize.
Units: m3/s

Parameters:	value (float or “Autosize”) – value for IDD Field Heating Speed 3 Supply Air Flow Rate
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of heating_speed_3_supply_air_flow_rate or None if not set
Return type:	float or “Autosize”

heating_speed_4_supply_air_flow_rate¶

field Heating Speed 4 Supply Air Flow Rate

Enter the operating supply air flow rate during heating
operation or specify autosize.
Units: m3/s

Parameters:	value (float or “Autosize”) – value for IDD Field Heating Speed 4 Supply Air Flow Rate
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of heating_speed_4_supply_air_flow_rate or None if not set
Return type:	float or “Autosize”

maximum_outdoor_drybulb_temperature_for_supplemental_heater_operation¶

field Maximum Outdoor Dry-Bulb Temperature for Supplemental Heater Operation

Units: C
Default value: 21.0
value <= 21.0

Parameters:	value (float) – value for IDD Field Maximum Outdoor Dry-Bulb Temperature for Supplemental Heater Operation
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of maximum_outdoor_drybulb_temperature_for_supplemental_heater_operation or None if not set
Return type:	float

maximum_supply_air_temperature_from_supplemental_heater¶

field Maximum Supply Air Temperature from Supplemental Heater

Units: C

Parameters:	value (float or “Autosize”) – value for IDD Field Maximum Supply Air Temperature from Supplemental Heater
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of maximum_supply_air_temperature_from_supplemental_heater or None if not set
Return type:	float or “Autosize”

maximum_temperature_for_heat_recovery¶

field Maximum Temperature for Heat Recovery

Units: C
Default value: 80.0
value <= 100.0

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

minimum_outdoor_drybulb_temperature_for_compressor_operation¶

field Minimum Outdoor Dry-Bulb Temperature for Compressor Operation

Needs to match the corresponding minimum outdoor temperature defined
in the DX heating coil object.
Units: C
Default value: -8.0

Parameters:	value (float) – value for IDD Field Minimum Outdoor Dry-Bulb Temperature for Compressor Operation
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of minimum_outdoor_drybulb_temperature_for_compressor_operation 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

no_load_supply_air_flow_rate¶

field No Load Supply Air Flow Rate

Only used when the supply air fan operating mode is continuous (see field
Supply Air Fan Operating Mode Schedule Name). This air flow rate
is used when no heating or cooling is required and the coils are off.
If this field is left blank or zero, the supply air flow rate from the
previous on cycle (either cooling or heating) is used.
Units: m3/s

Parameters:	value (float or “Autosize”) – value for IDD Field No Load Supply Air Flow Rate
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of no_load_supply_air_flow_rate or None if not set
Return type:	float or “Autosize”

number_of_speeds_for_cooling¶

field Number of Speeds for Cooling

Enter the number of the following sets of data for air flow rates.
value >= 2
value <= 4

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

number_of_speeds_for_heating¶

field Number of Speeds for Heating

Enter the number of the following sets of data for air flow rates.
If Heating Coil Object Type is Coil:Heating:Water or Coil:Heating:Steam,
this field should be 1.
value >= 1
value <= 4

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

supplemental_heating_coil_name¶

field Supplemental Heating Coil Name

Needs to match in the supplemental heating coil object

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

supplemental_heating_coil_object_type¶

field Supplemental Heating Coil Object Type

works with gas, electric, hot water and steam heating coils

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

supply_air_fan_name¶

field Supply Air Fan Name

Enter the name of the supply air fan used in this unitary system.

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

supply_air_fan_object_type¶

field Supply Air Fan Object Type

Select the type of supply air fan used in this unitary system.

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

supply_air_fan_operating_mode_schedule_name¶

field Supply Air Fan Operating Mode Schedule Name

Enter the name of a schedule to control the supply air fan. Schedule values of zero
mean that the supply air fan will cycle off if there is no cooling or heating load
in the control zone. Non-zero schedule values mean that the supply air fan
will operate continuously even if there is no cooling or heating load
in the control zone. If this field is left blank, the supply air fan will
operate continuously for the entire simulation period.

Parameters:	value (str) – value for IDD Field Supply Air Fan Operating Mode Schedule Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of supply_air_fan_operating_mode_schedule_name or None if not set
Return type:	str

supply_air_fan_placement¶

field Supply Air Fan Placement

Select supply air fan placement as either BlowThrough or DrawThrough.
BlowThrough means the supply air fan is located before the cooling
coil. DrawThrough means the supply air fan is located after the heating coil
but before the optional supplemental heating coil.

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

class pyidf.unitary_equipment.AirLoopHvacUnitaryHeatPumpWaterToAir¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object AirLoopHVAC:UnitaryHeatPump:WaterToAir Unitary heat pump system, heating and cooling, single-speed with constant volume supply fan (continuous or cycling), direct expansion (DX) cooling coil, DX heating coil (water-to-air heat pump), and supplemental heating coil (gas, electric, hot water, or steam).

air_inlet_node_name¶

field Air Inlet Node Name

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

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.

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

controlling_zone_or_thermostat_location¶

field Controlling Zone or Thermostat Location

Parameters:	value (str) – value for IDD Field Controlling Zone or Thermostat Location
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of controlling_zone_or_thermostat_location or None if not set
Return type:	str

cooling_coil_name¶

field Cooling Coil Name

Needs to match in the water-to-air heat pump cooling coil object

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

cooling_coil_object_type¶

field Cooling Coil Object Type

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

cooling_convergence¶

field Cooling Convergence

Default value: 0.001

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

dehumidification_control_type¶

field Dehumidification Control Type

None = meet sensible load only
CoolReheat = cool beyond the dry-bulb setpoint.
as required to meet the humidity setpoint.  Valid only with
Coil:Cooling:WaterToAirHeatPump:EquationFit or
Coil:Cooling:WaterToAirHeatPump:VariableSpeedEquationFit
Default value: None

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

fan_placement¶

field Fan Placement

Default value: BlowThrough

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

fraction_of_oncycle_power_use¶

field Fraction of On-Cycle Power Use

The fraction of on-cycle power use to adjust the part load fraction based on
the off-cycle power consumption due to crankcase heaters, controls, fans, and etc.
Suggested value is 0.01 for a typical heat pump
Default value: 0.01
value <= 0.05

Parameters:	value (float) – value for IDD Field Fraction of On-Cycle Power Use
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of fraction_of_oncycle_power_use or None if not set
Return type:	float

heat_pump_coil_water_flow_mode¶

field Heat Pump Coil Water Flow Mode

used only when the heat pump coils are of the type WaterToAirHeatPump:EquationFit
Constant results in 100% water flow regardless of compressor PLR
Cycling results in water flow that matches compressor PLR
ConstantOnDemand results in 100% water flow whenever the coil is on, but is 0% whenever the coil has no load
Default value: Cycling

Parameters:	value (str) – value for IDD Field Heat Pump Coil Water Flow Mode
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of heat_pump_coil_water_flow_mode or None if not set
Return type:	str

heat_pump_fan_delay_time¶

field Heat Pump Fan Delay Time

Programmed time delay for heat pump fan to shut off after compressor cycle off.
Only required when fan operating mode is cycling
Enter 0 when fan operating mode is continuous
Units: s
Default value: 60.0

Parameters:	value (float) – value for IDD Field Heat Pump Fan Delay Time
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of heat_pump_fan_delay_time or None if not set
Return type:	float

heat_pump_time_constant¶

field Heat Pump Time Constant

Time constant for the cooling coil’s capacity to reach steady state after startup
Suggested value is 60 for a typical heat pump
Units: s
Default value: 60.0
value <= 500.0

Parameters:	value (float) – value for IDD Field Heat Pump Time Constant
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of heat_pump_time_constant or None if not set
Return type:	float

heating_coil_name¶

field Heating Coil Name

Needs to match in the water-to-air heat pump heating coil object

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

heating_coil_object_type¶

field Heating Coil Object Type

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

heating_convergence¶

field Heating Convergence

Default value: 0.001

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

maximum_cycling_rate¶

field Maximum Cycling Rate

The maximum on-off cycling rate for the compressor
Suggested value is 2.5 for a typical heat pump
Units: cycles/hr
Default value: 2.5
value <= 5.0

Parameters:	value (float) – value for IDD Field Maximum Cycling Rate
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of maximum_cycling_rate or None if not set
Return type:	float

maximum_outdoor_drybulb_temperature_for_supplemental_heater_operation¶

field Maximum Outdoor Dry-Bulb Temperature for Supplemental Heater Operation

Units: C
Default value: 21.0
value <= 21.0

Parameters:	value (float) – value for IDD Field Maximum Outdoor Dry-Bulb Temperature for Supplemental Heater Operation
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of maximum_outdoor_drybulb_temperature_for_supplemental_heater_operation or None if not set
Return type:	float

maximum_supply_air_temperature_from_supplemental_heater¶

field Maximum Supply Air Temperature from Supplemental Heater

Units: C

Parameters:	value (float or “Autosize”) – value for IDD Field Maximum Supply Air Temperature from Supplemental Heater
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of maximum_supply_air_temperature_from_supplemental_heater or None if not set
Return type:	float or “Autosize”

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

outdoor_drybulb_temperature_sensor_node_name¶

field Outdoor Dry-Bulb Temperature Sensor Node Name

Parameters:	value (str) – value for IDD Field Outdoor Dry-Bulb Temperature Sensor Node Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of outdoor_drybulb_temperature_sensor_node_name or None if not set
Return type:	str

supplemental_heating_coil_name¶

field Supplemental Heating Coil Name

Needs to match in the supplemental heating coil object

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

supplemental_heating_coil_object_type¶

field Supplemental Heating Coil Object Type

works with gas, electric, hot water and steam heating coils

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

supply_air_fan_name¶

field Supply Air Fan Name

Needs to match Fan:OnOff object

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

supply_air_fan_object_type¶

field Supply Air Fan Object Type

Only works with On/Off Fan

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

supply_air_fan_operating_mode_schedule_name¶

field Supply Air Fan Operating Mode Schedule Name

Enter the name of a schedule that controls fan operation. Schedule values of 0 denote
cycling fan operation (fan cycles with cooling or heating coil). Schedule values greater
than 0 denote constant fan operation (fan runs continually regardless of coil operation).
The fan operating mode defaults to cycling fan operation if this field is left blank.

Parameters:	value (str) – value for IDD Field Supply Air Fan Operating Mode Schedule Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of supply_air_fan_operating_mode_schedule_name or None if not set
Return type:	str

supply_air_flow_rate¶

field Supply Air Flow Rate

This value should be > 0 and <= than the fan air flow rate.

Units: m3/s

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

class pyidf.unitary_equipment.AirLoopHvacUnitarySystem¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object AirLoopHVAC:UnitarySystem AirloopHVAC:UnitarySystem is a generic HVAC system type that allows any configuration of coils and/or fan. This object is a replacement of other AirloopHVAC objects. This object can be used in outdoor air systems, outdoor air units, air loops, and as zone equipment if desired.

air_inlet_node_name¶

field Air Inlet Node Name

Enter the node name used as the inlet air node for the unitary system.

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

Enter the node name used as the outlet air node for the unitary system.

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

ancillary_offcycle_electric_power¶

field Ancillary Off-Cycle Electric Power

Enter the value of ancillary electric power for controls or other devices consumed during the off cycle.

Units: W

Parameters:	value (float) – value for IDD Field Ancillary Off-Cycle Electric Power
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of ancillary_offcycle_electric_power or None if not set
Return type:	float

ancillary_oncycle_electric_power¶

field Ancillary On-Cycle Electric Power

Enter the value of ancillary electric power for controls or other devices consumed during the on cycle.

Units: W

Parameters:	value (float) – value for IDD Field Ancillary On-Cycle Electric Power
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of ancillary_oncycle_electric_power or None if not set
Return type:	float

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.
A schedule value greater than zero (usually 1 is used) indicates that the unit is
available to operate as needed. A value less than or equal to zero (usually zero
is used) denotes that the unit must be 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

control_type¶

field Control Type

Load control requires a Controlling Zone name.
SetPoint control requires set points at coil outlet node.
Default value: Load

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

controlling_zone_or_thermostat_location¶

field Controlling Zone or Thermostat Location

Used only for Load based control

Zone name where thermostat is located. Required when Control Type = Load.

Parameters:	value (str) – value for IDD Field Controlling Zone or Thermostat Location
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of controlling_zone_or_thermostat_location or None if not set
Return type:	str

cooling_coil_name¶

field Cooling Coil Name

Enter the name of the cooling coil if included in the unitary system.

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

cooling_coil_object_type¶

field Cooling Coil Object Type

Enter the type of cooling coil if included in the unitary system.

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

cooling_fraction_of_autosized_cooling_supply_air_flow_rate¶

field Cooling Fraction of Autosized Cooling Supply Air Flow Rate

Enter the supply air volume flow rate as a fraction of the cooling supply air flow rate.
Required field when Cooling Supply Air Flow Rate Method is FractionOfAutosizedCoolingValue.
This field may be blank if a cooling coil is not included in the unitary system.

Parameters:	value (float) – value for IDD Field Cooling Fraction of Autosized Cooling Supply Air Flow Rate
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of cooling_fraction_of_autosized_cooling_supply_air_flow_rate or None if not set
Return type:	float

cooling_supply_air_flow_rate¶

field Cooling Supply Air Flow Rate

Enter the magnitude of the supply air volume flow rate during cooling operation.
Required field when Cooling Supply Air Flow Rate Method is SupplyAirFlowRate.
This field may be blank if a cooling coil is not included in the unitary system.
Units: m3/s

Parameters:	value (float or “Autosize”) – value for IDD Field Cooling Supply Air Flow Rate
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of cooling_supply_air_flow_rate or None if not set
Return type:	float or “Autosize”

cooling_supply_air_flow_rate_method¶

field Cooling Supply Air Flow Rate Method

Enter the method used to determine the cooling supply air volume flow rate.
None is used when a cooling coil is not included in the unitary system or this field may be blank.
SupplyAirFlowRate is selected when the magnitude of the supply air volume is used.
FlowPerFloorArea is selected when the supply air volume flow rate is based on total floor area
served by the unitary system.
FractionOfAutosizedCoolingValue is selected when the supply air volume is a fraction of the
value determined by the simulation.
FlowPerCoolingCapacity is selected when the supply air volume is a fraction of the cooling
capacity as determined by the simulation.

Parameters:	value (str) – value for IDD Field Cooling Supply Air Flow Rate Method
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of cooling_supply_air_flow_rate_method or None if not set
Return type:	str

cooling_supply_air_flow_rate_per_floor_area¶

field Cooling Supply Air Flow Rate Per Floor Area

Enter the supply air volume flow rate per total floor area fraction.
Required field when Cooling Supply Air Flow Rate Method is FlowPerFloorArea.
This field may be blank if a cooling coil is not included in the unitary system.
Units: m3/s-m2

Parameters:	value (float) – value for IDD Field Cooling Supply Air Flow Rate Per Floor Area
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of cooling_supply_air_flow_rate_per_floor_area or None if not set
Return type:	float

cooling_supply_air_flow_rate_per_unit_of_capacity¶

field Cooling Supply Air Flow Rate Per Unit of Capacity

Enter the supply air volume flow rate as a fraction of the cooling capacity.
Required field when Cooling Supply Air Flow Rate Method is FlowPerCoolingCapacity.
This field may be blank if a cooling coil is not included in the unitary system.
Units: m3/s-W

Parameters:	value (float) – value for IDD Field Cooling Supply Air Flow Rate Per Unit of Capacity
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of cooling_supply_air_flow_rate_per_unit_of_capacity or None if not set
Return type:	float

dehumidification_control_type¶

field Dehumidification Control Type

None = meet sensible load only
Multimode = activate enhanced dehumidification mode
as needed and meet sensible load.  Valid only with
cooling coil type CoilSystem:Cooling:DX:HeatExchangerAssisted.
This control mode allows the heat exchanger to be turned
on and off based on the zone dehumidification requirements.
A ZoneControl:Humidistat object is also required.
CoolReheat = cool beyond the dry-bulb setpoint.
as required to meet the humidity setpoint.  Valid with all
cooling coil types. When a heat exchanger assisted cooling
coil is used, the heat exchanger is locked on at all times.
A ZoneControl:Humidistat object is also required.
Default value: None

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

design_heat_recovery_water_flow_rate¶

field Design Heat Recovery Water Flow Rate

If non-zero, then the heat recovery inlet and outlet node names must be entered.
Used for heat recovery to an EnergyPlus plant loop.
Units: m3/s

Parameters:	value (float) – value for IDD Field Design Heat Recovery Water Flow Rate
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of design_heat_recovery_water_flow_rate or None if not set
Return type:	float

design_specification_multispeed_object_name¶

field Design Specification Multispeed Object Name

Enter the name of the performance specification object used to describe the multispeed coil.

Parameters:	value (str) – value for IDD Field Design Specification Multispeed Object Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of design_specification_multispeed_object_name or None if not set
Return type:	str

design_specification_multispeed_object_type¶

field Design Specification Multispeed Object Type

Enter the type of performance specification object used to describe the multispeed coil.

Parameters:	value (str) – value for IDD Field Design Specification Multispeed Object Type
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of design_specification_multispeed_object_type or None if not set
Return type:	str

doas_dx_cooling_coil_leaving_minimum_air_temperature¶

field DOAS DX Cooling Coil Leaving Minimum Air Temperature

DX cooling coil leaving minimum air temperature defines the minimum DOAS DX cooling coil
leaving air temperature that should be maintained to avoid frost formation. This input
field is optional and only used along with the input field above.
Units: C
Default value: 2.0
value <= 7.2

Parameters:	value (float) – value for IDD Field DOAS DX Cooling Coil Leaving Minimum Air Temperature
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of doas_dx_cooling_coil_leaving_minimum_air_temperature or None if not set
Return type:	float

dx_heating_coil_sizing_ratio¶

field DX Heating Coil Sizing Ratio

Used to adjust heat pump heating capacity with respect to DX cooling capacity
used only for heat pump configurations (i.e., a DX cooling and DX heating coil is used).
Default value: 1.0

Parameters:	value (float) – value for IDD Field DX Heating Coil Sizing Ratio
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of dx_heating_coil_sizing_ratio or None if not set
Return type:	float

fan_placement¶

field Fan Placement

Enter the type of supply air fan if included in the unitary system.

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

fraction_of_oncycle_power_use¶

field Fraction of On-Cycle Power Use

Used only for water source heat pump.
The fraction of on-cycle power use to adjust the part load fraction based on
the off-cycle power consumption due to crankcase heaters, controls, fans, and etc.
Suggested value is 0.01 for a typical heat pump.
Default value: 0.01
value <= 0.05

Parameters:	value (float) – value for IDD Field Fraction of On-Cycle Power Use
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of fraction_of_oncycle_power_use or None if not set
Return type:	float

heat_pump_fan_delay_time¶

field Heat Pump Fan Delay Time

Used only for water source heat pump.
Programmed time delay for heat pump fan to shut off after compressor cycle off.
Only required when fan operating mode is cycling.
Enter 0 when fan operating mode is continuous.
Units: s
Default value: 60.0

Parameters:	value (float) – value for IDD Field Heat Pump Fan Delay Time
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of heat_pump_fan_delay_time or None if not set
Return type:	float

heat_pump_time_constant¶

field Heat Pump Time Constant

Used only for water source heat pump.
Time constant for the cooling coil’s capacity to reach steady state after startup.
Suggested value is 60 for a typical heat pump.
Units: s
Default value: 60.0
value <= 500.0

Parameters:	value (float) – value for IDD Field Heat Pump Time Constant
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of heat_pump_time_constant or None if not set
Return type:	float

heat_recovery_water_inlet_node_name¶

field Heat Recovery Water Inlet Node Name

Enter the name of the heat recovery water inlet node if plant water loop connections are present.

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

heat_recovery_water_outlet_node_name¶

field Heat Recovery Water Outlet Node Name

Enter the name of the heat recovery water outlet node if plant water loop connections are present.

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

heating_coil_name¶

field Heating Coil Name

Enter the name of the heating coil if included in the unitary system.

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

heating_coil_object_type¶

field Heating Coil Object Type

Enter the type of heating coil if included in the unitary system.

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

heating_fraction_of_autosized_heating_supply_air_flow_rate¶

field Heating Fraction of Autosized Heating Supply Air Flow Rate

Enter the supply air volume flow rate as a fraction of the heating supply air flow rate.
Required field when Heating Supply Air Flow Rate Method is FractionOfAutosizedHeatingValue.
This field may be blank if a heating coil is not included in the unitary system.

Parameters:	value (float) – value for IDD Field Heating Fraction of Autosized Heating Supply Air Flow Rate
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of heating_fraction_of_autosized_heating_supply_air_flow_rate or None if not set
Return type:	float

heating_supply_air_flow_rate¶

field Heating Supply Air Flow Rate

Enter the magnitude of the supply air volume flow rate during heating operation.
Required field when Heating Supply Air Flow Rate Method is SupplyAirFlowRate.
This field may be blank if a heating coil is not included in the unitary system.
Units: m3/s

Parameters:	value (float or “Autosize”) – value for IDD Field Heating Supply Air Flow Rate
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of heating_supply_air_flow_rate or None if not set
Return type:	float or “Autosize”

heating_supply_air_flow_rate_method¶

field Heating Supply Air Flow Rate Method

Enter the method used to determine the heating supply air volume flow rate.
None is used when a heating coil is not included in the unitary system or this field may be blank.
SupplyAirFlowRate is selected when the magnitude of the supply air volume is used.
FlowPerFloorArea is selected when the supply air volume flow rate is based on total floor area
served by the unitary system.
FractionOfAutosizedHeatingValue is selected when the supply air volume is a fraction of the
value determined by the simulation.
FlowPerHeatingCapacity is selected when the supply air volume is a fraction of the heating
capacity as determined by the simulation.

Parameters:	value (str) – value for IDD Field Heating Supply Air Flow Rate Method
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of heating_supply_air_flow_rate_method or None if not set
Return type:	str

heating_supply_air_flow_rate_per_floor_area¶

field Heating Supply Air Flow Rate Per Floor Area

Enter the supply air volume flow rate per total floor area fraction.
Required field when Heating Supply Air Flow Rate Method is FlowPerFloorArea.
This field may be blank if a heating coil is not included in the unitary system.
Units: m3/s-m2

Parameters:	value (float) – value for IDD Field Heating Supply Air Flow Rate Per Floor Area
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of heating_supply_air_flow_rate_per_floor_area or None if not set
Return type:	float

heating_supply_air_flow_rate_per_unit_of_capacity¶

field Heating Supply Air Flow Rate Per Unit of Capacity

Enter the supply air volume flow rate as a fraction of the heating capacity.
Required field when Heating Supply Air Flow Rate Method is FlowPerHeatingCapacity.
This field may be blank if a heating coil is not included in the unitary system.
Units: m3/s-W

Parameters:	value (float) – value for IDD Field Heating Supply Air Flow Rate Per Unit of Capacity
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of heating_supply_air_flow_rate_per_unit_of_capacity or None if not set
Return type:	float

latent_load_control¶

field Latent Load Control

SensibleOnlyLoadControl is selected when thermostat control is used.
LatentOnlyLoadControl is selected when humidistat control is used.
LatentWithSensibleLoadControl is selected when thermostat control is used and
dehumidification is required only when a sensible load exists.
LatentOrSensibleLoadControl is selected when thermostat control is used and
dehumidification is required any time the humidistat set point is exceeded.
Default value: SensibleOnlyLoadControl

Parameters:	value (str) – value for IDD Field Latent Load Control
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of latent_load_control or None if not set
Return type:	str

maximum_cycling_rate¶

field Maximum Cycling Rate

Used only for water source heat pump.
The maximum on-off cycling rate for the compressor.
Suggested value is 2.5 for a typical heat pump.
Units: cycles/hr
Default value: 2.5
value <= 5.0

Parameters:	value (float) – value for IDD Field Maximum Cycling Rate
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of maximum_cycling_rate or None if not set
Return type:	float

maximum_outdoor_drybulb_temperature_for_supplemental_heater_operation¶

field Maximum Outdoor Dry-Bulb Temperature for Supplemental Heater Operation

Enter the maximum outdoor dry-bulb temperature for supplemental heater operation.
Units: C
Default value: 21.0

Parameters:	value (float) – value for IDD Field Maximum Outdoor Dry-Bulb Temperature for Supplemental Heater Operation
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of maximum_outdoor_drybulb_temperature_for_supplemental_heater_operation or None if not set
Return type:	float

maximum_supply_air_temperature¶

field Maximum Supply Air Temperature

Enter the maximum supply air temperature leaving the heating coil.
Units: C
Default value: 80.0

Parameters:	value (float or “Autosize”) – value for IDD Field Maximum Supply Air Temperature
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of maximum_supply_air_temperature or None if not set
Return type:	float or “Autosize”

maximum_temperature_for_heat_recovery¶

field Maximum Temperature for Heat Recovery

Enter the maximum heat recovery inlet temperature allowed for heat recovery.
Units: C
Default value: 80.0
value <= 100.0

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

name¶

field Name

Unique name for the Unitary System.

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

no_load_fraction_of_autosized_cooling_supply_air_flow_rate¶

field No Load Fraction of Autosized Cooling Supply Air Flow Rate

Enter the supply air volume flow rate as a fraction of the cooling supply air flow rate.

Required field when No Load Supply Air Flow Rate Method is FractionOfAutosizedCoolingValue.

Parameters:	value (float) – value for IDD Field No Load Fraction of Autosized Cooling Supply Air Flow Rate
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of no_load_fraction_of_autosized_cooling_supply_air_flow_rate or None if not set
Return type:	float

no_load_fraction_of_autosized_heating_supply_air_flow_rate¶

field No Load Fraction of Autosized Heating Supply Air Flow Rate

Enter the supply air volume flow rate as a fraction of the heating supply air flow rate.

Required field when No Load Supply Air Flow Rate Method is FractionOfAutosizedHeatingValue.

Parameters:	value (float) – value for IDD Field No Load Fraction of Autosized Heating Supply Air Flow Rate
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of no_load_fraction_of_autosized_heating_supply_air_flow_rate or None if not set
Return type:	float

no_load_supply_air_flow_rate¶

field No Load Supply Air Flow Rate

Enter the magnitude of the supply air volume flow rate during when no cooling or heating is required.
Required field when No Load Supply Air Flow Rate Method is SupplyAirFlowRate.
Units: m3/s

Parameters:	value (float or “Autosize”) – value for IDD Field No Load Supply Air Flow Rate
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of no_load_supply_air_flow_rate or None if not set
Return type:	float or “Autosize”

no_load_supply_air_flow_rate_method¶

field No Load Supply Air Flow Rate Method

Enter the method used to determine the supply air volume flow rate when no cooling or heating is required.
None is used when a cooling and heating coil is not included in the unitary system or this field may be blank.
SupplyAirFlowRate is selected when the magnitude of the supply air volume is used.
FlowPerFloorArea is selected when the supply air volume flow rate is based on total floor area
served by the unitary system.
FractionOfAutosizedCoolingValue is selected when the supply air volume is a fraction of the
cooling value determined by the simulation.
FractionOfAutosizedHeatingValue is selected when the supply air volume is a fraction of the
heating value determined by the simulation.
FlowPerCoolingCapacity is selected when the supply air volume is a fraction of the cooling
capacity as determined by the simulation.
FlowPerHeatingCapacity is selected when the supply air volume is a fraction of the heating
capacity as determined by the simulation.

Parameters:	value (str) – value for IDD Field No Load Supply Air Flow Rate Method
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of no_load_supply_air_flow_rate_method or None if not set
Return type:	str

no_load_supply_air_flow_rate_per_floor_area¶

field No Load Supply Air Flow Rate Per Floor Area

Enter the supply air volume flow rate per total floor area fraction.
Required field when No Load Supply Air Flow Rate Method is FlowPerFloorArea.
Units: m3/s-m2

Parameters:	value (float) – value for IDD Field No Load Supply Air Flow Rate Per Floor Area
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of no_load_supply_air_flow_rate_per_floor_area or None if not set
Return type:	float

no_load_supply_air_flow_rate_per_unit_of_capacity_during_cooling_operation¶

field No Load Supply Air Flow Rate Per Unit of Capacity During Cooling Operation

Enter the supply air volume flow rate as a fraction of the cooling capacity.
Required field when No Load Supply Air Flow Rate Method is FlowPerCoolingCapacity.
Units: m3/s-W

Parameters:	value (float) – value for IDD Field No Load Supply Air Flow Rate Per Unit of Capacity During Cooling Operation
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of no_load_supply_air_flow_rate_per_unit_of_capacity_during_cooling_operation or None if not set
Return type:	float

no_load_supply_air_flow_rate_per_unit_of_capacity_during_heating_operation¶

field No Load Supply Air Flow Rate Per Unit of Capacity During Heating Operation

Enter the supply air volume flow rate as a fraction of the heating capacity.
Required field when No Load Supply Air Flow Rate Method is FlowPerHeatingCapacity.
Units: m3/s-W

Parameters:	value (float) – value for IDD Field No Load Supply Air Flow Rate Per Unit of Capacity During Heating Operation
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of no_load_supply_air_flow_rate_per_unit_of_capacity_during_heating_operation or None if not set
Return type:	float

outdoor_drybulb_temperature_sensor_node_name¶

field Outdoor Dry-Bulb Temperature Sensor Node Name

If this field is blank, outdoor temperature from the weather file is used.
If this field is not blank, the node name specified determines the outdoor temperature used
for controlling supplemental heater operation.

Parameters:	value (str) – value for IDD Field Outdoor Dry-Bulb Temperature Sensor Node Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of outdoor_drybulb_temperature_sensor_node_name or None if not set
Return type:	str

supplemental_heating_coil_name¶

field Supplemental Heating Coil Name

Enter the name of the supplemental heating coil if included in the unitary system.

Only required if dehumidification control type is “CoolReheat”.

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

supplemental_heating_coil_object_type¶

field Supplemental Heating Coil Object Type

Enter the type of supplemental heating coil if included in the unitary system.

Only required if dehumidification control type is “CoolReheat”.

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

supply_air_fan_operating_mode_schedule_name¶

field Supply Air Fan Operating Mode Schedule Name

A fan operating mode schedule value of 0 indicates cycling fan mode (supply air
fan cycles on and off in tandem with the cooling or heating coil).
Any other schedule value indicates continuous fan mode (supply air fan operates
continuously regardless of cooling or heating coil operation). Provide a schedule
with non-zero values when high humidity control is specified.
Leaving this schedule name blank will default to constant fan mode for the
entire simulation period.
This field is not used when set point based control is used where a set point
controls the coil (i.e., model assumes constant fan mode operation).

Parameters:	value (str) – value for IDD Field Supply Air Fan Operating Mode Schedule Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of supply_air_fan_operating_mode_schedule_name or None if not set
Return type:	str

supply_fan_name¶

field Supply Fan Name

Enter the name of the supply air fan if included in the unitary system.

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

supply_fan_object_type¶

field Supply Fan Object Type

Enter the type of supply air fan if included in the unitary system.
Fan:ConstantVolume only works with continuous fan operating mode (i.e. supply
air fan operating mode schedule values greater than 0).
Specify a Fan:OnOff object when the Supply Air Fan Operating Mode Schedule Name
input field above is left blank.
Specify a Fan:VariableVolume when modeling VAV systems which used setpoint based control
if the fan is included in the unitary system object.
The ComponentModel fan type may be substituted for the ConstantVolume or VariableVolume
fan types when more detailed fan modeling is required.
The variable or constant volume fan may be specified on the branch instead of contained
within the unitary system object (i.e., this field may be blank for certain configurations).

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

use_doas_dx_cooling_coil¶

field Use DOAS DX Cooling Coil

If Yes, the DX cooling coil runs as 100% DOAS DX coil.
If No, the DX cooling coil runs as a regular DX coil.
If left blank the default is regular dx coil.
Default value: No

Parameters:	value (str) – value for IDD Field Use DOAS DX Cooling Coil
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of use_doas_dx_cooling_coil or None if not set
Return type:	str

class pyidf.unitary_equipment.UnitarySystemPerformanceMultispeed¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object UnitarySystemPerformance:Multispeed The UnitarySystemPerformance object is used to specify the air flow ratio at each operating speed. This object is primarily used for multispeed DX and water coils to allow operation at alternate flow rates different from those specified in the coil object.

add_extensible(heating_speed_1_supply_air_flow_ratio=None, cooling_speed_1_supply_air_flow_ratio=None)¶

Add values for extensible fields

Parameters:

heating_speed_1_supply_air_flow_ratio (float or “Autosize”) – value for IDD Field Heating Speed 1 Supply Air Flow Ratio if value is None it will not be checked against the specification and is assumed to be a missing value
cooling_speed_1_supply_air_flow_ratio (float or “Autosize”) – value for IDD Field Cooling Speed 1 Supply Air Flow Ratio if value is None it will not be checked against the specification and is assumed to be a missing value

extensibles¶: Get list of all extensibles

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

number_of_speeds_for_cooling¶

field Number of Speeds for Cooling

Used only for Multi speed coils
Enter the number of the following sets of data for air flow rates.
value <= 10

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

number_of_speeds_for_heating¶

field Number of Speeds for Heating

Used only for Multi speed coils
Enter the number of the following sets of data for air flow rates.
value <= 10

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

pyidf.unitary_equipment module¶

Related Topics

This Page