pyidf.coils module

Data objects in group “Coils”

class pyidf.coils.CoilCoolingDxMultiSpeed

Bases: pyidf.helper.DataObject

Corresponds to IDD object Coil:Cooling:DX:MultiSpeed Direct expansion (DX) cooling coil and condensing unit (includes electric or engine-driven compressor and condenser fan), multi-speed (or variable-speed). Optional moisture evaporation from wet coil when compressor cycles off with continuous fan operation. Requires two to four sets of performance data and will interpolate between speeds. Modeled as a single coil (multi-speed compressor or multiple compressors with row split or intertwined coil).

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

apply_latent_degradation_to_speeds_greater_than_1

field Apply Latent Degradation to Speeds Greater than 1

Default value: No

Parameters:value (str) – value for IDD Field Apply Latent Degradation to Speeds Greater than 1 Raises:ValueError – if value is not a valid value Returns:the value of apply_latent_degradation_to_speeds_greater_than_1 or None if not set Return type:str

apply_part_load_fraction_to_speeds_greater_than_1

field Apply Part Load Fraction to Speeds Greater than 1

Default value: No

Parameters:value (str) – value for IDD Field Apply Part Load Fraction to Speeds Greater than 1 Raises:ValueError – if value is not a valid value Returns:the value of apply_part_load_fraction_to_speeds_greater_than_1 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

basin_heater_capacity

field Basin Heater Capacity

This field is only used for Condenser Type = EvaporativelyCooled and for periods

when the basin heater is available (field Basin Heater Operating Schedule Name).

For this situation, the heater maintains the basin water temperature at the basin heater

setpoint temperature when the outdoor air temperature falls below the setpoint temperature.

The basin heater only operates when the DX coil is off.

Units: W/K

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

basin_heater_operating_schedule_name

field Basin Heater Operating Schedule Name

This field is only used for Condenser Type = EvaporativelyCooled.

Schedule values greater than 0 allow the basin heater to operate whenever the outdoor

air dry-bulb temperature is below the basin heater setpoint temperature.

If a schedule name is not entered, the basin heater is allowed to operate

throughout the entire simulation.

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

basin_heater_setpoint_temperature

field Basin Heater Setpoint Temperature

This field is only used for Condenser Type = EvaporativelyCooled.

Enter the outdoor dry-bulb temperature when the basin heater turns on.

Units: C

Default value: 2.0

value >= 2.0

Parameters:value (float) – value for IDD Field Basin Heater Setpoint Temperature Raises:ValueError – if value is not a valid value Returns:the value of basin_heater_setpoint_temperature or None if not set Return type:float

condensate_collection_water_storage_tank_name

field Condensate Collection Water Storage Tank Name

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

condenser_air_inlet_node_name

field Condenser Air Inlet Node Name

Enter the name of an outdoor air node. This node name is also specified in

an OutdoorAir:Node or OutdoorAir:NodeList object.

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

condenser_type

field Condenser Type

Default value: AirCooled

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

crankcase_heater_capacity

field Crankcase Heater Capacity

Units: W

IP-Units: W

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

fuel_type

field Fuel Type

Default value: NaturalGas

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

maximum_outdoor_drybulb_temperature_for_crankcase_heater_operation

field Maximum Outdoor Dry-Bulb Temperature for Crankcase Heater Operation

Units: C

Default value: 10.0

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

number_of_speeds

field Number of Speeds

Enter the number of the following sets of data for coil capacity, SHR, COP,

flow rate, and associated curves.

value >= 2

value <= 4

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

rated_evaporator_fan_power_per_volume_flow_rate

field Rated Evaporator Fan Power Per Volume Flow Rate

Enter the evaporator fan power per air volume flow rate at the rated test conditions.

The test conditions vary external static pressure based on total cooling capacity.

This value is only used to calculate Seasonal Energy Efficiency Ratio (SEER), and the

Standard Rating (Net) Cooling Capacity which will be outputs in the EnergyPlus eio file.

This value is not used for modeling the evaporator fan during simulations.

Units: W/(m3/s)

Default value: 773.3

value <= 1250.0

Parameters:value (float) – value for IDD Field Rated Evaporator Fan Power Per Volume Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of rated_evaporator_fan_power_per_volume_flow_rate or None if not set Return type:float

rated_evaporator_fan_power_per_volume_flow_rate_v3

field Rated Evaporator Fan Power Per Volume Flow Rate v3

Enter the evaporator fan power per air volume flow rate at the rated test conditions.

The test conditions vary external static pressure based on total cooling capacity.

This value is only used to calculate Seasonal Energy Efficiency Ratio (SEER), and the

Standard Rating (Net) Cooling Capacity which will be outputs in the EnergyPlus eio file.

This value is not used for modeling the evaporator fan during simulations.

Units: W/(m3/s)

Default value: 773.3

value <= 1250.0

Parameters:value (float) – value for IDD Field Rated Evaporator Fan Power Per Volume Flow Rate v3 Raises:ValueError – if value is not a valid value Returns:the value of rated_evaporator_fan_power_per_volume_flow_rate_v3 or None if not set Return type:float

rated_evaporator_fan_power_per_volume_flow_rate_v4

field Rated Evaporator Fan Power Per Volume Flow Rate v4

Enter the evaporator fan power per air volume flow rate at the rated test conditions.

The test conditions vary external static pressure based on total cooling capacity.

This value is only used to calculate Seasonal Energy Efficiency Ratio (SEER), and the

Standard Rating (Net) Cooling Capacity which will be outputs in the EnergyPlus eio file.

This value is not used for modeling the evaporator fan during simulations.

Units: W/(m3/s)

Default value: 773.3

value <= 1250.0

Parameters:value (float) – value for IDD Field Rated Evaporator Fan Power Per Volume Flow Rate v4 Raises:ValueError – if value is not a valid value Returns:the value of rated_evaporator_fan_power_per_volume_flow_rate_v4 or None if not set Return type:float

rated_evaporator_fan_power_per_volume_flow_rate_v5

field Rated Evaporator Fan Power Per Volume Flow Rate v5

Enter the evaporator fan power per air volume flow rate at the rated test conditions.

The test conditions vary external static pressure based on total cooling capacity.

This value is only used to calculate Seasonal Energy Efficiency Ratio (SEER), and the

Standard Rating (Net) Cooling Capacity which will be outputs in the EnergyPlus eio file.

This value is not used for modeling the evaporator fan during simulations.

Units: W/(m3/s)

Default value: 773.3

value <= 1250.0

Parameters:value (float) – value for IDD Field Rated Evaporator Fan Power Per Volume Flow Rate v5 Raises:ValueError – if value is not a valid value Returns:the value of rated_evaporator_fan_power_per_volume_flow_rate_v5 or None if not set Return type:float

speed_1_energy_input_ratio_function_of_flow_fraction_curve_name

field Speed 1 Energy Input Ratio Function of Flow Fraction Curve Name

quadratic curve = a + b*ff + c*ff**2

cubic curve = a + b*ff + c*ff**2 + d*ff**3

ff = fraction of the full load flow

Parameters:value (str) – value for IDD Field Speed 1 Energy Input Ratio Function of Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_1_energy_input_ratio_function_of_flow_fraction_curve_name or None if not set Return type:str

speed_1_energy_input_ratio_function_of_temperature_curve_name

field Speed 1 Energy Input Ratio Function of Temperature Curve Name

curve = a + b*wb + c*wb**2 + d*edb + e*edb**2 + f*wb*edb

wb = entering wet-bulb temperature (C)

edb = dry-bulb temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Speed 1 Energy Input Ratio Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_1_energy_input_ratio_function_of_temperature_curve_name or None if not set Return type:str

speed_1_evaporative_condenser_air_flow_rate

field Speed 1 Evaporative Condenser Air Flow Rate

Used to calculate evaporative condenser water use

Units: m3/s

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

speed_1_evaporative_condenser_effectiveness

field Speed 1 Evaporative Condenser Effectiveness

Units: dimensionless

Default value: 0.9

value <= 1.0

Parameters:value (float) – value for IDD Field Speed 1 Evaporative Condenser Effectiveness Raises:ValueError – if value is not a valid value Returns:the value of speed_1_evaporative_condenser_effectiveness or None if not set Return type:float

speed_1_gross_rated_cooling_cop

field Speed 1 Gross Rated Cooling COP

Gross cooling capacity divided by power input to the compressor and outdoor fan,

does not include supply fan heat or supply fan electrical energy input

Units: W/W

Default value: 3.0

Parameters:value (float) – value for IDD Field Speed 1 Gross Rated Cooling COP Raises:ValueError – if value is not a valid value Returns:the value of speed_1_gross_rated_cooling_cop or None if not set Return type:float

speed_1_gross_rated_sensible_heat_ratio

field Speed 1 Gross Rated Sensible Heat Ratio

Gross Rated Sensible Heat Ratio (gross sensible capacity/gross total capacity)

Sensible and total capacities do not include supply fan heat

value >= 0.5

value <= 1.0

Parameters:value (float or “Autosize”) – value for IDD Field Speed 1 Gross Rated Sensible Heat Ratio Raises:ValueError – if value is not a valid value Returns:the value of speed_1_gross_rated_sensible_heat_ratio or None if not set Return type:float or “Autosize”

speed_1_gross_rated_total_cooling_capacity

field Speed 1 Gross Rated Total Cooling Capacity

Total cooling capacity not accounting for the effect of supply air fan heat

Gross capacity excluding supply air fan heat

Rating point: air entering the cooling coil at 26.7 C dry-bulb/19.4 C wet-bulb, and

air entering the outdoor condenser coil at 35 C dry-bulb/23.9 C wet-bulb

Speed 1 is defined as low speed

Units: W

Parameters:value (float or “Autosize”) – value for IDD Field Speed 1 Gross Rated Total Cooling Capacity Raises:ValueError – if value is not a valid value Returns:the value of speed_1_gross_rated_total_cooling_capacity or None if not set Return type:float or “Autosize”

speed_1_latent_capacity_time_constant

field Speed 1 Latent Capacity Time Constant

Time constant for the cooling coil’s latent capacity to reach steady state after

startup. Suggested value is 45; zero value means latent degradation

model is disabled.

Units: s

value <= 500.0

Parameters:value (float) – value for IDD Field Speed 1 Latent Capacity Time Constant Raises:ValueError – if value is not a valid value Returns:the value of speed_1_latent_capacity_time_constant or None if not set Return type:float

speed_1_maximum_cycling_rate

field Speed 1 Maximum Cycling Rate

The maximum on-off cycling rate for the compressor, which occurs at 50% run time

fraction. Suggested value is 3; zero value means latent degradation

model is disabled.

Units: cycles/hr

value <= 5.0

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

speed_1_nominal_time_for_condensate_removal_to_begin

field Speed 1 Nominal Time for Condensate Removal to Begin

The nominal time for condensate to begin leaving the coil’s condensate

drain line at the coil’s rated air flow rate and temperature conditions.

Nominal time is equal to the ratio of the energy of the coil’s maximum

condensate holding capacity (J) to the coil’s steady state latent capacity (W).

Suggested value is 1000; zero value means latent degradation model is disabled.

Units: s

value <= 3000.0

Parameters:value (float) – value for IDD Field Speed 1 Nominal Time for Condensate Removal to Begin Raises:ValueError – if value is not a valid value Returns:the value of speed_1_nominal_time_for_condensate_removal_to_begin or None if not set Return type:float

speed_1_part_load_fraction_correlation_curve_name

field Speed 1 Part Load Fraction Correlation Curve Name

quadratic curve = a + b*PLR + c*PLR**2

cubic curve = a + b*PLR + c*PLR**2 + d*PLR**3

PLR = part load ratio (cooling load/steady state capacity)

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

speed_1_rated_air_flow_rate

field Speed 1 Rated Air Flow Rate

Flow rate corresponding to rated total cooling capacity, rated SHR and rated

COP should be between 0.00004027 m3/s and .00006041 m3/s per watt of rated total

cooling capacity

Units: m3/s

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

speed_1_rated_evaporative_condenser_pump_power_consumption

field Speed 1 Rated Evaporative Condenser Pump Power Consumption

Rated power consumed by the evaporative condenser’s water pump at high speed

Units: W

Parameters:value (float or “Autosize”) – value for IDD Field Speed 1 Rated Evaporative Condenser Pump Power Consumption Raises:ValueError – if value is not a valid value Returns:the value of speed_1_rated_evaporative_condenser_pump_power_consumption or None if not set Return type:float or “Autosize”

speed_1_rated_waste_heat_fraction_of_power_input

field Speed 1 Rated Waste Heat Fraction of Power Input

Recoverable waste heat at full load and rated conditions

Units: dimensionless

Default value: 0.2

value <= 1.0

Parameters:value (float) – value for IDD Field Speed 1 Rated Waste Heat Fraction of Power Input Raises:ValueError – if value is not a valid value Returns:the value of speed_1_rated_waste_heat_fraction_of_power_input or None if not set Return type:float

speed_1_ratio_of_initial_moisture_evaporation_rate_and_steady_state_latent_capacity

field Speed 1 Ratio of Initial Moisture Evaporation Rate and Steady State Latent Capacity

Ratio of the initial moisture evaporation Rate from the Cooling Coil (when

the compressor first turns off) and the Coil’s steady state latent capacity

at rated air flow rate and temperature conditions. Suggested value is 1.5; zero value

means latent degradation model is disabled.

Units: dimensionless

value <= 5.0

Parameters:value (float) – value for IDD Field Speed 1 Ratio of Initial Moisture Evaporation Rate and Steady State Latent Capacity Raises:ValueError – if value is not a valid value Returns:the value of speed_1_ratio_of_initial_moisture_evaporation_rate_and_steady_state_latent_capacity or None if not set Return type:float

speed_1_total_cooling_capacity_function_of_flow_fraction_curve_name

field Speed 1 Total Cooling Capacity Function of Flow Fraction Curve Name

quadratic curve = a + b*ff + c*ff**2

cubic curve = a + b*ff + c*ff**2 + d*ff**3

ff = Fraction of the full load Flow

Parameters:value (str) – value for IDD Field Speed 1 Total Cooling Capacity Function of Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_1_total_cooling_capacity_function_of_flow_fraction_curve_name or None if not set Return type:str

speed_1_total_cooling_capacity_function_of_temperature_curve_name

field Speed 1 Total Cooling Capacity Function of Temperature Curve Name

curve = a + b*wb + c*wb**2 + d*edb + e*edb**2 + f*wb*edb

wb = entering wet-bulb temperature (C)

edb = dry-bulb temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Speed 1 Total Cooling Capacity Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_1_total_cooling_capacity_function_of_temperature_curve_name or None if not set Return type:str

speed_1_waste_heat_function_of_temperature_curve_name

field Speed 1 Waste Heat Function of Temperature Curve Name

curve = a + b*odb + c*odb**2 + d*db + e*db**2 + f*odb*db

odb = Outdoor air dry-bulb temperature (C)

db = entering coil dry-bulb temperature (C)

Parameters:value (str) – value for IDD Field Speed 1 Waste Heat Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_1_waste_heat_function_of_temperature_curve_name or None if not set Return type:str

speed_2_energy_input_ratio_function_of_flow_fraction_curve_name

field Speed 2 Energy Input Ratio Function of Flow Fraction Curve Name

quadratic curve = a + b*ff + c*ff**2

cubic curve = a + b*ff + c*ff**2 + d*ff**3

ff = Fraction of the full load Flow

Parameters:value (str) – value for IDD Field Speed 2 Energy Input Ratio Function of Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_2_energy_input_ratio_function_of_flow_fraction_curve_name or None if not set Return type:str

speed_2_energy_input_ratio_function_of_temperature_curve_name

field Speed 2 Energy Input Ratio Function of Temperature Curve Name

curve = a + b*wb + c*wb**2 + d*edb + e*edb**2 + f*wb*edb

wb = entering wet-bulb temperature (C)

edb = dry-bulb temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Speed 2 Energy Input Ratio Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_2_energy_input_ratio_function_of_temperature_curve_name or None if not set Return type:str

speed_2_evaporative_condenser_air_flow_rate

field Speed 2 Evaporative Condenser Air Flow Rate

Used to calculate evaporative condenser water use

Units: m3/s

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

speed_2_evaporative_condenser_effectiveness

field Speed 2 Evaporative Condenser Effectiveness

Units: dimensionless

Default value: 0.9

value <= 1.0

Parameters:value (float) – value for IDD Field Speed 2 Evaporative Condenser Effectiveness Raises:ValueError – if value is not a valid value Returns:the value of speed_2_evaporative_condenser_effectiveness or None if not set Return type:float

speed_2_gross_rated_cooling_cop

field Speed 2 Gross Rated Cooling COP

Gross cooling capacity divided by power input to the compressor and outdoor fan,

does not include supply fan heat or supply fan electrical energy input

Units: W/W

Default value: 3.0

Parameters:value (float) – value for IDD Field Speed 2 Gross Rated Cooling COP Raises:ValueError – if value is not a valid value Returns:the value of speed_2_gross_rated_cooling_cop or None if not set Return type:float

speed_2_gross_rated_sensible_heat_ratio

field Speed 2 Gross Rated Sensible Heat Ratio

Gross Rated Sensible Heat Ratio (gross sensible capacity/gross total capacity)

Sensible and total capacities do not include supply fan heat

value >= 0.5

value <= 1.0

Parameters:value (float or “Autosize”) – value for IDD Field Speed 2 Gross Rated Sensible Heat Ratio Raises:ValueError – if value is not a valid value Returns:the value of speed_2_gross_rated_sensible_heat_ratio or None if not set Return type:float or “Autosize”

speed_2_gross_rated_total_cooling_capacity

field Speed 2 Gross Rated Total Cooling Capacity

Total cooling capacity not accounting for the effect of supply air fan heat

Gross capacity excluding supply air fan heat

Rating point: air entering the cooling coil at 26.7 C dry-bulb/19.4 C wet-bulb, and

air entering the outdoor condenser coil at 35 C dry-bulb/23.9 C wet-bulb

Units: W

Parameters:value (float or “Autosize”) – value for IDD Field Speed 2 Gross Rated Total Cooling Capacity Raises:ValueError – if value is not a valid value Returns:the value of speed_2_gross_rated_total_cooling_capacity or None if not set Return type:float or “Autosize”

speed_2_latent_capacity_time_constant

field Speed 2 Latent Capacity Time Constant

Time constant for the cooling coil’s latent capacity to reach steady state after

startup. Suggested value is 45; zero value means latent degradation

model is disabled.

Units: s

value <= 500.0

Parameters:value (float) – value for IDD Field Speed 2 Latent Capacity Time Constant Raises:ValueError – if value is not a valid value Returns:the value of speed_2_latent_capacity_time_constant or None if not set Return type:float

speed_2_maximum_cycling_rate

field Speed 2 Maximum Cycling Rate

The maximum on-off cycling rate for the compressor, which occurs at 50% run time

fraction. Suggested value is 3; zero value means latent degradation

model is disabled.

Units: cycles/hr

value <= 5.0

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

speed_2_nominal_time_for_condensate_removal_to_begin

field Speed 2 Nominal Time for Condensate Removal to Begin

The nominal time for condensate to begin leaving the coil’s condensate

drain line at the coil’s rated air flow rate and temperature conditions.

Nominal time is equal to the ratio of the energy of the coil’s maximum

condensate holding capacity (J) to the coil’s steady state latent capacity (W).

Suggested value is 1000; zero value means latent degradation model is disabled.

Units: s

value <= 3000.0

Parameters:value (float) – value for IDD Field Speed 2 Nominal Time for Condensate Removal to Begin Raises:ValueError – if value is not a valid value Returns:the value of speed_2_nominal_time_for_condensate_removal_to_begin or None if not set Return type:float

speed_2_part_load_fraction_correlation_curve_name

field Speed 2 Part Load Fraction Correlation Curve Name

quadratic curve = a + b*PLR + c*PLR**2

cubic curve = a + b*PLR + c*PLR**2 + d*PLR**3

PLR = part load ratio (Cooling load/steady state capacity)

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

speed_2_rated_air_flow_rate

field Speed 2 Rated Air Flow Rate

Flow rate corresponding to rated total cooling capacity, rated SHR and rated

COP should be between 0.00004027 m3/s and .00006041 m3/s per watt of rated total

cooling capacity for Speed 2.

Units: m3/s

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

speed_2_rated_evaporative_condenser_pump_power_consumption

field Speed 2 Rated Evaporative Condenser Pump Power Consumption

Rated power consumed by the evaporative condenser’s water pump at low speed

Units: W

Parameters:value (float or “Autosize”) – value for IDD Field Speed 2 Rated Evaporative Condenser Pump Power Consumption Raises:ValueError – if value is not a valid value Returns:the value of speed_2_rated_evaporative_condenser_pump_power_consumption or None if not set Return type:float or “Autosize”

speed_2_rated_waste_heat_fraction_of_power_input

field Speed 2 Rated Waste Heat Fraction of Power Input

Recoverable waste heat at full load and rated conditions

Units: dimensionless

Default value: 0.2

value <= 1.0

Parameters:value (float) – value for IDD Field Speed 2 Rated Waste Heat Fraction of Power Input Raises:ValueError – if value is not a valid value Returns:the value of speed_2_rated_waste_heat_fraction_of_power_input or None if not set Return type:float

speed_2_ratio_of_initial_moisture_evaporation_rate_and_steady_state_latent_capacity

field Speed 2 Ratio of Initial Moisture Evaporation Rate and steady state Latent Capacity

Ratio of the initial moisture evaporation rate from the cooling coil (when

the compressor first turns off) and the coil’s steady state latent capacity

at rated air flow rate and temperature conditions. Suggested value is 1.5; zero value

means latent degradation model is disabled.

Units: dimensionless

value <= 5.0

Parameters:value (float) – value for IDD Field Speed 2 Ratio of Initial Moisture Evaporation Rate and steady state Latent Capacity Raises:ValueError – if value is not a valid value Returns:the value of speed_2_ratio_of_initial_moisture_evaporation_rate_and_steady_state_latent_capacity or None if not set Return type:float

speed_2_total_cooling_capacity_function_of_flow_fraction_curve_name

field Speed 2 Total Cooling Capacity Function of Flow Fraction Curve Name

quadratic curve = a + b*ff + c*ff**2

cubic curve = a + b*ff + c*ff**2 + d*ff**3

ff = fraction of the full load flow

Parameters:value (str) – value for IDD Field Speed 2 Total Cooling Capacity Function of Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_2_total_cooling_capacity_function_of_flow_fraction_curve_name or None if not set Return type:str

speed_2_total_cooling_capacity_function_of_temperature_curve_name

field Speed 2 Total Cooling Capacity Function of Temperature Curve Name

curve = a + b*wb + c*wb**2 + d*edb + e*edb**2 + f*wb*edb

wb = entering wet-bulb temperature (C)

edb = dry-bulb temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Speed 2 Total Cooling Capacity Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_2_total_cooling_capacity_function_of_temperature_curve_name or None if not set Return type:str

speed_2_waste_heat_function_of_temperature_curve_name

field Speed 2 Waste Heat Function of Temperature Curve Name

curve = a + b*odb + c*odb**2 + d*db + e*db**2 + f*odb*db

odb = Outdoor air dry-bulb temperature (C)

db = entering coil dry-bulb temperature (C)

Parameters:value (str) – value for IDD Field Speed 2 Waste Heat Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_2_waste_heat_function_of_temperature_curve_name or None if not set Return type:str

speed_3_energy_input_ratio_function_of_flow_fraction_curve_name

field Speed 3 Energy Input Ratio Function of Flow Fraction Curve Name

quadratic curve = a + b*ff + c*ff**2

cubic curve = a + b*ff + c*ff**2 + d*ff**3

ff = fraction of the full load flow

Parameters:value (str) – value for IDD Field Speed 3 Energy Input Ratio Function of Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_3_energy_input_ratio_function_of_flow_fraction_curve_name or None if not set Return type:str

speed_3_energy_input_ratio_function_of_temperature_curve_name

field Speed 3 Energy Input Ratio Function of Temperature Curve Name

curve = a + b*wb + c*wb**2 + d*edb + e*edb**2 + f*wb*edb

wb = entering wet-bulb temperature (C)

edb = dry-bulb temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Speed 3 Energy Input Ratio Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_3_energy_input_ratio_function_of_temperature_curve_name or None if not set Return type:str

speed_3_evaporative_condenser_air_flow_rate

field Speed 3 Evaporative Condenser Air Flow Rate

Used to calculate evaporative condenser water use

Units: m3/s

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

speed_3_evaporative_condenser_effectiveness

field Speed 3 Evaporative Condenser Effectiveness

Units: dimensionless

Default value: 0.9

value <= 1.0

Parameters:value (float) – value for IDD Field Speed 3 Evaporative Condenser Effectiveness Raises:ValueError – if value is not a valid value Returns:the value of speed_3_evaporative_condenser_effectiveness or None if not set Return type:float

speed_3_gross_rated_cooling_cop

field Speed 3 Gross Rated Cooling COP

Gross cooling capacity divided by power input to the compressor and outdoor fan,

does not include supply fan heat or supply fan electrical energy input

Units: W/W

Default value: 3.0

Parameters:value (float) – value for IDD Field Speed 3 Gross Rated Cooling COP Raises:ValueError – if value is not a valid value Returns:the value of speed_3_gross_rated_cooling_cop or None if not set Return type:float

speed_3_gross_rated_sensible_heat_ratio

field Speed 3 Gross Rated Sensible Heat Ratio

Gross Rated Sensible Heat Ratio (gross sensible capacity/gross total capacity)

Sensible and total capacities do not include supply fan heat

value >= 0.5

value <= 1.0

Parameters:value (float or “Autosize”) – value for IDD Field Speed 3 Gross Rated Sensible Heat Ratio Raises:ValueError – if value is not a valid value Returns:the value of speed_3_gross_rated_sensible_heat_ratio or None if not set Return type:float or “Autosize”

speed_3_gross_rated_total_cooling_capacity

field Speed 3 Gross Rated Total Cooling Capacity

Total cooling capacity not accounting for the effect of supply air fan heat

Gross capacity excluding supply air fan heat

Rating point: air entering the cooling coil at 26.7 C dry-bulb/19.4 C wet-bulb, and

air entering the outdoor condenser coil at 35 C dry-bulb/23.9 C wet-bulb

Units: W

Parameters:value (float or “Autosize”) – value for IDD Field Speed 3 Gross Rated Total Cooling Capacity Raises:ValueError – if value is not a valid value Returns:the value of speed_3_gross_rated_total_cooling_capacity or None if not set Return type:float or “Autosize”

speed_3_latent_capacity_time_constant

field Speed 3 Latent Capacity Time Constant

Time constant for the cooling coil’s latent capacity to reach steady state after

startup. Suggested value is 45; zero value means latent degradation

model is disabled.

Units: s

value <= 500.0

Parameters:value (float) – value for IDD Field Speed 3 Latent Capacity Time Constant Raises:ValueError – if value is not a valid value Returns:the value of speed_3_latent_capacity_time_constant or None if not set Return type:float

speed_3_maximum_cycling_rate

field Speed 3 Maximum Cycling Rate

The maximum on-off cycling rate for the compressor, which occurs at 50% run time

fraction. Suggested value is 3; zero value means latent degradation

model is disabled.

Units: cycles/hr

value <= 5.0

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

speed_3_nominal_time_for_condensate_removal_to_begin

field Speed 3 Nominal Time for Condensate Removal to Begin

The nominal time for condensate to begin leaving the coil’s condensate

drain line at the coil’s rated air flow rate and temperature conditions.

Nominal time is equal to the ratio of the energy of the coil’s maximum

condensate holding capacity (J) to the coil’s steady state latent capacity (W).

Suggested value is 1000; zero value means latent degradation model is disabled.

Units: s

value <= 3000.0

Parameters:value (float) – value for IDD Field Speed 3 Nominal Time for Condensate Removal to Begin Raises:ValueError – if value is not a valid value Returns:the value of speed_3_nominal_time_for_condensate_removal_to_begin or None if not set Return type:float

speed_3_part_load_fraction_correlation_curve_name

field Speed 3 Part Load Fraction Correlation Curve Name

quadratic curve = a + b*PLR + c*PLR**2

cubic curve = a + b*PLR + c*PLR**2 + d*PLR**3

PLR = part load ratio (Cooling load/steady state capacity)

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

speed_3_rated_air_flow_rate

field Speed 3 Rated Air Flow Rate

Flow rate corresponding to rated total cooling capacity, rated SHR and rated

COP should be between 0.00004027 m3/s and .00006041 m3/s per watt of rated total

cooling capacity for Speed 3.

Units: m3/s

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

speed_3_rated_evaporative_condenser_pump_power_consumption

field Speed 3 Rated Evaporative Condenser Pump Power Consumption

Rated power consumed by the evaporative condenser’s water pump at Low speed

Units: W

Parameters:value (float or “Autosize”) – value for IDD Field Speed 3 Rated Evaporative Condenser Pump Power Consumption Raises:ValueError – if value is not a valid value Returns:the value of speed_3_rated_evaporative_condenser_pump_power_consumption or None if not set Return type:float or “Autosize”

speed_3_rated_waste_heat_fraction_of_power_input

field Speed 3 Rated Waste Heat Fraction of Power Input

Recoverable waste heat at full load and rated conditions

Units: dimensionless

Default value: 0.2

value <= 1.0

Parameters:value (float) – value for IDD Field Speed 3 Rated Waste Heat Fraction of Power Input Raises:ValueError – if value is not a valid value Returns:the value of speed_3_rated_waste_heat_fraction_of_power_input or None if not set Return type:float

speed_3_ratio_of_initial_moisture_evaporation_rate_and_steady_state_latent_capacity

field Speed 3 Ratio of Initial Moisture Evaporation Rate and steady state Latent Capacity

Ratio of the initial moisture evaporation rate from the cooling coil (when

the compressor first turns off) and the coil’s steady state latent capacity

at rated air flow and temperature conditions. Suggested value is 1.5; zero value

means latent degradation model is disabled.

Units: dimensionless

value <= 5.0

Parameters:value (float) – value for IDD Field Speed 3 Ratio of Initial Moisture Evaporation Rate and steady state Latent Capacity Raises:ValueError – if value is not a valid value Returns:the value of speed_3_ratio_of_initial_moisture_evaporation_rate_and_steady_state_latent_capacity or None if not set Return type:float

speed_3_total_cooling_capacity_function_of_flow_fraction_curve_name

field Speed 3 Total Cooling Capacity Function of Flow Fraction Curve Name

quadratic curve = a + b*ff + c*ff**2

cubic curve = a + b*ff + c*ff**2 + d*ff**3

ff = fraction of the full load flow

Parameters:value (str) – value for IDD Field Speed 3 Total Cooling Capacity Function of Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_3_total_cooling_capacity_function_of_flow_fraction_curve_name or None if not set Return type:str

speed_3_total_cooling_capacity_function_of_temperature_curve_name

field Speed 3 Total Cooling Capacity Function of Temperature Curve Name

curve = a + b*wb + c*wb**2 + d*edb + e*edb**2 + f*wb*edb

wb = entering wet-bulb temperature (C)

edb = dry-bulb temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Speed 3 Total Cooling Capacity Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_3_total_cooling_capacity_function_of_temperature_curve_name or None if not set Return type:str

speed_3_waste_heat_function_of_temperature_curve_name

field Speed 3 Waste Heat Function of Temperature Curve Name

curve = a + b*odb + c*odb**2 + d*db + e*db**2 + f*odb*db

odb = Outdoor air dry-bulb temperature (C)

db = entering coil dry-bulb temperature (C)

Parameters:value (str) – value for IDD Field Speed 3 Waste Heat Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_3_waste_heat_function_of_temperature_curve_name or None if not set Return type:str

speed_4_energy_input_ratio_function_of_flow_fraction_curve_name

field Speed 4 Energy Input Ratio Function of Flow Fraction Curve Name

quadratic curve = a + b*ff + c*ff**2

cubic curve = a + b*ff + c*ff**2 + d*ff**3

ff = fraction of the full load flow

Parameters:value (str) – value for IDD Field Speed 4 Energy Input Ratio Function of Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_4_energy_input_ratio_function_of_flow_fraction_curve_name or None if not set Return type:str

speed_4_energy_input_ratio_function_of_temperature_curve_name

field Speed 4 Energy Input Ratio Function of Temperature Curve Name

curve = a + b*wb + c*wb**2 + d*edb + e*edb**2 + f*wb*edb

wb = entering wet-bulb temperature (C)

edb = dry-bulb temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Speed 4 Energy Input Ratio Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_4_energy_input_ratio_function_of_temperature_curve_name or None if not set Return type:str

speed_4_evaporative_condenser_air_flow_rate

field Speed 4 Evaporative Condenser Air Flow Rate

Used to calculate evaporative condenser water use

Units: m3/s

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

speed_4_evaporative_condenser_effectiveness

field Speed 4 Evaporative Condenser Effectiveness

Units: dimensionless

Default value: 0.9

value <= 1.0

Parameters:value (float) – value for IDD Field Speed 4 Evaporative Condenser Effectiveness Raises:ValueError – if value is not a valid value Returns:the value of speed_4_evaporative_condenser_effectiveness or None if not set Return type:float

speed_4_gross_rated_cooling_cop

field Speed 4 Gross Rated Cooling COP

Gross cooling capacity divided by power input to the compressor and outdoor fan,

does not include supply fan heat or supply fan electrical energy input

Units: W/W

Default value: 3.0

Parameters:value (float) – value for IDD Field Speed 4 Gross Rated Cooling COP Raises:ValueError – if value is not a valid value Returns:the value of speed_4_gross_rated_cooling_cop or None if not set Return type:float

speed_4_gross_rated_sensible_heat_ratio

field Speed 4 Gross Rated Sensible Heat Ratio

Gross Rated Sensible Heat Ratio (gross sensible capacity/gross total capacity)

Sensible and total capacities do not include supply fan heat

value >= 0.5

value <= 1.0

Parameters:value (float or “Autosize”) – value for IDD Field Speed 4 Gross Rated Sensible Heat Ratio Raises:ValueError – if value is not a valid value Returns:the value of speed_4_gross_rated_sensible_heat_ratio or None if not set Return type:float or “Autosize”

speed_4_gross_rated_total_cooling_capacity

field Speed 4 Gross Rated Total Cooling Capacity

Total cooling capacity not accounting for the effect of supply air fan heat

Gross capacity excluding supply air fan heat

Rating point: air entering the cooling coil at 26.7 C dry-bulb/19.4 C wet-bulb, and

air entering the outdoor condenser coil at 35 C dry-bulb/23.9 C wet-bulb

Units: W

Parameters:value (float or “Autosize”) – value for IDD Field Speed 4 Gross Rated Total Cooling Capacity Raises:ValueError – if value is not a valid value Returns:the value of speed_4_gross_rated_total_cooling_capacity or None if not set Return type:float or “Autosize”

speed_4_latent_capacity_time_constant

field Speed 4 Latent Capacity Time Constant

Time constant for the cooling coil’s latent capacity to reach steady state after

startup. Suggested value is 45; zero value means latent degradation

model is disabled.

Units: s

value <= 500.0

Parameters:value (float) – value for IDD Field Speed 4 Latent Capacity Time Constant Raises:ValueError – if value is not a valid value Returns:the value of speed_4_latent_capacity_time_constant or None if not set Return type:float

speed_4_maximum_cycling_rate

field Speed 4 Maximum Cycling Rate

The maximum on-off cycling rate for the compressor, which occurs at 50% run time

fraction. Suggested value is 3; zero value means latent degradation

model is disabled.

Units: cycles/hr

value <= 5.0

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

speed_4_nominal_time_for_condensate_removal_to_begin

field Speed 4 Nominal Time for Condensate Removal to Begin

The nominal time for condensate to begin leaving the coil’s condensate

drain line at the coil’s rated air flow rate and temperature conditions.

Nominal time is equal to the ratio of the energy of the coil’s maximum

condensate holding capacity (J) to the coil’s steady state latent capacity (W).

Suggested value is 1000; zero value means latent degradation model is disabled.

Units: s

value <= 3000.0

Parameters:value (float) – value for IDD Field Speed 4 Nominal Time for Condensate Removal to Begin Raises:ValueError – if value is not a valid value Returns:the value of speed_4_nominal_time_for_condensate_removal_to_begin or None if not set Return type:float

speed_4_part_load_fraction_correlation_curve_name

field Speed 4 Part Load Fraction Correlation Curve Name

quadratic curve = a + b*PLR + c*PLR**2

cubic curve = a + b*PLR + c*PLR**2 + d*PLR**3

PLR = part load ratio (cooling load/steady state capacity)

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

speed_4_rated_air_flow_rate

field Speed 4 Rated Air Flow Rate

Flow rate corresponding to rated total cooling capacity, rated SHR and rated

COP should be between 0.00004027 m3/s and .00006041 m3/s per watt of rated total

cooling capacity for Speed 4

Units: m3/s

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

speed_4_rated_evaporative_condenser_pump_power_consumption

field Speed 4 Rated Evaporative Condenser Pump Power Consumption

Rated power consumed by the evaporative condenser’s water pump at Speed 4

Units: W

Parameters:value (float or “Autosize”) – value for IDD Field Speed 4 Rated Evaporative Condenser Pump Power Consumption Raises:ValueError – if value is not a valid value Returns:the value of speed_4_rated_evaporative_condenser_pump_power_consumption or None if not set Return type:float or “Autosize”

speed_4_rated_waste_heat_fraction_of_power_input

field Speed 4 Rated Waste Heat Fraction of Power Input

Recoverable waste heat at full load and rated conditions

Units: dimensionless

Default value: 0.2

value <= 1.0

Parameters:value (float) – value for IDD Field Speed 4 Rated Waste Heat Fraction of Power Input Raises:ValueError – if value is not a valid value Returns:the value of speed_4_rated_waste_heat_fraction_of_power_input or None if not set Return type:float

speed_4_ratio_of_initial_moisture_evaporation_rate_and_steady_state_latent_capacity

field Speed 4 Ratio of Initial Moisture Evaporation Rate and steady state Latent Capacity

Ratio of the initial moisture evaporation rate from the cooling coil (when

the compressor first turns off) and the coil’s steady state latent capacity

at rated air flow rate and temperature conditions. Suggested value is 1.5; zero value

means latent degradation model is disabled.

Units: dimensionless

value <= 5.0

Parameters:value (float) – value for IDD Field Speed 4 Ratio of Initial Moisture Evaporation Rate and steady state Latent Capacity Raises:ValueError – if value is not a valid value Returns:the value of speed_4_ratio_of_initial_moisture_evaporation_rate_and_steady_state_latent_capacity or None if not set Return type:float

speed_4_total_cooling_capacity_function_of_flow_fraction_curve_name

field Speed 4 Total Cooling Capacity Function of Flow Fraction Curve Name

quadratic curve = a + b*ff + c*ff**2

cubic curve = a + b*ff + c*ff**2 + d*ff**3

ff = fraction of the full load flow

Parameters:value (str) – value for IDD Field Speed 4 Total Cooling Capacity Function of Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_4_total_cooling_capacity_function_of_flow_fraction_curve_name or None if not set Return type:str

speed_4_total_cooling_capacity_function_of_temperature_curve_name

field Speed 4 Total Cooling Capacity Function of Temperature Curve Name

curve = a + b*wb + c*wb**2 + d*edb + e*edb**2 + f*wb*edb

wb = entering wet-bulb temperature (C)

edb = dry-bulb temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Speed 4 Total Cooling Capacity Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_4_total_cooling_capacity_function_of_temperature_curve_name or None if not set Return type:str

speed_4_waste_heat_function_of_temperature_curve_name

field Speed 4 Waste Heat Function of Temperature Curve Name

curve = a + b*odb + c*odb**2 + d*db + e*db**2 + f*odb*db

odb = Outdoor air dry-bulb temperature (C)

db = entering coil dry-bulb temperature (C)

Parameters:value (str) – value for IDD Field Speed 4 Waste Heat Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_4_waste_heat_function_of_temperature_curve_name or None if not set Return type:str

supply_water_storage_tank_name

field Supply Water Storage Tank Name

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

zone_name_for_condenser_placement

field Zone Name for Condenser Placement

This input field is name of a conditioned or unconditioned zone where the secondary

coil (condenser) of DX system or a heat pump is to be placed. This is an optional

input field specified only when user desires to reject the condenser heat into a

zone. The heat rejected is modelled as internal sensible heat gain of the zone.

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

class pyidf.coils.CoilCoolingDxSingleSpeed

Bases: pyidf.helper.DataObject

Corresponds to IDD object Coil:Cooling:DX:SingleSpeed Direct expansion (DX) cooling coil and condensing unit (includes electric compressor and condenser fan), single-speed. Optional inputs for moisture evaporation from wet coil when compressor cycles off with continuous fan operation.

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

basin_heater_capacity

field Basin Heater Capacity

This field is only used for Condenser Type = EvaporativelyCooled and for periods

when the basin heater is available (field Basin Heater Operating Schedule Name).

For this situation, the heater maintains the basin water temperature at the basin heater

setpoint temperature when the outdoor air temperature falls below the setpoint temperature.

The basin heater only operates when the DX coil is off.

Units: W/K

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

basin_heater_operating_schedule_name

field Basin Heater Operating Schedule Name

This field is only used for Condenser Type = EvaporativelyCooled.

Schedule values greater than 0 allow the basin heater to operate whenever the outdoor

air dry-bulb temperature is below the basin heater setpoint temperature.

If a schedule name is not entered, the basin heater is allowed to operate

throughout the entire simulation.

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

basin_heater_setpoint_temperature

field Basin Heater Setpoint Temperature

This field is only used for Condenser Type = EvaporativelyCooled.

Enter the outdoor dry-bulb temperature when the basin heater turns on.

Units: C

Default value: 2.0

value >= 2.0

Parameters:value (float) – value for IDD Field Basin Heater Setpoint Temperature Raises:ValueError – if value is not a valid value Returns:the value of basin_heater_setpoint_temperature or None if not set Return type:float

condensate_collection_water_storage_tank_name

field Condensate Collection Water Storage Tank Name

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

condenser_air_inlet_node_name

field Condenser Air Inlet Node Name

Enter the name of an outdoor air node. This node name is also specified in

an OutdoorAir:Node or OutdoorAir:NodeList object.

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

condenser_type

field Condenser Type

Default value: AirCooled

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

crankcase_heater_capacity

field Crankcase Heater Capacity

Units: W

IP-Units: W

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

energy_input_ratio_function_of_flow_fraction_curve_name

field Energy Input Ratio Function of Flow Fraction Curve Name

quadratic curve = a + b*ff + c*ff**2

cubic curve = a + b*ff + c*ff**2 + d*ff**3

ff = Fraction of the full load flow

Parameters:value (str) – value for IDD Field Energy Input Ratio Function of Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of energy_input_ratio_function_of_flow_fraction_curve_name or None if not set Return type:str

energy_input_ratio_function_of_temperature_curve_name

field Energy Input Ratio Function of Temperature Curve Name

curve = a + b*wb + c*wb**2 + d*edb + e*edb**2 + f*wb*edb

wb = entering wet-bulb temperature (C)

edb = dry-bulb temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Energy Input Ratio Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of energy_input_ratio_function_of_temperature_curve_name or None if not set Return type:str

evaporative_condenser_air_flow_rate

field Evaporative Condenser Air Flow Rate

Used to calculate evaporative condenser water use

Units: m3/s

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

evaporative_condenser_effectiveness

field Evaporative Condenser Effectiveness

Units: dimensionless

Default value: 0.9

value <= 1.0

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

evaporative_condenser_pump_rated_power_consumption

field Evaporative Condenser Pump Rated Power Consumption

Rated power consumed by the evaporative condenser’s water pump

Units: W

Parameters:value (float or “Autosize”) – value for IDD Field Evaporative Condenser Pump Rated Power Consumption Raises:ValueError – if value is not a valid value Returns:the value of evaporative_condenser_pump_rated_power_consumption or None if not set Return type:float or “Autosize”

gross_rated_cooling_cop

field Gross Rated Cooling COP

Gross cooling capacity divided by power input to the compressor and outdoor fan,

does not include supply fan heat or supply fan electrical energy input

Units: W/W

Default value: 3.0

Parameters:value (float) – value for IDD Field Gross Rated Cooling COP Raises:ValueError – if value is not a valid value Returns:the value of gross_rated_cooling_cop or None if not set Return type:float

gross_rated_sensible_heat_ratio

field Gross Rated Sensible Heat Ratio

Rated sensible heat ratio (gross sensible capacity/gross total capacity)

sensible and total capacities do not include supply fan heat

value >= 0.5

value <= 1.0

Parameters:value (float or “Autosize”) – value for IDD Field Gross Rated Sensible Heat Ratio Raises:ValueError – if value is not a valid value Returns:the value of gross_rated_sensible_heat_ratio or None if not set Return type:float or “Autosize”

gross_rated_total_cooling_capacity

field Gross Rated Total Cooling Capacity

Total cooling capacity not accounting for the effect of supply air fan heat

gross capacity excluding supply air fan heat

rating point: air entering the cooling coil at 26.7 C dry-bulb/19.4 C wet-bulb, and

air entering the outdoor condenser coil at 35 C dry-bulb/23.9 C wet-bulb

Units: W

Parameters:value (float or “Autosize”) – value for IDD Field Gross Rated Total Cooling Capacity Raises:ValueError – if value is not a valid value Returns:the value of gross_rated_total_cooling_capacity or None if not set Return type:float or “Autosize”

latent_capacity_time_constant

field Latent Capacity Time Constant

Time constant for the cooling coil’s latent capacity to reach steady state after

startup. Suggested value is 45; zero value means latent degradation model is disabled.

Units: s

value <= 500.0

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

maximum_cycling_rate

field Maximum Cycling Rate

The maximum on-off cycling Rate for the compressor, which occurs at 50% run time

fraction. Suggested value is 3; zero value means latent degradation model is disabled.

Units: cycles/hr

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_crankcase_heater_operation

field Maximum Outdoor Dry-Bulb Temperature for Crankcase Heater Operation

Units: C

Default value: 10.0

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

nominal_time_for_condensate_removal_to_begin

field Nominal Time for Condensate Removal to Begin

The nominal time for condensate to begin leaving the coil’s condensate

drain line at the coil’s rated air flow rate and temperature conditions.

Nominal time is equal to the ratio of the energy of the coil’s maximum

condensate holding capacity (J) to the coil’s steady state latent capacity (W).

Suggested value is 1000; zero value means latent degradation model is disabled.

Units: s

value <= 3000.0

Parameters:value (float) – value for IDD Field Nominal Time for Condensate Removal to Begin Raises:ValueError – if value is not a valid value Returns:the value of nominal_time_for_condensate_removal_to_begin or None if not set Return type:float

part_load_fraction_correlation_curve_name

field Part Load Fraction Correlation Curve Name

quadratic curve = a + b*PLR + c*PLR**2

cubic curve = a + b*PLR + c*PLR**2 + d*PLR**3

PLR = part load ratio (cooling load/steady state capacity)

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

rated_air_flow_rate

field Rated Air Flow Rate

Flow rate corresponding to rated total cooling capacity, Rated SHR and Rated COP

should be between 0.00004027 m3/s and .00006041 m3/s per watt of rated total cooling capacity

Units: m3/s

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

rated_evaporator_fan_power_per_volume_flow_rate

field Rated Evaporator Fan Power Per Volume Flow Rate

Enter the evaporator fan power per air volume flow rate at the rated test conditions.

The test conditions vary external static pressure based on total cooling capacity.

This value is only used to calculate Seasonal Energy Efficiency Ratio (SEER), Energy

Efficiency Ratio (EER), Integrated Energy Efficiency Ratio (IEER), and the Standard Rating

(Net) Cooling Capacity which will be outputs in the EnergyPlus eio file. This value is not

used for modeling the evaporator fan during simulations.

Units: W/(m3/s)

Default value: 773.3

value <= 1250.0

Parameters:value (float) – value for IDD Field Rated Evaporator Fan Power Per Volume Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of rated_evaporator_fan_power_per_volume_flow_rate or None if not set Return type:float

ratio_of_initial_moisture_evaporation_rate_and_steady_state_latent_capacity

field Ratio of Initial Moisture Evaporation Rate and Steady State Latent Capacity

Ratio of the initial moisture evaporation rate from the cooling coil (when

the compressor first turns off) and the coil’s steady state latent capacity

at rated air flow rate and temperature conditions. Suggested value is 1.5; zero value

means latent degradation model is disabled.

Units: dimensionless

value <= 5.0

Parameters:value (float) – value for IDD Field Ratio of Initial Moisture Evaporation Rate and Steady State Latent Capacity Raises:ValueError – if value is not a valid value Returns:the value of ratio_of_initial_moisture_evaporation_rate_and_steady_state_latent_capacity or None if not set Return type:float

report_ashrae_standard_127_performance_ratings

field Report ASHRAE Standard 127 Performance Ratings

when this input field is specified as Yes then the program calculates the net cooling

capacity and total electric power input of DX cooling coils per ANSI/ASHRAE 127.

Default value: No

Parameters:value (str) – value for IDD Field Report ASHRAE Standard 127 Performance Ratings Raises:ValueError – if value is not a valid value Returns:the value of report_ashrae_standard_127_performance_ratings or None if not set Return type:str

sensible_heat_ratio_function_of_flow_fraction_curve_name

field Sensible Heat Ratio Function of Flow Fraction Curve Name

quadratic curve = a + b*ff + c*ff**2

cubic curve = a + b*ff + c*ff**2 + d*ff**3

ff = fraction of the full load flow

Parameters:value (str) – value for IDD Field Sensible Heat Ratio Function of Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of sensible_heat_ratio_function_of_flow_fraction_curve_name or None if not set Return type:str

sensible_heat_ratio_function_of_temperature_curve_name

field Sensible Heat Ratio Function of Temperature Curve Name

curve = a + b*wb + c*wb**2 + d*db + e*db**2 + f*wb*db

wb = entering wet-bulb temperature seen by the DX cooling coil (C)

db = entering dry-bulb temperature seen by the DX cooling coil (C)

entering temperature can be outside air or pretreated air.

Parameters:value (str) – value for IDD Field Sensible Heat Ratio Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of sensible_heat_ratio_function_of_temperature_curve_name or None if not set Return type:str

supply_water_storage_tank_name

field Supply Water Storage Tank Name

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

total_cooling_capacity_function_of_flow_fraction_curve_name

field Total Cooling Capacity Function of Flow Fraction Curve Name

quadratic curve = a + b*ff + c*ff**2

cubic curve = a + b*ff + c*ff**2 + d*ff**3

ff = Fraction of the full load flow

Parameters:value (str) – value for IDD Field Total Cooling Capacity Function of Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of total_cooling_capacity_function_of_flow_fraction_curve_name or None if not set Return type:str

total_cooling_capacity_function_of_temperature_curve_name

field Total Cooling Capacity Function of Temperature Curve Name

curve = a + b*wb + c*wb**2 + d*edb + e*edb**2 + f*wb*edb

wb = entering wet-bulb temperature (C)

edb = dry-bulb temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Total Cooling Capacity Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of total_cooling_capacity_function_of_temperature_curve_name or None if not set Return type:str

zone_name_for_condenser_placement

field Zone Name for Condenser Placement

This input field is name of a conditioned or unconditioned zone where the secondary

coil (condenser) of DX system or a heat pump is to be placed. This is an optional

input field specified only when user desires to reject the condenser heat into a

zone. The heat rejected is modelled as internal sensible heat gain of the zone.

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

class pyidf.coils.CoilCoolingDxSingleSpeedThermalStorage

Bases: pyidf.helper.DataObject

Corresponds to IDD object Coil:Cooling:DX:SingleSpeed:ThermalStorage Direct expansion (DX) cooling coil and condensing unit (includes electric compressor and condenser fan), single-speed with packaged integrated thermal storage for cooling.

ancillary_electric_power

field Ancillary Electric Power

controls and miscellaneous standby ancillary electric power draw, when available

Units: W

Parameters:value (float) – value for IDD Field Ancillary Electric Power Raises:ValueError – if value is not a valid value Returns:the value of ancillary_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

basin_heater_availability_schedule_name

field Basin Heater Availability Schedule Name

This field is only used for Condenser Type = EvaporativelyCooled.

Schedule values greater than 0 allow the basin heater to operate whenever the outdoor

air dry-bulb temperature is below the basin heater setpoint temperature.

If a schedule name is not entered, the basin heater is allowed to operate

throughout the entire simulation.

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

basin_heater_capacity

field Basin Heater Capacity

This field is only used for Condenser Type = EvaporativelyCooled and for periods

when the basin heater is available (field Basin Heater Operating Schedule Name).

For this situation, the heater maintains the basin water temperature at the basin heater

setpoint temperature when the outdoor air temperature falls below the setpoint temperature.

The basin heater only operates when the DX coil is off.

If this field is blank, the basin heater is always available.

Units: W/K

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

basin_heater_setpoint_temperature

field Basin Heater Setpoint Temperature

This field is only used for Condenser Type = EvaporativelyCooled.

Enter the outdoor dry-bulb temperature when the basin heater turns on.

Units: C

Default value: 2.0

value >= 2.0

Parameters:value (float) – value for IDD Field Basin Heater Setpoint Temperature Raises:ValueError – if value is not a valid value Returns:the value of basin_heater_setpoint_temperature or None if not set Return type:float

charge_only_mode_available

field Charge Only Mode Available

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

charge_only_mode_capacity_sizing_factor

field Charge Only Mode Capacity Sizing Factor

If previous field is autocalculate, this determines the charging capacity

as a multiplier on the Cooling Only Mode Rated Total Evaporator Cooling Capacity

Default value: 1.0

Parameters:value (float) – value for IDD Field Charge Only Mode Capacity Sizing Factor Raises:ValueError – if value is not a valid value Returns:the value of charge_only_mode_capacity_sizing_factor or None if not set Return type:float

charge_only_mode_charging_rated_cop

field Charge Only Mode Charging Rated COP

net cooling capacity divided by power input to the compressor (for charging) and outdoor fan,

includes any internal devices

required field if Charge Only Mode is available

Units: W/W

Default value: 3.0

Parameters:value (float) – value for IDD Field Charge Only Mode Charging Rated COP Raises:ValueError – if value is not a valid value Returns:the value of charge_only_mode_charging_rated_cop or None if not set Return type:float

charge_only_mode_rated_storage_charging_capacity

field Charge Only Mode Rated Storage Charging Capacity

required field if Charge Only Mode is available

net capacity including any internal devices

air entering the outdoor condenser coil at 35 C dry-bulb/23.9 C wet-bulb

thermal storage tank at 26.7 C (water) or storage faction of 0.5 (ice)

Units: W

Parameters:value (float or “Autocalculate”) – value for IDD Field Charge Only Mode Rated Storage Charging Capacity Raises:ValueError – if value is not a valid value Returns:the value of charge_only_mode_rated_storage_charging_capacity or None if not set Return type:float or “Autocalculate”

charge_only_mode_storage_charge_capacity_function_of_temperature_curve_name

field Charge Only Mode Storage Charge Capacity Function of Temperature Curve Name

required field if Charge Only Mode is available

Any curve or table with two independent variables can be used

curve = a + b*db + c*db**2 + d*stes + e*stes**2 + f*db*stes

x = db = dry-bulb temperature seen by the condenser (C)

y = stes = state of thermal energy storage (C or fraction)

Parameters:value (str) – value for IDD Field Charge Only Mode Storage Charge Capacity Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of charge_only_mode_storage_charge_capacity_function_of_temperature_curve_name or None if not set Return type:str

charge_only_mode_storage_energy_input_ratio_function_of_temperature_curve_name

field Charge Only Mode Storage Energy Input Ratio Function of Temperature Curve Name

required field if Charge Only Mode is available

Any curve or table with two independent variables can be used

curve = a + b*db + c*db**2 + d*stes + e*stes**2 + f*db*stes

x = db = dry-bulb temperature seen by the condenser (C)

y = stes = state of thermal energy storage (C or fraction)

Parameters:value (str) – value for IDD Field Charge Only Mode Storage Energy Input Ratio Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of charge_only_mode_storage_energy_input_ratio_function_of_temperature_curve_name or None if not set Return type:str

cold_weather_operation_ancillary_power

field Cold Weather Operation Ancillary Power

Units: W

Parameters:value (float) – value for IDD Field Cold Weather Operation Ancillary Power Raises:ValueError – if value is not a valid value Returns:the value of cold_weather_operation_ancillary_power or None if not set Return type:float

cold_weather_operation_minimum_outdoor_air_temperature

field Cold Weather Operation Minimum Outdoor Air Temperature

Units: C

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

condensate_collection_water_storage_tank_name

field Condensate Collection Water Storage Tank Name

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

condenser_air_flow_sizing_factor

field Condenser Air Flow Sizing Factor

If previous field is autocalculate, this determines the condenser air flow size as a

multiplier on the Rated Evaporator Air Flow Rate.

Default value: 1.0

Parameters:value (float) – value for IDD Field Condenser Air Flow Sizing Factor Raises:ValueError – if value is not a valid value Returns:the value of condenser_air_flow_sizing_factor or None if not set Return type:float

condenser_air_inlet_node_name

field Condenser Air Inlet Node Name

Enter the name of an outdoor air node. This node name is also specified in

an OutdoorAir:Node or OutdoorAir:NodeList object.

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

condenser_air_outlet_node_name

field Condenser Air Outlet Node Name

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

condenser_design_air_flow_rate

field Condenser Design Air Flow Rate

Used to calculate condenser leaving conditions and water use if evaporatively cooled.

Units: m3/s

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

condenser_type

field Condenser Type

Default value: AirCooled

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

cooling_and_charge_mode_available

field Cooling And Charge Mode Available

Parameters:value (str) – value for IDD Field Cooling And Charge Mode Available Raises:ValueError – if value is not a valid value Returns:the value of cooling_and_charge_mode_available or None if not set Return type:str

cooling_and_charge_mode_capacity_sizing_factor

field Cooling And Charge Mode Capacity Sizing Factor

If previous field is autocalculate, this determines the evaporator capacity

as a multiplier on the Cooling Only Mode Rated Total Evaporator Cooling Capacity

Default value: 0.5

Parameters:value (float) – value for IDD Field Cooling And Charge Mode Capacity Sizing Factor Raises:ValueError – if value is not a valid value Returns:the value of cooling_and_charge_mode_capacity_sizing_factor or None if not set Return type:float

cooling_and_charge_mode_charging_rated_cop

field Cooling And Charge Mode Charging Rated COP

net cooling capacity divided by power input to the compressor (for charging) and outdoor fan,

includes any internal devices

required field if Cooling And Charge Mode is available

Units: W/W

Default value: 3.0

Parameters:value (float) – value for IDD Field Cooling And Charge Mode Charging Rated COP Raises:ValueError – if value is not a valid value Returns:the value of cooling_and_charge_mode_charging_rated_cop or None if not set Return type:float

cooling_and_charge_mode_cooling_rated_cop

field Cooling And Charge Mode Cooling Rated COP

Gross evaporator cooling capacity divided by power input to the compressor (for cooling) and outdoor fan,

does not include supply fan heat or supply fan electrical energy input

required field if Cooling And Charge Mode is available

Units: W/W

Default value: 3.0

Parameters:value (float) – value for IDD Field Cooling And Charge Mode Cooling Rated COP Raises:ValueError – if value is not a valid value Returns:the value of cooling_and_charge_mode_cooling_rated_cop or None if not set Return type:float

cooling_and_charge_mode_evaporator_energy_input_ratio_function_of_flow_fraction_curve_name

field Cooling And Charge Mode Evaporator Energy Input Ratio Function of Flow Fraction Curve Name

required field if Cooling And Charge Mode is available

Any curve or table with one independent variable can be used

quadratic curve = a + b*ff + c*ff**2

cubic curve = a + b*ff + c*ff**2 + d*ff**3

x = ff = Fraction of the full load evaporator air flow

Parameters:value (str) – value for IDD Field Cooling And Charge Mode Evaporator Energy Input Ratio Function of Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of cooling_and_charge_mode_evaporator_energy_input_ratio_function_of_flow_fraction_curve_name or None if not set Return type:str

cooling_and_charge_mode_evaporator_energy_input_ratio_function_of_temperature_curve_name

field Cooling And Charge Mode Evaporator Energy Input Ratio Function of Temperature Curve Name

required field if Cooling And Charge Mode is available

Allowed curve or table objects are Curve:Triquadratic and Table:MultiVariableLookup

curve or table = func(x = ewb, y = db, z = stes)

x = ewb = evaporator entering wet-bulb temperature (C)

y = db = dry-bulb temperature seen by the condenser (C)

z = stes = state of thermal energy storage (C or fraction)

Parameters:value (str) – value for IDD Field Cooling And Charge Mode Evaporator Energy Input Ratio Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of cooling_and_charge_mode_evaporator_energy_input_ratio_function_of_temperature_curve_name or None if not set Return type:str

cooling_and_charge_mode_evaporator_part_load_fraction_correlation_curve_name

field Cooling And Charge Mode Evaporator Part Load Fraction Correlation Curve Name

required field if Cooling And Charge Mode is available

Any curve or table with one independent variable can be used

quadratic curve = a + b*PLR + c*PLR**2

cubic curve = a + b*PLR + c*PLR**2 + d*PLR**3

x = PLR = part load ratio (evaporator cooling load/steady state capacity)

Parameters:value (str) – value for IDD Field Cooling And Charge Mode Evaporator Part Load Fraction Correlation Curve Name Raises:ValueError – if value is not a valid value Returns:the value of cooling_and_charge_mode_evaporator_part_load_fraction_correlation_curve_name or None if not set Return type:str

cooling_and_charge_mode_rated_sensible_heat_ratio

field Cooling And Charge Mode Rated Sensible Heat Ratio

required field if Cooling And Charge Mode is available

Rated sensible heat ratio (gross sensible evaporator capacity/gross total evaporator capacity)

sensible and total capacities do not include supply fan heat

Default value: 0.7

value <= 1.0

Parameters:value (float) – value for IDD Field Cooling And Charge Mode Rated Sensible Heat Ratio Raises:ValueError – if value is not a valid value Returns:the value of cooling_and_charge_mode_rated_sensible_heat_ratio or None if not set Return type:float

cooling_and_charge_mode_rated_storage_charging_capacity

field Cooling And Charge Mode Rated Storage Charging Capacity

required field if Cooling And Charge Mode is available

net capacity including any internal devices

rating point: air entering the cooling coil at 26.7 C dry-bulb/19.4 C wet-bulb, and

air entering the outdoor condenser coil at 35 C dry-bulb/23.9 C wet-bulb

thermal storage tank at Fluid Storage Tank Rating Temperature (water or fluid) or storage faction of 0.5 (ice)

Units: W

Parameters:value (float or “Autocalculate”) – value for IDD Field Cooling And Charge Mode Rated Storage Charging Capacity Raises:ValueError – if value is not a valid value Returns:the value of cooling_and_charge_mode_rated_storage_charging_capacity or None if not set Return type:float or “Autocalculate”

cooling_and_charge_mode_rated_total_evaporator_cooling_capacity

field Cooling And Charge Mode Rated Total Evaporator Cooling Capacity

required field if Cooling And Charge Mode is available

gross capacity excluding supply air fan heat

rating point: air entering the cooling coil at 26.7 C dry-bulb/19.4 C wet-bulb, and

air entering the outdoor condenser coil at 35 C dry-bulb/23.9 C wet-bulb

thermal storage tank at Fluid Storage Tank Rating Temperature (water or fluid) or storage faction of 0.5 (ice)

Units: W

Parameters:value (float or “Autocalculate”) – value for IDD Field Cooling And Charge Mode Rated Total Evaporator Cooling Capacity Raises:ValueError – if value is not a valid value Returns:the value of cooling_and_charge_mode_rated_total_evaporator_cooling_capacity or None if not set Return type:float or “Autocalculate”

cooling_and_charge_mode_sensible_heat_ratio_function_of_flow_fraction_curve_name

field Cooling And Charge Mode Sensible Heat Ratio Function of Flow Fraction Curve Name

required field if Cooling And Charge Mode is available

Any curve or table with one independent variable can be used

quadratic curve = a + b*ff + c*ff**2

cubic curve = a + b*ff + c*ff**2 + d*ff**3

x = ff = Fraction of the full load evaporator air flow

Parameters:value (str) – value for IDD Field Cooling And Charge Mode Sensible Heat Ratio Function of Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of cooling_and_charge_mode_sensible_heat_ratio_function_of_flow_fraction_curve_name or None if not set Return type:str

cooling_and_charge_mode_sensible_heat_ratio_function_of_temperature_curve_name

field Cooling And Charge Mode Sensible Heat Ratio Function of Temperature Curve Name

required field if Cooling And Charge Mode is available

Curves or tables with either two or three independent variables can be used.

Curve:Biquadratic, Table:TwoIndependentVariables, Curve:Bicubic and Curve:QuadraticLinear allowed

curve = a + b*ewb + c*ewb**2 + d*edb + e*edb**2 + f*ewb*edb

x = ewb = entering wet-bulb temperature seen by the cooling coil (C)

y = edb = entering dry-bulb temperature seen by the cooling coil (C)

Also allows Curve:Triquadratic and Table:MultiVariableLookup

curve or table = func(x = ewb, y = edb, z = stes)

z = stes = state of thermal energy storage (C or fraction)

Parameters:value (str) – value for IDD Field Cooling And Charge Mode Sensible Heat Ratio Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of cooling_and_charge_mode_sensible_heat_ratio_function_of_temperature_curve_name or None if not set Return type:str

cooling_and_charge_mode_storage_capacity_sizing_factor

field Cooling And Charge Mode Storage Capacity Sizing Factor

If previous field is autocalculate, this determines the storage cooling capacity

as a multiplier on the Cooling Only Mode Rated Total Evaporator Cooling Capacity

Default value: 0.5

Parameters:value (float) – value for IDD Field Cooling And Charge Mode Storage Capacity Sizing Factor Raises:ValueError – if value is not a valid value Returns:the value of cooling_and_charge_mode_storage_capacity_sizing_factor or None if not set Return type:float

cooling_and_charge_mode_storage_charge_capacity_function_of_temperature_curve_name

field Cooling And Charge Mode Storage Charge Capacity Function of Temperature Curve Name

required field if Cooling And Charge Mode is available

Allowed curve or table objects are Curve:Triquadratic and Table:MultiVariableLookup

curve or table = func(x = ewb, y = db, z = stes)

x = ewb = evaporator entering wet-bulb temperature (C)

y = db = dry-bulb temperature seen by the condenser (C)

z = stes = state of thermal energy storage (C or fraction)

Parameters:value (str) – value for IDD Field Cooling And Charge Mode Storage Charge Capacity Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of cooling_and_charge_mode_storage_charge_capacity_function_of_temperature_curve_name or None if not set Return type:str

cooling_and_charge_mode_storage_charge_capacity_function_of_total_evaporator_plr_curve_name

field Cooling And Charge Mode Storage Charge Capacity Function of Total Evaporator PLR Curve Name

required field if Cooling And Charge Mode is available

Any curve or table with one independent variable can be used

quadratic curve = a + b*PLR + c*PLR**2

cubic curve = a + b*PLR + c*PLR**2 + d*PLR**3

x = PLR = part load ratio (evaporator cooling load/steady state capacity)

Parameters:value (str) – value for IDD Field Cooling And Charge Mode Storage Charge Capacity Function of Total Evaporator PLR Curve Name Raises:ValueError – if value is not a valid value Returns:the value of cooling_and_charge_mode_storage_charge_capacity_function_of_total_evaporator_plr_curve_name or None if not set Return type:str

cooling_and_charge_mode_storage_energy_input_ratio_function_of_flow_fraction_curve_name

field Cooling And Charge Mode Storage Energy Input Ratio Function of Flow Fraction Curve Name

required field if Cooling And Charge Mode is available

Any curve or table with one independent variable can be used

quadratic curve = a + b*ff + c*ff**2

cubic curve = a + b*ff + c*ff**2 + d*ff**3

x = ff = Fraction of the full load evaporator air flow

Parameters:value (str) – value for IDD Field Cooling And Charge Mode Storage Energy Input Ratio Function of Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of cooling_and_charge_mode_storage_energy_input_ratio_function_of_flow_fraction_curve_name or None if not set Return type:str

cooling_and_charge_mode_storage_energy_input_ratio_function_of_temperature_curve_name

field Cooling And Charge Mode Storage Energy Input Ratio Function of Temperature Curve Name

required field if Cooling And Charge Mode is available

Allowed curve or table objects are Curve:Triquadratic and Table:MultiVariableLookup

curve or table = func(x = ewb, y = db, z = stes)

x = ewb = evaporator entering wet-bulb temperature (C)

y = db = dry-bulb temperature seen by the condenser (C)

z = stes = state of thermal energy storage (C or fraction)

Parameters:value (str) – value for IDD Field Cooling And Charge Mode Storage Energy Input Ratio Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of cooling_and_charge_mode_storage_energy_input_ratio_function_of_temperature_curve_name or None if not set Return type:str

cooling_and_charge_mode_storage_energy_part_load_fraction_correlation_curve_name

field Cooling And Charge Mode Storage Energy Part Load Fraction Correlation Curve Name

required field if Cooling And Charge Mode is available

Any curve or table with one independent variable can be used

quadratic curve = a + b*PLR + c*PLR**2

cubic curve = a + b*PLR + c*PLR**2 + d*PLR**3

x = PLR = part load ratio (evaporator cooling load/steady state capacity)

Parameters:value (str) – value for IDD Field Cooling And Charge Mode Storage Energy Part Load Fraction Correlation Curve Name Raises:ValueError – if value is not a valid value Returns:the value of cooling_and_charge_mode_storage_energy_part_load_fraction_correlation_curve_name or None if not set Return type:str

cooling_and_charge_mode_total_evaporator_cooling_capacity_function_of_flow_fraction_curve_name

field Cooling And Charge Mode Total Evaporator Cooling Capacity Function of Flow Fraction Curve Name

required field if Cooling And Charge Mode is available

Any curve or table with one independent variable can be used

quadratic curve = a + b*ff + c*ff**2

cubic curve = a + b*ff + c*ff**2 + d*ff**3

x = ff = Fraction of the full load evaporator air flow

Parameters:value (str) – value for IDD Field Cooling And Charge Mode Total Evaporator Cooling Capacity Function of Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of cooling_and_charge_mode_total_evaporator_cooling_capacity_function_of_flow_fraction_curve_name or None if not set Return type:str

cooling_and_charge_mode_total_evaporator_cooling_capacity_function_of_temperature_curve_name

field Cooling And Charge Mode Total Evaporator Cooling Capacity Function of Temperature Curve Name

required field if Cooling And Charge Mode is available

Allowed curve or table objects are Curve:Triquadratic and Table:MultiVariableLookup

curve or table = func(x = ewb, y = db, z = stes)

x = ewb = evaporator entering wet-bulb temperature (C)

y = db = dry-bulb temperature seen by the condenser (C)

z = stes = state of thermal energy storage (C or fraction)

Parameters:value (str) – value for IDD Field Cooling And Charge Mode Total Evaporator Cooling Capacity Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of cooling_and_charge_mode_total_evaporator_cooling_capacity_function_of_temperature_curve_name or None if not set Return type:str

cooling_and_discharge_mode_available

field Cooling And Discharge Mode Available

Parameters:value (str) – value for IDD Field Cooling And Discharge Mode Available Raises:ValueError – if value is not a valid value Returns:the value of cooling_and_discharge_mode_available or None if not set Return type:str

cooling_and_discharge_mode_cooling_rated_cop

field Cooling And Discharge Mode Cooling Rated COP

Gross evaporator cooling capacity divided by power input to the compressor (for cooling) and outdoor fan,

does not include supply fan heat or supply fan electrical energy input

required field if Cooling And Discharge Mode is available

Units: W/W

Default value: 3.0

Parameters:value (float) – value for IDD Field Cooling And Discharge Mode Cooling Rated COP Raises:ValueError – if value is not a valid value Returns:the value of cooling_and_discharge_mode_cooling_rated_cop or None if not set Return type:float

cooling_and_discharge_mode_discharging_rated_cop

field Cooling And Discharge Mode Discharging Rated COP

gross cooling capacity divided by power input to the compressor (for discharging),

includes any internal devices for discharging storage but not supply fan

required field if Cooling And Discharge Mode is available

Units: W/W

Default value: 3.0

Parameters:value (float) – value for IDD Field Cooling And Discharge Mode Discharging Rated COP Raises:ValueError – if value is not a valid value Returns:the value of cooling_and_discharge_mode_discharging_rated_cop or None if not set Return type:float

cooling_and_discharge_mode_evaporator_capacity_sizing_factor

field Cooling And Discharge Mode Evaporator Capacity Sizing Factor

If previous field is autocalculate, this determines the charging capacity

as a multiplier on the Cooling Only Mode Rated Total Evaporator Cooling Capacity

Default value: 1.0

Parameters:value (float) – value for IDD Field Cooling And Discharge Mode Evaporator Capacity Sizing Factor Raises:ValueError – if value is not a valid value Returns:the value of cooling_and_discharge_mode_evaporator_capacity_sizing_factor or None if not set Return type:float

cooling_and_discharge_mode_evaporator_energy_input_ratio_function_of_flow_fraction_curve_name

field Cooling And Discharge Mode Evaporator Energy Input Ratio Function of Flow Fraction Curve Name

required field if Cooling And Discharge Mode is available

Any curve or table with one independent variable can be used

quadratic curve = a + b*ff + c*ff**2

cubic curve = a + b*ff + c*ff**2 + d*ff**3

ff = Fraction of the full load evaporator air flow

Parameters:value (str) – value for IDD Field Cooling And Discharge Mode Evaporator Energy Input Ratio Function of Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of cooling_and_discharge_mode_evaporator_energy_input_ratio_function_of_flow_fraction_curve_name or None if not set Return type:str

cooling_and_discharge_mode_evaporator_energy_input_ratio_function_of_temperature_curve_name

field Cooling And Discharge Mode Evaporator Energy Input Ratio Function of Temperature Curve Name

required field if Cooling And Discharge Mode is available

Allowed curve or table objects are Curve:Triquadratic and Table:MultiVariableLookup

curve or table = func(x = ewb, y = db, z = stes)

x = ewb = evaporator entering wet-bulb temperature (C)

y = db = dry-bulb temperature seen by the condenser (C)

z = stes = state of thermal energy storage (C or fraction)

Parameters:value (str) – value for IDD Field Cooling And Discharge Mode Evaporator Energy Input Ratio Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of cooling_and_discharge_mode_evaporator_energy_input_ratio_function_of_temperature_curve_name or None if not set Return type:str

cooling_and_discharge_mode_evaporator_part_load_fraction_correlation_curve_name

field Cooling And Discharge Mode Evaporator Part Load Fraction Correlation Curve Name

required field if Cooling And Discharge Mode is available

Any curve or table with one independent variable can be used

quadratic curve = a + b*PLR + c*PLR**2

cubic curve = a + b*PLR + c*PLR**2 + d*PLR**3

x = PLR = part load ratio (evaporator cooling load/steady state capacity)

Parameters:value (str) – value for IDD Field Cooling And Discharge Mode Evaporator Part Load Fraction Correlation Curve Name Raises:ValueError – if value is not a valid value Returns:the value of cooling_and_discharge_mode_evaporator_part_load_fraction_correlation_curve_name or None if not set Return type:str

cooling_and_discharge_mode_rated_sensible_heat_ratio

field Cooling And Discharge Mode Rated Sensible Heat Ratio

required field if Cooling And Discharge Mode is available

Rated sensible heat ratio (gross sensible evaporator capacity/gross total evaporator capacity)

sensible and total capacities do not include supply fan heat

Default value: 0.7

value <= 1.0

Parameters:value (float) – value for IDD Field Cooling And Discharge Mode Rated Sensible Heat Ratio Raises:ValueError – if value is not a valid value Returns:the value of cooling_and_discharge_mode_rated_sensible_heat_ratio or None if not set Return type:float

cooling_and_discharge_mode_rated_storage_discharging_capacity

field Cooling And Discharge Mode Rated Storage Discharging Capacity

required field if Cooling And Discharge Mode is available

net capacity including any internal devices

rating point: air entering the cooling coil at 26.7 C dry-bulb/19.4 C wet-bulb, and

air entering the outdoor condenser coil at 35 C dry-bulb/23.9 C wet-bulb

thermal storage tank at 26.7 C (water) or storage faction of 0.5 (ice)

Units: W

Parameters:value (float or “Autocalculate”) – value for IDD Field Cooling And Discharge Mode Rated Storage Discharging Capacity Raises:ValueError – if value is not a valid value Returns:the value of cooling_and_discharge_mode_rated_storage_discharging_capacity or None if not set Return type:float or “Autocalculate”

cooling_and_discharge_mode_rated_total_evaporator_cooling_capacity

field Cooling And Discharge Mode Rated Total Evaporator Cooling Capacity

required field if Cooling And Discharge Mode is available

gross capacity excluding supply air fan heat

rating point: air entering the cooling coil at 26.7 C dry-bulb/19.4 C wet-bulb, and

air entering the outdoor condenser coil at 35 C dry-bulb/23.9 C wet-bulb

thermal storage tank at Fluid Storage Tank Rating Temperature (water or fluid) or storage faction of 0.5 (ice)

Units: W

Parameters:value (float or “Autocalculate”) – value for IDD Field Cooling And Discharge Mode Rated Total Evaporator Cooling Capacity Raises:ValueError – if value is not a valid value Returns:the value of cooling_and_discharge_mode_rated_total_evaporator_cooling_capacity or None if not set Return type:float or “Autocalculate”

cooling_and_discharge_mode_sensible_heat_ratio_function_of_flow_fraction_curve_name

field Cooling And Discharge Mode Sensible Heat Ratio Function of Flow Fraction Curve Name

required field if Cooling And Discharge Mode is available

Any curve or table with one independent variable can be used

quadratic curve = a + b*ff + c*ff**2

cubic curve = a + b*ff + c*ff**2 + d*ff**3

x = ff = Fraction of the full load evaporator air flow

Parameters:value (str) – value for IDD Field Cooling And Discharge Mode Sensible Heat Ratio Function of Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of cooling_and_discharge_mode_sensible_heat_ratio_function_of_flow_fraction_curve_name or None if not set Return type:str

cooling_and_discharge_mode_sensible_heat_ratio_function_of_temperature_curve_name

field Cooling And Discharge Mode Sensible Heat Ratio Function of Temperature Curve Name

required field if Cooling And Discharge Mode is available

Curves or tables with either two or three independent variables can be used.

curve = a + b*ewb + c*ewb**2 + d*edb + e*edb**2 + f*ewb*edb

x = ewb = entering wet-bulb temperature seen by the cooling coil (C)

y = edb = entering dry-bulb temperature seen by the cooling coil (C)

Also allows Curve:Triquadratic and Table:MultiVariableLookup

curve or table = func(x = ewb, y = edb, z = stes)

z = stes = state of thermal energy storage (C or fraction)

Parameters:value (str) – value for IDD Field Cooling And Discharge Mode Sensible Heat Ratio Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of cooling_and_discharge_mode_sensible_heat_ratio_function_of_temperature_curve_name or None if not set Return type:str

cooling_and_discharge_mode_storage_discharge_capacity_function_of_flow_fraction_curve_name

field Cooling And Discharge Mode Storage Discharge Capacity Function of Flow Fraction Curve Name

required field if Cooling And Discharge Mode is available

Any curve or table with one independent variable can be used

quadratic curve = a + b*ff + c*ff**2

cubic curve = a + b*ff + c*ff**2 + d*ff**3

ff = Fraction of the full load evaporator air flow

Parameters:value (str) – value for IDD Field Cooling And Discharge Mode Storage Discharge Capacity Function of Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of cooling_and_discharge_mode_storage_discharge_capacity_function_of_flow_fraction_curve_name or None if not set Return type:str

cooling_and_discharge_mode_storage_discharge_capacity_function_of_temperature_curve_name

field Cooling And Discharge Mode Storage Discharge Capacity Function of Temperature Curve Name

required field if Cooling And Discharge Mode is available

Allowed curve or table objects are Curve:Triquadratic and Table:MultiVariableLookup

curve or table = func(x = ewb, y = db, z = stes)

x = ewb = evaporator entering wet-bulb temperature (C)

y = db = dry-bulb temperature seen by the condenser (C)

z = stes = state of thermal energy storage (C or fraction)

Parameters:value (str) – value for IDD Field Cooling And Discharge Mode Storage Discharge Capacity Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of cooling_and_discharge_mode_storage_discharge_capacity_function_of_temperature_curve_name or None if not set Return type:str

cooling_and_discharge_mode_storage_discharge_capacity_function_of_total_evaporator_plr_curve_name

field Cooling And Discharge Mode Storage Discharge Capacity Function of Total Evaporator PLR Curve Name

required field if Cooling And Discharge Mode is available

Any curve or table with one independent variable can be used

quadratic curve = a + b*PLR + c*PLR**2

cubic curve = a + b*PLR + c*PLR**2 + d*PLR**3

x =PLR = part load ratio (evaporator cooling load/steady state capacity)

Parameters:value (str) – value for IDD Field Cooling And Discharge Mode Storage Discharge Capacity Function of Total Evaporator PLR Curve Name Raises:ValueError – if value is not a valid value Returns:the value of cooling_and_discharge_mode_storage_discharge_capacity_function_of_total_evaporator_plr_curve_name or None if not set Return type:str

cooling_and_discharge_mode_storage_discharge_capacity_sizing_factor

field Cooling And Discharge Mode Storage Discharge Capacity Sizing Factor

If previous field is autocalculate, this determines the charging capacity

as a multiplier on the Cooling Only Mode Rated Total Evaporator Cooling Capacity

Default value: 1.0

Parameters:value (float) – value for IDD Field Cooling And Discharge Mode Storage Discharge Capacity Sizing Factor Raises:ValueError – if value is not a valid value Returns:the value of cooling_and_discharge_mode_storage_discharge_capacity_sizing_factor or None if not set Return type:float

cooling_and_discharge_mode_storage_energy_input_ratio_function_of_flow_fraction_curve_name

field Cooling And Discharge Mode Storage Energy Input Ratio Function of Flow Fraction Curve Name

required field if Cooling And Discharge Mode is available

Any curve or table with one independent variable can be used

quadratic curve = a + b*ff + c*ff**2

cubic curve = a + b*ff + c*ff**2 + d*ff**3

x = ff = Fraction of the full load evaporator air flow

Parameters:value (str) – value for IDD Field Cooling And Discharge Mode Storage Energy Input Ratio Function of Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of cooling_and_discharge_mode_storage_energy_input_ratio_function_of_flow_fraction_curve_name or None if not set Return type:str

cooling_and_discharge_mode_storage_energy_input_ratio_function_of_temperature_curve_name

field Cooling And Discharge Mode Storage Energy Input Ratio Function of Temperature Curve Name

required field if Cooling And Discharge Mode is available

Allowed curve or table objects are Curve:Triquadratic and Table:MultiVariableLookup

curve or table = func(x = ewb, y = db, z = stes)

x = ewb = evaporator entering wet-bulb temperature (C)

y = db = dry-bulb temperature seen by the condenser (C)

z = stes = state of thermal energy storage (C or fraction)

Parameters:value (str) – value for IDD Field Cooling And Discharge Mode Storage Energy Input Ratio Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of cooling_and_discharge_mode_storage_energy_input_ratio_function_of_temperature_curve_name or None if not set Return type:str

cooling_and_discharge_mode_storage_energy_part_load_fraction_correlation_curve_name

field Cooling And Discharge Mode Storage Energy Part Load Fraction Correlation Curve Name

required field if Cooling And Discharge Mode is available

Any curve or table with one independent variable can be used

quadratic curve = a + b*PLR + c*PLR**2

cubic curve = a + b*PLR + c*PLR**2 + d*PLR**3

x = PLR = part load ratio (evaporator cooling load/steady state capacity)

Parameters:value (str) – value for IDD Field Cooling And Discharge Mode Storage Energy Part Load Fraction Correlation Curve Name Raises:ValueError – if value is not a valid value Returns:the value of cooling_and_discharge_mode_storage_energy_part_load_fraction_correlation_curve_name or None if not set Return type:str

cooling_and_discharge_mode_total_evaporator_cooling_capacity_function_of_flow_fraction_curve_name

field Cooling And Discharge Mode Total Evaporator Cooling Capacity Function of Flow Fraction Curve Name

required field if Cooling And Discharge Mode is available

Any curve or table with one independent variable can be used

quadratic curve = a + b*ff + c*ff**2

cubic curve = a + b*ff + c*ff**2 + d*ff**3

x = ff = Fraction of the full load evaporator air flow

Parameters:value (str) – value for IDD Field Cooling And Discharge Mode Total Evaporator Cooling Capacity Function of Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of cooling_and_discharge_mode_total_evaporator_cooling_capacity_function_of_flow_fraction_curve_name or None if not set Return type:str

cooling_and_discharge_mode_total_evaporator_cooling_capacity_function_of_temperature_curve_name

field Cooling And Discharge Mode Total Evaporator Cooling Capacity Function of Temperature Curve Name

required field if Cooling Only Mode is available

Allowed curve or table objects are Curve:Triquadratic and Table:MultiVariableLookup

curve or table = func(x = ewb, y = db, z = stes)

x = ewb = evaporator entering wet-bulb temperature (C)

y = db = dry-bulb temperature seen by the condenser (C)

z = stes = state of thermal energy storage (C or fraction)

Parameters:value (str) – value for IDD Field Cooling And Discharge Mode Total Evaporator Cooling Capacity Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of cooling_and_discharge_mode_total_evaporator_cooling_capacity_function_of_temperature_curve_name or None if not set Return type:str

cooling_only_mode_available

field Cooling Only Mode Available

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

cooling_only_mode_energy_input_ratio_function_of_flow_fraction_curve_name

field Cooling Only Mode Energy Input Ratio Function of Flow Fraction Curve Name

required field if Cooling Only Mode is available

Any curve or table with one independent variable can be used

quadratic curve = a + b*ff + c*ff**2

cubic curve = a + b*ff + c*ff**2 + d*ff**3

x = ff = Fraction of the full load evaporator air flow

Parameters:value (str) – value for IDD Field Cooling Only Mode Energy Input Ratio Function of Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of cooling_only_mode_energy_input_ratio_function_of_flow_fraction_curve_name or None if not set Return type:str

cooling_only_mode_energy_input_ratio_function_of_temperature_curve_name

field Cooling Only Mode Energy Input Ratio Function of Temperature Curve Name

required field if Cooling Only Mode is available

Any curve or table with two independent variables can be used

curve = a + b*ewb + c*ewb**2 + d*db + e*db**2 + f*ewb*db

x = ewb = evaporator entering wet-bulb temperature (C)

y = db = dry-bulb temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Cooling Only Mode Energy Input Ratio Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of cooling_only_mode_energy_input_ratio_function_of_temperature_curve_name or None if not set Return type:str

cooling_only_mode_part_load_fraction_correlation_curve_name

field Cooling Only Mode Part Load Fraction Correlation Curve Name

required field if Cooling Only Mode is available

Any curve or table with one independent variable can be used

quadratic curve = a + b*PLR + c*PLR**2

cubic curve = a + b*PLR + c*PLR**2 + d*PLR**3

x = PLR = part load ratio (evaporator cooling load/steady state capacity)

Parameters:value (str) – value for IDD Field Cooling Only Mode Part Load Fraction Correlation Curve Name Raises:ValueError – if value is not a valid value Returns:the value of cooling_only_mode_part_load_fraction_correlation_curve_name or None if not set Return type:str

cooling_only_mode_rated_cop

field Cooling Only Mode Rated COP

Gross cooling capacity divided by power input to the compressor and outdoor fan,

does not include supply fan heat or supply fan electrical energy input

required field if Cooling Only Mode is available

Units: W/W

Default value: 3.0

Parameters:value (float) – value for IDD Field Cooling Only Mode Rated COP Raises:ValueError – if value is not a valid value Returns:the value of cooling_only_mode_rated_cop or None if not set Return type:float

cooling_only_mode_rated_sensible_heat_ratio

field Cooling Only Mode Rated Sensible Heat Ratio

required field if Cooling Only Mode is available

Rated sensible heat ratio (gross sensible capacity/gross total capacity)

sensible and total capacities do not include supply fan heat

Default value: 0.7

value <= 1.0

Parameters:value (float) – value for IDD Field Cooling Only Mode Rated Sensible Heat Ratio Raises:ValueError – if value is not a valid value Returns:the value of cooling_only_mode_rated_sensible_heat_ratio or None if not set Return type:float

cooling_only_mode_rated_total_evaporator_cooling_capacity

field Cooling Only Mode Rated Total Evaporator Cooling Capacity

required field if Cooling Only Mode is available or if autocalculating sizes

gross capacity excluding supply air fan heat

rating point: air entering the cooling coil at 26.7 C dry-bulb/19.4 C wet-bulb, and

air entering the outdoor condenser coil at 35 C dry-bulb/23.9 C wet-bulb

Units: W

Parameters:value (float or “Autosize”) – value for IDD Field Cooling Only Mode Rated Total Evaporator Cooling Capacity Raises:ValueError – if value is not a valid value Returns:the value of cooling_only_mode_rated_total_evaporator_cooling_capacity or None if not set Return type:float or “Autosize”

cooling_only_mode_sensible_heat_ratio_function_of_flow_fraction_curve_name

field Cooling Only Mode Sensible Heat Ratio Function of Flow Fraction Curve Name

required field if Cooling Only Mode is available

Any curve or table with one independent variable can be used

quadratic curve = a + b*ff + c*ff**2

cubic curve = a + b*ff + c*ff**2 + d*ff**3

x = ff = Fraction of the full load evaporator air flow

Parameters:value (str) – value for IDD Field Cooling Only Mode Sensible Heat Ratio Function of Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of cooling_only_mode_sensible_heat_ratio_function_of_flow_fraction_curve_name or None if not set Return type:str

cooling_only_mode_sensible_heat_ratio_function_of_temperature_curve_name

field Cooling Only Mode Sensible Heat Ratio Function of Temperature Curve Name

required field if Cooling Only Mode is available

Any curve or table with two independent variables can be used

curve = a + b*ewb + c*ewb**2 + d*edb + e*edb**2 + f*ewb*edb

x = ewb = evaporator entering wet-bulb temperature seen by the cooling coil (C)

y = edb = evaporator entering dry-bulb temperature seen by the cooling coil (C)

Parameters:value (str) – value for IDD Field Cooling Only Mode Sensible Heat Ratio Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of cooling_only_mode_sensible_heat_ratio_function_of_temperature_curve_name or None if not set Return type:str

cooling_only_mode_total_evaporator_cooling_capacity_function_of_flow_fraction_curve_name

field Cooling Only Mode Total Evaporator Cooling Capacity Function of Flow Fraction Curve Name

required field if Cooling Only Mode is available

Any curve or table with one independent variable can be used

quadratic curve = a + b*ff + c*ff**2

cubic curve = a + b*ff + c*ff**2 + d*ff**3

x = ff = Fraction of the full load evaporator air flow rate

Parameters:value (str) – value for IDD Field Cooling Only Mode Total Evaporator Cooling Capacity Function of Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of cooling_only_mode_total_evaporator_cooling_capacity_function_of_flow_fraction_curve_name or None if not set Return type:str

cooling_only_mode_total_evaporator_cooling_capacity_function_of_temperature_curve_name

field Cooling Only Mode Total Evaporator Cooling Capacity Function of Temperature Curve Name

required field if Cooling Only Mode is available

Any curve or table with two independent variables can be used

biquadratic curve = a + b*ewb + c*ewb**2 + d*db + e*db**2 + f*ewb*db

x = ewb = evaporator entering wet-bulb temperature (C)

y = db = dry-bulb temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Cooling Only Mode Total Evaporator Cooling Capacity Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of cooling_only_mode_total_evaporator_cooling_capacity_function_of_temperature_curve_name or None if not set Return type:str

discharge_only_mode_available

field Discharge Only Mode Available

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

discharge_only_mode_capacity_sizing_factor

field Discharge Only Mode Capacity Sizing Factor

If previous field is autocalculate, this determines the discharging capacity

as a multiplier on the Cooling Only Mode Rated Total Evaporator Cooling Capacity

Default value: 1.0

Parameters:value (float) – value for IDD Field Discharge Only Mode Capacity Sizing Factor Raises:ValueError – if value is not a valid value Returns:the value of discharge_only_mode_capacity_sizing_factor or None if not set Return type:float

discharge_only_mode_energy_input_ratio_function_of_flow_fraction_curve_name

field Discharge Only Mode Energy Input Ratio Function of Flow Fraction Curve Name

required field if Discharge Only Mode is available

Any curve or table with one independent variable can be used

quadratic curve = a + b*ff + c*ff**2

cubic curve = a + b*ff + c*ff**2 + d*ff**3

x = ff = Fraction of the full load evaporator air flow

Parameters:value (str) – value for IDD Field Discharge Only Mode Energy Input Ratio Function of Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of discharge_only_mode_energy_input_ratio_function_of_flow_fraction_curve_name or None if not set Return type:str

discharge_only_mode_energy_input_ratio_function_of_temperature_curve_name

field Discharge Only Mode Energy Input Ratio Function of Temperature Curve Name

required field if Discharge Only Mode is available

Any curve or table with two independent variables can be used

curve = a + b*ewb + c*ewb**2 + d*stes + e*stes**2 + f*ewb*stes

x = ewb = evaporator entering wet-bulb temperature (C)

y = stes = state of thermal energy storage (C or fraction)

Parameters:value (str) – value for IDD Field Discharge Only Mode Energy Input Ratio Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of discharge_only_mode_energy_input_ratio_function_of_temperature_curve_name or None if not set Return type:str

discharge_only_mode_part_load_fraction_correlation_curve_name

field Discharge Only Mode Part Load Fraction Correlation Curve Name

required field if Discharge Only Mode is available

Any curve or table with one independent variable can be used

quadratic curve = a + b*PLR + c*PLR**2

cubic curve = a + b*PLR + c*PLR**2 + d*PLR**3

Parameters:value (str) – value for IDD Field Discharge Only Mode Part Load Fraction Correlation Curve Name Raises:ValueError – if value is not a valid value Returns:the value of discharge_only_mode_part_load_fraction_correlation_curve_name or None if not set Return type:str

discharge_only_mode_rated_cop

field Discharge Only Mode Rated COP

required field if Discharge Only Mode is available

gross cooling capacity divided by power input to the compressor (for discharging),

includes any internal devices for discharging storage but not supply fan

Units: W/W

Default value: 3.0

Parameters:value (float) – value for IDD Field Discharge Only Mode Rated COP Raises:ValueError – if value is not a valid value Returns:the value of discharge_only_mode_rated_cop or None if not set Return type:float

discharge_only_mode_rated_sensible_heat_ratio

field Discharge Only Mode Rated Sensible Heat Ratio

required field if Discharge Only Mode is available

Rated sensible heat ratio (gross sensible evaporator capacity/gross total evaporator capacity)

sensible and total capacities do not include supply fan heat

value <= 1.0

Parameters:value (float) – value for IDD Field Discharge Only Mode Rated Sensible Heat Ratio Raises:ValueError – if value is not a valid value Returns:the value of discharge_only_mode_rated_sensible_heat_ratio or None if not set Return type:float

discharge_only_mode_rated_storage_discharging_capacity

field Discharge Only Mode Rated Storage Discharging Capacity

required field if Discharge Only Mode is available

net capacity including any internal devices

rating point: air entering the cooling coil at 26.7 C dry-bulb/19.4 C wet-bulb, and

thermal storage tank at 26.7 C (water) or storage faction of 0.5 (ice)

Units: W

Parameters:value (float or “Autocalculate”) – value for IDD Field Discharge Only Mode Rated Storage Discharging Capacity Raises:ValueError – if value is not a valid value Returns:the value of discharge_only_mode_rated_storage_discharging_capacity or None if not set Return type:float or “Autocalculate”

discharge_only_mode_sensible_heat_ratio_function_of_flow_fraction_curve_name

field Discharge Only Mode Sensible Heat Ratio Function of Flow Fraction Curve Name

required field if Discharge Only Mode is available

Any curve or table with one independent variable can be used

quadratic curve = a + b*ff + c*ff**2

cubic curve = a + b*ff + c*ff**2 + d*ff**3

ff = Fraction of the full load evaporator air flow

Parameters:value (str) – value for IDD Field Discharge Only Mode Sensible Heat Ratio Function of Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of discharge_only_mode_sensible_heat_ratio_function_of_flow_fraction_curve_name or None if not set Return type:str

discharge_only_mode_sensible_heat_ratio_function_of_temperature_curve_name

field Discharge Only Mode Sensible Heat Ratio Function of Temperature Curve Name

required field if Discharge Only Mode is available

Curves or tables with either two or three independent variables can be used.

Curve:Biquadratic, Table:TwoIndependentVariables, Curve:Bicubic and Curve:QuadraticLinear allowed

curve = a + b*ewb + c*ewb**2 + d*edb + e*edb**2 + f*ewb*edb

x = ewb = entering wet-bulb temperature seen by the cooling coil (C)

y = edb = entering dry-bulb temperature seen by the cooling coil (C)

Also allows Curve:Triquadratic and Table:MultiVariableLookup

curve or table = func(x = ewb, y = edb, z = stes)

z = stes = state of thermal energy storage (C or fraction)

Parameters:value (str) – value for IDD Field Discharge Only Mode Sensible Heat Ratio Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of discharge_only_mode_sensible_heat_ratio_function_of_temperature_curve_name or None if not set Return type:str

discharge_only_mode_storage_discharge_capacity_function_of_flow_fraction_curve_name

field Discharge Only Mode Storage Discharge Capacity Function of Flow Fraction Curve Name

required field if Discharge Only Mode is available

Any curve or table with one independent variable can be used

quadratic curve = a + b*ff + c*ff**2

cubic curve = a + b*ff + c*ff**2 + d*ff**3

x = ff = Fraction of the full load evaporator air flow

Parameters:value (str) – value for IDD Field Discharge Only Mode Storage Discharge Capacity Function of Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of discharge_only_mode_storage_discharge_capacity_function_of_flow_fraction_curve_name or None if not set Return type:str

discharge_only_mode_storage_discharge_capacity_function_of_temperature_curve_name

field Discharge Only Mode Storage Discharge Capacity Function of Temperature Curve Name

required field if Discharge Only Mode is available

Any curve or table with two independent variables can be used

curve = a + b*ewb + c*ewb**2 + d*stes + e*stes**2 + f*ewb*stes

x = ewb = evaporator entering wet-bulb temperature (C)

y = stes = state of thermal energy storage (C or fraction)

Parameters:value (str) – value for IDD Field Discharge Only Mode Storage Discharge Capacity Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of discharge_only_mode_storage_discharge_capacity_function_of_temperature_curve_name or None if not set Return type:str

evaporative_condenser_effectiveness

field Evaporative Condenser Effectiveness

required field if condenser type is evaporatively cooled

Units: dimensionless

Default value: 0.7

value <= 1.0

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

evaporative_condenser_pump_rated_power_consumption

field Evaporative Condenser Pump Rated Power Consumption

Rated power consumed by the evaporative condenser’s water pump

Units: W

Parameters:value (float or “Autosize”) – value for IDD Field Evaporative Condenser Pump Rated Power Consumption Raises:ValueError – if value is not a valid value Returns:the value of evaporative_condenser_pump_rated_power_consumption or None if not set Return type:float or “Autosize”

evaporator_air_inlet_node_name

field Evaporator Air Inlet Node Name

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

evaporator_air_outlet_node_name

field Evaporator Air Outlet Node Name

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

fluid_storage_tank_rating_temperature

field Fluid Storage Tank Rating Temperature

required field if Storage Type is Water or UserDefinedFluidType

Units: C

Parameters:value (float) – value for IDD Field Fluid Storage Tank Rating Temperature Raises:ValueError – if value is not a valid value Returns:the value of fluid_storage_tank_rating_temperature or None if not set Return type:float

fluid_storage_volume

field Fluid Storage Volume

required field if Storage Type is Water or UserDefinedFluidType

Units: m3

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

ice_storage_capacity

field Ice Storage Capacity

required field if Storage Type is Ice

Units: GJ

Parameters:value (float or “Autocalculate”) – value for IDD Field Ice Storage Capacity Raises:ValueError – if value is not a valid value Returns:the value of ice_storage_capacity or None if not set Return type:float or “Autocalculate”

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

operating_mode_control_method

field Operating Mode Control Method

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

operation_mode_control_schedule_name

field Operation Mode Control Schedule Name

This field is used if the control method is set to ScheduledModes

Schedule values control operating mode: 0=off, 1=cooling only, 2= cooling and charge,

3= cooling and discharge, 4= charge only, and 5= discharge only

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

rated_evaporator_air_flow_rate

field Rated Evaporator Air Flow Rate

Flow rate corresponding to rated total cooling capacity, Rated SHR and Rated COP

Units: m3/s

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

storage_capacity_sizing_factor

field Storage Capacity Sizing Factor

If one of the previous two fields is set to autocalculate, this determines the storage capacity

as a function of Cooling Only Mode Rated Total Evaporator Cooling Capacity

Units: hr

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

storage_tank_ambient_temperature_node_name

field Storage Tank Ambient Temperature Node Name

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

storage_tank_maximum_operating_limit_fluid_temperature

field Storage Tank Maximum Operating Limit Fluid Temperature

For fluid storage tanks only, maximum limit for storage tank

If omitted,then the maximum temperature limit is that used for fluid property data.

Units: C

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

storage_tank_minimum_operating_limit_fluid_temperature

field Storage Tank Minimum Operating Limit Fluid Temperature

For fluid storage tanks only, minimum limit for storage tank

If omitted,then the minimum temperature limit is that used for fluid property data.

Units: C

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

storage_tank_plant_connection_design_flow_rate

field Storage Tank Plant Connection Design Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Storage Tank Plant Connection Design Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of storage_tank_plant_connection_design_flow_rate or None if not set Return type:float

storage_tank_plant_connection_heat_transfer_effectiveness

field Storage Tank Plant Connection Heat Transfer Effectiveness

Default value: 0.7

value <= 1.0

Parameters:value (float) – value for IDD Field Storage Tank Plant Connection Heat Transfer Effectiveness Raises:ValueError – if value is not a valid value Returns:the value of storage_tank_plant_connection_heat_transfer_effectiveness or None if not set Return type:float

storage_tank_plant_connection_inlet_node_name

field Storage Tank Plant Connection Inlet Node Name

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

storage_tank_plant_connection_outlet_node_name

field Storage Tank Plant Connection Outlet Node Name

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

storage_tank_to_ambient_uvalue_times_area_heat_transfer_coefficient

field Storage Tank to Ambient U-value Times Area Heat Transfer Coefficient

Units: W/K

Parameters:value (float) – value for IDD Field Storage Tank to Ambient U-value Times Area Heat Transfer Coefficient Raises:ValueError – if value is not a valid value Returns:the value of storage_tank_to_ambient_uvalue_times_area_heat_transfer_coefficient or None if not set Return type:float

storage_type

field Storage Type

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

supply_water_storage_tank_name

field Supply Water Storage Tank Name

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

user_defined_fluid_type

field User Defined Fluid Type

This field is required when Storage Type is UserDefinedFluidType

Parameters:value (str) – value for IDD Field User Defined Fluid Type Raises:ValueError – if value is not a valid value Returns:the value of user_defined_fluid_type or None if not set Return type:str

class pyidf.coils.CoilCoolingDxTwoSpeed

Bases: pyidf.helper.DataObject

Corresponds to IDD object Coil:Cooling:DX:TwoSpeed Direct expansion (DX) cooling coil and condensing unit (includes electric compressor and condenser fan), two-speed (or variable-speed). Requires two sets of performance data and will interpolate between speeds. Modeled as a single coil (multi-speed compressor or multiple compressors with row split or intertwined coil).

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

basin_heater_capacity

field Basin Heater Capacity

This field is only used for Condenser Type = EvaporativelyCooled and for periods

when the basin heater is available (field Basin Heater Operating Schedule Name).

For this situation, the heater maintains the basin water temperature at the basin heater

setpoint temperature when the outdoor air temperature falls below the setpoint temperature.

The basin heater only operates when the DX coil is off.

Units: W/K

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

basin_heater_operating_schedule_name

field Basin Heater Operating Schedule Name

This field is only used for Condenser Type = EvaporativelyCooled.

Schedule values greater than 0 allow the basin heater to operate whenever the outdoor

air dry-bulb temperature is below the basin heater setpoint temperature.

If a schedule name is not entered, the basin heater is allowed to operate

throughout the entire simulation.

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

basin_heater_setpoint_temperature

field Basin Heater Setpoint Temperature

This field is only used for Condenser Type = EvaporativelyCooled.

Enter the outdoor dry-bulb temperature when the basin heater turns on.

Units: C

Default value: 2.0

value >= 2.0

Parameters:value (float) – value for IDD Field Basin Heater Setpoint Temperature Raises:ValueError – if value is not a valid value Returns:the value of basin_heater_setpoint_temperature or None if not set Return type:float

condensate_collection_water_storage_tank_name

field Condensate Collection Water Storage Tank Name

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

condenser_air_inlet_node_name

field Condenser Air Inlet Node Name

Enter the name of an outdoor air node. This node name is also specified in

an OutdoorAir:Node or OutdoorAir:NodeList object.

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

condenser_type

field Condenser Type

Default value: AirCooled

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

energy_input_ratio_function_of_flow_fraction_curve_name

field Energy Input Ratio Function of Flow Fraction Curve Name

quadratic curve = a + b*ff + c*ff**2

cubic curve = a + b*ff + c*ff**2 + d*ff**3

ff = fraction of the full load flow

Parameters:value (str) – value for IDD Field Energy Input Ratio Function of Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of energy_input_ratio_function_of_flow_fraction_curve_name or None if not set Return type:str

energy_input_ratio_function_of_temperature_curve_name

field Energy Input Ratio Function of Temperature Curve Name

curve = a + b*wb + c*wb**2 + d*edb + e*edb**2 + f*wb*edb

wb = entering wet-bulb temperature (C)

edb = dry-bulb temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Energy Input Ratio Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of energy_input_ratio_function_of_temperature_curve_name or None if not set Return type:str

high_speed_evaporative_condenser_air_flow_rate

field High Speed Evaporative Condenser Air Flow Rate

Used to calculate evaporative condenser water use

Units: m3/s

Parameters:value (float or “Autosize”) – value for IDD Field High Speed Evaporative Condenser Air Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of high_speed_evaporative_condenser_air_flow_rate or None if not set Return type:float or “Autosize”

high_speed_evaporative_condenser_effectiveness

field High Speed Evaporative Condenser Effectiveness

Units: dimensionless

Default value: 0.9

value <= 1.0

Parameters:value (float) – value for IDD Field High Speed Evaporative Condenser Effectiveness Raises:ValueError – if value is not a valid value Returns:the value of high_speed_evaporative_condenser_effectiveness or None if not set Return type:float

high_speed_evaporative_condenser_pump_rated_power_consumption

field High Speed Evaporative Condenser Pump Rated Power Consumption

Rated power consumed by the evaporative condenser’s water pump at high speed

Units: W

Parameters:value (float or “Autosize”) – value for IDD Field High Speed Evaporative Condenser Pump Rated Power Consumption Raises:ValueError – if value is not a valid value Returns:the value of high_speed_evaporative_condenser_pump_rated_power_consumption or None if not set Return type:float or “Autosize”

high_speed_gross_rated_cooling_cop

field High Speed Gross Rated Cooling COP

Gross cooling capacity divided by power input to the compressor and outdoor fan,

does not include supply fan heat or supply fan electrical energy input

Units: W/W

Default value: 3.0

Parameters:value (float) – value for IDD Field High Speed Gross Rated Cooling COP Raises:ValueError – if value is not a valid value Returns:the value of high_speed_gross_rated_cooling_cop or None if not set Return type:float

high_speed_gross_rated_total_cooling_capacity

field High Speed Gross Rated Total Cooling Capacity

Total cooling capacity not accounting for the effect of supply air fan heat

gross capacity excluding supply air fan heat

rating point: air entering the cooling coil at 26.7 C dry-bulb/19.4 C wet-bulb, and

air entering the outdoor condenser coil at 35 C dry-bulb/23.9 C wet-bulb

Units: W

Parameters:value (float or “Autosize”) – value for IDD Field High Speed Gross Rated Total Cooling Capacity Raises:ValueError – if value is not a valid value Returns:the value of high_speed_gross_rated_total_cooling_capacity or None if not set Return type:float or “Autosize”

high_speed_rated_air_flow_rate

field High Speed Rated Air Flow Rate

Flow rate corresponding to rated total cooling capacity, Rated SHR

and Rated COP. Should be between 0.00004027 m3/s and .00006041 m3/s per watt

of rated total cooling capacity.

Units: m3/s

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

high_speed_rated_sensible_heat_ratio

field High Speed Rated Sensible Heat Ratio

Rated sensible heat ratio (gross sensible capacity/gross total capacity)

sensible and total capacities do not include supply fan heat

value >= 0.5

value <= 1.0

Parameters:value (float or “Autosize”) – value for IDD Field High Speed Rated Sensible Heat Ratio Raises:ValueError – if value is not a valid value Returns:the value of high_speed_rated_sensible_heat_ratio or None if not set Return type:float or “Autosize”

low_speed_energy_input_ratio_function_of_temperature_curve_name

field Low Speed Energy Input Ratio Function of Temperature Curve Name

curve = a + b*wb + c*wb**2 + d*edb + e*edb**2 + f*wb*edb

wb = entering wet-bulb temperature (C)

edb = dry-bulb temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Low Speed Energy Input Ratio Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of low_speed_energy_input_ratio_function_of_temperature_curve_name or None if not set Return type:str

low_speed_evaporative_condenser_air_flow_rate

field Low Speed Evaporative Condenser Air Flow Rate

Used to calculate evaporative condenser water use

Units: m3/s

Parameters:value (float or “Autosize”) – value for IDD Field Low Speed Evaporative Condenser Air Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of low_speed_evaporative_condenser_air_flow_rate or None if not set Return type:float or “Autosize”

low_speed_evaporative_condenser_effectiveness

field Low Speed Evaporative Condenser Effectiveness

Units: dimensionless

Default value: 0.9

value <= 1.0

Parameters:value (float) – value for IDD Field Low Speed Evaporative Condenser Effectiveness Raises:ValueError – if value is not a valid value Returns:the value of low_speed_evaporative_condenser_effectiveness or None if not set Return type:float

low_speed_evaporative_condenser_pump_rated_power_consumption

field Low Speed Evaporative Condenser Pump Rated Power Consumption

Rated power consumed by the evaporative condenser’s water pump at low speed

Units: W

Parameters:value (float or “Autosize”) – value for IDD Field Low Speed Evaporative Condenser Pump Rated Power Consumption Raises:ValueError – if value is not a valid value Returns:the value of low_speed_evaporative_condenser_pump_rated_power_consumption or None if not set Return type:float or “Autosize”

low_speed_gross_rated_cooling_cop

field Low Speed Gross Rated Cooling COP

Gross cooling capacity divided by power input to the compressor and outdoor fan,

does not include supply fan heat or supply fan electrical energy input

Units: W/W

Default value: 3.0

Parameters:value (float) – value for IDD Field Low Speed Gross Rated Cooling COP Raises:ValueError – if value is not a valid value Returns:the value of low_speed_gross_rated_cooling_cop or None if not set Return type:float

low_speed_gross_rated_sensible_heat_ratio

field Low Speed Gross Rated Sensible Heat Ratio

Gross Rated Sensible Heat Ratio (gross sensible capacity/gross total capacity)

sensible and total capacities do not include supply fan heat

value >= 0.5

value <= 1.0

Parameters:value (float or “Autosize”) – value for IDD Field Low Speed Gross Rated Sensible Heat Ratio Raises:ValueError – if value is not a valid value Returns:the value of low_speed_gross_rated_sensible_heat_ratio or None if not set Return type:float or “Autosize”

low_speed_gross_rated_total_cooling_capacity

field Low Speed Gross Rated Total Cooling Capacity

Total cooling capacity not accounting for the effect of supply air fan heat

gross capacity excluding supply air fan heat

rating point: air entering the cooling coil at 26.7 C dry-bulb/19.4 C wet-bulb, and

air entering the outdoor condenser coil at 35 C dry-bulb/23.9 C wet-bulb

Units: W

Parameters:value (float or “Autosize”) – value for IDD Field Low Speed Gross Rated Total Cooling Capacity Raises:ValueError – if value is not a valid value Returns:the value of low_speed_gross_rated_total_cooling_capacity or None if not set Return type:float or “Autosize”

low_speed_rated_air_flow_rate

field Low Speed Rated Air Flow Rate

Flow rate corresponding to rated total cooling capacity, Rated SHR

and Rated COP. Should be between 0.00004027 m3/s and .00006041 m3/s per watt

of rated total cooling capacity.

Units: m3/s

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

low_speed_sensible_heat_ratio_function_of_flow_fraction_curve_name

field Low Speed Sensible Heat Ratio Function of Flow Fraction Curve Name

quadratic curve = a + b*ff + c*ff**2

cubic curve = a + b*ff + c*ff**2 + d*ff**3

ff = fraction of the full load flow

Parameters:value (str) – value for IDD Field Low Speed Sensible Heat Ratio Function of Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of low_speed_sensible_heat_ratio_function_of_flow_fraction_curve_name or None if not set Return type:str

low_speed_sensible_heat_ratio_function_of_temperature_curve_name

field Low Speed Sensible Heat Ratio Function of Temperature Curve Name

curve = a + b*wb + c*wb**2 + d*db + e*db**2 + f*wb*db

wb = entering wet-bulb temperature seen by the DX cooling coil (C)

db = entering dry-bulb temperature seen by the DX cooling coil (C)

entering temperature can be outside air or pretreated air.

Parameters:value (str) – value for IDD Field Low Speed Sensible Heat Ratio Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of low_speed_sensible_heat_ratio_function_of_temperature_curve_name or None if not set Return type:str

low_speed_total_cooling_capacity_function_of_temperature_curve_name

field Low Speed Total Cooling Capacity Function of Temperature Curve Name

curve = a + b*wb + c*wb**2 + d*edb + e*edb**2 + f*wb*edb

wb = entering wet-bulb temperature (C)

edb = dry-bulb temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Low Speed Total Cooling Capacity Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of low_speed_total_cooling_capacity_function_of_temperature_curve_name or None if not set Return type:str

name

field Name

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

part_load_fraction_correlation_curve_name

field Part Load Fraction Correlation Curve Name

quadratic curve = a + b*PLR + c*PLR**2

cubic curve = a + b*PLR + c*PLR**2 + d*PLR**3

PLR = part load ratio (cooling load/steady state capacity)

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

sensible_heat_ratio_function_of_flow_fraction_curve_name

field Sensible Heat Ratio Function of Flow Fraction Curve Name

quadratic curve = a + b*ff + c*ff**2

cubic curve = a + b*ff + c*ff**2 + d*ff**3

ff = fraction of the full load flow

Parameters:value (str) – value for IDD Field Sensible Heat Ratio Function of Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of sensible_heat_ratio_function_of_flow_fraction_curve_name or None if not set Return type:str

sensible_heat_ratio_function_of_temperature_curve_name

field Sensible Heat Ratio Function of Temperature Curve Name

curve = a + b*wb + c*wb**2 + d*db + e*db**2 + f*wb*db

wb = entering wet-bulb temperature seen by the DX cooling coil (C)

db = entering dry-bulb temperature seen by the DX cooling coil (C)

entering temperature can be outside air or pretreated air.

Parameters:value (str) – value for IDD Field Sensible Heat Ratio Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of sensible_heat_ratio_function_of_temperature_curve_name or None if not set Return type:str

supply_water_storage_tank_name

field Supply Water Storage Tank Name

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

total_cooling_capacity_function_of_flow_fraction_curve_name

field Total Cooling Capacity Function of Flow Fraction Curve Name

quadratic curve = a + b*ff + c*ff**2

cubic curve = a + b*ff + c*ff**2 + d*ff**3

ff = fraction of the full load flow

Parameters:value (str) – value for IDD Field Total Cooling Capacity Function of Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of total_cooling_capacity_function_of_flow_fraction_curve_name or None if not set Return type:str

total_cooling_capacity_function_of_temperature_curve_name

field Total Cooling Capacity Function of Temperature Curve Name

curve = a + b*wb + c*wb**2 + d*edb + e*edb**2 + f*wb*edb

wb = entering wet-bulb temperature (C)

edb = dry-bulb temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Total Cooling Capacity Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of total_cooling_capacity_function_of_temperature_curve_name or None if not set Return type:str

unit_internal_static_air_pressure

field Unit Internal Static Air Pressure

Enter pressure drop for the unit containing the coil.

This value is only used to calculate Energy Efficiency Ratio

(EER), Integrated Energy Efficiency Ratio (IEER), and the

Standard Rating (Net) Cooling Capacity. This value is not

used for modeling the evaporator fan during simulations.

Units: Pa

Parameters:value (float) – value for IDD Field Unit Internal Static Air Pressure Raises:ValueError – if value is not a valid value Returns:the value of unit_internal_static_air_pressure or None if not set Return type:float

zone_name_for_condenser_placement

field Zone Name for Condenser Placement

This input field is name of a conditioned or unconditioned zone where the secondary

coil (condenser) of DX system or a heat pump is to be placed. This is an optional

input field specified only when user desires to reject the condenser heat into a

zone. The heat rejected is modelled as internal sensible heat gain of the zone.

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

class pyidf.coils.CoilCoolingDxTwoStageWithHumidityControlMode

Bases: pyidf.helper.DataObject

Corresponds to IDD object Coil:Cooling:DX:TwoStageWithHumidityControlMode Direct expansion (DX) cooling coil and condensing unit (includes electric compressor and condenser fan), two-stage with humidity control mode (e.g. sub-cool or hot gas reheat). Optional inputs for moisture evaporation from wet coil when compressor cycles off with continuous fan operation. Requires two to four sets of performance data, see CoilPerformance:DX:Cooling. Stages are modeled as a face-split coil.

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

basin_heater_capacity

field Basin Heater Capacity

This field is only used for Condenser Type = EvaporativelyCooled and for periods

when the basin heater is available (field Basin Heater Operating Schedule Name).

For this situation, the heater maintains the basin water temperature at the basin heater

setpoint temperature when the outdoor air temperature falls below the setpoint temperature.

The basin heater only operates when the DX coil is off.

Units: W/K

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

basin_heater_operating_schedule_name

field Basin Heater Operating Schedule Name

This field is only used for Condenser Type = EvaporativelyCooled.

Schedule values greater than 0 allow the basin heater to operate whenever the outdoor

air dry-bulb temperature is below the basin heater setpoint temperature.

If a schedule name is not entered, the basin heater is allowed to operate

throughout the entire simulation.

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

basin_heater_setpoint_temperature

field Basin Heater Setpoint Temperature

This field is only used for Condenser Type = EvaporativelyCooled.

Enter the outdoor dry-bulb temperature when the basin heater turns on.

Units: C

Default value: 2.0

value >= 2.0

Parameters:value (float) – value for IDD Field Basin Heater Setpoint Temperature Raises:ValueError – if value is not a valid value Returns:the value of basin_heater_setpoint_temperature or None if not set Return type:float

condensate_collection_water_storage_tank_name

field Condensate Collection Water Storage Tank Name

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

crankcase_heater_capacity

field Crankcase Heater Capacity

Units: W

IP-Units: W

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

dehumidification_mode_1_stage_12_coil_performance_name

field Dehumidification Mode 1 Stage 1+2 Coil Performance Name

Parameters:value (str) – value for IDD Field Dehumidification Mode 1 Stage 1+2 Coil Performance Name Raises:ValueError – if value is not a valid value Returns:the value of dehumidification_mode_1_stage_12_coil_performance_name or None if not set Return type:str

dehumidification_mode_1_stage_12_coil_performance_object_type

field Dehumidification Mode 1 Stage 1+2 Coil Performance Object Type

Parameters:value (str) – value for IDD Field Dehumidification Mode 1 Stage 1+2 Coil Performance Object Type Raises:ValueError – if value is not a valid value Returns:the value of dehumidification_mode_1_stage_12_coil_performance_object_type or None if not set Return type:str

dehumidification_mode_1_stage_1_coil_performance_name

field Dehumidification Mode 1 Stage 1 Coil Performance Name

Parameters:value (str) – value for IDD Field Dehumidification Mode 1 Stage 1 Coil Performance Name Raises:ValueError – if value is not a valid value Returns:the value of dehumidification_mode_1_stage_1_coil_performance_name or None if not set Return type:str

dehumidification_mode_1_stage_1_coil_performance_object_type

field Dehumidification Mode 1 Stage 1 Coil Performance Object Type

Parameters:value (str) – value for IDD Field Dehumidification Mode 1 Stage 1 Coil Performance Object Type Raises:ValueError – if value is not a valid value Returns:the value of dehumidification_mode_1_stage_1_coil_performance_object_type or None if not set Return type:str

maximum_outdoor_drybulb_temperature_for_crankcase_heater_operation

field Maximum Outdoor Dry-Bulb Temperature for Crankcase Heater Operation

Units: C

Default value: 10.0

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

normal_mode_stage_12_coil_performance_name

field Normal Mode Stage 1+2 Coil Performance Name

Parameters:value (str) – value for IDD Field Normal Mode Stage 1+2 Coil Performance Name Raises:ValueError – if value is not a valid value Returns:the value of normal_mode_stage_12_coil_performance_name or None if not set Return type:str

normal_mode_stage_12_coil_performance_object_type

field Normal Mode Stage 1+2 Coil Performance Object Type

Parameters:value (str) – value for IDD Field Normal Mode Stage 1+2 Coil Performance Object Type Raises:ValueError – if value is not a valid value Returns:the value of normal_mode_stage_12_coil_performance_object_type or None if not set Return type:str

normal_mode_stage_1_coil_performance_name

field Normal Mode Stage 1 Coil Performance Name

Parameters:value (str) – value for IDD Field Normal Mode Stage 1 Coil Performance Name Raises:ValueError – if value is not a valid value Returns:the value of normal_mode_stage_1_coil_performance_name or None if not set Return type:str

normal_mode_stage_1_coil_performance_object_type

field Normal Mode Stage 1 Coil Performance Object Type

Parameters:value (str) – value for IDD Field Normal Mode Stage 1 Coil Performance Object Type Raises:ValueError – if value is not a valid value Returns:the value of normal_mode_stage_1_coil_performance_object_type or None if not set Return type:str

number_of_capacity_stages

field Number of Capacity Stages

Default value: 1

value >= 1

value <= 2

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

number_of_enhanced_dehumidification_modes

field Number of Enhanced Dehumidification Modes

value <= 1

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

supply_water_storage_tank_name

field Supply Water Storage Tank Name

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

class pyidf.coils.CoilCoolingDxVariableRefrigerantFlow

Bases: pyidf.helper.DataObject

Corresponds to IDD object Coil:Cooling:DX:VariableRefrigerantFlow Variable refrigerant flow (VRF) direct expansion (DX) cooling coil. Used with ZoneHVAC:TerminalUnit:VariableRefrigerantFlow. Condensing unit is modeled separately, see AirConditioner:VariableRefrigerantFlow.

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

coil_air_inlet_node

field Coil Air Inlet Node

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

coil_air_outlet_node

field Coil Air Outlet Node

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

cooling_capacity_modifier_curve_function_of_flow_fraction_name

field Cooling Capacity Modifier Curve Function of Flow Fraction Name

quadratic curve = a + b*ff + c*ff**2

cubic curve = a + b*ff + c*ff**2 + d*ff**3

ff = fraction of the full load flow

Parameters:value (str) – value for IDD Field Cooling Capacity Modifier Curve Function of Flow Fraction Name Raises:ValueError – if value is not a valid value Returns:the value of cooling_capacity_modifier_curve_function_of_flow_fraction_name or None if not set Return type:str

cooling_capacity_ratio_modifier_function_of_temperature_curve_name

field Cooling Capacity Ratio Modifier Function of Temperature Curve Name

Parameters:value (str) – value for IDD Field Cooling Capacity Ratio Modifier Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of cooling_capacity_ratio_modifier_function_of_temperature_curve_name or None if not set Return type:str

gross_rated_sensible_heat_ratio

field Gross Rated Sensible Heat Ratio

Sensible heat ratio excluding supply air fan heat

Parameters:value (float or “Autosize”) – value for IDD Field Gross Rated Sensible Heat Ratio Raises:ValueError – if value is not a valid value Returns:the value of gross_rated_sensible_heat_ratio or None if not set Return type:float or “Autosize”

gross_rated_total_cooling_capacity

field Gross Rated Total Cooling Capacity

Total cooling capacity not accounting for the effect of supply air fan heat

Cooling capacity excluding supply air fan heat

Units: W

Parameters:value (float or “Autosize”) – value for IDD Field Gross Rated Total Cooling Capacity Raises:ValueError – if value is not a valid value Returns:the value of gross_rated_total_cooling_capacity 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

name_of_water_storage_tank_for_condensate_collection

field Name of Water Storage Tank for Condensate Collection

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

rated_air_flow_rate

field Rated Air Flow Rate

Volume flow rate corresponding to rated total cooling capacity

should be between 0.00004027 m3/s and .00006041 m3/s per watt of rated total cooling capacity

Units: m3/s

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

class pyidf.coils.CoilCoolingDxVariableRefrigerantFlowFluidTemperatureControl

Bases: pyidf.helper.DataObject

Corresponds to IDD object Coil:Cooling:DX:VariableRefrigerantFlow:FluidTemperatureControl This is a key object in the new physics based VRF model applicable for Fluid Temperature Control. It describes the the indoor unit coil of the system at cooling mode. Used with ZoneHVAC:TerminalUnit:VariableRefrigerantFlow. Outdoor unit is modeled separately, see AirConditioner:VariableRefrigerantFlow:FluidTemperatureControl.

availability_schedule_name

field Availability Schedule Name

Enter the name of a schedule that defines the availability of the coil

Schedule values of 0 denote the unit is off. All other values denote the unit is available

If this field is left blank, the unit is available the entire simulation

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

coil_air_inlet_node

field Coil Air Inlet Node

the inlet node to the coil

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

coil_air_outlet_node

field Coil Air Outlet Node

the outlet node to the coil

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

indoor_unit_evaporating_temperature_function_of_superheating_curve_name

field Indoor Unit Evaporating Temperature Function of Superheating Curve Name

Parameters:value (str) – value for IDD Field Indoor Unit Evaporating Temperature Function of Superheating Curve Name Raises:ValueError – if value is not a valid value Returns:the value of indoor_unit_evaporating_temperature_function_of_superheating_curve_name or None if not set Return type:str

indoor_unit_reference_superheating

field Indoor Unit Reference Superheating

Units: deltaC

Default value: 5.0

Parameters:value (float) – value for IDD Field Indoor Unit Reference Superheating Raises:ValueError – if value is not a valid value Returns:the value of indoor_unit_reference_superheating 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

name_of_water_storage_tank_for_condensate_collection

field Name of Water Storage Tank for Condensate Collection

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

rated_sensible_heat_ratio

field Rated Sensible Heat Ratio

Supply air fan heat is not included

Parameters:value (float or “Autosize”) – value for IDD Field Rated Sensible Heat Ratio Raises:ValueError – if value is not a valid value Returns:the value of rated_sensible_heat_ratio or None if not set Return type:float or “Autosize”

rated_total_cooling_capacity

field Rated Total Cooling Capacity

Supply air fan heat is not included

Units: W

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

class pyidf.coils.CoilCoolingDxVariableSpeed

Bases: pyidf.helper.DataObject

Corresponds to IDD object Coil:Cooling:DX:VariableSpeed Direct expansion (DX) cooling coil and condensing unit (includes electric compressor and condenser fan), variable-speed. Optional inputs for moisture evaporation from wet coil when compressor cycles off with continuous fan operation. Requires two to ten sets of performance data and will interpolate between speeds. Modeled as a single coil with variable-speed compressor.

basin_heater_capacity

field Basin Heater Capacity

This field is only used for Condenser Type = EvaporativelyCooled and for periods

when the basin heater is available (field Basin Heater Operating Schedule Name).

For this situation, the heater maintains the basin water temperature at the basin heater

setpoint temperature when the outdoor air temperature falls below the setpoint temperature.

The basin heater only operates when the DX coil is off.

Units: W/K

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

basin_heater_operating_schedule_name

field Basin Heater Operating Schedule Name

This field is only used for Condenser Type = EvaporativelyCooled.

Schedule values greater than 0 allow the basin heater to operate whenever the outdoor

air dry-bulb temperature is below the basin heater setpoint temperature.

If a schedule name is not entered, the basin heater is allowed to operate

throughout the entire simulation.

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

basin_heater_setpoint_temperature

field Basin Heater Setpoint Temperature

This field is only used for Condenser Type = EvaporativelyCooled.

Enter the outdoor dry-bulb temperature when the basin heater turns on.

Units: C

Default value: 2.0

value >= 2.0

Parameters:value (float) – value for IDD Field Basin Heater Setpoint Temperature Raises:ValueError – if value is not a valid value Returns:the value of basin_heater_setpoint_temperature or None if not set Return type:float

condensate_collection_water_storage_tank_name

field Condensate Collection Water Storage Tank Name

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

condenser_air_inlet_node_name

field Condenser Air Inlet Node Name

Enter the name of an outdoor air node. This node name is also specified in

an OutdoorAir:Node or OutdoorAir:NodeList object.

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

condenser_type

field Condenser Type

Default value: AirCooled

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

crankcase_heater_capacity

field Crankcase Heater Capacity

Units: W

IP-Units: W

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

energy_part_load_fraction_curve_name

field Energy Part Load Fraction Curve Name

quadratic curve = a + b*PLR + c*PLR**2

cubic curve = a + b*PLR + c*PLR**2 + d*PLR**3

PLR = part load ratio (cooling load/steady state capacity)

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

evaporative_condenser_pump_rated_power_consumption

field Evaporative Condenser Pump Rated Power Consumption

Rated power consumed by the evaporative condenser’s water pump

Units: W

Parameters:value (float or “Autosize”) – value for IDD Field Evaporative Condenser Pump Rated Power Consumption Raises:ValueError – if value is not a valid value Returns:the value of evaporative_condenser_pump_rated_power_consumption or None if not set Return type:float or “Autosize”

gross_rated_total_cooling_capacity_at_selected_nominal_speed_level

field Gross Rated Total Cooling Capacity At Selected Nominal Speed Level

Total cooling capacity not accounting for the effect of supply air fan heat

Units: w

Default value: “autosize”

Parameters:value (float or “Autosize”) – value for IDD Field Gross Rated Total Cooling Capacity At Selected Nominal Speed Level Raises:ValueError – if value is not a valid value Returns:the value of gross_rated_total_cooling_capacity_at_selected_nominal_speed_level or None if not set Return type:float or “Autosize”

indoor_air_inlet_node_name

field Indoor Air Inlet Node Name

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

indoor_air_outlet_node_name

field Indoor Air Outlet Node Name

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

initial_moisture_evaporation_rate_divided_by_steadystate_ac_latent_capacity

field Initial Moisture Evaporation Rate Divided by Steady-State AC Latent Capacity

Units: dimensionless

Parameters:value (float) – value for IDD Field Initial Moisture Evaporation Rate Divided by Steady-State AC Latent Capacity Raises:ValueError – if value is not a valid value Returns:the value of initial_moisture_evaporation_rate_divided_by_steadystate_ac_latent_capacity or None if not set Return type:float

maximum_outdoor_drybulb_temperature_for_crankcase_heater_operation

field Maximum Outdoor Dry-Bulb Temperature for Crankcase Heater Operation

Units: C

Default value: 10.0

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

nominal_speed_level

field Nominal Speed Level

must be lower than or equal to the highest speed number

Units: dimensionless

Default value: 2

Parameters:value (int) – value for IDD Field Nominal Speed Level Raises:ValueError – if value is not a valid value Returns:the value of nominal_speed_level or None if not set Return type:int

nominal_time_for_condensate_to_begin_leaving_the_coil

field Nominal Time for Condensate to Begin Leaving the Coil

Units: s

Parameters:value (float) – value for IDD Field Nominal Time for Condensate to Begin Leaving the Coil Raises:ValueError – if value is not a valid value Returns:the value of nominal_time_for_condensate_to_begin_leaving_the_coil or None if not set Return type:float

number_of_speeds

field Number of Speeds

Units: dimensionless

Default value: 2

value >= 1

value <= 10

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

rated_air_flow_rate_at_selected_nominal_speed_level

field Rated Air Flow Rate At Selected Nominal Speed Level

Units: m3/s

Default value: “autosize”

Parameters:value (float or “Autosize”) – value for IDD Field Rated Air Flow Rate At Selected Nominal Speed Level Raises:ValueError – if value is not a valid value Returns:the value of rated_air_flow_rate_at_selected_nominal_speed_level or None if not set Return type:float or “Autosize”

speed_10_energy_input_ratio_function_of_air_flow_fraction_curve_name

field Speed 10 Energy Input Ratio Function of Air Flow Fraction Curve Name

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 10 Energy Input Ratio Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_10_energy_input_ratio_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_10_energy_input_ratio_function_of_temperature_curve_name

field Speed 10 Energy Input Ratio Function of Temperature Curve Name

curve = a + b*wb + c*wb**2 + d*odb + e*odb**2 + f*wb*odb

wb = entering wet-bulb temperature (C)

odb = air entering temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Speed 10 Energy Input Ratio Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_10_energy_input_ratio_function_of_temperature_curve_name or None if not set Return type:str

speed_10_reference_unit_condenser_air_flow_rate

field Speed 10 Reference Unit Condenser Air Flow Rate

optional

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 10 Reference Unit Condenser Air Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_10_reference_unit_condenser_air_flow_rate or None if not set Return type:float

speed_10_reference_unit_gross_rated_cooling_cop

field Speed 10 Reference Unit Gross Rated Cooling COP

Units: dimensionless

Parameters:value (float) – value for IDD Field Speed 10 Reference Unit Gross Rated Cooling COP Raises:ValueError – if value is not a valid value Returns:the value of speed_10_reference_unit_gross_rated_cooling_cop or None if not set Return type:float

speed_10_reference_unit_gross_rated_sensible_heat_ratio

field Speed 10 Reference Unit Gross Rated Sensible Heat Ratio

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Speed 10 Reference Unit Gross Rated Sensible Heat Ratio Raises:ValueError – if value is not a valid value Returns:the value of speed_10_reference_unit_gross_rated_sensible_heat_ratio or None if not set Return type:float

speed_10_reference_unit_gross_rated_total_cooling_capacity

field Speed 10 Reference Unit Gross Rated Total Cooling Capacity

Total cooling capacity not accounting for the effect of supply air fan heat

Units: w

Parameters:value (float) – value for IDD Field Speed 10 Reference Unit Gross Rated Total Cooling Capacity Raises:ValueError – if value is not a valid value Returns:the value of speed_10_reference_unit_gross_rated_total_cooling_capacity or None if not set Return type:float

speed_10_reference_unit_rated_air_flow_rate

field Speed 10 Reference Unit Rated Air Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 10 Reference Unit Rated Air Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_10_reference_unit_rated_air_flow_rate or None if not set Return type:float

speed_10_reference_unit_rated_pad_effectiveness_of_evap_precooling

field Speed 10 Reference Unit Rated Pad Effectiveness of Evap Precooling

optional

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Speed 10 Reference Unit Rated Pad Effectiveness of Evap Precooling Raises:ValueError – if value is not a valid value Returns:the value of speed_10_reference_unit_rated_pad_effectiveness_of_evap_precooling or None if not set Return type:float

speed_10_total_cooling_capacity_function_of_air_flow_fraction_curve_name

field Speed 10 Total Cooling Capacity Function of Air Flow Fraction Curve Name

optional

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 10 Total Cooling Capacity Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_10_total_cooling_capacity_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_10_total_cooling_capacity_function_of_temperature_curve_name

field Speed 10 Total Cooling Capacity Function of Temperature Curve Name

curve = a + b*wb + c*wb**2 + d*odb + e*odb**2 + f*wb*odb

wb = entering wet-bulb temperature (C)

odb = air entering temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Speed 10 Total Cooling Capacity Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_10_total_cooling_capacity_function_of_temperature_curve_name or None if not set Return type:str

speed_1_energy_input_ratio_function_of_air_flow_fraction_curve_name

field Speed 1 Energy Input Ratio Function of Air Flow Fraction Curve Name

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 1 Energy Input Ratio Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_1_energy_input_ratio_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_1_energy_input_ratio_function_of_temperature_curve_name

field Speed 1 Energy Input Ratio Function of Temperature Curve Name

curve = a + b*wb + c*wb**2 + d*odb + e*odb**2 + f*wb*odb

wb = entering wet-bulb temperature (C)

odb = air entering temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Speed 1 Energy Input Ratio Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_1_energy_input_ratio_function_of_temperature_curve_name or None if not set Return type:str

speed_1_reference_unit_gross_rated_cooling_cop

field Speed 1 Reference Unit Gross Rated Cooling COP

Units: dimensionless

Parameters:value (float) – value for IDD Field Speed 1 Reference Unit Gross Rated Cooling COP Raises:ValueError – if value is not a valid value Returns:the value of speed_1_reference_unit_gross_rated_cooling_cop or None if not set Return type:float

speed_1_reference_unit_gross_rated_sensible_heat_ratio

field Speed 1 Reference Unit Gross Rated Sensible Heat Ratio

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Speed 1 Reference Unit Gross Rated Sensible Heat Ratio Raises:ValueError – if value is not a valid value Returns:the value of speed_1_reference_unit_gross_rated_sensible_heat_ratio or None if not set Return type:float

speed_1_reference_unit_gross_rated_total_cooling_capacity

field Speed 1 Reference Unit Gross Rated Total Cooling Capacity

Total cooling capacity not accounting for the effect of supply air fan heat

Units: w

Parameters:value (float) – value for IDD Field Speed 1 Reference Unit Gross Rated Total Cooling Capacity Raises:ValueError – if value is not a valid value Returns:the value of speed_1_reference_unit_gross_rated_total_cooling_capacity or None if not set Return type:float

speed_1_reference_unit_rated_air_flow_rate

field Speed 1 Reference Unit Rated Air Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 1 Reference Unit Rated Air Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_1_reference_unit_rated_air_flow_rate or None if not set Return type:float

speed_1_reference_unit_rated_condenser_air_flow_rate

field Speed 1 Reference Unit Rated Condenser Air Flow Rate

This field is only used for Condenser Type = EvaporativelyCooled

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 1 Reference Unit Rated Condenser Air Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_1_reference_unit_rated_condenser_air_flow_rate or None if not set Return type:float

speed_1_reference_unit_rated_pad_effectiveness_of_evap_precooling

field Speed 1 Reference Unit Rated Pad Effectiveness of Evap Precooling

This field is only used for Condenser Type = EvaporativelyCooled

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Speed 1 Reference Unit Rated Pad Effectiveness of Evap Precooling Raises:ValueError – if value is not a valid value Returns:the value of speed_1_reference_unit_rated_pad_effectiveness_of_evap_precooling or None if not set Return type:float

speed_1_total_cooling_capacity_function_of_air_flow_fraction_curve_name

field Speed 1 Total Cooling Capacity Function of Air Flow Fraction Curve Name

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 1 Total Cooling Capacity Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_1_total_cooling_capacity_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_1_total_cooling_capacity_function_of_temperature_curve_name

field Speed 1 Total Cooling Capacity Function of Temperature Curve Name

curve = a + b*wb + c*wb**2 + d*odb + e*odb**2 + f*wb*odb

wb = entering wet-bulb temperature (C)

odb = air entering temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Speed 1 Total Cooling Capacity Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_1_total_cooling_capacity_function_of_temperature_curve_name or None if not set Return type:str

speed_2_energy_input_ratio_function_of_air_flow_fraction_curve_name

field Speed 2 Energy Input Ratio Function of Air Flow Fraction Curve Name

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 2 Energy Input Ratio Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_2_energy_input_ratio_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_2_energy_input_ratio_function_of_temperature_curve_name

field Speed 2 Energy Input Ratio Function of Temperature Curve Name

curve = a + b*wb + c*wb**2 + d*odb + e*odb**2 + f*wb*odb

wb = entering wet-bulb temperature (C)

odb = air entering temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Speed 2 Energy Input Ratio Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_2_energy_input_ratio_function_of_temperature_curve_name or None if not set Return type:str

speed_2_reference_unit_gross_rated_cooling_cop

field Speed 2 Reference Unit Gross Rated Cooling COP

Units: dimensionless

Parameters:value (float) – value for IDD Field Speed 2 Reference Unit Gross Rated Cooling COP Raises:ValueError – if value is not a valid value Returns:the value of speed_2_reference_unit_gross_rated_cooling_cop or None if not set Return type:float

speed_2_reference_unit_gross_rated_sensible_heat_ratio

field Speed 2 Reference Unit Gross Rated Sensible Heat Ratio

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Speed 2 Reference Unit Gross Rated Sensible Heat Ratio Raises:ValueError – if value is not a valid value Returns:the value of speed_2_reference_unit_gross_rated_sensible_heat_ratio or None if not set Return type:float

speed_2_reference_unit_gross_rated_total_cooling_capacity

field Speed 2 Reference Unit Gross Rated Total Cooling Capacity

Total cooling capacity not accounting for the effect of supply air fan heat

Units: w

Parameters:value (float) – value for IDD Field Speed 2 Reference Unit Gross Rated Total Cooling Capacity Raises:ValueError – if value is not a valid value Returns:the value of speed_2_reference_unit_gross_rated_total_cooling_capacity or None if not set Return type:float

speed_2_reference_unit_rated_air_flow_rate

field Speed 2 Reference Unit Rated Air Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 2 Reference Unit Rated Air Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_2_reference_unit_rated_air_flow_rate or None if not set Return type:float

speed_2_reference_unit_rated_condenser_air_flow_rate

field Speed 2 Reference Unit Rated Condenser Air Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 2 Reference Unit Rated Condenser Air Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_2_reference_unit_rated_condenser_air_flow_rate or None if not set Return type:float

speed_2_reference_unit_rated_pad_effectiveness_of_evap_precooling

field Speed 2 Reference Unit Rated Pad Effectiveness of Evap Precooling

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Speed 2 Reference Unit Rated Pad Effectiveness of Evap Precooling Raises:ValueError – if value is not a valid value Returns:the value of speed_2_reference_unit_rated_pad_effectiveness_of_evap_precooling or None if not set Return type:float

speed_2_total_cooling_capacity_function_of_air_flow_fraction_curve_name

field Speed 2 Total Cooling Capacity Function of Air Flow Fraction Curve Name

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 2 Total Cooling Capacity Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_2_total_cooling_capacity_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_2_total_cooling_capacity_function_of_temperature_curve_name

field Speed 2 Total Cooling Capacity Function of Temperature Curve Name

curve = a + b*wb + c*wb**2 + d*odb + e*odb**2 + f*wb*odb

wb = entering wet-bulb temperature (C)

odb = air entering temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Speed 2 Total Cooling Capacity Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_2_total_cooling_capacity_function_of_temperature_curve_name or None if not set Return type:str

speed_3_energy_input_ratio_function_of_air_flow_fraction_curve_name

field Speed 3 Energy Input Ratio Function of Air Flow Fraction Curve Name

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 3 Energy Input Ratio Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_3_energy_input_ratio_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_3_energy_input_ratio_function_of_temperature_curve_name

field Speed 3 Energy Input Ratio Function of Temperature Curve Name

curve = a + b*wb + c*wb**2 + d*odb + e*odb**2 + f*wb*odb

wb = entering wet-bulb temperature (C)

odb = air entering temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Speed 3 Energy Input Ratio Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_3_energy_input_ratio_function_of_temperature_curve_name or None if not set Return type:str

speed_3_reference_unit_gross_rated_cooling_cop

field Speed 3 Reference Unit Gross Rated Cooling COP

Units: dimensionless

Parameters:value (float) – value for IDD Field Speed 3 Reference Unit Gross Rated Cooling COP Raises:ValueError – if value is not a valid value Returns:the value of speed_3_reference_unit_gross_rated_cooling_cop or None if not set Return type:float

speed_3_reference_unit_gross_rated_sensible_heat_ratio

field Speed 3 Reference Unit Gross Rated Sensible Heat Ratio

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Speed 3 Reference Unit Gross Rated Sensible Heat Ratio Raises:ValueError – if value is not a valid value Returns:the value of speed_3_reference_unit_gross_rated_sensible_heat_ratio or None if not set Return type:float

speed_3_reference_unit_gross_rated_total_cooling_capacity

field Speed 3 Reference Unit Gross Rated Total Cooling Capacity

Total cooling capacity not accounting for the effect of supply air fan heat

Units: w

Parameters:value (float) – value for IDD Field Speed 3 Reference Unit Gross Rated Total Cooling Capacity Raises:ValueError – if value is not a valid value Returns:the value of speed_3_reference_unit_gross_rated_total_cooling_capacity or None if not set Return type:float

speed_3_reference_unit_rated_air_flow_rate

field Speed 3 Reference Unit Rated Air Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 3 Reference Unit Rated Air Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_3_reference_unit_rated_air_flow_rate or None if not set Return type:float

speed_3_reference_unit_rated_condenser_air_flow_rate

field Speed 3 Reference Unit Rated Condenser Air Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 3 Reference Unit Rated Condenser Air Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_3_reference_unit_rated_condenser_air_flow_rate or None if not set Return type:float

speed_3_reference_unit_rated_pad_effectiveness_of_evap_precooling

field Speed 3 Reference Unit Rated Pad Effectiveness of Evap Precooling

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Speed 3 Reference Unit Rated Pad Effectiveness of Evap Precooling Raises:ValueError – if value is not a valid value Returns:the value of speed_3_reference_unit_rated_pad_effectiveness_of_evap_precooling or None if not set Return type:float

speed_3_total_cooling_capacity_function_of_air_flow_fraction_curve_name

field Speed 3 Total Cooling Capacity Function of Air Flow Fraction Curve Name

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 3 Total Cooling Capacity Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_3_total_cooling_capacity_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_3_total_cooling_capacity_function_of_temperature_curve_name

field Speed 3 Total Cooling Capacity Function of Temperature Curve Name

curve = a + b*wb + c*wb**2 + d*odb + e*odb**2 + f*wb*odb

wb = entering wet-bulb temperature (C)

odb = air entering temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Speed 3 Total Cooling Capacity Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_3_total_cooling_capacity_function_of_temperature_curve_name or None if not set Return type:str

speed_4_energy_input_ratio_function_of_air_flow_fraction_curve_name

field Speed 4 Energy Input Ratio Function of Air Flow Fraction Curve Name

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 4 Energy Input Ratio Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_4_energy_input_ratio_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_4_energy_input_ratio_function_of_temperature_curve_name

field Speed 4 Energy Input Ratio Function of Temperature Curve Name

curve = a + b*wb + c*wb**2 + d*odb + e*odb**2 + f*wb*odb

wb = entering wet-bulb temperature (C)

odb = air entering temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Speed 4 Energy Input Ratio Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_4_energy_input_ratio_function_of_temperature_curve_name or None if not set Return type:str

speed_4_reference_unit_gross_rated_cooling_cop

field Speed 4 Reference Unit Gross Rated Cooling COP

Units: dimensionless

Parameters:value (float) – value for IDD Field Speed 4 Reference Unit Gross Rated Cooling COP Raises:ValueError – if value is not a valid value Returns:the value of speed_4_reference_unit_gross_rated_cooling_cop or None if not set Return type:float

speed_4_reference_unit_gross_rated_sensible_heat_ratio

field Speed 4 Reference Unit Gross Rated Sensible Heat Ratio

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Speed 4 Reference Unit Gross Rated Sensible Heat Ratio Raises:ValueError – if value is not a valid value Returns:the value of speed_4_reference_unit_gross_rated_sensible_heat_ratio or None if not set Return type:float

speed_4_reference_unit_gross_rated_total_cooling_capacity

field Speed 4 Reference Unit Gross Rated Total Cooling Capacity

Total cooling capacity not accounting for the effect of supply air fan heat

Units: w

Parameters:value (float) – value for IDD Field Speed 4 Reference Unit Gross Rated Total Cooling Capacity Raises:ValueError – if value is not a valid value Returns:the value of speed_4_reference_unit_gross_rated_total_cooling_capacity or None if not set Return type:float

speed_4_reference_unit_rated_air_flow_rate

field Speed 4 Reference Unit Rated Air Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 4 Reference Unit Rated Air Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_4_reference_unit_rated_air_flow_rate or None if not set Return type:float

speed_4_reference_unit_rated_condenser_air_flow_rate

field Speed 4 Reference Unit Rated Condenser Air Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 4 Reference Unit Rated Condenser Air Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_4_reference_unit_rated_condenser_air_flow_rate or None if not set Return type:float

speed_4_reference_unit_rated_pad_effectiveness_of_evap_precooling

field Speed 4 Reference Unit Rated Pad Effectiveness of Evap Precooling

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Speed 4 Reference Unit Rated Pad Effectiveness of Evap Precooling Raises:ValueError – if value is not a valid value Returns:the value of speed_4_reference_unit_rated_pad_effectiveness_of_evap_precooling or None if not set Return type:float

speed_4_total_cooling_capacity_function_of_air_flow_fraction_curve_name

field Speed 4 Total Cooling Capacity Function of Air Flow Fraction Curve Name

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 4 Total Cooling Capacity Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_4_total_cooling_capacity_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_4_total_cooling_capacity_function_of_temperature_curve_name

field Speed 4 Total Cooling Capacity Function of Temperature Curve Name

curve = a + b*wb + c*wb**2 + d*odb + e*odb**2 + f*wb*odb

wb = entering wet-bulb temperature (C)

odb = air entering temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Speed 4 Total Cooling Capacity Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_4_total_cooling_capacity_function_of_temperature_curve_name or None if not set Return type:str

speed_5_energy_input_ratio_function_of_air_flow_fraction_curve_name

field Speed 5 Energy Input Ratio Function of Air Flow Fraction Curve Name

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 5 Energy Input Ratio Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_5_energy_input_ratio_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_5_energy_input_ratio_function_of_temperature_curve_name

field Speed 5 Energy Input Ratio Function of Temperature Curve Name

curve = a + b*wb + c*wb**2 + d*odb + e*odb**2 + f*wb*odb

wb = entering wet-bulb temperature (C)

odb = air entering temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Speed 5 Energy Input Ratio Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_5_energy_input_ratio_function_of_temperature_curve_name or None if not set Return type:str

speed_5_reference_unit_gross_rated_cooling_cop

field Speed 5 Reference Unit Gross Rated Cooling COP

Units: dimensionless

Parameters:value (float) – value for IDD Field Speed 5 Reference Unit Gross Rated Cooling COP Raises:ValueError – if value is not a valid value Returns:the value of speed_5_reference_unit_gross_rated_cooling_cop or None if not set Return type:float

speed_5_reference_unit_gross_rated_sensible_heat_ratio

field Speed 5 Reference Unit Gross Rated Sensible Heat Ratio

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Speed 5 Reference Unit Gross Rated Sensible Heat Ratio Raises:ValueError – if value is not a valid value Returns:the value of speed_5_reference_unit_gross_rated_sensible_heat_ratio or None if not set Return type:float

speed_5_reference_unit_gross_rated_total_cooling_capacity

field Speed 5 Reference Unit Gross Rated Total Cooling Capacity

Total cooling capacity not accounting for the effect of supply air fan heat

Units: w

Parameters:value (float) – value for IDD Field Speed 5 Reference Unit Gross Rated Total Cooling Capacity Raises:ValueError – if value is not a valid value Returns:the value of speed_5_reference_unit_gross_rated_total_cooling_capacity or None if not set Return type:float

speed_5_reference_unit_rated_air_flow_rate

field Speed 5 Reference Unit Rated Air Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 5 Reference Unit Rated Air Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_5_reference_unit_rated_air_flow_rate or None if not set Return type:float

speed_5_reference_unit_rated_condenser_air_flow_rate

field Speed 5 Reference Unit Rated Condenser Air Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 5 Reference Unit Rated Condenser Air Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_5_reference_unit_rated_condenser_air_flow_rate or None if not set Return type:float

speed_5_reference_unit_rated_pad_effectiveness_of_evap_precooling

field Speed 5 Reference Unit Rated Pad Effectiveness of Evap Precooling

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Speed 5 Reference Unit Rated Pad Effectiveness of Evap Precooling Raises:ValueError – if value is not a valid value Returns:the value of speed_5_reference_unit_rated_pad_effectiveness_of_evap_precooling or None if not set Return type:float

speed_5_total_cooling_capacity_function_of_air_flow_fraction_curve_name

field Speed 5 Total Cooling Capacity Function of Air Flow Fraction Curve Name

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 5 Total Cooling Capacity Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_5_total_cooling_capacity_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_5_total_cooling_capacity_function_of_temperature_curve_name

field Speed 5 Total Cooling Capacity Function of Temperature Curve Name

curve = a + b*wb + c*wb**2 + d*odb + e*odb**2 + f*wb*odb

wb = entering wet-bulb temperature (C)

odb = air entering temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Speed 5 Total Cooling Capacity Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_5_total_cooling_capacity_function_of_temperature_curve_name or None if not set Return type:str

speed_6_energy_input_ratio_function_of_air_flow_fraction_curve_name

field Speed 6 Energy Input Ratio Function of Air Flow Fraction Curve Name

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 6 Energy Input Ratio Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_6_energy_input_ratio_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_6_energy_input_ratio_function_of_temperature_curve_name

field Speed 6 Energy Input Ratio Function of Temperature Curve Name

curve = a + b*wb + c*wb**2 + d*odb + e*odb**2 + f*wb*odb

wb = entering wet-bulb temperature (C)

odb = air entering temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Speed 6 Energy Input Ratio Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_6_energy_input_ratio_function_of_temperature_curve_name or None if not set Return type:str

speed_6_reference_unit_condenser_air_flow_rate

field Speed 6 Reference Unit Condenser Air Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 6 Reference Unit Condenser Air Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_6_reference_unit_condenser_air_flow_rate or None if not set Return type:float

speed_6_reference_unit_gross_rated_cooling_cop

field Speed 6 Reference Unit Gross Rated Cooling COP

Units: dimensionless

Parameters:value (float) – value for IDD Field Speed 6 Reference Unit Gross Rated Cooling COP Raises:ValueError – if value is not a valid value Returns:the value of speed_6_reference_unit_gross_rated_cooling_cop or None if not set Return type:float

speed_6_reference_unit_gross_rated_sensible_heat_ratio

field Speed 6 Reference Unit Gross Rated Sensible Heat Ratio

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Speed 6 Reference Unit Gross Rated Sensible Heat Ratio Raises:ValueError – if value is not a valid value Returns:the value of speed_6_reference_unit_gross_rated_sensible_heat_ratio or None if not set Return type:float

speed_6_reference_unit_gross_rated_total_cooling_capacity

field Speed 6 Reference Unit Gross Rated Total Cooling Capacity

Total cooling capacity not accounting for the effect of supply air fan heat

Units: w

Parameters:value (float) – value for IDD Field Speed 6 Reference Unit Gross Rated Total Cooling Capacity Raises:ValueError – if value is not a valid value Returns:the value of speed_6_reference_unit_gross_rated_total_cooling_capacity or None if not set Return type:float

speed_6_reference_unit_rated_air_flow_rate

field Speed 6 Reference Unit Rated Air Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 6 Reference Unit Rated Air Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_6_reference_unit_rated_air_flow_rate or None if not set Return type:float

speed_6_reference_unit_rated_pad_effectiveness_of_evap_precooling

field Speed 6 Reference Unit Rated Pad Effectiveness of Evap Precooling

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Speed 6 Reference Unit Rated Pad Effectiveness of Evap Precooling Raises:ValueError – if value is not a valid value Returns:the value of speed_6_reference_unit_rated_pad_effectiveness_of_evap_precooling or None if not set Return type:float

speed_6_total_cooling_capacity_function_of_air_flow_fraction_curve_name

field Speed 6 Total Cooling Capacity Function of Air Flow Fraction Curve Name

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 6 Total Cooling Capacity Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_6_total_cooling_capacity_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_6_total_cooling_capacity_function_of_temperature_curve_name

field Speed 6 Total Cooling Capacity Function of Temperature Curve Name

curve = a + b*wb + c*wb**2 + d*odb + e*odb**2 + f*wb*odb

wb = entering wet-bulb temperature (C)

odb = air entering temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Speed 6 Total Cooling Capacity Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_6_total_cooling_capacity_function_of_temperature_curve_name or None if not set Return type:str

speed_7_energy_input_ratio_function_of_air_flow_fraction_curve_name

field Speed 7 Energy Input Ratio Function of Air Flow Fraction Curve Name

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 7 Energy Input Ratio Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_7_energy_input_ratio_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_7_energy_input_ratio_function_of_temperature_curve_name

field Speed 7 Energy Input Ratio Function of Temperature Curve Name

curve = a + b*wb + c*wb**2 + d*odb + e*odb**2 + f*wb*odb

wb = entering wet-bulb temperature (C)

odb = air entering temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Speed 7 Energy Input Ratio Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_7_energy_input_ratio_function_of_temperature_curve_name or None if not set Return type:str

speed_7_reference_unit_condenser_flow_rate

field Speed 7 Reference Unit Condenser Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 7 Reference Unit Condenser Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_7_reference_unit_condenser_flow_rate or None if not set Return type:float

speed_7_reference_unit_gross_rated_cooling_cop

field Speed 7 Reference Unit Gross Rated Cooling COP

Units: dimensionless

Parameters:value (float) – value for IDD Field Speed 7 Reference Unit Gross Rated Cooling COP Raises:ValueError – if value is not a valid value Returns:the value of speed_7_reference_unit_gross_rated_cooling_cop or None if not set Return type:float

speed_7_reference_unit_gross_rated_sensible_heat_ratio

field Speed 7 Reference Unit Gross Rated Sensible Heat Ratio

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Speed 7 Reference Unit Gross Rated Sensible Heat Ratio Raises:ValueError – if value is not a valid value Returns:the value of speed_7_reference_unit_gross_rated_sensible_heat_ratio or None if not set Return type:float

speed_7_reference_unit_gross_rated_total_cooling_capacity

field Speed 7 Reference Unit Gross Rated Total Cooling Capacity

Total cooling capacity not accounting for the effect of supply air fan heat

Units: w

Parameters:value (float) – value for IDD Field Speed 7 Reference Unit Gross Rated Total Cooling Capacity Raises:ValueError – if value is not a valid value Returns:the value of speed_7_reference_unit_gross_rated_total_cooling_capacity or None if not set Return type:float

speed_7_reference_unit_rated_air_flow_rate

field Speed 7 Reference Unit Rated Air Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 7 Reference Unit Rated Air Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_7_reference_unit_rated_air_flow_rate or None if not set Return type:float

speed_7_reference_unit_rated_pad_effectiveness_of_evap_precooling

field Speed 7 Reference Unit Rated Pad Effectiveness of Evap Precooling

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Speed 7 Reference Unit Rated Pad Effectiveness of Evap Precooling Raises:ValueError – if value is not a valid value Returns:the value of speed_7_reference_unit_rated_pad_effectiveness_of_evap_precooling or None if not set Return type:float

speed_7_total_cooling_capacity_function_of_air_flow_fraction_curve_name

field Speed 7 Total Cooling Capacity Function of Air Flow Fraction Curve Name

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 7 Total Cooling Capacity Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_7_total_cooling_capacity_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_7_total_cooling_capacity_function_of_temperature_curve_name

field Speed 7 Total Cooling Capacity Function of Temperature Curve Name

curve = a + b*wb + c*wb**2 + d*odb + e*odb**2 + f*wb*odb

wb = entering wet-bulb temperature (C)

odb = air entering temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Speed 7 Total Cooling Capacity Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_7_total_cooling_capacity_function_of_temperature_curve_name or None if not set Return type:str

speed_8_energy_input_ratio_function_of_air_flow_fraction_curve_name

field Speed 8 Energy Input Ratio Function of Air Flow Fraction Curve Name

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 8 Energy Input Ratio Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_8_energy_input_ratio_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_8_energy_input_ratio_function_of_temperature_curve_name

field Speed 8 Energy Input Ratio Function of Temperature Curve Name

curve = a + b*wb + c*wb**2 + d*odb + e*odb**2 + f*wb*odb

wb = entering wet-bulb temperature (C)

odb = air entering temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Speed 8 Energy Input Ratio Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_8_energy_input_ratio_function_of_temperature_curve_name or None if not set Return type:str

speed_8_reference_unit_condenser_air_flow_rate

field Speed 8 Reference Unit Condenser Air Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 8 Reference Unit Condenser Air Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_8_reference_unit_condenser_air_flow_rate or None if not set Return type:float

speed_8_reference_unit_gross_rated_cooling_cop

field Speed 8 Reference Unit Gross Rated Cooling COP

Units: dimensionless

Parameters:value (float) – value for IDD Field Speed 8 Reference Unit Gross Rated Cooling COP Raises:ValueError – if value is not a valid value Returns:the value of speed_8_reference_unit_gross_rated_cooling_cop or None if not set Return type:float

speed_8_reference_unit_gross_rated_sensible_heat_ratio

field Speed 8 Reference Unit Gross Rated Sensible Heat Ratio

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Speed 8 Reference Unit Gross Rated Sensible Heat Ratio Raises:ValueError – if value is not a valid value Returns:the value of speed_8_reference_unit_gross_rated_sensible_heat_ratio or None if not set Return type:float

speed_8_reference_unit_gross_rated_total_cooling_capacity

field Speed 8 Reference Unit Gross Rated Total Cooling Capacity

Total cooling capacity not accounting for the effect of supply air fan heat

Units: w

Parameters:value (float) – value for IDD Field Speed 8 Reference Unit Gross Rated Total Cooling Capacity Raises:ValueError – if value is not a valid value Returns:the value of speed_8_reference_unit_gross_rated_total_cooling_capacity or None if not set Return type:float

speed_8_reference_unit_rated_air_flow_rate

field Speed 8 Reference Unit Rated Air Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 8 Reference Unit Rated Air Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_8_reference_unit_rated_air_flow_rate or None if not set Return type:float

speed_8_reference_unit_rated_pad_effectiveness_of_evap_precooling

field Speed 8 Reference Unit Rated Pad Effectiveness of Evap Precooling

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Speed 8 Reference Unit Rated Pad Effectiveness of Evap Precooling Raises:ValueError – if value is not a valid value Returns:the value of speed_8_reference_unit_rated_pad_effectiveness_of_evap_precooling or None if not set Return type:float

speed_8_total_cooling_capacity_function_of_air_flow_fraction_curve_name

field Speed 8 Total Cooling Capacity Function of Air Flow Fraction Curve Name

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 8 Total Cooling Capacity Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_8_total_cooling_capacity_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_8_total_cooling_capacity_function_of_temperature_curve_name

field Speed 8 Total Cooling Capacity Function of Temperature Curve Name

curve = a + b*wb + c*wb**2 + d*odb + e*odb**2 + f*wb*odb

wb = entering wet-bulb temperature (C)

odb = air entering temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Speed 8 Total Cooling Capacity Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_8_total_cooling_capacity_function_of_temperature_curve_name or None if not set Return type:str

speed_9_energy_input_ratio_function_of_air_flow_fraction_curve_name

field Speed 9 Energy Input Ratio Function of Air Flow Fraction Curve Name

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 9 Energy Input Ratio Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_9_energy_input_ratio_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_9_energy_input_ratio_function_of_temperature_curve_name

field Speed 9 Energy Input Ratio Function of Temperature Curve Name

curve = a + b*wb + c*wb**2 + d*odb + e*odb**2 + f*wb*odb

wb = entering wet-bulb temperature (C)

odb = air entering temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Speed 9 Energy Input Ratio Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_9_energy_input_ratio_function_of_temperature_curve_name or None if not set Return type:str

speed_9_reference_unit_condenser_air_flow_rate

field Speed 9 Reference Unit Condenser Air Flow Rate

optional

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 9 Reference Unit Condenser Air Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_9_reference_unit_condenser_air_flow_rate or None if not set Return type:float

speed_9_reference_unit_gross_rated_cooling_cop

field Speed 9 Reference Unit Gross Rated Cooling COP

Units: dimensionless

Parameters:value (float) – value for IDD Field Speed 9 Reference Unit Gross Rated Cooling COP Raises:ValueError – if value is not a valid value Returns:the value of speed_9_reference_unit_gross_rated_cooling_cop or None if not set Return type:float

speed_9_reference_unit_gross_rated_sensible_heat_ratio

field Speed 9 Reference Unit Gross Rated Sensible Heat Ratio

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Speed 9 Reference Unit Gross Rated Sensible Heat Ratio Raises:ValueError – if value is not a valid value Returns:the value of speed_9_reference_unit_gross_rated_sensible_heat_ratio or None if not set Return type:float

speed_9_reference_unit_gross_rated_total_cooling_capacity

field Speed 9 Reference Unit Gross Rated Total Cooling Capacity

Total cooling capacity not accounting for the effect of supply air fan heat

Units: w

Parameters:value (float) – value for IDD Field Speed 9 Reference Unit Gross Rated Total Cooling Capacity Raises:ValueError – if value is not a valid value Returns:the value of speed_9_reference_unit_gross_rated_total_cooling_capacity or None if not set Return type:float

speed_9_reference_unit_rated_air_flow_rate

field Speed 9 Reference Unit Rated Air Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 9 Reference Unit Rated Air Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_9_reference_unit_rated_air_flow_rate or None if not set Return type:float

speed_9_reference_unit_rated_pad_effectiveness_of_evap_precooling

field Speed 9 Reference Unit Rated Pad Effectiveness of Evap Precooling

optional

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Speed 9 Reference Unit Rated Pad Effectiveness of Evap Precooling Raises:ValueError – if value is not a valid value Returns:the value of speed_9_reference_unit_rated_pad_effectiveness_of_evap_precooling or None if not set Return type:float

speed_9_total_cooling_capacity_function_of_air_flow_fraction_curve_name

field Speed 9 Total Cooling Capacity Function of Air Flow Fraction Curve Name

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 9 Total Cooling Capacity Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_9_total_cooling_capacity_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_9_total_cooling_capacity_function_of_temperature_curve_name

field Speed 9 Total Cooling Capacity Function of Temperature Curve Name

curve = a + b*wb + c*wb**2 + d*odb + e*odb**2 + f*wb*odb

wb = entering wet-bulb temperature (C)

odb = air entering temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Speed 9 Total Cooling Capacity Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_9_total_cooling_capacity_function_of_temperature_curve_name or None if not set Return type:str

supply_water_storage_tank_name

field Supply Water Storage Tank Name

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

class pyidf.coils.CoilCoolingWater

Bases: pyidf.helper.DataObject

Corresponds to IDD object Coil:Cooling:Water Chilled water cooling coil, NTU-effectiveness model, with inputs for design entering and leaving conditions.

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

condensate_collection_water_storage_tank_name

field Condensate Collection Water Storage Tank Name

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

design_air_flow_rate

field Design Air Flow Rate

Units: m3/s

Default value: “autosize”

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

design_inlet_air_humidity_ratio

field Design Inlet Air Humidity Ratio

Units: kgWater/kgDryAir

Default value: “autosize”

Parameters:value (float or “Autosize”) – value for IDD Field Design Inlet Air Humidity Ratio Raises:ValueError – if value is not a valid value Returns:the value of design_inlet_air_humidity_ratio or None if not set Return type:float or “Autosize”

design_inlet_air_temperature

field Design Inlet Air Temperature

Units: C

Default value: “autosize”

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

design_inlet_water_temperature

field Design Inlet Water Temperature

Units: C

Default value: “autosize”

Parameters:value (float or “Autosize”) – value for IDD Field Design Inlet Water Temperature Raises:ValueError – if value is not a valid value Returns:the value of design_inlet_water_temperature or None if not set Return type:float or “Autosize”

design_outlet_air_humidity_ratio

field Design Outlet Air Humidity Ratio

Units: kgWater/kgDryAir

Default value: “autosize”

Parameters:value (float or “Autosize”) – value for IDD Field Design Outlet Air Humidity Ratio Raises:ValueError – if value is not a valid value Returns:the value of design_outlet_air_humidity_ratio or None if not set Return type:float or “Autosize”

design_outlet_air_temperature

field Design Outlet Air Temperature

Units: C

Default value: “autosize”

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

design_water_flow_rate

field Design Water Flow Rate

Units: m3/s

IP-Units: gal/min

Default value: “autosize”

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

heat_exchanger_configuration

field Heat Exchanger Configuration

Default value: CounterFlow

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

name

field Name

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

type_of_analysis

field Type of Analysis

Default value: SimpleAnalysis

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

water_inlet_node_name

field Water Inlet Node Name

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

water_outlet_node_name

field Water Outlet Node Name

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

class pyidf.coils.CoilCoolingWaterDetailedGeometry

Bases: pyidf.helper.DataObject

Corresponds to IDD object Coil:Cooling:Water:DetailedGeometry Chilled water cooling coil, detailed flat fin coil model for continuous plate fins, with inputs for detailed coil geometry specifications.

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

coil_depth

field Coil Depth

Units: m

IP-Units: in

Default value: “autosize”

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

condensate_collection_water_storage_tank_name

field Condensate Collection Water Storage Tank Name

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

fin_diameter

field Fin Diameter

Fin diameter or the coil height

Units: m

IP-Units: in

Default value: “autosize”

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

fin_spacing

field Fin Spacing

Fin spacing or distance

Units: m

IP-Units: in

Default value: 0.0018

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

fin_surface_area

field Fin Surface Area

Units: m2

Default value: “autosize”

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

fin_thermal_conductivity

field Fin Thermal Conductivity

Units: W/m-K

Default value: 204.0

value >= 1.0

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

fin_thickness

field Fin Thickness

Units: m

IP-Units: in

Default value: 0.0015

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

maximum_water_flow_rate

field Maximum Water Flow Rate

Units: m3/s

IP-Units: gal/min

Default value: “autosize”

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

minimum_airflow_area

field Minimum Airflow Area

Units: m2

Default value: “autosize”

Parameters:value (float or “Autosize”) – value for IDD Field Minimum Airflow Area Raises:ValueError – if value is not a valid value Returns:the value of minimum_airflow_area 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

number_of_tube_rows

field Number of Tube Rows

Default value: 4.0

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

number_of_tubes_per_row

field Number of Tubes per Row

Default value: “autosize”

Parameters:value (float or “Autosize”) – value for IDD Field Number of Tubes per Row Raises:ValueError – if value is not a valid value Returns:the value of number_of_tubes_per_row or None if not set Return type:float or “Autosize”

total_tube_inside_area

field Total Tube Inside Area

Total tube inside surface area

Units: m2

Default value: “autosize”

Parameters:value (float or “Autosize”) – value for IDD Field Total Tube Inside Area Raises:ValueError – if value is not a valid value Returns:the value of total_tube_inside_area or None if not set Return type:float or “Autosize”

tube_depth_spacing

field Tube Depth Spacing

Units: m

IP-Units: in

Default value: 0.026

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

tube_inside_diameter

field Tube Inside Diameter

Inner diameter of tubes

Units: m

IP-Units: in

Default value: 0.01445

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

tube_outside_diameter

field Tube Outside Diameter

Outer diameter of tubes

Units: m

IP-Units: in

Default value: 0.0159

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

tube_outside_surface_area

field Tube Outside Surface Area

Tube Primary Surface Area

Units: m2

Default value: “autosize”

Parameters:value (float or “Autosize”) – value for IDD Field Tube Outside Surface Area Raises:ValueError – if value is not a valid value Returns:the value of tube_outside_surface_area or None if not set Return type:float or “Autosize”

tube_thermal_conductivity

field Tube Thermal Conductivity

Units: W/m-K

Default value: 386.0

value >= 1.0

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

water_inlet_node_name

field Water Inlet Node Name

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

water_outlet_node_name

field Water Outlet Node Name

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

class pyidf.coils.CoilCoolingWaterToAirHeatPumpEquationFit

Bases: pyidf.helper.DataObject

Corresponds to IDD object Coil:Cooling:WaterToAirHeatPump:EquationFit Direct expansion (DX) cooling coil for water-to-air heat pump (includes electric compressor), single-speed, equation-fit model. Optional inputs for moisture evaporation from wet coil when compressor cycles off with continuous fan operation. Equation-fit model uses normalized curves to describe the heat pump performance.

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

cooling_power_consumption_coefficient_1

field Cooling Power Consumption Coefficient 1

Parameters:value (float) – value for IDD Field Cooling Power Consumption Coefficient 1 Raises:ValueError – if value is not a valid value Returns:the value of cooling_power_consumption_coefficient_1 or None if not set Return type:float

cooling_power_consumption_coefficient_2

field Cooling Power Consumption Coefficient 2

Parameters:value (float) – value for IDD Field Cooling Power Consumption Coefficient 2 Raises:ValueError – if value is not a valid value Returns:the value of cooling_power_consumption_coefficient_2 or None if not set Return type:float

cooling_power_consumption_coefficient_3

field Cooling Power Consumption Coefficient 3

Parameters:value (float) – value for IDD Field Cooling Power Consumption Coefficient 3 Raises:ValueError – if value is not a valid value Returns:the value of cooling_power_consumption_coefficient_3 or None if not set Return type:float

cooling_power_consumption_coefficient_4

field Cooling Power Consumption Coefficient 4

Parameters:value (float) – value for IDD Field Cooling Power Consumption Coefficient 4 Raises:ValueError – if value is not a valid value Returns:the value of cooling_power_consumption_coefficient_4 or None if not set Return type:float

cooling_power_consumption_coefficient_5

field Cooling Power Consumption Coefficient 5

Parameters:value (float) – value for IDD Field Cooling Power Consumption Coefficient 5 Raises:ValueError – if value is not a valid value Returns:the value of cooling_power_consumption_coefficient_5 or None if not set Return type:float

gross_rated_cooling_cop

field Gross Rated Cooling COP

Parameters:value (float) – value for IDD Field Gross Rated Cooling COP Raises:ValueError – if value is not a valid value Returns:the value of gross_rated_cooling_cop or None if not set Return type:float

gross_rated_sensible_cooling_capacity

field Gross Rated Sensible Cooling Capacity

Units: W

Parameters:value (float or “Autosize”) – value for IDD Field Gross Rated Sensible Cooling Capacity Raises:ValueError – if value is not a valid value Returns:the value of gross_rated_sensible_cooling_capacity or None if not set Return type:float or “Autosize”

gross_rated_total_cooling_capacity

field Gross Rated Total Cooling Capacity

Total cooling capacity not accounting for the effect of supply air fan heat

Units: W

Parameters:value (float or “Autosize”) – value for IDD Field Gross Rated Total Cooling Capacity Raises:ValueError – if value is not a valid value Returns:the value of gross_rated_total_cooling_capacity 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

nominal_time_for_condensate_removal_to_begin

field Nominal Time for Condensate Removal to Begin

The nominal time for condensate to begin leaving the coil’s condensate

drain line at the coil’s rated air flow and temperature conditions.

Nominal time is equal to the ratio of the energy of the coil’s maximum

condensate holding capacity (J) to the coil’s steady state latent capacity (W).

Suggested value is 1000; zero value means latent degradation model is disabled.

Units: s

value <= 3000.0

Parameters:value (float) – value for IDD Field Nominal Time for Condensate Removal to Begin Raises:ValueError – if value is not a valid value Returns:the value of nominal_time_for_condensate_removal_to_begin or None if not set Return type:float

rated_air_flow_rate

field Rated Air Flow Rate

Units: m3/s

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

rated_water_flow_rate

field Rated Water Flow Rate

Units: m3/s

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

ratio_of_initial_moisture_evaporation_rate_and_steady_state_latent_capacity

field Ratio of Initial Moisture Evaporation Rate and Steady State Latent Capacity

Ratio of the initial moisture evaporation rate from the cooling coil (when

the compressor first turns off) and the coil’s steady state latent capacity

at rated air flow rate and temperature conditions. Suggested value is 1.5; zero value

means latent degradation model is disabled.

Units: dimensionless

value <= 5.0

Parameters:value (float) – value for IDD Field Ratio of Initial Moisture Evaporation Rate and Steady State Latent Capacity Raises:ValueError – if value is not a valid value Returns:the value of ratio_of_initial_moisture_evaporation_rate_and_steady_state_latent_capacity or None if not set Return type:float

sensible_cooling_capacity_coefficient_1

field Sensible Cooling Capacity Coefficient 1

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

sensible_cooling_capacity_coefficient_2

field Sensible Cooling Capacity Coefficient 2

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

sensible_cooling_capacity_coefficient_3

field Sensible Cooling Capacity Coefficient 3

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

sensible_cooling_capacity_coefficient_4

field Sensible Cooling Capacity Coefficient 4

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

sensible_cooling_capacity_coefficient_5

field Sensible Cooling Capacity Coefficient 5

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

sensible_cooling_capacity_coefficient_6

field Sensible Cooling Capacity Coefficient 6

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

total_cooling_capacity_coefficient_1

field Total Cooling Capacity Coefficient 1

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

total_cooling_capacity_coefficient_2

field Total Cooling Capacity Coefficient 2

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

total_cooling_capacity_coefficient_3

field Total Cooling Capacity Coefficient 3

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

total_cooling_capacity_coefficient_4

field Total Cooling Capacity Coefficient 4

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

total_cooling_capacity_coefficient_5

field Total Cooling Capacity Coefficient 5

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

water_inlet_node_name

field Water Inlet Node Name

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

water_outlet_node_name

field Water Outlet Node Name

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

class pyidf.coils.CoilCoolingWaterToAirHeatPumpParameterEstimation

Bases: pyidf.helper.DataObject

Corresponds to IDD object Coil:Cooling:WaterToAirHeatPump:ParameterEstimation Direct expansion (DX) cooling coil for water-to-air heat pump (includes electric compressor), single-speed, parameter estimation model. Optional inputs for moisture evaporation from wet coil when compressor cycles off with continuous fan operation. Parameter estimation model is a deterministic model that requires a consistent set of parameters to describe the operating conditions of the heat pump components.

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

compressor_clearance_factor

field Compressor Clearance Factor

Used when Compressor Type is Reciprocating.

Leave this field blank for Compressor Type is Rotary or Scroll.

Previously part of Parameter 8

Units: dimensionless

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

compressor_efficiency

field Compressor Efficiency

Previously called Parameter 5

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

compressor_piston_displacement

field Compressor Piston Displacement

Use when Compressor Type is Reciprocating or Rotary

Leave this field blank for Compressor Type is Scroll.

Previously part of Parameter 6

Units: m3/s

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

compressor_power_losses

field Compressor Power Losses

Accounts for the loss of work due to mechanical and electrical losses in the compressor.

Previously called Parameter 4

Units: W

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

compressor_suction_or_discharge_pressure_drop

field Compressor Suction/Discharge Pressure Drop

Used when Compressor Type is Rotary or Reciprocating

Leave this field blank for Compressor Type is Scroll.

Previously part of Parameter 7

Units: Pa

Parameters:value (float) – value for IDD Field Compressor Suction/Discharge Pressure Drop Raises:ValueError – if value is not a valid value Returns:the value of compressor_suction_or_discharge_pressure_drop or None if not set Return type:float

compressor_type

field Compressor Type

Parameters 1-5 are as named below.

Parameters 6-10 depend on the type of compressor and fluid.

Refer to the InputOutputReference on the parameters required

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

design_source_side_flow_rate

field Design Source Side Flow Rate

Units: m3/s

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

high_pressure_cutoff

field High Pressure Cutoff

Units: Pa

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

leak_rate_coefficient

field Leak Rate Coefficient

Use when Compressor Type is Scroll.

Leave this field blank for Compressor Type is Rotary or Reciprocating.

Previously part of Parameter 8

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

load_side_outside_surface_heat_transfer_coefficient

field Load Side Outside Surface Heat Transfer Coefficient

Previously called Parameter 2

Units: W/K

Parameters:value (float) – value for IDD Field Load Side Outside Surface Heat Transfer Coefficient Raises:ValueError – if value is not a valid value Returns:the value of load_side_outside_surface_heat_transfer_coefficient or None if not set Return type:float

load_side_total_heat_transfer_coefficient

field Load Side Total Heat Transfer Coefficient

Previously called Parameter 1

Units: W/K

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

low_pressure_cutoff

field Low Pressure Cutoff

Units: Pa

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

name

field Name

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

nominal_cooling_coil_capacity

field Nominal Cooling Coil Capacity

Units: W

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

nominal_time_for_condensate_removal_to_begin

field Nominal Time for Condensate Removal to Begin

The nominal time for condensate to begin leaving the coil’s condensate

drain line at the coil’s rated air flow rate and temperature conditions.

Nominal time is equal to the ratio of the energy of the coil’s maximum

condensate holding capacity (J) to the coil’s steady state latent capacity (W).

Suggested value is 1000; zero value means latent degradation model is disabled.

Units: s

value <= 3000.0

Parameters:value (float) – value for IDD Field Nominal Time for Condensate Removal to Begin Raises:ValueError – if value is not a valid value Returns:the value of nominal_time_for_condensate_removal_to_begin or None if not set Return type:float

ratio_of_initial_moisture_evaporation_rate_and_steady_state_latent_capacity

field Ratio of Initial Moisture Evaporation Rate and Steady State Latent Capacity

Ratio of the initial moisture evaporation rate from the cooling coil (when

the compressor first turns off) and the coil’s steady state latent capacity

at rated air flow rate and temperature conditions. Suggested value is 1.5; zero value

means latent degradation model is disabled.

Units: dimensionless

value <= 5.0

Parameters:value (float) – value for IDD Field Ratio of Initial Moisture Evaporation Rate and Steady State Latent Capacity Raises:ValueError – if value is not a valid value Returns:the value of ratio_of_initial_moisture_evaporation_rate_and_steady_state_latent_capacity or None if not set Return type:float

refrigerant_type

field Refrigerant Type

Default value: R22

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

refrigerant_volume_flow_rate

field Refrigerant Volume Flow Rate

Use when Compressor Type is Scroll

Leave this field blank for Compressor Type is Rotary or Reciprocating.

Previously part of Parameter 6

Units: m3/s

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

source_side_heat_transfer_coefficient

field Source Side Heat Transfer Coefficient

Use when Source Side Fluid Name is Water

Leave this field blank when Source Side Fluid Name is an antifreeze

Previously part of Parameter 9

Units: W/K

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

source_side_heat_transfer_resistance1

field Source Side Heat Transfer Resistance1

Use when Source Side Fluid Name is an antifreeze

Leave this field blank for Source Side Fluid is Water

Previously part of Parameter 9

Units: dimensionless

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

source_side_heat_transfer_resistance2

field Source Side Heat Transfer Resistance2

Use when Source Side Fluid Name is an antifreeze

Leave this field blank for Source Side Fluid is Water

Previously part of Parameter 10

Units: W/K

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

superheat_temperature_at_the_evaporator_outlet

field Superheat Temperature at the Evaporator Outlet

Previously called Parameter 3

Units: C

Parameters:value (float) – value for IDD Field Superheat Temperature at the Evaporator Outlet Raises:ValueError – if value is not a valid value Returns:the value of superheat_temperature_at_the_evaporator_outlet or None if not set Return type:float

volume_ratio

field Volume Ratio

Use when Compressor Type is Scroll.

Leave this field blank for Compressor Type is Rotary or Reciprocating.

Previously part of Parameter 7

Units: dimensionless

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

water_inlet_node_name

field Water Inlet Node Name

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

water_outlet_node_name

field Water Outlet Node Name

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

class pyidf.coils.CoilCoolingWaterToAirHeatPumpVariableSpeedEquationFit

Bases: pyidf.helper.DataObject

Corresponds to IDD object Coil:Cooling:WaterToAirHeatPump:VariableSpeedEquationFit Direct expansion (DX) cooling coil for water-to-air heat pump (includes electric compressor), variable-speed, equation-fit model. Optional inputs for moisture evaporation from wet coil when compressor cycles off with continuous fan operation. Equation-fit model uses normalized curves to describe the heat pump performance. Requires two to ten sets of performance data and will interpolate between speeds. Modeled as a single coil with variable-speed compressor.

energy_part_load_fraction_curve_name

field Energy Part Load Fraction Curve Name

quadratic curve = a + b*PLR + c*PLR**2

cubic curve = a + b*PLR + c*PLR**2 + d*PLR**3

PLR = part load ratio (cooling load/steady state capacity)

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

flag_for_using_hot_gas_reheat_0_or_1

field Flag for Using Hot Gas Reheat, 0 or 1

Flag for using hot gas reheat, 0 - not used, 1 - used

Units: dimensionless

Parameters:value (float) – value for IDD Field Flag for Using Hot Gas Reheat, 0 or 1 Raises:ValueError – if value is not a valid value Returns:the value of flag_for_using_hot_gas_reheat_0_or_1 or None if not set Return type:float

gross_rated_total_cooling_capacity_at_selected_nominal_speed_level

field Gross Rated Total Cooling Capacity At Selected Nominal Speed Level

Total cooling capacity not accounting for the effect of supply air fan heat

Units: w

Default value: “autosize”

Parameters:value (float or “Autosize”) – value for IDD Field Gross Rated Total Cooling Capacity At Selected Nominal Speed Level Raises:ValueError – if value is not a valid value Returns:the value of gross_rated_total_cooling_capacity_at_selected_nominal_speed_level or None if not set Return type:float or “Autosize”

indoor_air_inlet_node_name

field Indoor Air Inlet Node Name

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

indoor_air_outlet_node_name

field Indoor Air Outlet Node Name

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

initial_moisture_evaporation_rate_divided_by_steadystate_ac_latent_capacity

field Initial Moisture Evaporation Rate Divided by Steady-State AC Latent Capacity

Units: dimensionless

Parameters:value (float) – value for IDD Field Initial Moisture Evaporation Rate Divided by Steady-State AC Latent Capacity Raises:ValueError – if value is not a valid value Returns:the value of initial_moisture_evaporation_rate_divided_by_steadystate_ac_latent_capacity or None if not set Return type:float

name

field Name

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

nominal_speed_level

field Nominal Speed Level

must be lower than or equal to the highest speed number

Units: dimensionless

Default value: 2

Parameters:value (int) – value for IDD Field Nominal Speed Level Raises:ValueError – if value is not a valid value Returns:the value of nominal_speed_level or None if not set Return type:int

nominal_time_for_condensate_to_begin_leaving_the_coil

field Nominal Time for Condensate to Begin Leaving the Coil

Units: s

Parameters:value (float) – value for IDD Field Nominal Time for Condensate to Begin Leaving the Coil Raises:ValueError – if value is not a valid value Returns:the value of nominal_time_for_condensate_to_begin_leaving_the_coil or None if not set Return type:float

number_of_speeds

field Number of Speeds

Units: dimensionless

Default value: 2

value >= 1

value <= 10

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

rated_air_flow_rate_at_selected_nominal_speed_level

field Rated Air Flow Rate At Selected Nominal Speed Level

Units: m3/s

Default value: “autosize”

Parameters:value (float or “Autosize”) – value for IDD Field Rated Air Flow Rate At Selected Nominal Speed Level Raises:ValueError – if value is not a valid value Returns:the value of rated_air_flow_rate_at_selected_nominal_speed_level or None if not set Return type:float or “Autosize”

rated_water_flow_rate_at_selected_nominal_speed_level

field Rated Water Flow Rate At Selected Nominal Speed Level

Units: m3/s

Default value: “autosize”

Parameters:value (float or “Autosize”) – value for IDD Field Rated Water Flow Rate At Selected Nominal Speed Level Raises:ValueError – if value is not a valid value Returns:the value of rated_water_flow_rate_at_selected_nominal_speed_level or None if not set Return type:float or “Autosize”

speed_10_energy_input_ratio_function_of_air_flow_fraction_curve_name

field Speed 10 Energy Input Ratio Function of Air Flow Fraction Curve Name

optional

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 10 Energy Input Ratio Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_10_energy_input_ratio_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_10_energy_input_ratio_function_of_temperature_curve_name

field Speed 10 Energy Input Ratio Function of Temperature Curve Name

optional

curve = a + b*wb + c*wb**2 + d*ewt + e*ewt**2 + f*wb*ewt

wb = entering wet-bulb temperature (C)

ewt = water entering temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Speed 10 Energy Input Ratio Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_10_energy_input_ratio_function_of_temperature_curve_name or None if not set Return type:str

speed_10_energy_input_ratio_function_of_water_flow_fraction_curve_name

field Speed 10 Energy Input Ratio Function of Water Flow Fraction Curve Name

optional

quadratic curve = a + b*ffw + c*ffw**2

cubic curve = a + b*ffw + c*ffw**2 + d*ffw**3

ffw = Fraction of the full load Water Flow

Parameters:value (str) – value for IDD Field Speed 10 Energy Input Ratio Function of Water Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_10_energy_input_ratio_function_of_water_flow_fraction_curve_name or None if not set Return type:str

speed_10_reference_unit_gross_rated_cooling_cop

field Speed 10 Reference Unit Gross Rated Cooling COP

Units: dimensionless

Parameters:value (float) – value for IDD Field Speed 10 Reference Unit Gross Rated Cooling COP Raises:ValueError – if value is not a valid value Returns:the value of speed_10_reference_unit_gross_rated_cooling_cop or None if not set Return type:float

speed_10_reference_unit_gross_rated_sensible_heat_ratio

field Speed 10 Reference Unit Gross Rated Sensible Heat Ratio

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Speed 10 Reference Unit Gross Rated Sensible Heat Ratio Raises:ValueError – if value is not a valid value Returns:the value of speed_10_reference_unit_gross_rated_sensible_heat_ratio or None if not set Return type:float

speed_10_reference_unit_gross_rated_total_cooling_capacity

field Speed 10 Reference Unit Gross Rated Total Cooling Capacity

Total cooling capacity not accounting for the effect of supply air fan heat

Units: w

Parameters:value (float) – value for IDD Field Speed 10 Reference Unit Gross Rated Total Cooling Capacity Raises:ValueError – if value is not a valid value Returns:the value of speed_10_reference_unit_gross_rated_total_cooling_capacity or None if not set Return type:float

speed_10_reference_unit_rated_air_flow_rate

field Speed 10 Reference Unit Rated Air Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 10 Reference Unit Rated Air Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_10_reference_unit_rated_air_flow_rate or None if not set Return type:float

speed_10_reference_unit_rated_water_flow_rate

field Speed 10 Reference Unit Rated Water Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 10 Reference Unit Rated Water Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_10_reference_unit_rated_water_flow_rate or None if not set Return type:float

speed_10_reference_unit_waste_heat_fraction_of_input_power_at_rated_conditions

field Speed 10 Reference Unit Waste Heat Fraction of Input Power At Rated Conditions

Units: dimensionless

Parameters:value (float) – value for IDD Field Speed 10 Reference Unit Waste Heat Fraction of Input Power At Rated Conditions Raises:ValueError – if value is not a valid value Returns:the value of speed_10_reference_unit_waste_heat_fraction_of_input_power_at_rated_conditions or None if not set Return type:float

speed_10_total_cooling_capacity_function_of_air_flow_fraction_curve_name

field Speed 10 Total Cooling Capacity Function of Air Flow Fraction Curve Name

optional

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 10 Total Cooling Capacity Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_10_total_cooling_capacity_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_10_total_cooling_capacity_function_of_temperature_curve_name

field Speed 10 Total Cooling Capacity Function of Temperature Curve Name

optional

curve = a + b*wb + c*wb**2 + d*ewt + e*ewt**2 + f*wb*ewt

wb = entering wet-bulb temperature (C)

ewt = water entering temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Speed 10 Total Cooling Capacity Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_10_total_cooling_capacity_function_of_temperature_curve_name or None if not set Return type:str

speed_10_total_cooling_capacity_function_of_water_flow_fraction_curve_name

field Speed 10 Total Cooling Capacity Function of Water Flow Fraction Curve Name

optional

quadratic curve = a + b*ffw + c*ffw**2

cubic curve = a + b*ffw + c*ffw**2 + d*ffw**3

ffw = Fraction of the full load Water Flow

Parameters:value (str) – value for IDD Field Speed 10 Total Cooling Capacity Function of Water Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_10_total_cooling_capacity_function_of_water_flow_fraction_curve_name or None if not set Return type:str

speed_10_waste_heat_function_of_temperature_curve_name

field Speed 10 Waste Heat Function of Temperature Curve Name

optional

curve = a + b*wb + c*wb**2 + d*ewt + e*ewt**2 + f*wb*ewt

wb = entering wet-bulb temperature (C)

ewt = water entering temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Speed 10 Waste Heat Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_10_waste_heat_function_of_temperature_curve_name or None if not set Return type:str

speed_1_energy_input_ratio_function_of_air_flow_fraction_curve_name

field Speed 1 Energy Input Ratio Function of Air Flow Fraction Curve Name

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 1 Energy Input Ratio Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_1_energy_input_ratio_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_1_energy_input_ratio_function_of_temperature_curve_name

field Speed 1 Energy Input Ratio Function of Temperature Curve Name

curve = a + b*wb + c*wb**2 + d*ewt + e*ewt**2 + f*wb*ewt

wb = entering wet-bulb temperature (C)

ewt = water entering temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Speed 1 Energy Input Ratio Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_1_energy_input_ratio_function_of_temperature_curve_name or None if not set Return type:str

speed_1_energy_input_ratio_function_of_water_flow_fraction_curve_name

field Speed 1 Energy Input Ratio Function of Water Flow Fraction Curve Name

quadratic curve = a + b*ffw + c*ffw**2

cubic curve = a + b*ffw + c*ffw**2 + d*ffw**3

ffw = Fraction of the full load Water Flow

Parameters:value (str) – value for IDD Field Speed 1 Energy Input Ratio Function of Water Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_1_energy_input_ratio_function_of_water_flow_fraction_curve_name or None if not set Return type:str

speed_1_reference_unit_gross_rated_cooling_cop

field Speed 1 Reference Unit Gross Rated Cooling COP

Units: dimensionless

Parameters:value (float) – value for IDD Field Speed 1 Reference Unit Gross Rated Cooling COP Raises:ValueError – if value is not a valid value Returns:the value of speed_1_reference_unit_gross_rated_cooling_cop or None if not set Return type:float

speed_1_reference_unit_gross_rated_sensible_heat_ratio

field Speed 1 Reference Unit Gross Rated Sensible Heat Ratio

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Speed 1 Reference Unit Gross Rated Sensible Heat Ratio Raises:ValueError – if value is not a valid value Returns:the value of speed_1_reference_unit_gross_rated_sensible_heat_ratio or None if not set Return type:float

speed_1_reference_unit_gross_rated_total_cooling_capacity

field Speed 1 Reference Unit Gross Rated Total Cooling Capacity

Total cooling capacity not accounting for the effect of supply air fan heat

Units: w

Parameters:value (float) – value for IDD Field Speed 1 Reference Unit Gross Rated Total Cooling Capacity Raises:ValueError – if value is not a valid value Returns:the value of speed_1_reference_unit_gross_rated_total_cooling_capacity or None if not set Return type:float

speed_1_reference_unit_rated_air_flow_rate

field Speed 1 Reference Unit Rated Air Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 1 Reference Unit Rated Air Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_1_reference_unit_rated_air_flow_rate or None if not set Return type:float

speed_1_reference_unit_rated_water_flow_rate

field Speed 1 Reference Unit Rated Water Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 1 Reference Unit Rated Water Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_1_reference_unit_rated_water_flow_rate or None if not set Return type:float

speed_1_reference_unit_waste_heat_fraction_of_input_power_at_rated_conditions

field Speed 1 Reference Unit Waste Heat Fraction of Input Power At Rated Conditions

Units: dimensionless

Parameters:value (float) – value for IDD Field Speed 1 Reference Unit Waste Heat Fraction of Input Power At Rated Conditions Raises:ValueError – if value is not a valid value Returns:the value of speed_1_reference_unit_waste_heat_fraction_of_input_power_at_rated_conditions or None if not set Return type:float

speed_1_total_cooling_capacity_function_of_air_flow_fraction_curve_name

field Speed 1 Total Cooling Capacity Function of Air Flow Fraction Curve Name

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 1 Total Cooling Capacity Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_1_total_cooling_capacity_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_1_total_cooling_capacity_function_of_temperature_curve_name

field Speed 1 Total Cooling Capacity Function of Temperature Curve Name

curve = a + b*wb + c*wb**2 + d*ewt + e*ewt**2 + f*wb*ewt

wb = entering wet-bulb temperature (C)

ewt = water entering temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Speed 1 Total Cooling Capacity Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_1_total_cooling_capacity_function_of_temperature_curve_name or None if not set Return type:str

speed_1_total_cooling_capacity_function_of_water_flow_fraction_curve_name

field Speed 1 Total Cooling Capacity Function of Water Flow Fraction Curve Name

quadratic curve = a + b*ffw + c*ffw**2

cubic curve = a + b*ffw + c*ffw**2 + d*ffw**3

ffw = Fraction of the full load Water Flow

Parameters:value (str) – value for IDD Field Speed 1 Total Cooling Capacity Function of Water Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_1_total_cooling_capacity_function_of_water_flow_fraction_curve_name or None if not set Return type:str

speed_1_waste_heat_function_of_temperature_curve_name

field Speed 1 Waste Heat Function of Temperature Curve Name

curve = a + b*wb + c*wb**2 + d*ewt + e*ewt**2 + f*wb*ewt

wb = entering wet-bulb temperature (C)

ewt = water entering temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Speed 1 Waste Heat Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_1_waste_heat_function_of_temperature_curve_name or None if not set Return type:str

speed_2_energy_input_ratio_function_of_air_flow_fraction_curve_name

field Speed 2 Energy Input Ratio Function of Air Flow Fraction Curve Name

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 2 Energy Input Ratio Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_2_energy_input_ratio_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_2_energy_input_ratio_function_of_temperature_curve_name

field Speed 2 Energy Input Ratio Function of Temperature Curve Name

curve = a + b*wb + c*wb**2 + d*ewet + e*ewt**2 + f*wb*ewt

wb = entering wet-bulb temperature (C)

ewt = water entering temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Speed 2 Energy Input Ratio Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_2_energy_input_ratio_function_of_temperature_curve_name or None if not set Return type:str

speed_2_energy_input_ratio_function_of_water_flow_fraction_curve_name

field Speed 2 Energy Input Ratio Function of Water Flow Fraction Curve Name

quadratic curve = a + b*ffw + c*ffw**2

cubic curve = a + b*ffw + c*ffw**2 + d*ffw**3

ffw = Fraction of the full load Water Flow

Parameters:value (str) – value for IDD Field Speed 2 Energy Input Ratio Function of Water Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_2_energy_input_ratio_function_of_water_flow_fraction_curve_name or None if not set Return type:str

speed_2_reference_unit_gross_rated_cooling_cop

field Speed 2 Reference Unit Gross Rated Cooling COP

Units: dimensionless

Parameters:value (float) – value for IDD Field Speed 2 Reference Unit Gross Rated Cooling COP Raises:ValueError – if value is not a valid value Returns:the value of speed_2_reference_unit_gross_rated_cooling_cop or None if not set Return type:float

speed_2_reference_unit_gross_rated_sensible_heat_ratio

field Speed 2 Reference Unit Gross Rated Sensible Heat Ratio

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Speed 2 Reference Unit Gross Rated Sensible Heat Ratio Raises:ValueError – if value is not a valid value Returns:the value of speed_2_reference_unit_gross_rated_sensible_heat_ratio or None if not set Return type:float

speed_2_reference_unit_gross_rated_total_cooling_capacity

field Speed 2 Reference Unit Gross Rated Total Cooling Capacity

Total cooling capacity not accounting for the effect of supply air fan heat

Units: w

Parameters:value (float) – value for IDD Field Speed 2 Reference Unit Gross Rated Total Cooling Capacity Raises:ValueError – if value is not a valid value Returns:the value of speed_2_reference_unit_gross_rated_total_cooling_capacity or None if not set Return type:float

speed_2_reference_unit_rated_air_flow_rate

field Speed 2 Reference Unit Rated Air Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 2 Reference Unit Rated Air Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_2_reference_unit_rated_air_flow_rate or None if not set Return type:float

speed_2_reference_unit_rated_water_flow_rate

field Speed 2 Reference Unit Rated Water Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 2 Reference Unit Rated Water Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_2_reference_unit_rated_water_flow_rate or None if not set Return type:float

speed_2_reference_unit_waste_heat_fraction_of_input_power_at_rated_conditions

field Speed 2 Reference Unit Waste Heat Fraction of Input Power At Rated Conditions

Units: dimensionless

Parameters:value (float) – value for IDD Field Speed 2 Reference Unit Waste Heat Fraction of Input Power At Rated Conditions Raises:ValueError – if value is not a valid value Returns:the value of speed_2_reference_unit_waste_heat_fraction_of_input_power_at_rated_conditions or None if not set Return type:float

speed_2_total_cooling_capacity_function_of_air_flow_fraction_curve_name

field Speed 2 Total Cooling Capacity Function of Air Flow Fraction Curve Name

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 2 Total Cooling Capacity Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_2_total_cooling_capacity_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_2_total_cooling_capacity_function_of_temperature_curve_name

field Speed 2 Total Cooling Capacity Function of Temperature Curve Name

curve = a + b*wb + c*wb**2 + d*ewt + e*ewt**2 + f*wb*ewt

wb = entering wet-bulb temperature (C)

ewt = water entering temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Speed 2 Total Cooling Capacity Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_2_total_cooling_capacity_function_of_temperature_curve_name or None if not set Return type:str

speed_2_total_cooling_capacity_function_of_water_flow_fraction_curve_name

field Speed 2 Total Cooling Capacity Function of Water Flow Fraction Curve Name

quadratic curve = a + b*ffw + c*ffw**2

cubic curve = a + b*ffw + c*ffw**2 + d*ffw**3

ffw = Fraction of the full load Water Flow

Parameters:value (str) – value for IDD Field Speed 2 Total Cooling Capacity Function of Water Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_2_total_cooling_capacity_function_of_water_flow_fraction_curve_name or None if not set Return type:str

speed_2_waste_heat_function_of_temperature_curve_name

field Speed 2 Waste Heat Function of Temperature Curve Name

curve = a + b*wb + c*wb**2 + d*ewt + e*ewt**2 + f*wb*ewt

wb = entering wet-bulb temperature (C)

ewt = water entering temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Speed 2 Waste Heat Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_2_waste_heat_function_of_temperature_curve_name or None if not set Return type:str

speed_3_energy_input_ratio_function_of_air_flow_fraction_curve_name

field Speed 3 Energy Input Ratio Function of Air Flow Fraction Curve Name

optional

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 3 Energy Input Ratio Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_3_energy_input_ratio_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_3_energy_input_ratio_function_of_temperature_curve_name

field Speed 3 Energy Input Ratio Function of Temperature Curve Name

optional

curve = a + b*wb + c*wb**2 + d*ewt + e*ewt**2 + f*wb*ewt

wb = entering wet-bulb temperature (C)

ewt = water entering temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Speed 3 Energy Input Ratio Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_3_energy_input_ratio_function_of_temperature_curve_name or None if not set Return type:str

speed_3_energy_input_ratio_function_of_water_flow_fraction_curve_name

field Speed 3 Energy Input Ratio Function of Water Flow Fraction Curve Name

optional

quadratic curve = a + b*ffw + c*ffw**2

cubic curve = a + b*ffw + c*ffw**2 + d*ffw**3

ffw = Fraction of the full load Water Flow

Parameters:value (str) – value for IDD Field Speed 3 Energy Input Ratio Function of Water Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_3_energy_input_ratio_function_of_water_flow_fraction_curve_name or None if not set Return type:str

speed_3_reference_unit_gross_rated_cooling_cop

field Speed 3 Reference Unit Gross Rated Cooling COP

Units: dimensionless

Parameters:value (float) – value for IDD Field Speed 3 Reference Unit Gross Rated Cooling COP Raises:ValueError – if value is not a valid value Returns:the value of speed_3_reference_unit_gross_rated_cooling_cop or None if not set Return type:float

speed_3_reference_unit_gross_rated_sensible_heat_ratio

field Speed 3 Reference Unit Gross Rated Sensible Heat Ratio

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Speed 3 Reference Unit Gross Rated Sensible Heat Ratio Raises:ValueError – if value is not a valid value Returns:the value of speed_3_reference_unit_gross_rated_sensible_heat_ratio or None if not set Return type:float

speed_3_reference_unit_gross_rated_total_cooling_capacity

field Speed 3 Reference Unit Gross Rated Total Cooling Capacity

Total cooling capacity not accounting for the effect of supply air fan heat

Units: w

Parameters:value (float) – value for IDD Field Speed 3 Reference Unit Gross Rated Total Cooling Capacity Raises:ValueError – if value is not a valid value Returns:the value of speed_3_reference_unit_gross_rated_total_cooling_capacity or None if not set Return type:float

speed_3_reference_unit_rated_air_flow_rate

field Speed 3 Reference Unit Rated Air Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 3 Reference Unit Rated Air Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_3_reference_unit_rated_air_flow_rate or None if not set Return type:float

speed_3_reference_unit_rated_water_flow_rate

field Speed 3 Reference Unit Rated Water Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 3 Reference Unit Rated Water Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_3_reference_unit_rated_water_flow_rate or None if not set Return type:float

speed_3_reference_unit_waste_heat_fraction_of_input_power_at_rated_conditions

field Speed 3 Reference Unit Waste Heat Fraction of Input Power At Rated Conditions

Units: dimensionless

Parameters:value (float) – value for IDD Field Speed 3 Reference Unit Waste Heat Fraction of Input Power At Rated Conditions Raises:ValueError – if value is not a valid value Returns:the value of speed_3_reference_unit_waste_heat_fraction_of_input_power_at_rated_conditions or None if not set Return type:float

speed_3_total_cooling_capacity_function_of_air_flow_fraction_curve_name

field Speed 3 Total Cooling Capacity Function of Air Flow Fraction Curve Name

optional

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 3 Total Cooling Capacity Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_3_total_cooling_capacity_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_3_total_cooling_capacity_function_of_temperature_curve_name

field Speed 3 Total Cooling Capacity Function of Temperature Curve Name

optional

curve = a + b*wb + c*wb**2 + d*ewt + e*ewt**2 + f*wb*ewt

wb = entering wet-bulb temperature (C)

ewt = water entering temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Speed 3 Total Cooling Capacity Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_3_total_cooling_capacity_function_of_temperature_curve_name or None if not set Return type:str

speed_3_total_cooling_capacity_function_of_water_flow_fraction_curve_name

field Speed 3 Total Cooling Capacity Function of Water Flow Fraction Curve Name

optional

quadratic curve = a + b*ffw + c*ffw**2

cubic curve = a + b*ffw + c*ffw**2 + d*ffw**3

ffw = Fraction of the full load Water Flow

Parameters:value (str) – value for IDD Field Speed 3 Total Cooling Capacity Function of Water Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_3_total_cooling_capacity_function_of_water_flow_fraction_curve_name or None if not set Return type:str

speed_3_waste_heat_function_of_temperature_curve_name

field Speed 3 Waste Heat Function of Temperature Curve Name

optional

curve = a + b*wb + c*wb**2 + d*ewt + e*ewt**2 + f*wb*ewt

wb = entering wet-bulb temperature (C)

ewt = water entering temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Speed 3 Waste Heat Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_3_waste_heat_function_of_temperature_curve_name or None if not set Return type:str

speed_4_energy_input_ratio_function_of_air_flow_fraction_curve_name

field Speed 4 Energy Input Ratio Function of Air Flow Fraction Curve Name

optional

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 4 Energy Input Ratio Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_4_energy_input_ratio_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_4_energy_input_ratio_function_of_temperature_curve_name

field Speed 4 Energy Input Ratio Function of Temperature Curve Name

optional

curve = a + b*wb + c*wb**2 + d*ewt + e*ewt**2 + f*wb*ewt

wb = entering wet-bulb temperature (C)

ewt = water entering temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Speed 4 Energy Input Ratio Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_4_energy_input_ratio_function_of_temperature_curve_name or None if not set Return type:str

speed_4_energy_input_ratio_function_of_water_flow_fraction_curve_name

field Speed 4 Energy Input Ratio Function of Water Flow Fraction Curve Name

optional

quadratic curve = a + b*ffw + c*ffw**2

cubic curve = a + b*ffw + c*ffw**2 + d*ffw**3

ffw = Fraction of the full load Water Flow

Parameters:value (str) – value for IDD Field Speed 4 Energy Input Ratio Function of Water Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_4_energy_input_ratio_function_of_water_flow_fraction_curve_name or None if not set Return type:str

speed_4_reference_unit_gross_rated_cooling_cop

field Speed 4 Reference Unit Gross Rated Cooling COP

Units: dimensionless

Parameters:value (float) – value for IDD Field Speed 4 Reference Unit Gross Rated Cooling COP Raises:ValueError – if value is not a valid value Returns:the value of speed_4_reference_unit_gross_rated_cooling_cop or None if not set Return type:float

speed_4_reference_unit_gross_rated_sensible_heat_ratio

field Speed 4 Reference Unit Gross Rated Sensible Heat Ratio

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Speed 4 Reference Unit Gross Rated Sensible Heat Ratio Raises:ValueError – if value is not a valid value Returns:the value of speed_4_reference_unit_gross_rated_sensible_heat_ratio or None if not set Return type:float

speed_4_reference_unit_gross_rated_total_cooling_capacity

field Speed 4 Reference Unit Gross Rated Total Cooling Capacity

Total cooling capacity not accounting for the effect of supply air fan heat

Units: w

Parameters:value (float) – value for IDD Field Speed 4 Reference Unit Gross Rated Total Cooling Capacity Raises:ValueError – if value is not a valid value Returns:the value of speed_4_reference_unit_gross_rated_total_cooling_capacity or None if not set Return type:float

speed_4_reference_unit_rated_air_flow_rate

field Speed 4 Reference Unit Rated Air Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 4 Reference Unit Rated Air Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_4_reference_unit_rated_air_flow_rate or None if not set Return type:float

speed_4_reference_unit_rated_water_flow_rate

field Speed 4 Reference Unit Rated Water Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 4 Reference Unit Rated Water Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_4_reference_unit_rated_water_flow_rate or None if not set Return type:float

speed_4_reference_unit_waste_heat_fraction_of_input_power_at_rated_conditions

field Speed 4 Reference Unit Waste Heat Fraction of Input Power At Rated Conditions

Units: dimensionless

Parameters:value (float) – value for IDD Field Speed 4 Reference Unit Waste Heat Fraction of Input Power At Rated Conditions Raises:ValueError – if value is not a valid value Returns:the value of speed_4_reference_unit_waste_heat_fraction_of_input_power_at_rated_conditions or None if not set Return type:float

speed_4_total_cooling_capacity_function_of_air_flow_fraction_curve_name

field Speed 4 Total Cooling Capacity Function of Air Flow Fraction Curve Name

optional

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 4 Total Cooling Capacity Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_4_total_cooling_capacity_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_4_total_cooling_capacity_function_of_temperature_curve_name

field Speed 4 Total Cooling Capacity Function of Temperature Curve Name

optional

curve = a + b*wb + c*wb**2 + d*ewt + e*ewt**2 + f*wb*ewt

wb = entering wet-bulb temperature (C)

ewt = water entering temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Speed 4 Total Cooling Capacity Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_4_total_cooling_capacity_function_of_temperature_curve_name or None if not set Return type:str

speed_4_total_cooling_capacity_function_of_water_flow_fraction_curve_name

field Speed 4 Total Cooling Capacity Function of Water Flow Fraction Curve Name

optional

quadratic curve = a + b*ffw + c*ffw**2

cubic curve = a + b*ffw + c*ffw**2 + d*ffw**3

ffw = Fraction of the full load Water Flow

Parameters:value (str) – value for IDD Field Speed 4 Total Cooling Capacity Function of Water Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_4_total_cooling_capacity_function_of_water_flow_fraction_curve_name or None if not set Return type:str

speed_4_waste_heat_function_of_temperature_curve_name

field Speed 4 Waste Heat Function of Temperature Curve Name

optional

curve = a + b*wb + c*wb**2 + d*ewt + e*ewt**2 + f*wb*ewt

wb = entering wet-bulb temperature (C)

ewt = water entering temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Speed 4 Waste Heat Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_4_waste_heat_function_of_temperature_curve_name or None if not set Return type:str

speed_5_energy_input_ratio_function_of_air_flow_fraction_curve_name

field Speed 5 Energy Input Ratio Function of Air Flow Fraction Curve Name

optional

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 5 Energy Input Ratio Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_5_energy_input_ratio_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_5_energy_input_ratio_function_of_temperature_curve_name

field Speed 5 Energy Input Ratio Function of Temperature Curve Name

optional

curve = a + b*wb + c*wb**2 + d*ewt + e*ewt**2 + f*wb*ewt

wb = entering wet-bulb temperature (C)

ewt = water entering temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Speed 5 Energy Input Ratio Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_5_energy_input_ratio_function_of_temperature_curve_name or None if not set Return type:str

speed_5_energy_input_ratio_function_of_water_flow_fraction_curve_name

field Speed 5 Energy Input Ratio Function of Water Flow Fraction Curve Name

optional

quadratic curve = a + b*ffw + c*ffw**2

cubic curve = a + b*ffw + c*ffw**2 + d*ffw**3

ffw = Fraction of the full load Water Flow

Parameters:value (str) – value for IDD Field Speed 5 Energy Input Ratio Function of Water Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_5_energy_input_ratio_function_of_water_flow_fraction_curve_name or None if not set Return type:str

speed_5_reference_unit_gross_rated_cooling_cop

field Speed 5 Reference Unit Gross Rated Cooling COP

Units: dimensionless

Parameters:value (float) – value for IDD Field Speed 5 Reference Unit Gross Rated Cooling COP Raises:ValueError – if value is not a valid value Returns:the value of speed_5_reference_unit_gross_rated_cooling_cop or None if not set Return type:float

speed_5_reference_unit_gross_rated_sensible_heat_ratio

field Speed 5 Reference Unit Gross Rated Sensible Heat Ratio

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Speed 5 Reference Unit Gross Rated Sensible Heat Ratio Raises:ValueError – if value is not a valid value Returns:the value of speed_5_reference_unit_gross_rated_sensible_heat_ratio or None if not set Return type:float

speed_5_reference_unit_gross_rated_total_cooling_capacity

field Speed 5 Reference Unit Gross Rated Total Cooling Capacity

Total cooling capacity not accounting for the effect of supply air fan heat

Units: w

Parameters:value (float) – value for IDD Field Speed 5 Reference Unit Gross Rated Total Cooling Capacity Raises:ValueError – if value is not a valid value Returns:the value of speed_5_reference_unit_gross_rated_total_cooling_capacity or None if not set Return type:float

speed_5_reference_unit_rated_air_flow_rate

field Speed 5 Reference Unit Rated Air Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 5 Reference Unit Rated Air Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_5_reference_unit_rated_air_flow_rate or None if not set Return type:float

speed_5_reference_unit_rated_water_flow_rate

field Speed 5 Reference Unit Rated Water Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 5 Reference Unit Rated Water Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_5_reference_unit_rated_water_flow_rate or None if not set Return type:float

speed_5_reference_unit_waste_heat_fraction_of_input_power_at_rated_conditions

field Speed 5 Reference Unit Waste Heat Fraction of Input Power At Rated Conditions

Units: dimensionless

Parameters:value (float) – value for IDD Field Speed 5 Reference Unit Waste Heat Fraction of Input Power At Rated Conditions Raises:ValueError – if value is not a valid value Returns:the value of speed_5_reference_unit_waste_heat_fraction_of_input_power_at_rated_conditions or None if not set Return type:float

speed_5_total_cooling_capacity_function_of_air_flow_fraction_curve_name

field Speed 5 Total Cooling Capacity Function of Air Flow Fraction Curve Name

optional

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 5 Total Cooling Capacity Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_5_total_cooling_capacity_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_5_total_cooling_capacity_function_of_temperature_curve_name

field Speed 5 Total Cooling Capacity Function of Temperature Curve Name

optional

curve = a + b*wb + c*wb**2 + d*ewt + e*ewt**2 + f*wb*ewt

wb = entering wet-bulb temperature (C)

ewt = water entering temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Speed 5 Total Cooling Capacity Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_5_total_cooling_capacity_function_of_temperature_curve_name or None if not set Return type:str

speed_5_total_cooling_capacity_function_of_water_flow_fraction_curve_name

field Speed 5 Total Cooling Capacity Function of Water Flow Fraction Curve Name

optional

quadratic curve = a + b*ffw + c*ffw**2

cubic curve = a + b*ffw + c*ffw**2 + d*ffw**3

ffw = Fraction of the full load Water Flow

Parameters:value (str) – value for IDD Field Speed 5 Total Cooling Capacity Function of Water Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_5_total_cooling_capacity_function_of_water_flow_fraction_curve_name or None if not set Return type:str

speed_5_waste_heat_function_of_temperature_curve_name

field Speed 5 Waste Heat Function of Temperature Curve Name

optional

curve = a + b*wb + c*wb**2 + d*ewt + e*ewt**2 + f*wb*ewt

wb = entering wet-bulb temperature (C)

ewt = water entering temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Speed 5 Waste Heat Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_5_waste_heat_function_of_temperature_curve_name or None if not set Return type:str

speed_6_energy_input_ratio_function_of_air_flow_fraction_curve_name

field Speed 6 Energy Input Ratio Function of Air Flow Fraction Curve Name

optional

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 6 Energy Input Ratio Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_6_energy_input_ratio_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_6_energy_input_ratio_function_of_temperature_curve_name

field Speed 6 Energy Input Ratio Function of Temperature Curve Name

optional

curve = a + b*wb + c*wb**2 + d*ewt + e*ewt**2 + f*wb*ewt

wb = entering wet-bulb temperature (C)

ewt = water entering temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Speed 6 Energy Input Ratio Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_6_energy_input_ratio_function_of_temperature_curve_name or None if not set Return type:str

speed_6_energy_input_ratio_function_of_water_flow_fraction_curve_name

field Speed 6 Energy Input Ratio Function of Water Flow Fraction Curve Name

optional

quadratic curve = a + b*ffw + c*ffw**2

cubic curve = a + b*ffw + c*ffw**2 + d*ffw**3

ffw = Fraction of the full load Water Flow

Parameters:value (str) – value for IDD Field Speed 6 Energy Input Ratio Function of Water Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_6_energy_input_ratio_function_of_water_flow_fraction_curve_name or None if not set Return type:str

speed_6_reference_unit_gross_rated_cooling_cop

field Speed 6 Reference Unit Gross Rated Cooling COP

Units: dimensionless

Parameters:value (float) – value for IDD Field Speed 6 Reference Unit Gross Rated Cooling COP Raises:ValueError – if value is not a valid value Returns:the value of speed_6_reference_unit_gross_rated_cooling_cop or None if not set Return type:float

speed_6_reference_unit_gross_rated_sensible_heat_ratio

field Speed 6 Reference Unit Gross Rated Sensible Heat Ratio

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Speed 6 Reference Unit Gross Rated Sensible Heat Ratio Raises:ValueError – if value is not a valid value Returns:the value of speed_6_reference_unit_gross_rated_sensible_heat_ratio or None if not set Return type:float

speed_6_reference_unit_gross_rated_total_cooling_capacity

field Speed 6 Reference Unit Gross Rated Total Cooling Capacity

Total cooling capacity not accounting for the effect of supply air fan heat

Units: w

Parameters:value (float) – value for IDD Field Speed 6 Reference Unit Gross Rated Total Cooling Capacity Raises:ValueError – if value is not a valid value Returns:the value of speed_6_reference_unit_gross_rated_total_cooling_capacity or None if not set Return type:float

speed_6_reference_unit_rated_air_flow_rate

field Speed 6 Reference Unit Rated Air Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 6 Reference Unit Rated Air Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_6_reference_unit_rated_air_flow_rate or None if not set Return type:float

speed_6_reference_unit_rated_water_flow_rate

field Speed 6 Reference Unit Rated Water Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 6 Reference Unit Rated Water Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_6_reference_unit_rated_water_flow_rate or None if not set Return type:float

speed_6_reference_unit_waste_heat_fraction_of_input_power_at_rated_conditions

field Speed 6 Reference Unit Waste Heat Fraction of Input Power At Rated Conditions

Units: dimensionless

Parameters:value (float) – value for IDD Field Speed 6 Reference Unit Waste Heat Fraction of Input Power At Rated Conditions Raises:ValueError – if value is not a valid value Returns:the value of speed_6_reference_unit_waste_heat_fraction_of_input_power_at_rated_conditions or None if not set Return type:float

speed_6_total_cooling_capacity_function_of_air_flow_fraction_curve_name

field Speed 6 Total Cooling Capacity Function of Air Flow Fraction Curve Name

optional

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 6 Total Cooling Capacity Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_6_total_cooling_capacity_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_6_total_cooling_capacity_function_of_temperature_curve_name

field Speed 6 Total Cooling Capacity Function of Temperature Curve Name

optional

curve = a + b*wb + c*wb**2 + d*ewt + e*ewt**2 + f*wb*ewt

wb = entering wet-bulb temperature (C)

ewt = water entering temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Speed 6 Total Cooling Capacity Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_6_total_cooling_capacity_function_of_temperature_curve_name or None if not set Return type:str

speed_6_total_cooling_capacity_function_of_water_flow_fraction_curve_name

field Speed 6 Total Cooling Capacity Function of Water Flow Fraction Curve Name

optional

quadratic curve = a + b*ffw + c*ffw**2

cubic curve = a + b*ffw + c*ffw**2 + d*ffw**3

ffw = Fraction of the full load Water Flow

Parameters:value (str) – value for IDD Field Speed 6 Total Cooling Capacity Function of Water Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_6_total_cooling_capacity_function_of_water_flow_fraction_curve_name or None if not set Return type:str

speed_6_waste_heat_function_of_temperature_curve_name

field Speed 6 Waste Heat Function of Temperature Curve Name

optional

curve = a + b*wb + c*wb**2 + d*ewt + e*ewt**2 + f*wb*ewt

wb = entering wet-bulb temperature (C)

ewt = water entering temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Speed 6 Waste Heat Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_6_waste_heat_function_of_temperature_curve_name or None if not set Return type:str

speed_7_energy_input_ratio_function_of_air_flow_fraction_curve_name

field Speed 7 Energy Input Ratio Function of Air Flow Fraction Curve Name

optional

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 7 Energy Input Ratio Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_7_energy_input_ratio_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_7_energy_input_ratio_function_of_temperature_curve_name

field Speed 7 Energy Input Ratio Function of Temperature Curve Name

optional

curve = a + b*wb + c*wb**2 + d*ewt + e*ewt**2 + f*wb*ewt

wb = entering wet-bulb temperature (C)

ewt = water entering temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Speed 7 Energy Input Ratio Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_7_energy_input_ratio_function_of_temperature_curve_name or None if not set Return type:str

speed_7_energy_input_ratio_function_of_water_flow_fraction_curve_name

field Speed 7 Energy Input Ratio Function of Water Flow Fraction Curve Name

optional

quadratic curve = a + b*ffw + c*ffw**2

cubic curve = a + b*ffw + c*ffw**2 + d*ffw**3

ffw = Fraction of the full load Water Flow

Parameters:value (str) – value for IDD Field Speed 7 Energy Input Ratio Function of Water Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_7_energy_input_ratio_function_of_water_flow_fraction_curve_name or None if not set Return type:str

speed_7_reference_unit_gross_rated_cooling_cop

field Speed 7 Reference Unit Gross Rated Cooling COP

Units: dimensionless

Parameters:value (float) – value for IDD Field Speed 7 Reference Unit Gross Rated Cooling COP Raises:ValueError – if value is not a valid value Returns:the value of speed_7_reference_unit_gross_rated_cooling_cop or None if not set Return type:float

speed_7_reference_unit_gross_rated_sensible_heat_ratio

field Speed 7 Reference Unit Gross Rated Sensible Heat Ratio

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Speed 7 Reference Unit Gross Rated Sensible Heat Ratio Raises:ValueError – if value is not a valid value Returns:the value of speed_7_reference_unit_gross_rated_sensible_heat_ratio or None if not set Return type:float

speed_7_reference_unit_gross_rated_total_cooling_capacity

field Speed 7 Reference Unit Gross Rated Total Cooling Capacity

Total cooling capacity not accounting for the effect of supply air fan heat

Units: w

Parameters:value (float) – value for IDD Field Speed 7 Reference Unit Gross Rated Total Cooling Capacity Raises:ValueError – if value is not a valid value Returns:the value of speed_7_reference_unit_gross_rated_total_cooling_capacity or None if not set Return type:float

speed_7_reference_unit_rated_air_flow_rate

field Speed 7 Reference Unit Rated Air Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 7 Reference Unit Rated Air Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_7_reference_unit_rated_air_flow_rate or None if not set Return type:float

speed_7_reference_unit_rated_water_flow_rate

field Speed 7 Reference Unit Rated Water Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 7 Reference Unit Rated Water Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_7_reference_unit_rated_water_flow_rate or None if not set Return type:float

speed_7_reference_unit_waste_heat_fraction_of_input_power_at_rated_conditions

field Speed 7 Reference Unit Waste Heat Fraction of Input Power At Rated Conditions

Units: dimensionless

Parameters:value (float) – value for IDD Field Speed 7 Reference Unit Waste Heat Fraction of Input Power At Rated Conditions Raises:ValueError – if value is not a valid value Returns:the value of speed_7_reference_unit_waste_heat_fraction_of_input_power_at_rated_conditions or None if not set Return type:float

speed_7_total_cooling_capacity_function_of_air_flow_fraction_curve_name

field Speed 7 Total Cooling Capacity Function of Air Flow Fraction Curve Name

optional

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 7 Total Cooling Capacity Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_7_total_cooling_capacity_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_7_total_cooling_capacity_function_of_temperature_curve_name

field Speed 7 Total Cooling Capacity Function of Temperature Curve Name

optional

curve = a + b*wb + c*wb**2 + d*ewt + e*ewt**2 + f*wb*ewt

wb = entering wet-bulb temperature (C)

ewt = water entering temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Speed 7 Total Cooling Capacity Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_7_total_cooling_capacity_function_of_temperature_curve_name or None if not set Return type:str

speed_7_total_cooling_capacity_function_of_water_flow_fraction_curve_name

field Speed 7 Total Cooling Capacity Function of Water Flow Fraction Curve Name

optional

quadratic curve = a + b*ffw + c*ffw**2

cubic curve = a + b*ffw + c*ffw**2 + d*ffw**3

ffw = Fraction of the full load Water Flow

Parameters:value (str) – value for IDD Field Speed 7 Total Cooling Capacity Function of Water Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_7_total_cooling_capacity_function_of_water_flow_fraction_curve_name or None if not set Return type:str

speed_7_waste_heat_function_of_temperature_curve_name

field Speed 7 Waste Heat Function of Temperature Curve Name

optional

curve = a + b*wb + c*wb**2 + d*ewt + e*ewt**2 + f*wb*ewt

wb = entering wet-bulb temperature (C)

ewt = water entering temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Speed 7 Waste Heat Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_7_waste_heat_function_of_temperature_curve_name or None if not set Return type:str

speed_8_energy_input_ratio_function_of_air_flow_fraction_curve_name

field Speed 8 Energy Input Ratio Function of Air Flow Fraction Curve Name

optional

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 8 Energy Input Ratio Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_8_energy_input_ratio_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_8_energy_input_ratio_function_of_temperature_curve_name

field Speed 8 Energy Input Ratio Function of Temperature Curve Name

optional

curve = a + b*wb + c*wb**2 + d*ewt + e*ewt**2 + f*wb*ewt

wb = entering wet-bulb temperature (C)

ewt = water entering temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Speed 8 Energy Input Ratio Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_8_energy_input_ratio_function_of_temperature_curve_name or None if not set Return type:str

speed_8_energy_input_ratio_function_of_water_flow_fraction_curve_name

field Speed 8 Energy Input Ratio Function of Water Flow Fraction Curve Name

optional

quadratic curve = a + b*ffw + c*ffw**2

cubic curve = a + b*ffw + c*ffw**2 + d*ffw**3

ffw = Fraction of the full load Water Flow

Parameters:value (str) – value for IDD Field Speed 8 Energy Input Ratio Function of Water Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_8_energy_input_ratio_function_of_water_flow_fraction_curve_name or None if not set Return type:str

speed_8_reference_unit_gross_rated_cooling_cop

field Speed 8 Reference Unit Gross Rated Cooling COP

Units: dimensionless

Parameters:value (float) – value for IDD Field Speed 8 Reference Unit Gross Rated Cooling COP Raises:ValueError – if value is not a valid value Returns:the value of speed_8_reference_unit_gross_rated_cooling_cop or None if not set Return type:float

speed_8_reference_unit_gross_rated_sensible_heat_ratio

field Speed 8 Reference Unit Gross Rated Sensible Heat Ratio

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Speed 8 Reference Unit Gross Rated Sensible Heat Ratio Raises:ValueError – if value is not a valid value Returns:the value of speed_8_reference_unit_gross_rated_sensible_heat_ratio or None if not set Return type:float

speed_8_reference_unit_gross_rated_total_cooling_capacity

field Speed 8 Reference Unit Gross Rated Total Cooling Capacity

Total cooling capacity not accounting for the effect of supply air fan heat

Units: w

Parameters:value (float) – value for IDD Field Speed 8 Reference Unit Gross Rated Total Cooling Capacity Raises:ValueError – if value is not a valid value Returns:the value of speed_8_reference_unit_gross_rated_total_cooling_capacity or None if not set Return type:float

speed_8_reference_unit_rated_air_flow_rate

field Speed 8 Reference Unit Rated Air Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 8 Reference Unit Rated Air Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_8_reference_unit_rated_air_flow_rate or None if not set Return type:float

speed_8_reference_unit_rated_water_flow_rate

field Speed 8 Reference Unit Rated Water Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 8 Reference Unit Rated Water Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_8_reference_unit_rated_water_flow_rate or None if not set Return type:float

speed_8_reference_unit_waste_heat_fraction_of_input_power_at_rated_conditions

field Speed 8 Reference Unit Waste Heat Fraction of Input Power At Rated Conditions

Units: dimensionless

Parameters:value (float) – value for IDD Field Speed 8 Reference Unit Waste Heat Fraction of Input Power At Rated Conditions Raises:ValueError – if value is not a valid value Returns:the value of speed_8_reference_unit_waste_heat_fraction_of_input_power_at_rated_conditions or None if not set Return type:float

speed_8_total_cooling_capacity_function_of_air_flow_fraction_curve_name

field Speed 8 Total Cooling Capacity Function of Air Flow Fraction Curve Name

optional

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 8 Total Cooling Capacity Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_8_total_cooling_capacity_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_8_total_cooling_capacity_function_of_temperature_curve_name

field Speed 8 Total Cooling Capacity Function of Temperature Curve Name

optional

curve = a + b*wb + c*wb**2 + d*ewt + e*ewt**2 + f*wb*ewt

wb = entering wet-bulb temperature (C)

ewt = water entering temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Speed 8 Total Cooling Capacity Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_8_total_cooling_capacity_function_of_temperature_curve_name or None if not set Return type:str

speed_8_total_cooling_capacity_function_of_water_flow_fraction_curve_name

field Speed 8 Total Cooling Capacity Function of Water Flow Fraction Curve Name

optional

quadratic curve = a + b*ffw + c*ffw**2

cubic curve = a + b*ffw + c*ffw**2 + d*ffw**3

ffw = Fraction of the full load Water Flow

Parameters:value (str) – value for IDD Field Speed 8 Total Cooling Capacity Function of Water Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_8_total_cooling_capacity_function_of_water_flow_fraction_curve_name or None if not set Return type:str

speed_8_waste_heat_function_of_temperature_curve_name

field Speed 8 Waste Heat Function of Temperature Curve Name

optional

curve = a + b*wb + c*wb**2 + d*ewt + e*ewt**2 + f*wb*ewt

wb = entering wet-bulb temperature (C)

ewt = water entering temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Speed 8 Waste Heat Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_8_waste_heat_function_of_temperature_curve_name or None if not set Return type:str

speed_9_energy_input_ratio_function_of_air_flow_fraction_curve_name

field Speed 9 Energy Input Ratio Function of Air Flow Fraction Curve Name

optional

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 9 Energy Input Ratio Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_9_energy_input_ratio_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_9_energy_input_ratio_function_of_temperature_curve_name

field Speed 9 Energy Input Ratio Function of Temperature Curve Name

optional

curve = a + b*wb + c*wb**2 + d*ewt + e*ewt**2 + f*wb*ewt

wb = entering wet-bulb temperature (C)

ewt = water entering temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Speed 9 Energy Input Ratio Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_9_energy_input_ratio_function_of_temperature_curve_name or None if not set Return type:str

speed_9_energy_input_ratio_function_of_water_flow_fraction_curve_name

field Speed 9 Energy Input Ratio Function of Water Flow Fraction Curve Name

optional

quadratic curve = a + b*ffw + c*ffw**2

cubic curve = a + b*ffw + c*ffw**2 + d*ffw**3

ffw = Fraction of the full load Water Flow

Parameters:value (str) – value for IDD Field Speed 9 Energy Input Ratio Function of Water Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_9_energy_input_ratio_function_of_water_flow_fraction_curve_name or None if not set Return type:str

speed_9_reference_unit_gross_rated_cooling_cop

field Speed 9 Reference Unit Gross Rated Cooling COP

Units: dimensionless

Parameters:value (float) – value for IDD Field Speed 9 Reference Unit Gross Rated Cooling COP Raises:ValueError – if value is not a valid value Returns:the value of speed_9_reference_unit_gross_rated_cooling_cop or None if not set Return type:float

speed_9_reference_unit_gross_rated_sensible_heat_ratio

field Speed 9 Reference Unit Gross Rated Sensible Heat Ratio

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Speed 9 Reference Unit Gross Rated Sensible Heat Ratio Raises:ValueError – if value is not a valid value Returns:the value of speed_9_reference_unit_gross_rated_sensible_heat_ratio or None if not set Return type:float

speed_9_reference_unit_gross_rated_total_cooling_capacity

field Speed 9 Reference Unit Gross Rated Total Cooling Capacity

Total cooling capacity not accounting for the effect of supply air fan heat

Units: w

Parameters:value (float) – value for IDD Field Speed 9 Reference Unit Gross Rated Total Cooling Capacity Raises:ValueError – if value is not a valid value Returns:the value of speed_9_reference_unit_gross_rated_total_cooling_capacity or None if not set Return type:float

speed_9_reference_unit_rated_air_flow_rate

field Speed 9 Reference Unit Rated Air Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 9 Reference Unit Rated Air Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_9_reference_unit_rated_air_flow_rate or None if not set Return type:float

speed_9_reference_unit_rated_water_flow_rate

field Speed 9 Reference Unit Rated Water Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 9 Reference Unit Rated Water Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_9_reference_unit_rated_water_flow_rate or None if not set Return type:float

speed_9_reference_unit_waste_heat_fraction_of_input_power_at_rated_conditions

field Speed 9 Reference Unit Waste Heat Fraction of Input Power At Rated Conditions

Units: dimensionless

Parameters:value (float) – value for IDD Field Speed 9 Reference Unit Waste Heat Fraction of Input Power At Rated Conditions Raises:ValueError – if value is not a valid value Returns:the value of speed_9_reference_unit_waste_heat_fraction_of_input_power_at_rated_conditions or None if not set Return type:float

speed_9_total_cooling_capacity_function_of_air_flow_fraction_curve_name

field Speed 9 Total Cooling Capacity Function of Air Flow Fraction Curve Name

optional

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 9 Total Cooling Capacity Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_9_total_cooling_capacity_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_9_total_cooling_capacity_function_of_temperature_curve_name

field Speed 9 Total Cooling Capacity Function of Temperature Curve Name

optional

curve = a + b*wb + c*wb**2 + d*ewt + e*ewt**2 + f*wb*ewt

wb = entering wet-bulb temperature (C)

ewt = water entering temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Speed 9 Total Cooling Capacity Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_9_total_cooling_capacity_function_of_temperature_curve_name or None if not set Return type:str

speed_9_total_cooling_capacity_function_of_water_flow_fraction_curve_name

field Speed 9 Total Cooling Capacity Function of Water Flow Fraction Curve Name

optional

quadratic curve = a + b*ffw + c*ffw**2

cubic curve = a + b*ffw + c*ffw**2 + d*ffw**3

ffw = Fraction of the full load Water Flow

Parameters:value (str) – value for IDD Field Speed 9 Total Cooling Capacity Function of Water Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_9_total_cooling_capacity_function_of_water_flow_fraction_curve_name or None if not set Return type:str

speed_9_waste_heat_function_of_temperature_curve_name

field Speed 9 Waste Heat Function of Temperature Curve Name

optional

curve = a + b*wb + c*wb**2 + d*ewt + e*ewt**2 + f*wb*ewt

wb = entering wet-bulb temperature (C)

ewt = water entering temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Speed 9 Waste Heat Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_9_waste_heat_function_of_temperature_curve_name or None if not set Return type:str

watertorefrigerant_hx_water_inlet_node_name

field Water-to-Refrigerant HX Water Inlet Node Name

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

watertorefrigerant_hx_water_outlet_node_name

field Water-to-Refrigerant HX Water Outlet Node Name

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

class pyidf.coils.CoilHeatingDesuperheater

Bases: pyidf.helper.DataObject

Corresponds to IDD object Coil:Heating:Desuperheater Desuperheater air heating coil. The heating energy provided by this coil is reclaimed from the superheated refrigerant gas leaving a compressor and does not impact the performance of the compressor. If the coil is located directly in an air loop branch or outdoor air equipment list, then it is controlled on leaving air temperature and the Temperature Setpoint Node Name must be specified. If the coil is contained within another component such as a unitary system, then the coil is controlled by the parent component and the setpoint node name is not entered.

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

heat_reclaim_recovery_efficiency

field Heat Reclaim Recovery Efficiency

Parameters:value (float) – value for IDD Field Heat Reclaim Recovery Efficiency Raises:ValueError – if value is not a valid value Returns:the value of heat_reclaim_recovery_efficiency or None if not set Return type:float

heating_source_name

field Heating Source Name

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

heating_source_object_type

field Heating Source Object Type

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

name

field Name

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

parasitic_electric_load

field Parasitic Electric Load

parasitic electric load associated with the desuperheater coil operation

such as solenoid valves, etc.

Units: W

IP-Units: W

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

temperature_setpoint_node_name

field Temperature Setpoint Node Name

Required if coil is temperature controlled.

Temperature-based control requires the use of a SetpointManager object

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

class pyidf.coils.CoilHeatingDxMultiSpeed

Bases: pyidf.helper.DataObject

Corresponds to IDD object Coil:Heating:DX:MultiSpeed Direct expansion (DX) heating coil (air-to-air heat pump) and compressor unit (includes electric or engine-driven compressor and outdoor fan), multi-speed (or variable-speed), with defrost controls. Requires two to four sets of performance data and will interpolate between speeds.

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

apply_part_load_fraction_to_speeds_greater_than_1

field Apply Part Load Fraction to Speeds Greater than 1

Default value: No

Parameters:value (str) – value for IDD Field Apply Part Load Fraction to Speeds Greater than 1 Raises:ValueError – if value is not a valid value Returns:the value of apply_part_load_fraction_to_speeds_greater_than_1 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

crankcase_heater_capacity

field Crankcase Heater Capacity

Units: W

IP-Units: W

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

defrost_control

field Defrost Control

Default value: Timed

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

defrost_energy_input_ratio_function_of_temperature_curve_name

field Defrost Energy Input Ratio Function of Temperature Curve Name

biquadratic curve = a + b*wb + c*wb**2 + d*oat + e*oat**2 + f*wb*oat

wb = wet-bulb temperature (C) of air entering the indoor coil

oat = outdoor air dry-bulb temperature (C)

only required if ReverseCycle defrost strategy is specified

Parameters:value (str) – value for IDD Field Defrost Energy Input Ratio Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of defrost_energy_input_ratio_function_of_temperature_curve_name or None if not set Return type:str

defrost_strategy

field Defrost Strategy

Default value: ReverseCycle

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

defrost_time_period_fraction

field Defrost Time Period Fraction

Fraction of time in defrost mode

only applicable if timed defrost control is specified

Default value: 0.058333

Parameters:value (float) – value for IDD Field Defrost Time Period Fraction Raises:ValueError – if value is not a valid value Returns:the value of defrost_time_period_fraction or None if not set Return type:float

fuel_type

field Fuel Type

Default value: NaturalGas

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

maximum_outdoor_drybulb_temperature_for_crankcase_heater_operation

field Maximum Outdoor Dry-Bulb Temperature for Crankcase Heater Operation

Units: C

Default value: 10.0

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

maximum_outdoor_drybulb_temperature_for_defrost_operation

field Maximum Outdoor Dry-Bulb Temperature for Defrost Operation

Units: C

Default value: 5.0

value <= 7.22

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

minimum_outdoor_drybulb_temperature_for_compressor_operation

field Minimum Outdoor Dry-Bulb Temperature for Compressor Operation

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

number_of_speeds

field Number of Speeds

Enter the number of the following sets of data for coil capacity, COP,

flow rate, and associated curves.

value >= 2

value <= 4

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

outdoor_drybulb_temperature_to_turn_on_compressor

field Outdoor Dry-Bulb Temperature to Turn On Compressor

The outdoor temperature when the compressor is automatically turned back on following an

automatic shut off because of low outdoor dry-bulb temperature. This field is only used

for the calculation of HSPF. If this field is not provided, then outdoor bin temperature

used in the HSPF calculation is always considered to be greater than this temperature and

‘Minimum Outdoor Dry-Bulb Temperature for Compressor Operation’ field described above.

This assumption is based on AHRI standard 210/240 (2008) and can introduce significant error

in the final value of HSPF.

Units: C

Parameters:value (float) – value for IDD Field Outdoor Dry-Bulb Temperature to Turn On Compressor Raises:ValueError – if value is not a valid value Returns:the value of outdoor_drybulb_temperature_to_turn_on_compressor or None if not set Return type:float

region_number_for_calculating_hspf

field Region number for Calculating HSPF

Standard Region number for which HSPF and other standard ratings are calculated

Default value: 4

value >= 1

value <= 6

Parameters:value (int) – value for IDD Field Region number for Calculating HSPF Raises:ValueError – if value is not a valid value Returns:the value of region_number_for_calculating_hspf or None if not set Return type:int

resistive_defrost_heater_capacity

field Resistive Defrost Heater Capacity

only applicable if resistive defrost strategy is specified

Units: W

IP-Units: W

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

speed_1_energy_input_ratio_function_of_flow_fraction_curve_name

field Speed 1 Energy Input Ratio Function of Flow Fraction Curve Name

quadratic curve = a + b*ff + c*ff**2

cubic curve = a + b*ff + c*ff**2 + d*ff**3

ff = fraction of the full load flow

Parameters:value (str) – value for IDD Field Speed 1 Energy Input Ratio Function of Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_1_energy_input_ratio_function_of_flow_fraction_curve_name or None if not set Return type:str

speed_1_energy_input_ratio_function_of_temperature_curve_name

field Speed 1 Energy Input Ratio Function of Temperature Curve Name

quadratic curve = a + b*oat + c*oat**2

cubic curve = a + b*oat + c*oat**2 + d*oat**3

biquadratic curve = a + b*iat + c*iat**2 + d*oat + e*oat**2 + f*iat*oat

oat = outdoor air dry-bulb temperature (C)

iat = indoor air dry-bulb temperature (C)

biquadratic curve is recommended if sufficient manufacturer data is

available for the energy input ratio to be sensitive to both iat and oat.

Parameters:value (str) – value for IDD Field Speed 1 Energy Input Ratio Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_1_energy_input_ratio_function_of_temperature_curve_name or None if not set Return type:str

speed_1_gross_rated_heating_capacity

field Speed 1 Gross Rated Heating Capacity

Heating capacity not accounting for the effect of supply air fan heat

capacity excluding supply air fan heat

rating point outdoor dry-bulb temp 8.33 C, outdoor wet-bulb temp 6.11 C

rating point heating coil entering air dry-bulb 21.11 C, coil entering

wet-bulb 15.55 C

Units: W

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

speed_1_gross_rated_heating_cop

field Speed 1 Gross Rated Heating COP

Rated heating capacity divided by power input to the compressor and outdoor fan,

does not include supply air fan heat or supply air fan electrical energy

Units: W/W

Parameters:value (float) – value for IDD Field Speed 1 Gross Rated Heating COP Raises:ValueError – if value is not a valid value Returns:the value of speed_1_gross_rated_heating_cop or None if not set Return type:float

speed_1_heating_capacity_function_of_flow_fraction_curve_name

field Speed 1 Heating Capacity Function of Flow Fraction Curve Name

quadratic curve = a + b*ff + c*ff**2

cubic curve = a + b*ff + c*ff**2 + d*ff**3

ff = fraction of the full load flow

Parameters:value (str) – value for IDD Field Speed 1 Heating Capacity Function of Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_1_heating_capacity_function_of_flow_fraction_curve_name or None if not set Return type:str

speed_1_heating_capacity_function_of_temperature_curve_name

field Speed 1 Heating Capacity Function of Temperature Curve Name

quadratic curve = a + b*oat + c*oat**2

cubic curve = a + b*oat + c*oat**2 + d*oat**3

biquadratic curve = a + b*iat + c*iat**2 + d*oat + e*oat**2 + f*iat*oat

oat = outdoor air dry-bulb temperature (C)

iat = indoor air dry-bulb temperature (C)

biquadratic curve is recommended if sufficient manufacturer data is

available for the heating capacity to be sensitive to both iat and oat.

Parameters:value (str) – value for IDD Field Speed 1 Heating Capacity Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_1_heating_capacity_function_of_temperature_curve_name or None if not set Return type:str

speed_1_nominal_sensible_heat_ratio_of_secondary_coil

field Speed 1 Nominal Sensible Heat Ratio of Secondary Coil

This input value is the nominal sensible heat ratio used to split the heat extracted by

a secondary DX coil (evaporator) of a heat pump into sensible and latent components.

This is an optional input field. If this input field is left blank, then pure sensible

internal heat gain is assumed, i.e., sensible heat ratio of 1.0.

Units: m3/s

value <= 1.0

Parameters:value (float) – value for IDD Field Speed 1 Nominal Sensible Heat Ratio of Secondary Coil Raises:ValueError – if value is not a valid value Returns:the value of speed_1_nominal_sensible_heat_ratio_of_secondary_coil or None if not set Return type:float

speed_1_part_load_fraction_correlation_curve_name

field Speed 1 Part Load Fraction Correlation Curve Name

quadratic curve = a + b*PLR + c*PLR**2

cubic curve = a + b*PLR + c*PLR**2 + d*PLR**3

PLR = part load ratio (sensible heating load/steady state heating capacity)

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

speed_1_rated_air_flow_rate

field Speed 1 Rated Air Flow Rate

Flow rate corresponding to rated total capacity

should be between 0.00004027 m3/s and .00006041 m3/s per watt of rated total

heating capacity

Units: m3/s

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

speed_1_rated_supply_air_fan_power_per_volume_flow_rate

field Speed 1 Rated Supply Air Fan Power Per Volume Flow Rate

Enter the supply air fan power per air volume flow rate at the rated speed 1 test conditions.

The test conditions vary external static pressure based on heating capacity. This value

is only used to calculate Heating Seasonal Performance Factor(HSPF). This value is not

used for modeling the supply air fan during simulations.

Units: W/(m3/s)

Default value: 773.3

value <= 1250.0

Parameters:value (float) – value for IDD Field Speed 1 Rated Supply Air Fan Power Per Volume Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_1_rated_supply_air_fan_power_per_volume_flow_rate or None if not set Return type:float

speed_1_rated_waste_heat_fraction_of_power_input

field Speed 1 Rated Waste Heat Fraction of Power Input

recoverable waste heat at full load and rated conditions

Units: dimensionless

Default value: 0.2

value <= 1.0

Parameters:value (float) – value for IDD Field Speed 1 Rated Waste Heat Fraction of Power Input Raises:ValueError – if value is not a valid value Returns:the value of speed_1_rated_waste_heat_fraction_of_power_input or None if not set Return type:float

speed_1_secondary_coil_air_flow_rate

field Speed 1 Secondary Coil Air Flow Rate

This input value is the secondary coil (evaporator) air flow rate when the heat pump

is working in heating mode or the secondary DX coil (condenser) air flow rate when the

heat pump is working in cooling mode.

Units: m3/s

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

speed_1_secondary_coil_fan_flow_scaling_factor

field Speed 1 Secondary Coil Fan Flow Scaling Factor

This input field is scaling factor for autosizing the secondary DX coil fan flow rate.

The secondary air flow rate is determined by multiplying the primary DX coil rated air

flow rate by the fan flow scaling factor. Default value is 1.25. If the secondary coil

fan flow rate is not autosized, then the secondary coil fan flow scaling factor is set

to 1.0.

Units: m3/s

Default value: 1.25

Parameters:value (float) – value for IDD Field Speed 1 Secondary Coil Fan Flow Scaling Factor Raises:ValueError – if value is not a valid value Returns:the value of speed_1_secondary_coil_fan_flow_scaling_factor or None if not set Return type:float

speed_1_sensible_heat_ratio_modifier_function_of_flow_fraction_curve_name

field Speed 1 Sensible Heat Ratio Modifier Function of Flow Fraction Curve Name

quadratic curve = a + b*ff + c*ff**2

cubic curve = a + b*ff + c*ff**2 + d*ff**3

ff = secondary air flow fraction of the full load flow

This input field is name of sensible heat ratio modifier curve. The value

of this curve modifies the nominal sensible heat ratio for current time step depending

on the secondary coil air flow fraction. This is an optional input field. If this input

field is left blank, then the nominal sensible heat ratio specified will be used.

Parameters:value (str) – value for IDD Field Speed 1 Sensible Heat Ratio Modifier Function of Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_1_sensible_heat_ratio_modifier_function_of_flow_fraction_curve_name or None if not set Return type:str

speed_1_sensible_heat_ratio_modifier_function_of_temperature_curve_name

field Speed 1 Sensible Heat Ratio Modifier Function of Temperature Curve Name

curve = a + b*wb + c*wb**2 + d*db + e*db**2 + f*wb*db

wb = entering wet-bulb temperature seen by the secondary DX coil (C)

db = entering dry-bulb temperature seen by the primary DX coil (C)

This input field is name of sensible heat ratio modifier biquadratic curve. The value

of this curve modifies the nominal sensible heat ratio for current time step depending

on the secondary zone air node wet-bulb temperature and the heating DX coil entering

air dry-bulb temperature. This is an optional input field. If this input field is left

blank, then the nominal sensible heat ratio specified in the field above will be used.

Parameters:value (str) – value for IDD Field Speed 1 Sensible Heat Ratio Modifier Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_1_sensible_heat_ratio_modifier_function_of_temperature_curve_name or None if not set Return type:str

speed_1_waste_heat_function_of_temperature_curve_name

field Speed 1 Waste Heat Function of Temperature Curve Name

curve = a + b*odb + c*odb**2 + d*db + e*db**2 + f*odb*db

odb = Outdoor air dry-bulb temperature (C)

db = entering coil dry-bulb temperature (C)

Parameters:value (str) – value for IDD Field Speed 1 Waste Heat Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_1_waste_heat_function_of_temperature_curve_name or None if not set Return type:str

speed_2_energy_input_ratio_function_of_flow_fraction_curve_name

field Speed 2 Energy Input Ratio Function of Flow Fraction Curve Name

quadratic curve = a + b*ff + c*ff**2

cubic curve = a + b*ff + c*ff**2 + d*ff**3

ff = fraction of the full load flow

Parameters:value (str) – value for IDD Field Speed 2 Energy Input Ratio Function of Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_2_energy_input_ratio_function_of_flow_fraction_curve_name or None if not set Return type:str

speed_2_energy_input_ratio_function_of_temperature_curve_name

field Speed 2 Energy Input Ratio Function of Temperature Curve Name

quadratic curve = a + b*oat + c*oat**2

cubic curve = a + b*oat + c*oat**2 + d*oat**3

biquadratic curve = a + b*iat + c*iat**2 + d*oat + e*oat**2 + f*iat*oat

oat = outdoor air dry-bulb temperature (C)

iat = indoor air dry-bulb temperature (C)

biquadratic curve is recommended if sufficient manufacturer data is

available for the energy input ratio to be sensitive to both iat and oat.

Parameters:value (str) – value for IDD Field Speed 2 Energy Input Ratio Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_2_energy_input_ratio_function_of_temperature_curve_name or None if not set Return type:str

speed_2_gross_rated_heating_capacity

field Speed 2 Gross Rated Heating Capacity

Heating capacity not accounting for the effect of supply air fan heat

capacity excluding supply air fan heat

rating point outdoor dry-bulb temp 8.33 C, outdoor wet-bulb temp 6.11 C

rating point heating coil entering air dry-bulb 21.11 C, coil entering

wet-bulb 15.55 C

Units: W

Parameters:value (float or “Autosize”) – value for IDD Field Speed 2 Gross Rated Heating Capacity Raises:ValueError – if value is not a valid value Returns:the value of speed_2_gross_rated_heating_capacity or None if not set Return type:float or “Autosize”

speed_2_gross_rated_heating_cop

field Speed 2 Gross Rated Heating COP

Rated heating capacity divided by power input to the compressor and outdoor fan,

does not include supply air fan heat or supply air fan electrical energy

Units: W/W

Parameters:value (float) – value for IDD Field Speed 2 Gross Rated Heating COP Raises:ValueError – if value is not a valid value Returns:the value of speed_2_gross_rated_heating_cop or None if not set Return type:float

speed_2_heating_capacity_function_of_flow_fraction_curve_name

field Speed 2 Heating Capacity Function of Flow Fraction Curve Name

quadratic curve = a + b*ff + c*ff**2

cubic curve = a + b*ff + c*ff**2 + d*ff**3

ff = fraction of the full load flow

Parameters:value (str) – value for IDD Field Speed 2 Heating Capacity Function of Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_2_heating_capacity_function_of_flow_fraction_curve_name or None if not set Return type:str

speed_2_heating_capacity_function_of_temperature_curve_name

field Speed 2 Heating Capacity Function of Temperature Curve Name

quadratic curve = a + b*oat + c*oat**2

cubic curve = a + b*oat + c*oat**2 + d*oat**3

biquadratic curve = a + b*iat + c*iat**2 + d*oat + e*oat**2 + f*iat*oat

oat = outdoor air dry-bulb temperature (C)

iat = indoor air dry-bulb temperature (C)

biquadratic curve is recommended if sufficient manufacturer data is

available for the heating capacity to be sensitive to both iat and oat.

Parameters:value (str) – value for IDD Field Speed 2 Heating Capacity Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_2_heating_capacity_function_of_temperature_curve_name or None if not set Return type:str

speed_2_nominal_sensible_heat_ratio_of_secondary_coil

field Speed 2 Nominal Sensible Heat Ratio of Secondary Coil

This input value is the nominal sensible heat ratio used to split the heat extracted by

a secondary DX coil (evaporator) of a heat pump into sensible and latent components.

This is an optional input field. If this input field is left blank, then pure sensible

internal heat gain is assumed, i.e., sensible heat ratio of 1.0.

Units: m3/s

value <= 1.0

Parameters:value (float) – value for IDD Field Speed 2 Nominal Sensible Heat Ratio of Secondary Coil Raises:ValueError – if value is not a valid value Returns:the value of speed_2_nominal_sensible_heat_ratio_of_secondary_coil or None if not set Return type:float

speed_2_part_load_fraction_correlation_curve_name

field Speed 2 Part Load Fraction Correlation Curve Name

quadratic curve = a + b*PLR + c*PLR**2

cubic curve = a + b*PLR + c*PLR**2 + d*PLR**3

PLR = part load ratio (sensible heating load/steady state heating capacity)

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

speed_2_rated_air_flow_rate

field Speed 2 Rated Air Flow Rate

Flow rate corresponding to rated total capacity

should be between 0.00004027 m3/s and .00006041 m3/s per watt of rated total

heating capacity

Units: m3/s

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

speed_2_rated_supply_air_fan_power_per_volume_flow_rate

field Speed 2 Rated Supply Air Fan Power Per Volume Flow Rate

Enter the supply air fan power per air volume flow rate at the rated speed 2 test conditions.

The test conditions vary external static pressure based on heating capacity. This value

is only used to calculate Heating Seasonal Performance Factor(HSPF). This value is not

used for modeling the supply air fan during simulations.

Units: W/(m3/s)

Default value: 773.3

value <= 1250.0

Parameters:value (float) – value for IDD Field Speed 2 Rated Supply Air Fan Power Per Volume Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_2_rated_supply_air_fan_power_per_volume_flow_rate or None if not set Return type:float

speed_2_rated_waste_heat_fraction_of_power_input

field Speed 2 Rated Waste Heat Fraction of Power Input

recoverable waste heat at full load and rated conditions

Units: dimensionless

Default value: 0.2

value <= 1.0

Parameters:value (float) – value for IDD Field Speed 2 Rated Waste Heat Fraction of Power Input Raises:ValueError – if value is not a valid value Returns:the value of speed_2_rated_waste_heat_fraction_of_power_input or None if not set Return type:float

speed_2_secondary_coil_air_flow_rate

field Speed 2 Secondary Coil Air Flow Rate

This input value is the secondary coil (evaporator) air flow rate when the heat pump

is working in heating mode or the secondary DX coil (condenser) air flow rate when the

heat pump is working in cooling mode.

Units: m3/s

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

speed_2_secondary_coil_fan_flow_scaling_factor

field Speed 2 Secondary Coil Fan Flow Scaling Factor

This input field is scaling factor for autosizing the secondary DX coil fan flow rate.

The secondary air flow rate is determined by multiplying the primary DX coil rated air

flow rate by the fan flow scaling factor. Default value is 1.25. If the secondary coil

fan flow rate is not autosized, then the secondary coil fan flow scaling factor is set

to 1.0.

Units: m3/s

Default value: 1.25

Parameters:value (float) – value for IDD Field Speed 2 Secondary Coil Fan Flow Scaling Factor Raises:ValueError – if value is not a valid value Returns:the value of speed_2_secondary_coil_fan_flow_scaling_factor or None if not set Return type:float

speed_2_sensible_heat_ratio_modifier_function_of_flow_fraction_curve_name

field Speed 2 Sensible Heat Ratio Modifier Function of Flow Fraction Curve Name

quadratic curve = a + b*ff + c*ff**2

cubic curve = a + b*ff + c*ff**2 + d*ff**3

ff = secondary air flow fraction of the full load flow

This input field is name of sensible heat ratio modifier curve. The value

of this curve modifies the nominal sensible heat ratio for current time step depending

on the secondary coil air flow fraction. This is an optional input field. If this input

field is left blank, then the nominal sensible heat ratio specified will be used.

Parameters:value (str) – value for IDD Field Speed 2 Sensible Heat Ratio Modifier Function of Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_2_sensible_heat_ratio_modifier_function_of_flow_fraction_curve_name or None if not set Return type:str

speed_2_sensible_heat_ratio_modifier_function_of_temperature_curve_name

field Speed 2 Sensible Heat Ratio Modifier Function of Temperature Curve Name

curve = a + b*wb + c*wb**2 + d*db + e*db**2 + f*wb*db

wb = entering wet-bulb temperature seen by the secondary DX coil (C)

db = entering dry-bulb temperature seen by the primary DX coil (C)

This input field is name of sensible heat ratio modifier biquadratic curve. The value

of this curve modifies the nominal sensible heat ratio for current time step depending

on the secondary zone air node wet-bulb temperature and the heating DX coil entering

air dry-bulb temperature. This is an optional input field. If this input field is left

blank, then the nominal sensible heat ratio specified in the field above will be used.

Parameters:value (str) – value for IDD Field Speed 2 Sensible Heat Ratio Modifier Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_2_sensible_heat_ratio_modifier_function_of_temperature_curve_name or None if not set Return type:str

speed_2_waste_heat_function_of_temperature_curve_name

field Speed 2 Waste Heat Function of Temperature Curve Name

curve = a + b*odb + c*odb**2 + d*db + e*db**2 + f*odb*db

odb = Outdoor air dry-bulb temperature (C)

db = entering coil dry-bulb temperature (C)

Parameters:value (str) – value for IDD Field Speed 2 Waste Heat Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_2_waste_heat_function_of_temperature_curve_name or None if not set Return type:str

speed_3_energy_input_ratio_function_of_flow_fraction_curve_name

field Speed 3 Energy Input Ratio Function of Flow Fraction Curve Name

quadratic curve = a + b*ff + c*ff**2

cubic curve = a + b*ff + c*ff**2 + d*ff**3

ff = fraction of the full load flow

Parameters:value (str) – value for IDD Field Speed 3 Energy Input Ratio Function of Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_3_energy_input_ratio_function_of_flow_fraction_curve_name or None if not set Return type:str

speed_3_energy_input_ratio_function_of_temperature_curve_name

field Speed 3 Energy Input Ratio Function of Temperature Curve Name

quadratic curve = a + b*oat + c*oat**2

cubic curve = a + b*oat + c*oat**2 + d*oat**3

biquadratic curve = a + b*iat + c*iat**2 + d*oat + e*oat**2 + f*iat*oat

oat = outdoor air dry-bulb temperature (C)

iat = indoor air dry-bulb temperature (C)

biquadratic curve is recommended if sufficient manufacturer data is

available for the energy input ratio to be sensitive to both iat and oat.

Parameters:value (str) – value for IDD Field Speed 3 Energy Input Ratio Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_3_energy_input_ratio_function_of_temperature_curve_name or None if not set Return type:str

speed_3_gross_rated_heating_capacity

field Speed 3 Gross Rated Heating Capacity

Heating capacity not accounting for the effect of supply air fan heat

capacity excluding supply air fan heat

rating point outdoor dry-bulb temp 8.33 C, outdoor wet-bulb temp 6.11 C

rating point heating coil entering air dry-bulb 21.11 C, coil entering

wet-bulb 15.55 C

Units: W

Parameters:value (float or “Autosize”) – value for IDD Field Speed 3 Gross Rated Heating Capacity Raises:ValueError – if value is not a valid value Returns:the value of speed_3_gross_rated_heating_capacity or None if not set Return type:float or “Autosize”

speed_3_gross_rated_heating_cop

field Speed 3 Gross Rated Heating COP

Rated heating capacity divided by power input to the compressor and outdoor fan,

does not include supply air fan heat or supply air fan electrical energy

Units: W/W

Parameters:value (float) – value for IDD Field Speed 3 Gross Rated Heating COP Raises:ValueError – if value is not a valid value Returns:the value of speed_3_gross_rated_heating_cop or None if not set Return type:float

speed_3_heating_capacity_function_of_flow_fraction_curve_name

field Speed 3 Heating Capacity Function of Flow Fraction Curve Name

quadratic curve = a + b*ff + c*ff**2

cubic curve = a + b*ff + c*ff**2 + d*ff**3

ff = fraction of the full load flow

Parameters:value (str) – value for IDD Field Speed 3 Heating Capacity Function of Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_3_heating_capacity_function_of_flow_fraction_curve_name or None if not set Return type:str

speed_3_heating_capacity_function_of_temperature_curve_name

field Speed 3 Heating Capacity Function of Temperature Curve Name

quadratic curve = a + b*oat + c*oat**2

cubic curve = a + b*oat + c*oat**2 + d*oat**3

biquadratic curve = a + b*iat + c*iat**2 + d*oat + e*oat**2 + f*iat*oat

oat = outdoor air dry-bulb temperature (C)

iat = indoor air dry-bulb temperature (C)

biquadratic curve is recommended if sufficient manufacturer data is

available for the heating capacity to be sensitive to both iat and oat.

Parameters:value (str) – value for IDD Field Speed 3 Heating Capacity Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_3_heating_capacity_function_of_temperature_curve_name or None if not set Return type:str

speed_3_nominal_sensible_heat_ratio_of_secondary_coil

field Speed 3 Nominal Sensible Heat Ratio of Secondary Coil

This input value is the nominal sensible heat ratio used to split the heat extracted by

a secondary DX coil (evaporator) of a heat pump into sensible and latent components.

This is an optional input field. If this input field is left blank, then pure sensible

internal heat gain is assumed, i.e., sensible heat ratio of 1.0.

Units: m3/s

value <= 1.0

Parameters:value (float) – value for IDD Field Speed 3 Nominal Sensible Heat Ratio of Secondary Coil Raises:ValueError – if value is not a valid value Returns:the value of speed_3_nominal_sensible_heat_ratio_of_secondary_coil or None if not set Return type:float

speed_3_part_load_fraction_correlation_curve_name

field Speed 3 Part Load Fraction Correlation Curve Name

quadratic curve = a + b*PLR + c*PLR**2

cubic curve = a + b*PLR + c*PLR**2 + d*PLR**3

PLR = part load ratio (sensible heating load/steady state heating capacity)

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

speed_3_rated_air_flow_rate

field Speed 3 Rated Air Flow Rate

Flow rate corresponding to rated total capacity

should be between 0.00004027 m3/s and .00006041 m3/s per watt of rated total

heating capacity

Units: m3/s

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

speed_3_rated_supply_air_fan_power_per_volume_flow_rate

field Speed 3 Rated Supply Air Fan Power Per Volume Flow Rate

Enter the supply air fan power per air volume flow rate at the rated speed 3 test conditions.

The test conditions vary external static pressure based on heating capacity. This value

is only used to calculate Heating Seasonal Performance Factor(HSPF). This value is not

used for modeling the supply air fan during simulations.

Units: W/(m3/s)

Default value: 773.3

value <= 1250.0

Parameters:value (float) – value for IDD Field Speed 3 Rated Supply Air Fan Power Per Volume Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_3_rated_supply_air_fan_power_per_volume_flow_rate or None if not set Return type:float

speed_3_rated_waste_heat_fraction_of_power_input

field Speed 3 Rated Waste Heat Fraction of Power Input

recoverable waste heat at full load and rated conditions

Units: dimensionless

Default value: 0.2

value <= 1.0

Parameters:value (float) – value for IDD Field Speed 3 Rated Waste Heat Fraction of Power Input Raises:ValueError – if value is not a valid value Returns:the value of speed_3_rated_waste_heat_fraction_of_power_input or None if not set Return type:float

speed_3_secondary_coil_air_flow_rate

field Speed 3 Secondary Coil Air Flow Rate

This input value is the secondary coil (evaporator) air flow rate when the heat pump

is working in heating mode or the secondary DX coil (condenser) air flow rate when the

heat pump is working in cooling mode.

Units: m3/s

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

speed_3_secondary_coil_fan_flow_scaling_factor

field Speed 3 Secondary Coil Fan Flow Scaling Factor

This input field is scaling factor for autosizing the secondary DX coil fan flow rate.

The secondary air flow rate is determined by multiplying the primary DX coil rated air

flow rate by the fan flow scaling factor. Default value is 1.25. If the secondary coil

fan flow rate is not autosized, then the secondary coil fan flow scaling factor is set

to 1.0.

Units: m3/s

Default value: 1.25

Parameters:value (float) – value for IDD Field Speed 3 Secondary Coil Fan Flow Scaling Factor Raises:ValueError – if value is not a valid value Returns:the value of speed_3_secondary_coil_fan_flow_scaling_factor or None if not set Return type:float

speed_3_sensible_heat_ratio_modifier_function_of_flow_fraction_curve_name

field Speed 3 Sensible Heat Ratio Modifier Function of Flow Fraction Curve Name

quadratic curve = a + b*ff + c*ff**2

cubic curve = a + b*ff + c*ff**2 + d*ff**3

ff = secondary air flow fraction of the full load flow

This input field is name of sensible heat ratio modifier curve. The value

of this curve modifies the nominal sensible heat ratio for current time step depending

on the secondary coil air flow fraction. This is an optional input field. If this input

field is left blank, then the nominal sensible heat ratio specified will be used.

Parameters:value (str) – value for IDD Field Speed 3 Sensible Heat Ratio Modifier Function of Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_3_sensible_heat_ratio_modifier_function_of_flow_fraction_curve_name or None if not set Return type:str

speed_3_sensible_heat_ratio_modifier_function_of_temperature_curve_name

field Speed 3 Sensible Heat Ratio Modifier Function of Temperature Curve Name

curve = a + b*wb + c*wb**2 + d*db + e*db**2 + f*wb*db

wb = entering wet-bulb temperature seen by the secondary DX coil (C)

db = entering dry-bulb temperature seen by the primary DX coil (C)

This input field is name of sensible heat ratio modifier biquadratic curve. The value

of this curve modifies the nominal sensible heat ratio for current time step depending

on the secondary zone air node wet-bulb temperature and the heating DX coil entering

air dry-bulb temperature. This is an optional input field. If this input field is left

blank, then the nominal sensible heat ratio specified in the field above will be used.

Parameters:value (str) – value for IDD Field Speed 3 Sensible Heat Ratio Modifier Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_3_sensible_heat_ratio_modifier_function_of_temperature_curve_name or None if not set Return type:str

speed_3_waste_heat_function_of_temperature_curve_name

field Speed 3 Waste Heat Function of Temperature Curve Name

curve = a + b*odb + c*odb**2 + d*db + e*db**2 + f*odb*db

odb = Outdoor air dry-bulb temperature (C)

db = entering coil dry-bulb temperature (C)

Parameters:value (str) – value for IDD Field Speed 3 Waste Heat Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_3_waste_heat_function_of_temperature_curve_name or None if not set Return type:str

speed_4_energy_input_ratio_function_of_flow_fraction_curve_name

field Speed 4 Energy Input Ratio Function of Flow Fraction Curve Name

quadratic curve = a + b*ff + c*ff**2

cubic curve = a + b*ff + c*ff**2 + d*ff**3

ff = fraction of the full load flow

Parameters:value (str) – value for IDD Field Speed 4 Energy Input Ratio Function of Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_4_energy_input_ratio_function_of_flow_fraction_curve_name or None if not set Return type:str

speed_4_energy_input_ratio_function_of_temperature_curve_name

field Speed 4 Energy Input Ratio Function of Temperature Curve Name

quadratic curve = a + b*oat + c*oat**2

cubic curve = a + b*oat + c*oat**2 + d*oat**3

biquadratic curve = a + b*iat + c*iat**2 + d*oat + e*oat**2 + f*iat*oat

oat = outdoor air dry-bulb temperature (C)

iat = indoor air dry-bulb temperature (C)

biquadratic curve is recommended if sufficient manufacturer data is

available for the energy input ratio to be sensitive to both iat and oat.

Parameters:value (str) – value for IDD Field Speed 4 Energy Input Ratio Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_4_energy_input_ratio_function_of_temperature_curve_name or None if not set Return type:str

speed_4_gross_rated_heating_capacity

field Speed 4 Gross Rated Heating Capacity

Heating capacity not accounting for the effect of supply air fan heat

capacity excluding supply air fan heat

rating point outdoor dry-bulb temp 8.33 C, outdoor wet-bulb temp 6.11 C

rating point heating coil entering air dry-bulb 21.11 C, coil entering

wet-bulb 15.55 C

Units: W

Parameters:value (float or “Autosize”) – value for IDD Field Speed 4 Gross Rated Heating Capacity Raises:ValueError – if value is not a valid value Returns:the value of speed_4_gross_rated_heating_capacity or None if not set Return type:float or “Autosize”

speed_4_gross_rated_heating_cop

field Speed 4 Gross Rated Heating COP

Rated heating capacity divided by power input to the compressor and outdoor fan,

does not include supply air fan heat or supply air fan electrical energy

Units: W/W

Parameters:value (float) – value for IDD Field Speed 4 Gross Rated Heating COP Raises:ValueError – if value is not a valid value Returns:the value of speed_4_gross_rated_heating_cop or None if not set Return type:float

speed_4_heating_capacity_function_of_flow_fraction_curve_name

field Speed 4 Heating Capacity Function of Flow Fraction Curve Name

quadratic curve = a + b*ff + c*ff**2

cubic curve = a + b*ff + c*ff**2 + d*ff**3

ff = fraction of the full load flow

Parameters:value (str) – value for IDD Field Speed 4 Heating Capacity Function of Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_4_heating_capacity_function_of_flow_fraction_curve_name or None if not set Return type:str

speed_4_heating_capacity_function_of_temperature_curve_name

field Speed 4 Heating Capacity Function of Temperature Curve Name

quadratic curve = a + b*oat + c*oat**2

cubic curve = a + b*oat + c*oat**2 + d*oat**3

biquadratic curve = a + b*iat + c*iat**2 + d*oat + e*oat**2 + f*iat*oat

oat = outdoor air dry-bulb temperature (C)

iat = indoor air dry-bulb temperature (C)

biquadratic curve is recommended if sufficient manufacturer data is

available for the heating capacity to be sensitive to both iat and oat.

Parameters:value (str) – value for IDD Field Speed 4 Heating Capacity Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_4_heating_capacity_function_of_temperature_curve_name or None if not set Return type:str

speed_4_nominal_sensible_heat_ratio_of_secondary_coil

field Speed 4 Nominal Sensible Heat Ratio of Secondary Coil

This input value is the nominal sensible heat ratio used to split the heat extracted by

a secondary DX coil (evaporator) of a heat pump into sensible and latent components.

This is an optional input field. If this input field is left blank, then pure sensible

internal heat gain is assumed, i.e., sensible heat ratio of 1.0.

Units: m3/s

value <= 1.0

Parameters:value (float) – value for IDD Field Speed 4 Nominal Sensible Heat Ratio of Secondary Coil Raises:ValueError – if value is not a valid value Returns:the value of speed_4_nominal_sensible_heat_ratio_of_secondary_coil or None if not set Return type:float

speed_4_part_load_fraction_correlation_curve_name

field Speed 4 Part Load Fraction Correlation Curve Name

quadratic curve = a + b*PLR + c*PLR**2

cubic curve = a + b*PLR + c*PLR**2 + d*PLR**3

PLR = part load ratio (sensible heating load/steady state heating capacity)

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

speed_4_rated_air_flow_rate

field Speed 4 Rated Air Flow Rate

Flow rate corresponding to rated total capacity

should be between 0.00004027 m3/s and .00006041 m3/s per watt of rated total

heating capacity

Units: m3/s

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

speed_4_rated_supply_air_fan_power_per_volume_flow_rate

field Speed 4 Rated Supply Air Fan Power Per Volume Flow Rate

Enter the supply air fan power per air volume flow rate at the rated speed 4 test conditions.

The test conditions vary external static pressure based on heating capacity. This value

is only used to calculate Heating Seasonal Performance Factor(HSPF). This value is not

used for modeling the supply air fan during simulations.

Units: W/(m3/s)

Default value: 773.3

value <= 1250.0

Parameters:value (float) – value for IDD Field Speed 4 Rated Supply Air Fan Power Per Volume Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_4_rated_supply_air_fan_power_per_volume_flow_rate or None if not set Return type:float

speed_4_rated_waste_heat_fraction_of_power_input

field Speed 4 Rated Waste Heat Fraction of Power Input

recoverable waste heat at full load and rated conditions

Units: dimensionless

Default value: 0.2

value <= 1.0

Parameters:value (float) – value for IDD Field Speed 4 Rated Waste Heat Fraction of Power Input Raises:ValueError – if value is not a valid value Returns:the value of speed_4_rated_waste_heat_fraction_of_power_input or None if not set Return type:float

speed_4_secondary_coil_air_flow_rate

field Speed 4 Secondary Coil Air Flow Rate

This input value is the secondary coil (evaporator) air flow rate when the heat pump

is working in heating mode or the secondary DX coil (condenser) air flow rate when the

heat pump is working in cooling mode.

Units: m3/s

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

speed_4_secondary_coil_fan_flow_scaling_factor

field Speed 4 Secondary Coil Fan Flow Scaling Factor

This input field is scaling factor for autosizing the secondary DX coil fan flow rate.

The secondary air flow rate is determined by multiplying the primary DX coil rated air

flow rate by the fan flow scaling factor. Default value is 1.25. If the secondary coil

fan flow rate is not autosized, then the secondary coil fan flow scaling factor is set

to 1.0.

Units: m3/s

Default value: 1.25

Parameters:value (float) – value for IDD Field Speed 4 Secondary Coil Fan Flow Scaling Factor Raises:ValueError – if value is not a valid value Returns:the value of speed_4_secondary_coil_fan_flow_scaling_factor or None if not set Return type:float

speed_4_sensible_heat_ratio_modifier_function_of_flow_fraction_curve_name

field Speed 4 Sensible Heat Ratio Modifier Function of Flow Fraction Curve Name

quadratic curve = a + b*ff + c*ff**2

cubic curve = a + b*ff + c*ff**2 + d*ff**3

ff = secondary air flow fraction of the full load flow

This input field is name of sensible heat ratio modifier curve. The value

of this curve modifies the nominal sensible heat ratio for current time step depending

on the secondary coil air flow fraction. This is an optional input field. If this input

field is left blank, then the nominal sensible heat ratio specified will be used.

Parameters:value (str) – value for IDD Field Speed 4 Sensible Heat Ratio Modifier Function of Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_4_sensible_heat_ratio_modifier_function_of_flow_fraction_curve_name or None if not set Return type:str

speed_4_sensible_heat_ratio_modifier_function_of_temperature_curve_name

field Speed 4 Sensible Heat Ratio Modifier Function of Temperature Curve Name

curve = a + b*wb + c*wb**2 + d*db + e*db**2 + f*wb*db

wb = entering wet-bulb temperature seen by the secondary DX coil (C)

db = entering dry-bulb temperature seen by the primary DX coil (C)

This input field is name of sensible heat ratio modifier biquadratic curve. The value

of this curve modifies the nominal sensible heat ratio for current time step depending

on the secondary zone air node wet-bulb temperature and the heating DX coil entering

air dry-bulb temperature. This is an optional input field. If this input field is left

blank, then the nominal sensible heat ratio specified in the field above will be used.

Parameters:value (str) – value for IDD Field Speed 4 Sensible Heat Ratio Modifier Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_4_sensible_heat_ratio_modifier_function_of_temperature_curve_name or None if not set Return type:str

speed_4_waste_heat_function_of_temperature_curve_name

field Speed 4 Waste Heat Function of Temperature Curve Name

curve = a + b*odb + c*odb**2 + d*db + e*db**2 + f*odb*db

odb = Outdoor air dry-bulb temperature (C)

db = entering coil dry-bulb temperature (C)

Parameters:value (str) – value for IDD Field Speed 4 Waste Heat Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_4_waste_heat_function_of_temperature_curve_name or None if not set Return type:str

zone_name_for_evaporator_placement

field Zone Name for Evaporator Placement

This input field is name of a conditioned or unconditioned zone where the secondary

coil (evaporator) of a heat pump is to be placed. This is an optional input field

specified only when user desires to extract heat from the zone. The heat extracted

is modeled as internal heat gain of the zone. If the primary DX system is a heat pump,

then the zone name should be the same as the zone name specified for placing the

secondary cooling DX coil.

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

class pyidf.coils.CoilHeatingDxSingleSpeed

Bases: pyidf.helper.DataObject

Corresponds to IDD object Coil:Heating:DX:SingleSpeed Direct expansion (DX) heating coil (air-to-air heat pump) and compressor unit (includes electric compressor and outdoor fan), single-speed, with defrost controls.

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

crankcase_heater_capacity

field Crankcase Heater Capacity

Units: W

IP-Units: W

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

defrost_control

field Defrost Control

Default value: Timed

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

defrost_energy_input_ratio_function_of_temperature_curve_name

field Defrost Energy Input Ratio Function of Temperature Curve Name

biquadratic curve = a + b*wb + c*wb**2 + d*oat + e*oat**2 + f*wb*oat

wb = wet-bulb temperature (C) of air entering the indoor coil

oat = outdoor air dry-bulb temperature (C)

only required if ReverseCycle defrost strategy is specified

Parameters:value (str) – value for IDD Field Defrost Energy Input Ratio Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of defrost_energy_input_ratio_function_of_temperature_curve_name or None if not set Return type:str

defrost_strategy

field Defrost Strategy

Default value: ReverseCycle

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

defrost_time_period_fraction

field Defrost Time Period Fraction

Fraction of time in defrost mode

only applicable if timed defrost control is specified

Default value: 0.058333

Parameters:value (float) – value for IDD Field Defrost Time Period Fraction Raises:ValueError – if value is not a valid value Returns:the value of defrost_time_period_fraction or None if not set Return type:float

energy_input_ratio_function_of_flow_fraction_curve_name

field Energy Input Ratio Function of Flow Fraction Curve Name

quadratic curve = a + b*ff + c*ff**2

cubic curve = a + b*ff + c*ff**2 + d*ff**3

ff = fraction of the full load flow

Parameters:value (str) – value for IDD Field Energy Input Ratio Function of Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of energy_input_ratio_function_of_flow_fraction_curve_name or None if not set Return type:str

energy_input_ratio_function_of_temperature_curve_name

field Energy Input Ratio Function of Temperature Curve Name

quadratic curve = a + b*oat + c*oat**2

cubic curve = a + b*oat + c*oat**2 + d*oat**3

biquadratic curve = a + b*iat + c*iat**2 + d*oat + e*oat**2 + f*iat*oat

oat = outdoor air dry-bulb temperature (C)

iat = indoor air dry-bulb temperature (C)

biquadratic curve is recommended if sufficient manufacturer data is

available for the energy input ratio to be sensitive to both iat and oat.

Parameters:value (str) – value for IDD Field Energy Input Ratio Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of energy_input_ratio_function_of_temperature_curve_name or None if not set Return type:str

evaporator_air_inlet_node_name

field Evaporator Air Inlet Node Name

Enter the name of an outdoor air node. This node name is also specified in

an OutdoorAir:Node or OutdoorAir:NodeList object.

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

gross_rated_heating_capacity

field Gross Rated Heating Capacity

Heating capacity not accounting for the effect of supply air fan heat

capacity excluding supply air fan heat

rating point outdoor dry-bulb temp 8.33 C, outdoor wet-bulb temp 6.11 C

rating point heating coil entering air dry-bulb 21.11 C, coil entering wet-bulb 15.55 C

Units: W

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

gross_rated_heating_cop

field Gross Rated Heating COP

Rated heating capacity divided by power input to the compressor and outdoor fan,

does not include supply air fan heat or supply air fan electrical energy

does not include supply air fan heat or supply air fan electrical energy

Units: W/W

Parameters:value (float) – value for IDD Field Gross Rated Heating COP Raises:ValueError – if value is not a valid value Returns:the value of gross_rated_heating_cop or None if not set Return type:float

heating_capacity_function_of_flow_fraction_curve_name

field Heating Capacity Function of Flow Fraction Curve Name

quadratic curve = a + b*ff + c*ff**2

cubic curve = a + b*ff + c*ff**2 + d*ff**3

ff = fraction of the full load flow

Parameters:value (str) – value for IDD Field Heating Capacity Function of Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of heating_capacity_function_of_flow_fraction_curve_name or None if not set Return type:str

heating_capacity_function_of_temperature_curve_name

field Heating Capacity Function of Temperature Curve Name

quadratic curve = a + b*oat + c*oat**2

cubic curve = a + b*oat + c*oat**2 + d*oat**3

biquadratic curve = a + b*iat + c*iat**2 + d*oat + e*oat**2 + f*iat*oat

oat = outdoor air dry-bulb temperature (C)

iat = indoor air dry-bulb temperature (C)

Biquadratic curve is recommended if sufficient manufacturer data is

available for the heating capacity to be sensitive to both iat and oat.

Parameters:value (str) – value for IDD Field Heating Capacity Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of heating_capacity_function_of_temperature_curve_name or None if not set Return type:str

maximum_outdoor_drybulb_temperature_for_crankcase_heater_operation

field Maximum Outdoor Dry-Bulb Temperature for Crankcase Heater Operation

Units: C

Default value: 10.0

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

maximum_outdoor_drybulb_temperature_for_defrost_operation

field Maximum Outdoor Dry-Bulb Temperature for Defrost Operation

Units: C

Default value: 5.0

value <= 7.22

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

minimum_outdoor_drybulb_temperature_for_compressor_operation

field Minimum Outdoor Dry-Bulb Temperature for Compressor Operation

Units: C

Default value: -8.0

value >= -20.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

nominal_sensible_heat_ratio_of_secondary_coil

field Nominal Sensible Heat Ratio of Secondary Coil

This input value is the nominal sensible heat ratio used to split the heat extracted by

a secondary DX coil (evaporator) of a heat pump into sensible and latent components.

This is an optional input field. If this input field is left blank, then pure sensible

internal heat gain is assumed, i.e., sensible heat ratio of 1.0.

Units: m3/s

value <= 1.0

Parameters:value (float) – value for IDD Field Nominal Sensible Heat Ratio of Secondary Coil Raises:ValueError – if value is not a valid value Returns:the value of nominal_sensible_heat_ratio_of_secondary_coil or None if not set Return type:float

outdoor_drybulb_temperature_to_turn_on_compressor

field Outdoor Dry-Bulb Temperature to Turn On Compressor

The outdoor temperature when the compressor is automatically turned back on following an

automatic shut off because of low outdoor dry-bulb temperature. This field is only used

for the calculation of HSPF. If this field is not provided, then outdoor bin temperature

used in the HSPF calculation is always considered to be greater than this temperature and

‘Minimum Outdoor Dry-Bulb Temperature for Compressor Operation’ field described above.

This assumption is based on AHRI standard 210/240 (2008) and can introduce significant error

in the final value of HSPF.

Units: C

Parameters:value (float) – value for IDD Field Outdoor Dry-Bulb Temperature to Turn On Compressor Raises:ValueError – if value is not a valid value Returns:the value of outdoor_drybulb_temperature_to_turn_on_compressor or None if not set Return type:float

part_load_fraction_correlation_curve_name

field Part Load Fraction Correlation Curve Name

quadratic curve = a + b*PLR + c*PLR**2

cubic curve = a + b*PLR + c*PLR**2 + d*PLR**3

PLR = part load ratio (sensible heating load/steady state heating capacity)

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

rated_air_flow_rate

field Rated Air Flow Rate

Flow rate corresponding to rated total capacity

should be between 0.00004027 m3/s and .00006041 m3/s per watt of rated heating capacity

Units: m3/s

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

rated_supply_fan_power_per_volume_flow_rate

field Rated Supply Fan Power Per Volume Flow Rate

Enter the supply fan power per air volume flow rate at the rated test conditions.

The test conditions vary external static pressure based on heating capacity.

This value is only used to calculate Heating Seasonal Performance Factor(HSPF). This value is not

used for modeling the supply (condenser) fan during simulations.

Units: W/(m3/s)

Default value: 773.3

value <= 1250.0

Parameters:value (float) – value for IDD Field Rated Supply Fan Power Per Volume Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of rated_supply_fan_power_per_volume_flow_rate or None if not set Return type:float

region_number_for_calculating_hspf

field Region number for calculating HSPF

Standard Region number for which HSPF and other standard ratings are calculated

Default value: 4

value >= 1

value <= 6

Parameters:value (int) – value for IDD Field Region number for calculating HSPF Raises:ValueError – if value is not a valid value Returns:the value of region_number_for_calculating_hspf or None if not set Return type:int

resistive_defrost_heater_capacity

field Resistive Defrost Heater Capacity

only applicable if resistive defrost strategy is specified

Units: W

IP-Units: W

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

secondary_coil_air_flow_rate

field Secondary Coil Air Flow Rate

This input value is the secondary coil (evaporator) air flow rate when the heat pump

is working in heating mode or the secondary DX coil (condenser) air flow rate when the

heat pump is working in cooling mode.

Units: m3/s

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

secondary_coil_fan_flow_scaling_factor

field Secondary Coil Fan Flow Scaling Factor

This input field is scaling factor for autosizing the secondary DX coil fan flow rate.

The secondary air flow rate is determined by multiplying the primary DX coil rated air

flow rate by the fan flow scaling factor. Default value is 1.25. If the secondary coil

fan flow rate is not autosized, then the secondary coil fan flow scaling factor is set

to 1.0.

Units: m3/s

Default value: 1.25

Parameters:value (float) – value for IDD Field Secondary Coil Fan Flow Scaling Factor Raises:ValueError – if value is not a valid value Returns:the value of secondary_coil_fan_flow_scaling_factor or None if not set Return type:float

sensible_heat_ratio_modifier_function_of_flow_fraction_curve_name

field Sensible Heat Ratio Modifier Function of Flow Fraction Curve Name

quadratic curve = a + b*ff + c*ff**2

cubic curve = a + b*ff + c*ff**2 + d*ff**3

ff = secondary air flow fraction of the full load flow

This input field is name of sensible heat ratio modifier curve. The value

of this curve modifies the nominal sensible heat ratio for current time step depending

on the secondary coil air flow fraction. This is an optional input field. If this input

field is left blank, then the nominal sensible heat ratio specified will be used.

Parameters:value (str) – value for IDD Field Sensible Heat Ratio Modifier Function of Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of sensible_heat_ratio_modifier_function_of_flow_fraction_curve_name or None if not set Return type:str

sensible_heat_ratio_modifier_function_of_temperature_curve_name

field Sensible Heat Ratio Modifier Function of Temperature Curve Name

curve = a + b*wb + c*wb**2 + d*db + e*db**2 + f*wb*db

wb = entering wet-bulb temperature seen by the secondary DX coil (C)

db = entering dry-bulb temperature seen by the primary DX coil (C)

This input field is name of sensible heat ratio modifier biquadratic curve. The value

of this curve modifies the nominal sensible heat ratio for current time step depending

on the secondary zone air node wet-bulb temperature and the heating DX coil entering

air dry-bulb temperature. This is an optional input field. If this input field is left

blank, then the nominal sensible heat ratio specified in the field above will be used.

Parameters:value (str) – value for IDD Field Sensible Heat Ratio Modifier Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of sensible_heat_ratio_modifier_function_of_temperature_curve_name or None if not set Return type:str

zone_name_for_evaporator_placement

field Zone Name for Evaporator Placement

This input field is name of a conditioned or unconditioned zone where the secondary

coil (evaporator) of a heat pump is to be placed. This is an optional input field

specified only when user desires to extract heat from the zone. The heat extracted

is modelled as internal gain of the zone. If the primary DX system is a heat pump,

then the zone name should be the same as the zone name specified for placing the

secondary cooling DX coil.

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

class pyidf.coils.CoilHeatingDxVariableRefrigerantFlow

Bases: pyidf.helper.DataObject

Corresponds to IDD object Coil:Heating:DX:VariableRefrigerantFlow Variable refrigerant flow (VRF) direct expansion (DX) heating coil (air-to-air heat pump). Used with ZoneHVAC:TerminalUnit:VariableRefrigerantFlow. Condensing unit is modeled separately, see AirConditioner:VariableRefrigerantFlow.

availability_schedule

field Availability Schedule

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 Raises:ValueError – if value is not a valid value Returns:the value of availability_schedule or None if not set Return type:str

coil_air_inlet_node

field Coil Air Inlet Node

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

coil_air_outlet_node

field Coil Air Outlet Node

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

gross_rated_heating_capacity

field Gross Rated Heating Capacity

Heating capacity not accounting for the effect of supply air fan heat

capacity excluding supply air fan heat

rating point outside dry-bulb temp 8.33 C, outside wet-bulb temp 6.11 C

rating point heating coil entering air dry-bulb 21.11 C, coil entering wetbulb 15.55 C

Units: W

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

heating_capacity_modifier_function_of_flow_fraction_curve_name

field Heating Capacity Modifier Function of Flow Fraction Curve Name

quadratic curve = a + b*ff + c*ff**2

cubic curve = a + b*ff + c*ff**2 + d*ff**3

ff = fraction of the full load flow

Parameters:value (str) – value for IDD Field Heating Capacity Modifier Function of Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of heating_capacity_modifier_function_of_flow_fraction_curve_name or None if not set Return type:str

heating_capacity_ratio_modifier_function_of_temperature_curve_name

field Heating Capacity Ratio Modifier Function of Temperature Curve Name

Parameters:value (str) – value for IDD Field Heating Capacity Ratio Modifier Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of heating_capacity_ratio_modifier_function_of_temperature_curve_name or None if not set Return type:str

name

field Name

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

rated_air_flow_rate

field Rated Air Flow Rate

volume flow rate corresponding to rated total capacity

should be between 0.00004027 m3/s and .00006041 m3/s per watt of rated heating capacity

Units: m3/s

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

class pyidf.coils.CoilHeatingDxVariableRefrigerantFlowFluidTemperatureControl

Bases: pyidf.helper.DataObject

Corresponds to IDD object Coil:Heating:DX:VariableRefrigerantFlow:FluidTemperatureControl This is a key object in the new physics based VRF model applicable for Fluid Temperature Control. It describes the the indoor unit coil of the system at heating mode. Used with ZoneHVAC:TerminalUnit:VariableRefrigerantFlow. Outdoor unit is modeled separately, see AirConditioner:VariableRefrigerantFlow:FluidTemperatureControl.

availability_schedule

field Availability Schedule

Enter the name of a schedule that defines the availability of the coil

Schedule values of 0 denote the unit is off. All other values denote the unit is available

If this field is left blank, the unit is available the entire simulation

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

coil_air_inlet_node

field Coil Air Inlet Node

the inlet node to the coil

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

coil_air_outlet_node

field Coil Air Outlet Node

the outlet node to the coil

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

indoor_unit_condensing_temperature_function_of_subcooling_curve_name

field Indoor Unit Condensing Temperature Function of Subcooling Curve Name

Parameters:value (str) – value for IDD Field Indoor Unit Condensing Temperature Function of Subcooling Curve Name Raises:ValueError – if value is not a valid value Returns:the value of indoor_unit_condensing_temperature_function_of_subcooling_curve_name or None if not set Return type:str

indoor_unit_reference_subcooling

field Indoor Unit Reference Subcooling

Units: deltaC

Default value: 5.0

Parameters:value (float) – value for IDD Field Indoor Unit Reference Subcooling Raises:ValueError – if value is not a valid value Returns:the value of indoor_unit_reference_subcooling 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

rated_total_heating_capacity

field Rated Total Heating Capacity

Supply air fan heat is not included

Units: W

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

class pyidf.coils.CoilHeatingDxVariableSpeed

Bases: pyidf.helper.DataObject

Corresponds to IDD object Coil:Heating:DX:VariableSpeed Direct expansion (DX) heating coil (air-to-air heat pump) and compressor unit (includes electric compressor and outdoor fan), variable-speed, with defrost controls. Requires two to ten sets of performance data and will interpolate between speeds.

crankcase_heater_capacity

field Crankcase Heater Capacity

Units: W

IP-Units: W

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

defrost_control

field Defrost Control

Default value: Timed

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

defrost_energy_input_ratio_function_of_temperature_curve_name

field Defrost Energy Input Ratio Function of Temperature Curve Name

biquadratic curve = a + b*wb + c*wb**2 + d*oat + e*oat**2 + f*wb*oat

wb = wet-bulb temperature (C) of air entering the indoor coil

oat = outdoor air dry-bulb temperature (C)

only required if ReverseCycle defrost strategy is specified

Parameters:value (str) – value for IDD Field Defrost Energy Input Ratio Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of defrost_energy_input_ratio_function_of_temperature_curve_name or None if not set Return type:str

defrost_strategy

field Defrost Strategy

Default value: ReverseCycle

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

defrost_time_period_fraction

field Defrost Time Period Fraction

Fraction of time in defrost mode

only applicable if timed defrost control is specified

Default value: 0.058333

Parameters:value (float) – value for IDD Field Defrost Time Period Fraction Raises:ValueError – if value is not a valid value Returns:the value of defrost_time_period_fraction or None if not set Return type:float

energy_part_load_fraction_curve_name

field Energy Part Load Fraction Curve Name

quadratic curve = a + b*PLR + c*PLR**2

cubic curve = a + b*PLR + c*PLR**2 + d*PLR**3

PLR = part load ratio (heating load/steady state capacity)

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

indoor_air_inlet_node_name

field Indoor Air Inlet Node Name

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

indoor_air_outlet_node_name

field Indoor Air Outlet Node Name

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

maximum_outdoor_drybulb_temperature_for_crankcase_heater_operation

field Maximum Outdoor Dry-Bulb Temperature for Crankcase Heater Operation

Units: C

Default value: 10.0

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

maximum_outdoor_drybulb_temperature_for_defrost_operation

field Maximum Outdoor Dry-Bulb Temperature for Defrost Operation

Units: C

Default value: 5.0

value <= 7.22

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

minimum_outdoor_drybulb_temperature_for_compressor_operation

field Minimum Outdoor Dry-Bulb Temperature for Compressor Operation

Units: C

Default value: -8.0

value >= -50.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

nominal_speed_level

field Nominal Speed Level

must be lower than or equal to the highest speed number

Units: dimensionless

Default value: 2

Parameters:value (int) – value for IDD Field Nominal Speed Level Raises:ValueError – if value is not a valid value Returns:the value of nominal_speed_level or None if not set Return type:int

number_of_speeds

field Number of Speeds

Units: dimensionless

Default value: 2

value >= 1

value <= 10

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

outdoor_drybulb_temperature_to_turn_on_compressor

field Outdoor Dry-Bulb Temperature to Turn On Compressor

The outdoor temperature when the compressor is automatically turned back on following an

automatic shut off because of low outdoor dry-bulb temperature. This field is only used

for the calculation of HSPF. If this field is not provided, then outdoor bin temperature

used in the HSPF calculation is always considered to be greater than this temperature and

‘Minimum Outdoor Dry-Bulb Temperature for Compressor Operation’ field described above.

This assumption is based on AHRI standard 210/240 (2008) and can introduce significant error

in the final value of HSPF.

Units: C

Parameters:value (float) – value for IDD Field Outdoor Dry-Bulb Temperature to Turn On Compressor Raises:ValueError – if value is not a valid value Returns:the value of outdoor_drybulb_temperature_to_turn_on_compressor or None if not set Return type:float

rated_air_flow_rate_at_selected_nominal_speed_level

field Rated Air Flow Rate At Selected Nominal Speed Level

Units: m3/s

Default value: “autosize”

Parameters:value (float or “Autosize”) – value for IDD Field Rated Air Flow Rate At Selected Nominal Speed Level Raises:ValueError – if value is not a valid value Returns:the value of rated_air_flow_rate_at_selected_nominal_speed_level or None if not set Return type:float or “Autosize”

rated_heating_capacity_at_selected_nominal_speed_level

field Rated Heating Capacity At Selected Nominal Speed Level

Units: w

Default value: “autosize”

Parameters:value (float or “Autosize”) – value for IDD Field Rated Heating Capacity At Selected Nominal Speed Level Raises:ValueError – if value is not a valid value Returns:the value of rated_heating_capacity_at_selected_nominal_speed_level or None if not set Return type:float or “Autosize”

resistive_defrost_heater_capacity

field Resistive Defrost Heater Capacity

only applicable if resistive defrost strategy is specified

Units: W

IP-Units: W

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

speed_10_energy_input_ratio_function_of_air_flow_fraction_curve_name

field Speed 10 Energy Input Ratio Function of Air Flow Fraction Curve Name

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 10 Energy Input Ratio Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_10_energy_input_ratio_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_10_energy_input_ratio_function_of_temperature_curve_name

field Speed 10 Energy Input Ratio Function of Temperature Curve Name

curve = a + b*db + c*db**2 + d*oat + e*oat**2 + f*db*oat

db = entering air dry-bulb temperature (C)

oat = air entering temperature seen by the evaporator (C)

Parameters:value (str) – value for IDD Field Speed 10 Energy Input Ratio Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_10_energy_input_ratio_function_of_temperature_curve_name or None if not set Return type:str

speed_10_heating_capacity_function_of_air_flow_fraction_curve_name

field Speed 10 Heating Capacity Function of Air Flow Fraction Curve Name

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 10 Heating Capacity Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_10_heating_capacity_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_10_heating_capacity_function_of_temperature_curve_name

field Speed 10 Heating Capacity Function of Temperature Curve Name

curve = a + b*db + c*db**2 + d*oat + e*oat**2 + f*db*oat

db = entering air dry-bulb temperature (C)

oat = air entering temperature seen by the evaporator (C)

Parameters:value (str) – value for IDD Field Speed 10 Heating Capacity Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_10_heating_capacity_function_of_temperature_curve_name or None if not set Return type:str

speed_10_reference_unit_gross_rated_heating_capacity

field Speed 10 Reference Unit Gross Rated Heating Capacity

Heating capacity not accounting for the effect of supply air fan heat

Units: w

Parameters:value (float) – value for IDD Field Speed 10 Reference Unit Gross Rated Heating Capacity Raises:ValueError – if value is not a valid value Returns:the value of speed_10_reference_unit_gross_rated_heating_capacity or None if not set Return type:float

speed_10_reference_unit_gross_rated_heating_cop

field Speed 10 Reference Unit Gross Rated Heating COP

Units: dimensionless

Parameters:value (float) – value for IDD Field Speed 10 Reference Unit Gross Rated Heating COP Raises:ValueError – if value is not a valid value Returns:the value of speed_10_reference_unit_gross_rated_heating_cop or None if not set Return type:float

speed_10_reference_unit_rated_air_flow_rate

field Speed 10 Reference Unit Rated Air Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 10 Reference Unit Rated Air Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_10_reference_unit_rated_air_flow_rate or None if not set Return type:float

speed_1_energy_input_ratio_function_of_air_flow_fraction_curve_name

field Speed 1 Energy Input Ratio Function of Air Flow Fraction Curve Name

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 1 Energy Input Ratio Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_1_energy_input_ratio_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_1_energy_input_ratio_function_of_temperature_curve_name

field Speed 1 Energy Input Ratio Function of Temperature Curve Name

curve = a + b*db + c*db**2 + d*oat + e*oat**2 + f*db*oat

db = entering air dry-bulb temperature (C)

oat = air entering temperature seen by the evaporator (C)

Parameters:value (str) – value for IDD Field Speed 1 Energy Input Ratio Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_1_energy_input_ratio_function_of_temperature_curve_name or None if not set Return type:str

speed_1_heating_capacity_function_of_temperature_curve_name

field Speed 1 Heating Capacity Function of Temperature Curve Name

curve = a + b*db + c*db**2 + d*oat + e*oat**2 + f*db*oat

db = entering air dry-bulb temperature (C)

oat = air entering temperature seen by the evaporator (C)

Parameters:value (str) – value for IDD Field Speed 1 Heating Capacity Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_1_heating_capacity_function_of_temperature_curve_name or None if not set Return type:str

speed_1_reference_unit_gross_rated_heating_capacity

field Speed 1 Reference Unit Gross Rated Heating Capacity

Heating capacity not accounting for the effect of supply air fan heat

Units: w

Parameters:value (float) – value for IDD Field Speed 1 Reference Unit Gross Rated Heating Capacity Raises:ValueError – if value is not a valid value Returns:the value of speed_1_reference_unit_gross_rated_heating_capacity or None if not set Return type:float

speed_1_reference_unit_gross_rated_heating_cop

field Speed 1 Reference Unit Gross Rated Heating COP

Units: dimensionless

Parameters:value (float) – value for IDD Field Speed 1 Reference Unit Gross Rated Heating COP Raises:ValueError – if value is not a valid value Returns:the value of speed_1_reference_unit_gross_rated_heating_cop or None if not set Return type:float

speed_1_reference_unit_rated_air_flow_rate

field Speed 1 Reference Unit Rated Air Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 1 Reference Unit Rated Air Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_1_reference_unit_rated_air_flow_rate or None if not set Return type:float

speed_1_total_heating_capacity_function_of_air_flow_fraction_curve_name

field Speed 1 Total Heating Capacity Function of Air Flow Fraction Curve Name

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 1 Total Heating Capacity Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_1_total_heating_capacity_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_2_energy_input_ratio_function_of_air_flow_fraction_curve_name

field Speed 2 Energy Input Ratio Function of Air Flow Fraction Curve Name

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 2 Energy Input Ratio Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_2_energy_input_ratio_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_2_energy_input_ratio_function_of_temperature_curve_name

field Speed 2 Energy Input Ratio Function of Temperature Curve Name

curve = a + b*db + c*db**2 + d*oat + e*oat**2 + f*db*oat

db = entering air dry-bulb temperature (C)

oat = air entering temperature seen by the evaporator (C)

Parameters:value (str) – value for IDD Field Speed 2 Energy Input Ratio Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_2_energy_input_ratio_function_of_temperature_curve_name or None if not set Return type:str

speed_2_heating_capacity_function_of_temperature_curve_name

field Speed 2 Heating Capacity Function of Temperature Curve Name

curve = a + b*db + c*db**2 + d*oat + e*oat**2 + f*db*oat

db = entering air dry-bulb temperature (C)

oat = air entering temperature seen by the evaporator (C)

Parameters:value (str) – value for IDD Field Speed 2 Heating Capacity Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_2_heating_capacity_function_of_temperature_curve_name or None if not set Return type:str

speed_2_reference_unit_gross_rated_heating_capacity

field Speed 2 Reference Unit Gross Rated Heating Capacity

Heating capacity not accounting for the effect of supply air fan heat

Units: w

Parameters:value (float) – value for IDD Field Speed 2 Reference Unit Gross Rated Heating Capacity Raises:ValueError – if value is not a valid value Returns:the value of speed_2_reference_unit_gross_rated_heating_capacity or None if not set Return type:float

speed_2_reference_unit_gross_rated_heating_cop

field Speed 2 Reference Unit Gross Rated Heating COP

Units: dimensionless

Parameters:value (float) – value for IDD Field Speed 2 Reference Unit Gross Rated Heating COP Raises:ValueError – if value is not a valid value Returns:the value of speed_2_reference_unit_gross_rated_heating_cop or None if not set Return type:float

speed_2_reference_unit_rated_air_flow_rate

field Speed 2 Reference Unit Rated Air Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 2 Reference Unit Rated Air Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_2_reference_unit_rated_air_flow_rate or None if not set Return type:float

speed_2_total_heating_capacity_function_of_air_flow_fraction_curve_name

field Speed 2 Total Heating Capacity Function of Air Flow Fraction Curve Name

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 2 Total Heating Capacity Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_2_total_heating_capacity_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_3_energy_input_ratio_function_of_air_flow_fraction_curve_name

field Speed 3 Energy Input Ratio Function of Air Flow Fraction Curve Name

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 3 Energy Input Ratio Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_3_energy_input_ratio_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_3_energy_input_ratio_function_of_temperature_curve_name

field Speed 3 Energy Input Ratio Function of Temperature Curve Name

curve = a + b*db + c*db**2 + d*oat + e*oat**2 + f*db*oat

db = entering air dry-bulb temperature (C)

oat = air entering temperature seen by the evaporator (C)

Parameters:value (str) – value for IDD Field Speed 3 Energy Input Ratio Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_3_energy_input_ratio_function_of_temperature_curve_name or None if not set Return type:str

speed_3_heating_capacity_function_of_temperature_curve_name

field Speed 3 Heating Capacity Function of Temperature Curve Name

curve = a + b*db + c*db**2 + d*oat + e*oat**2 + f*db*oat

db = entering air dry-bulb temperature (C)

oat = air entering temperature seen by the evaporator (C)

Parameters:value (str) – value for IDD Field Speed 3 Heating Capacity Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_3_heating_capacity_function_of_temperature_curve_name or None if not set Return type:str

speed_3_reference_unit_gross_rated_heating_capacity

field Speed 3 Reference Unit Gross Rated Heating Capacity

Heating capacity not accounting for the effect of supply air fan heat

Units: w

Parameters:value (float) – value for IDD Field Speed 3 Reference Unit Gross Rated Heating Capacity Raises:ValueError – if value is not a valid value Returns:the value of speed_3_reference_unit_gross_rated_heating_capacity or None if not set Return type:float

speed_3_reference_unit_gross_rated_heating_cop

field Speed 3 Reference Unit Gross Rated Heating COP

Units: dimensionless

Parameters:value (float) – value for IDD Field Speed 3 Reference Unit Gross Rated Heating COP Raises:ValueError – if value is not a valid value Returns:the value of speed_3_reference_unit_gross_rated_heating_cop or None if not set Return type:float

speed_3_reference_unit_rated_air_flow_rate

field Speed 3 Reference Unit Rated Air Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 3 Reference Unit Rated Air Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_3_reference_unit_rated_air_flow_rate or None if not set Return type:float

speed_3_total_heating_capacity_function_of_air_flow_fraction_curve_name

field Speed 3 Total Heating Capacity Function of Air Flow Fraction Curve Name

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 3 Total Heating Capacity Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_3_total_heating_capacity_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_4_energy_input_ratio_function_of_air_flow_fraction_curve_name

field Speed 4 Energy Input Ratio Function of Air Flow Fraction Curve Name

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 4 Energy Input Ratio Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_4_energy_input_ratio_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_4_energy_input_ratio_function_of_temperature_curve_name

field Speed 4 Energy Input Ratio Function of Temperature Curve Name

curve = a + b*db + c*db**2 + d*oat + e*oat**2 + f*db*oat

db = entering air dry-bulb temperature (C)

oat = air entering temperature seen by the evaporator (C)

Parameters:value (str) – value for IDD Field Speed 4 Energy Input Ratio Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_4_energy_input_ratio_function_of_temperature_curve_name or None if not set Return type:str

speed_4_heating_capacity_function_of_air_flow_fraction_curve_name

field Speed 4 Heating Capacity Function of Air Flow Fraction Curve Name

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 4 Heating Capacity Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_4_heating_capacity_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_4_heating_capacity_function_of_temperature_curve_name

field Speed 4 Heating Capacity Function of Temperature Curve Name

curve = a + b*db + c*db**2 + d*oat + e*oat**2 + f*db*oat

db = entering air dry-bulb temperature (C)

oat = air entering temperature seen by the evaporator (C)

Parameters:value (str) – value for IDD Field Speed 4 Heating Capacity Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_4_heating_capacity_function_of_temperature_curve_name or None if not set Return type:str

speed_4_reference_unit_gross_rated_heating_capacity

field Speed 4 Reference Unit Gross Rated Heating Capacity

Heating capacity not accounting for the effect of supply air fan heat

Units: w

Parameters:value (float) – value for IDD Field Speed 4 Reference Unit Gross Rated Heating Capacity Raises:ValueError – if value is not a valid value Returns:the value of speed_4_reference_unit_gross_rated_heating_capacity or None if not set Return type:float

speed_4_reference_unit_gross_rated_heating_cop

field Speed 4 Reference Unit Gross Rated Heating COP

Units: dimensionless

Parameters:value (float) – value for IDD Field Speed 4 Reference Unit Gross Rated Heating COP Raises:ValueError – if value is not a valid value Returns:the value of speed_4_reference_unit_gross_rated_heating_cop or None if not set Return type:float

speed_4_reference_unit_rated_air_flow_rate

field Speed 4 Reference Unit Rated Air Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 4 Reference Unit Rated Air Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_4_reference_unit_rated_air_flow_rate or None if not set Return type:float

speed_5_energy_input_ratio_function_of_air_flow_fraction_curve_name

field Speed 5 Energy Input Ratio Function of Air Flow Fraction Curve Name

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 5 Energy Input Ratio Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_5_energy_input_ratio_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_5_energy_input_ratio_function_of_temperature_curve_name

field Speed 5 Energy Input Ratio Function of Temperature Curve Name

curve = a + b*db + c*db**2 + d*oat + e*oat**2 + f*db*oat

db = entering air dry-bulb temperature (C)

oat = air entering temperature seen by the evaporator (C)

Parameters:value (str) – value for IDD Field Speed 5 Energy Input Ratio Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_5_energy_input_ratio_function_of_temperature_curve_name or None if not set Return type:str

speed_5_heating_capacity_function_of_air_flow_fraction_curve_name

field Speed 5 Heating Capacity Function of Air Flow Fraction Curve Name

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 5 Heating Capacity Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_5_heating_capacity_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_5_heating_capacity_function_of_temperature_curve_name

field Speed 5 Heating Capacity Function of Temperature Curve Name

curve = a + b*db + c*db**2 + d*oat + e*oat**2 + f*db*oat

db = entering air dry-bulb temperature (C)

oat = air entering temperature seen by the evaporator (C)

Parameters:value (str) – value for IDD Field Speed 5 Heating Capacity Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_5_heating_capacity_function_of_temperature_curve_name or None if not set Return type:str

speed_5_reference_unit_gross_rated_heating_capacity

field Speed 5 Reference Unit Gross Rated Heating Capacity

Heating capacity not accounting for the effect of supply air fan heat

Units: w

Parameters:value (float) – value for IDD Field Speed 5 Reference Unit Gross Rated Heating Capacity Raises:ValueError – if value is not a valid value Returns:the value of speed_5_reference_unit_gross_rated_heating_capacity or None if not set Return type:float

speed_5_reference_unit_gross_rated_heating_cop

field Speed 5 Reference Unit Gross Rated Heating COP

Units: dimensionless

Parameters:value (float) – value for IDD Field Speed 5 Reference Unit Gross Rated Heating COP Raises:ValueError – if value is not a valid value Returns:the value of speed_5_reference_unit_gross_rated_heating_cop or None if not set Return type:float

speed_5_reference_unit_rated_air_flow_rate

field Speed 5 Reference Unit Rated Air Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 5 Reference Unit Rated Air Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_5_reference_unit_rated_air_flow_rate or None if not set Return type:float

speed_6_energy_input_ratio_function_of_air_flow_fraction_curve_name

field Speed 6 Energy Input Ratio Function of Air Flow Fraction Curve Name

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 6 Energy Input Ratio Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_6_energy_input_ratio_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_6_energy_input_ratio_function_of_temperature_curve_name

field Speed 6 Energy Input Ratio Function of Temperature Curve Name

curve = a + b*db + c*db**2 + d*oat + e*oat**2 + f*db*oat

db = entering air dry-bulb temperature (C)

oat = air entering temperature seen by the evaporator (C)

Parameters:value (str) – value for IDD Field Speed 6 Energy Input Ratio Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_6_energy_input_ratio_function_of_temperature_curve_name or None if not set Return type:str

speed_6_heating_capacity_function_of_air_flow_fraction_curve_name

field Speed 6 Heating Capacity Function of Air Flow Fraction Curve Name

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 6 Heating Capacity Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_6_heating_capacity_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_6_heating_capacity_function_of_temperature_curve_name

field Speed 6 Heating Capacity Function of Temperature Curve Name

curve = a + b*db + c*db**2 + d*oat + e*oat**2 + f*db*oat

db = entering air dry-bulb temperature (C)

oat = air entering temperature seen by the evaporator (C)

Parameters:value (str) – value for IDD Field Speed 6 Heating Capacity Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_6_heating_capacity_function_of_temperature_curve_name or None if not set Return type:str

speed_6_reference_unit_gross_rated_heating_capacity

field Speed 6 Reference Unit Gross Rated Heating Capacity

Heating capacity not accounting for the effect of supply air fan heat

Units: w

Parameters:value (float) – value for IDD Field Speed 6 Reference Unit Gross Rated Heating Capacity Raises:ValueError – if value is not a valid value Returns:the value of speed_6_reference_unit_gross_rated_heating_capacity or None if not set Return type:float

speed_6_reference_unit_gross_rated_heating_cop

field Speed 6 Reference Unit Gross Rated Heating COP

Units: dimensionless

Parameters:value (float) – value for IDD Field Speed 6 Reference Unit Gross Rated Heating COP Raises:ValueError – if value is not a valid value Returns:the value of speed_6_reference_unit_gross_rated_heating_cop or None if not set Return type:float

speed_6_reference_unit_rated_air_flow_rate

field Speed 6 Reference Unit Rated Air Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 6 Reference Unit Rated Air Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_6_reference_unit_rated_air_flow_rate or None if not set Return type:float

speed_7_energy_input_ratio_function_of_air_flow_fraction_curve_name

field Speed 7 Energy Input Ratio Function of Air Flow Fraction Curve Name

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 7 Energy Input Ratio Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_7_energy_input_ratio_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_7_energy_input_ratio_function_of_temperature_curve_name

field Speed 7 Energy Input Ratio Function of Temperature Curve Name

curve = a + b*db + c*db**2 + d*oat + e*oat**2 + f*db*oat

db = entering air dry-bulb temperature (C)

oat = air entering temperature seen by the evaporator (C)

Parameters:value (str) – value for IDD Field Speed 7 Energy Input Ratio Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_7_energy_input_ratio_function_of_temperature_curve_name or None if not set Return type:str

speed_7_heating_capacity_function_of_air_flow_fraction_curve_name

field Speed 7 Heating Capacity Function of Air Flow Fraction Curve Name

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 7 Heating Capacity Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_7_heating_capacity_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_7_heating_capacity_function_of_temperature_curve_name

field Speed 7 Heating Capacity Function of Temperature Curve Name

curve = a + b*db + c*db**2 + d*oat + e*oat**2 + f*db*oat

db = entering air dry-bulb temperature (C)

oat = air entering temperature seen by the evaporator (C)

Parameters:value (str) – value for IDD Field Speed 7 Heating Capacity Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_7_heating_capacity_function_of_temperature_curve_name or None if not set Return type:str

speed_7_reference_unit_gross_rated_heating_capacity

field Speed 7 Reference Unit Gross Rated Heating Capacity

Heating capacity not accounting for the effect of supply air fan heat

Units: w

Parameters:value (float) – value for IDD Field Speed 7 Reference Unit Gross Rated Heating Capacity Raises:ValueError – if value is not a valid value Returns:the value of speed_7_reference_unit_gross_rated_heating_capacity or None if not set Return type:float

speed_7_reference_unit_gross_rated_heating_cop

field Speed 7 Reference Unit Gross Rated Heating COP

Units: dimensionless

Parameters:value (float) – value for IDD Field Speed 7 Reference Unit Gross Rated Heating COP Raises:ValueError – if value is not a valid value Returns:the value of speed_7_reference_unit_gross_rated_heating_cop or None if not set Return type:float

speed_7_reference_unit_rated_air_flow_rate

field Speed 7 Reference Unit Rated Air Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 7 Reference Unit Rated Air Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_7_reference_unit_rated_air_flow_rate or None if not set Return type:float

speed_8_energy_input_ratio_function_of_air_flow_fraction_curve_name

field Speed 8 Energy Input Ratio Function of Air Flow Fraction Curve Name

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 8 Energy Input Ratio Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_8_energy_input_ratio_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_8_energy_input_ratio_function_of_temperature_curve_name

field Speed 8 Energy Input Ratio Function of Temperature Curve Name

curve = a + b*db + c*db**2 + d*oat + e*oat**2 + f*db*oat

db = entering air dry-bulb temperature (C)

oat = air entering temperature seen by the evaporator (C)

Parameters:value (str) – value for IDD Field Speed 8 Energy Input Ratio Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_8_energy_input_ratio_function_of_temperature_curve_name or None if not set Return type:str

speed_8_heating_capacity_function_of_air_flow_fraction_curve_name

field Speed 8 Heating Capacity Function of Air Flow Fraction Curve Name

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 8 Heating Capacity Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_8_heating_capacity_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_8_heating_capacity_function_of_temperature_curve_name

field Speed 8 Heating Capacity Function of Temperature Curve Name

curve = a + b*db + c*db**2 + d*oat + e*oat**2 + f*db*oat

db = entering air dry-bulb temperature (C)

oat = air entering temperature seen by the evaporator (C)

Parameters:value (str) – value for IDD Field Speed 8 Heating Capacity Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_8_heating_capacity_function_of_temperature_curve_name or None if not set Return type:str

speed_8_reference_unit_gross_rated_heating_capacity

field Speed 8 Reference Unit Gross Rated Heating Capacity

Heating capacity not accounting for the effect of supply air fan heat

Units: w

Parameters:value (float) – value for IDD Field Speed 8 Reference Unit Gross Rated Heating Capacity Raises:ValueError – if value is not a valid value Returns:the value of speed_8_reference_unit_gross_rated_heating_capacity or None if not set Return type:float

speed_8_reference_unit_gross_rated_heating_cop

field Speed 8 Reference Unit Gross Rated Heating COP

Units: dimensionless

Parameters:value (float) – value for IDD Field Speed 8 Reference Unit Gross Rated Heating COP Raises:ValueError – if value is not a valid value Returns:the value of speed_8_reference_unit_gross_rated_heating_cop or None if not set Return type:float

speed_8_reference_unit_rated_air_flow_rate

field Speed 8 Reference Unit Rated Air Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 8 Reference Unit Rated Air Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_8_reference_unit_rated_air_flow_rate or None if not set Return type:float

speed_9_energy_input_ratio_function_of_air_flow_fraction_curve_name

field Speed 9 Energy Input Ratio Function of Air Flow Fraction Curve Name

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 9 Energy Input Ratio Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_9_energy_input_ratio_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_9_energy_input_ratio_function_of_temperature_curve_name

field Speed 9 Energy Input Ratio Function of Temperature Curve Name

curve = a + b*db + c*db**2 + d*oat + e*oat**2 + f*db*oat

db = entering air dry-bulb temperature (C)

oat = air entering temperature seen by the evaporator (C)

Parameters:value (str) – value for IDD Field Speed 9 Energy Input Ratio Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_9_energy_input_ratio_function_of_temperature_curve_name or None if not set Return type:str

speed_9_heating_capacity_function_of_air_flow_fraction_curve_name

field Speed 9 Heating Capacity Function of Air Flow Fraction Curve Name

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 9 Heating Capacity Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_9_heating_capacity_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_9_heating_capacity_function_of_temperature_curve_name

field Speed 9 Heating Capacity Function of Temperature Curve Name

curve = a + b*db + c*db**2 + d*oat + e*oat**2 + f*db*oat

db = entering air dry-bulb temperature (C)

oat = air entering temperature seen by the evaporator (C)

Parameters:value (str) – value for IDD Field Speed 9 Heating Capacity Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_9_heating_capacity_function_of_temperature_curve_name or None if not set Return type:str

speed_9_reference_unit_gross_rated_heating_capacity

field Speed 9 Reference Unit Gross Rated Heating Capacity

Heating capacity not accounting for the effect of supply air fan heat

Units: w

Parameters:value (float) – value for IDD Field Speed 9 Reference Unit Gross Rated Heating Capacity Raises:ValueError – if value is not a valid value Returns:the value of speed_9_reference_unit_gross_rated_heating_capacity or None if not set Return type:float

speed_9_reference_unit_gross_rated_heating_cop

field Speed 9 Reference Unit Gross Rated Heating COP

Units: dimensionless

Parameters:value (float) – value for IDD Field Speed 9 Reference Unit Gross Rated Heating COP Raises:ValueError – if value is not a valid value Returns:the value of speed_9_reference_unit_gross_rated_heating_cop or None if not set Return type:float

speed_9_reference_unit_rated_air_flow_rate

field Speed 9 Reference Unit Rated Air Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 9 Reference Unit Rated Air Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_9_reference_unit_rated_air_flow_rate or None if not set Return type:float

class pyidf.coils.CoilHeatingElectric

Bases: pyidf.helper.DataObject

Corresponds to IDD object Coil:Heating:Electric Electric heating coil. If the coil is located directly in an air loop branch or outdoor air equipment list, then it is controlled on leaving air temperature and the Temperature Setpoint Node Name must be specified. If the coil is contained within another component such as an air terminal unit, zone HVAC equipment, or unitary system, then the coil is controlled by the parent component and the setpoint node name is not entered.

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

efficiency

field Efficiency

Default value: 1.0

value <= 1.0

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

name

field Name

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

nominal_capacity

field Nominal Capacity

Units: W

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

temperature_setpoint_node_name

field Temperature Setpoint Node Name

Required if coil is temperature controlled.

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

class pyidf.coils.CoilHeatingElectricMultiStage

Bases: pyidf.helper.DataObject

Corresponds to IDD object Coil:Heating:Electric:MultiStage Electric heating coil, multi-stage. If the coil is located directly in an air loop branch or outdoor air equipment list, then it is controlled on leaving air temperature and the Temperature Setpoint Node Name must be specified. If the coil is contained within another component such as an air terminal unit, zone HVAC equipment, or unitary system, then the coil is controlled by the parent component and the setpoint node name is not entered.

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

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_stages

field Number of Stages

Enter the number of the following sets of data for coil

capacity and Efficiency.

value >= 1

value <= 4

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

stage_1_efficiency

field Stage 1 Efficiency

Units: W/W

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

stage_1_nominal_capacity

field Stage 1 Nominal Capacity

Units: W

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

stage_2_efficiency

field Stage 2 Efficiency

Units: W/W

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

stage_2_nominal_capacity

field Stage 2 Nominal Capacity

Units: W

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

stage_3_efficiency

field Stage 3 Efficiency

Units: W/W

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

stage_3_nominal_capacity

field Stage 3 Nominal Capacity

Units: W

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

stage_4_efficiency

field Stage 4 Efficiency

Units: W/W

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

stage_4_nominal_capacity

field Stage 4 Nominal Capacity

Units: W

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

temperature_setpoint_node_name

field Temperature Setpoint Node Name

Required if coil is temperature controlled.

controlled

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

class pyidf.coils.CoilHeatingGas

Bases: pyidf.helper.DataObject

Corresponds to IDD object Coil:Heating:Gas Gas heating coil. If the coil is located directly in an air loop branch or outdoor air equipment list, then it is controlled on leaving air temperature and the Temperature Setpoint Node Name must be specified. If the coil is contained within another component such as an air terminal unit, zone HVAC equipment, or unitary system, then the coil is controlled by the parent component and the setpoint node name is not entered.

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

gas_burner_efficiency

field Gas Burner Efficiency

Default value: 0.8

value <= 1.0

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

name

field Name

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

nominal_capacity

field Nominal Capacity

Units: W

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

parasitic_electric_load

field Parasitic Electric Load

parasitic electric load associated with the gas coil operation

such as an inducer fan, etc.. This will be modified by the part load ratio to reflect

the time of operation in a timestep.

Units: W

IP-Units: W

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

parasitic_gas_load

field Parasitic Gas Load

parasitic gas load associated with the gas coil operation (i.e., standing pilot)

Units: W

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

part_load_fraction_correlation_curve_name

field Part Load Fraction Correlation Curve Name

quadratic curve, PLF = a + b*PLR + c*PLR**2

cubic curve, PLF = a + b*PLR + c*PLR**2 + d*PLR**3

PLF = part load fraction

PLR = part load ratio (sensible heating load/steady state heating capacity)

Coil runtime fraction = Part Load Ratio / PLF

This part load degradation is for coil performance & will

increase the gas consumption of the coil due to transient coil operation.

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

temperature_setpoint_node_name

field Temperature Setpoint Node Name

optional, used if coil is temperature control and not load-base controlled

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

class pyidf.coils.CoilHeatingGasMultiStage

Bases: pyidf.helper.DataObject

Corresponds to IDD object Coil:Heating:Gas:MultiStage Gas heating coil, multi-stage. If the coil is located directly in an air loop branch or outdoor air equipment list, then it is controlled on leaving air temperature and the Temperature Setpoint Node Name must be specified. If the coil is contained within another component such as an air terminal unit, zone HVAC equipment, or unitary system, then the coil is controlled by the parent component and the setpoint node name is not entered.

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

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_stages

field Number of Stages

Enter the number of the following sets of data for coil

capacity and Gas Burner Efficiency.

value >= 1

value <= 4

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

parasitic_gas_load

field Parasitic Gas Load

parasitic gas load associated with the gas coil operation (i.e.,

standing pilot)

Units: W

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

part_load_fraction_correlation_curve_name

field Part Load Fraction Correlation Curve Name

quadratic curve, PLF = a + b*PLR + c*PLR**2

cubic curve, PLF = a + b*PLR + c*PLR**2 + d*PLR**3

PLF = part load fraction

PLR = part load ratio (sensible heating load/steady state

heating capacity)

Coil runtime fraction = Part Load Ratio / PLF

This part load degradation is for coil performance & will

increase the gas consumption of the coil due to transient coil

operation.

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

stage_1_gas_burner_efficiency

field Stage 1 Gas Burner Efficiency

Units: W/W

Parameters:value (float) – value for IDD Field Stage 1 Gas Burner Efficiency Raises:ValueError – if value is not a valid value Returns:the value of stage_1_gas_burner_efficiency or None if not set Return type:float

stage_1_nominal_capacity

field Stage 1 Nominal Capacity

Units: W

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

stage_1_parasitic_electric_load

field Stage 1 Parasitic Electric Load

Stage 1 parasitic electric load associated with the gas coil operation

such as an inducer fan, etc. This will be modified by the part

load ratio to reflect the time of operation in a timestep.

Units: W

IP-Units: W

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

stage_2_gas_burner_efficiency

field Stage 2 Gas Burner Efficiency

Units: W/W

Parameters:value (float) – value for IDD Field Stage 2 Gas Burner Efficiency Raises:ValueError – if value is not a valid value Returns:the value of stage_2_gas_burner_efficiency or None if not set Return type:float

stage_2_nominal_capacity

field Stage 2 Nominal Capacity

Units: W

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

stage_2_parasitic_electric_load

field Stage 2 Parasitic Electric Load

Stage 2 parasitic electric load associated with the gas coil operation

such as an inducer fan, etc. This will be modified by the part

load ratio to reflect the time of operation in a timestep.

Units: W

IP-Units: W

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

stage_3_gas_burner_efficiency

field Stage 3 Gas Burner Efficiency

Units: W/W

Parameters:value (float) – value for IDD Field Stage 3 Gas Burner Efficiency Raises:ValueError – if value is not a valid value Returns:the value of stage_3_gas_burner_efficiency or None if not set Return type:float

stage_3_nominal_capacity

field Stage 3 Nominal Capacity

Units: W

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

stage_3_parasitic_electric_load

field Stage 3 Parasitic Electric Load

Stage 3 parasitic electric load associated with the gas coil operation

such as an inducer fan, etc. This will be modified by the part

load ratio to reflect the time of operation in a timestep.

Units: W

IP-Units: W

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

stage_4_gas_burner_efficiency

field Stage 4 Gas Burner Efficiency

Units: W/W

Parameters:value (float) – value for IDD Field Stage 4 Gas Burner Efficiency Raises:ValueError – if value is not a valid value Returns:the value of stage_4_gas_burner_efficiency or None if not set Return type:float

stage_4_nominal_capacity

field Stage 4 Nominal Capacity

Units: W

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

stage_4_parasitic_electric_load

field Stage 4 Parasitic Electric Load

Stage 4 parasitic electric load associated with the gas coil operation

such as an inducer fan, etc. This will be modified by the part

load ratio to reflect the time of operation in a timestep.

Units: W

IP-Units: W

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

temperature_setpoint_node_name

field Temperature Setpoint Node Name

optional, used if coil is temperature control and not load-base

controlled.

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

class pyidf.coils.CoilHeatingSteam

Bases: pyidf.helper.DataObject

Corresponds to IDD object Coil:Heating:Steam Steam heating coil. Condenses and sub-cools steam at loop pressure and discharges condensate through steam traps to low pressure condensate line.

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

coil_control_type

field Coil Control Type

Use ZoneLoadControl if the coil is contained within another component such as an air

terminal unit, zone HVAC equipment, or unitary system. Use TemperatureSetpointControl

if the coil is located directly in an air loop branch or outdoor air equipment list.

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

degree_of_loop_subcooling

field Degree of Loop SubCooling

Units: C

Default value: 20.0

value >= 10.0

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

degree_of_subcooling

field Degree of SubCooling

Units: C

value >= 1.0

value <= 5.0

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

maximum_steam_flow_rate

field Maximum Steam Flow Rate

Units: m3/s

Parameters:value (float or “Autosize”) – value for IDD Field Maximum Steam Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of maximum_steam_flow_rate 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

temperature_setpoint_node_name

field Temperature Setpoint Node Name

Required if Coil Control Type is TemperatureSetpointControl

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

water_inlet_node_name

field Water Inlet Node Name

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

water_outlet_node_name

field Water Outlet Node Name

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

class pyidf.coils.CoilHeatingWater

Bases: pyidf.helper.DataObject

Corresponds to IDD object Coil:Heating:Water Hot water heating coil, NTU-effectiveness model, assumes a cross-flow heat exchanger. Two options for capacity inputs: UA and water flow rate or capacity and design temperatures.

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

maximum_water_flow_rate

field Maximum Water Flow Rate

Units: m3/s

IP-Units: gal/min

Default value: “autosize”

Parameters:value (float or “Autosize”) – value for IDD Field Maximum Water Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of maximum_water_flow_rate 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

performance_input_method

field Performance Input Method

Default value: UFactorTimesAreaAndDesignWaterFlowRate

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

rated_capacity

field Rated Capacity

Units: W

Default value: “autosize”

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

rated_inlet_air_temperature

field Rated Inlet Air Temperature

Units: C

Default value: 16.6

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

rated_inlet_water_temperature

field Rated Inlet Water Temperature

Units: C

Default value: 82.2

Parameters:value (float) – value for IDD Field Rated Inlet Water Temperature Raises:ValueError – if value is not a valid value Returns:the value of rated_inlet_water_temperature or None if not set Return type:float

rated_outlet_air_temperature

field Rated Outlet Air Temperature

Units: C

Default value: 32.2

Parameters:value (float) – value for IDD Field Rated Outlet Air Temperature Raises:ValueError – if value is not a valid value Returns:the value of rated_outlet_air_temperature or None if not set Return type:float

rated_outlet_water_temperature

field Rated Outlet Water Temperature

Units: C

Default value: 71.1

Parameters:value (float) – value for IDD Field Rated Outlet Water Temperature Raises:ValueError – if value is not a valid value Returns:the value of rated_outlet_water_temperature or None if not set Return type:float

rated_ratio_for_air_and_water_convection

field Rated Ratio for Air and Water Convection

Default value: 0.5

Parameters:value (float) – value for IDD Field Rated Ratio for Air and Water Convection Raises:ValueError – if value is not a valid value Returns:the value of rated_ratio_for_air_and_water_convection or None if not set Return type:float

ufactor_times_area_value

field U-Factor Times Area Value

UA value under rating conditions

Units: W/K

Default value: “autosize”

Parameters:value (float or “Autosize”) – value for IDD Field U-Factor Times Area Value Raises:ValueError – if value is not a valid value Returns:the value of ufactor_times_area_value or None if not set Return type:float or “Autosize”

water_inlet_node_name

field Water Inlet Node Name

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

water_outlet_node_name

field Water Outlet Node Name

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

class pyidf.coils.CoilHeatingWaterToAirHeatPumpEquationFit

Bases: pyidf.helper.DataObject

Corresponds to IDD object Coil:Heating:WaterToAirHeatPump:EquationFit Direct expansion (DX) heating coil for water-to-air heat pump (includes electric compressor), single-speed, equation-fit model. Equation-fit model uses normalized curves to describe the heat pump performance.

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

gross_rated_heating_capacity

field Gross Rated Heating Capacity

Heating capacity not accounting for the effect of supply air fan heat

Units: W

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

gross_rated_heating_cop

field Gross Rated Heating COP

Parameters:value (float) – value for IDD Field Gross Rated Heating COP Raises:ValueError – if value is not a valid value Returns:the value of gross_rated_heating_cop or None if not set Return type:float

heating_capacity_coefficient_1

field Heating Capacity Coefficient 1

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

heating_capacity_coefficient_2

field Heating Capacity Coefficient 2

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

heating_capacity_coefficient_3

field Heating Capacity Coefficient 3

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

heating_capacity_coefficient_4

field Heating Capacity Coefficient 4

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

heating_capacity_coefficient_5

field Heating Capacity Coefficient 5

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

heating_power_consumption_coefficient_1

field Heating Power Consumption Coefficient 1

Parameters:value (float) – value for IDD Field Heating Power Consumption Coefficient 1 Raises:ValueError – if value is not a valid value Returns:the value of heating_power_consumption_coefficient_1 or None if not set Return type:float

heating_power_consumption_coefficient_2

field Heating Power Consumption Coefficient 2

Parameters:value (float) – value for IDD Field Heating Power Consumption Coefficient 2 Raises:ValueError – if value is not a valid value Returns:the value of heating_power_consumption_coefficient_2 or None if not set Return type:float

heating_power_consumption_coefficient_3

field Heating Power Consumption Coefficient 3

Parameters:value (float) – value for IDD Field Heating Power Consumption Coefficient 3 Raises:ValueError – if value is not a valid value Returns:the value of heating_power_consumption_coefficient_3 or None if not set Return type:float

heating_power_consumption_coefficient_4

field Heating Power Consumption Coefficient 4

Parameters:value (float) – value for IDD Field Heating Power Consumption Coefficient 4 Raises:ValueError – if value is not a valid value Returns:the value of heating_power_consumption_coefficient_4 or None if not set Return type:float

heating_power_consumption_coefficient_5

field Heating Power Consumption Coefficient 5

Parameters:value (float) – value for IDD Field Heating Power Consumption Coefficient 5 Raises:ValueError – if value is not a valid value Returns:the value of heating_power_consumption_coefficient_5 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

rated_air_flow_rate

field Rated Air Flow Rate

Units: m3/s

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

rated_water_flow_rate

field Rated Water Flow Rate

Units: m3/s

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

water_inlet_node_name

field Water Inlet Node Name

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

water_outlet_node_name

field Water Outlet Node Name

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

class pyidf.coils.CoilHeatingWaterToAirHeatPumpParameterEstimation

Bases: pyidf.helper.DataObject

Corresponds to IDD object Coil:Heating:WaterToAirHeatPump:ParameterEstimation Direct expansion (DX) heating coil for water-to-air heat pump (includes electric compressor), single-speed, parameter estimation model. Parameter estimation model is a deterministic model that requires a consistent set of parameters to describe the operating conditions of the heat pump components.

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

compressor_clearance_factor

field Compressor Clearance Factor

Used when Compressor Type is Reciprocating.

Leave this field blank for Compressor Type is Rotary or Scroll.

Previously part of Parameter 7

Units: dimensionless

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

compressor_efficiency

field Compressor Efficiency

Previously called Parameter 4

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

compressor_piston_displacement

field Compressor Piston Displacement

Use when Compressor Type is Reciprocating or Rotary

Leave this field blank for Compressor Type is Scroll.

Previously part of Parameter 5

Units: m3/s

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

compressor_power_losses

field Compressor Power Losses

Accounts for the loss of work due to mechanical and electrical losses in the compressor.

Previously called Parameter 3

Units: W

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

compressor_suction_or_discharge_pressure_drop

field Compressor Suction/Discharge Pressure Drop

Used when Compressor Type is Rotary or Reciprocating

Leave this field blank for Compressor Type is Scroll.

Previously part of Parameter 6

Units: Pa

Parameters:value (float) – value for IDD Field Compressor Suction/Discharge Pressure Drop Raises:ValueError – if value is not a valid value Returns:the value of compressor_suction_or_discharge_pressure_drop or None if not set Return type:float

compressor_type

field Compressor Type

Parameters 1-4 are as named below.

Parameters 5-9 depend on the type of compressor.

Refer to the InputOutputReference on the parameters required

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

design_source_side_flow_rate

field Design Source Side Flow Rate

Units: m3/s

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

gross_rated_heating_capacity

field Gross Rated Heating Capacity

Heating capacity not accounting for the effect of supply air fan heat

Units: W

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

high_pressure_cutoff

field High Pressure Cutoff

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

leak_rate_coefficient

field Leak Rate Coefficient

Use when Compressor Type is Scroll.

Leave this field blank for Compressor Type is Rotary or Reciprocating.

Previously part of Parameter 7

Units: dimensionless

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

load_side_total_heat_transfer_coefficient

field Load Side Total Heat Transfer Coefficient

Previously called Parameter 1

Units: W/K

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

low_pressure_cutoff

field Low Pressure Cutoff

Units: Pa

Parameters:value (float) – value for IDD Field Low Pressure Cutoff Raises:ValueError – if value is not a valid value Returns:the value of low_pressure_cutoff 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

refrigerant_type

field Refrigerant Type

Default value: R22

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

refrigerant_volume_flow_rate

field Refrigerant Volume Flow Rate

Use when Compressor Type is Scroll

Leave this field blank for Compressor Type is Rotary or Reciprocating.

Previously part of Parameter 5

Units: m3/s

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

source_side_heat_transfer_coefficient

field Source Side Heat Transfer Coefficient

Use when Source Side Fluid Name is Water

Leave this field blank when Source Side Fluid is an antifreeze

Previously part of Parameter 8

Units: W/K

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

source_side_heat_transfer_resistance1

field Source Side Heat Transfer Resistance1

Use when Source Side Fluid Name is an antifreeze

Leave this field blank for Source Side Fluid is Water

Previously part of Parameter 8

Units: dimensionless

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

source_side_heat_transfer_resistance2

field Source Side Heat Transfer Resistance2

Use when Source Side Fluid Name is an antifreeze

Leave this field blank for Source Side Fluid is Water

Previously part of Parameter 9

Units: W/K

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

superheat_temperature_at_the_evaporator_outlet

field Superheat Temperature at the Evaporator Outlet

Previously called Parameter 2

Units: C

Parameters:value (float) – value for IDD Field Superheat Temperature at the Evaporator Outlet Raises:ValueError – if value is not a valid value Returns:the value of superheat_temperature_at_the_evaporator_outlet or None if not set Return type:float

volume_ratio

field Volume Ratio

Use when Compressor Type is Scroll.

Leave this field blank for Compressor Type is Rotary or Reciprocating.

Previously part of Parameter 6

Units: dimensionless

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

water_inlet_node_name

field Water Inlet Node Name

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

water_outlet_node_name

field Water Outlet Node Name

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

class pyidf.coils.CoilHeatingWaterToAirHeatPumpVariableSpeedEquationFit

Bases: pyidf.helper.DataObject

Corresponds to IDD object Coil:Heating:WaterToAirHeatPump:VariableSpeedEquationFit Direct expansion (DX) heating coil for water-to-air heat pump (includes electric compressor), variable-speed, equation-fit model. Equation-fit model uses normalized curves to describe the heat pump performance. Requires two to ten sets of performance data and will interpolate between speeds.

energy_part_load_fraction_curve_name

field Energy Part Load Fraction Curve Name

quadratic curve = a + b*PLR + c*PLR**2

cubic curve = a + b*PLR + c*PLR**2 + d*PLR**3

PLR = part load ratio (heating load/steady state capacity)

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

indoor_air_inlet_node_name

field Indoor Air Inlet Node Name

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

indoor_air_outlet_node_name

field Indoor Air Outlet Node Name

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

name

field Name

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

nominal_speed_level

field Nominal Speed Level

must be lower than or equal to the highest speed number

Units: dimensionless

Default value: 2

Parameters:value (int) – value for IDD Field Nominal Speed Level Raises:ValueError – if value is not a valid value Returns:the value of nominal_speed_level or None if not set Return type:int

number_of_speeds

field Number of Speeds

Units: dimensionless

Default value: 2

value >= 1

value <= 10

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

rated_air_flow_rate_at_selected_nominal_speed_level

field Rated Air Flow Rate At Selected Nominal Speed Level

Units: m3/s

Default value: “autosize”

Parameters:value (float or “Autosize”) – value for IDD Field Rated Air Flow Rate At Selected Nominal Speed Level Raises:ValueError – if value is not a valid value Returns:the value of rated_air_flow_rate_at_selected_nominal_speed_level or None if not set Return type:float or “Autosize”

rated_heating_capacity_at_selected_nominal_speed_level

field Rated Heating Capacity At Selected Nominal Speed Level

Units: w

Default value: “autosize”

Parameters:value (float or “Autosize”) – value for IDD Field Rated Heating Capacity At Selected Nominal Speed Level Raises:ValueError – if value is not a valid value Returns:the value of rated_heating_capacity_at_selected_nominal_speed_level or None if not set Return type:float or “Autosize”

rated_water_flow_rate_at_selected_nominal_speed_level

field Rated Water Flow Rate At Selected Nominal Speed Level

Units: m3/s

Default value: “autosize”

Parameters:value (float or “Autosize”) – value for IDD Field Rated Water Flow Rate At Selected Nominal Speed Level Raises:ValueError – if value is not a valid value Returns:the value of rated_water_flow_rate_at_selected_nominal_speed_level or None if not set Return type:float or “Autosize”

speed_10_energy_input_ratio_function_of_air_flow_fraction_curve_name

field Speed 10 Energy Input Ratio Function of Air Flow Fraction Curve Name

optional

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 10 Energy Input Ratio Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_10_energy_input_ratio_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_10_energy_input_ratio_function_of_temperature_curve_name

field Speed 10 Energy Input Ratio Function of Temperature Curve Name

optional

curve = a + b*db + c*db**2 + d*ewt + e*ewt**2 + f*db*ewt

db = entering air dry-bulb temperature (C)

ewt = water entering temperature seen by the evaporator (C)

Parameters:value (str) – value for IDD Field Speed 10 Energy Input Ratio Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_10_energy_input_ratio_function_of_temperature_curve_name or None if not set Return type:str

speed_10_energy_input_ratio_function_of_water_flow_fraction_curve_name

field Speed 10 Energy Input Ratio Function of Water Flow Fraction Curve Name

optional

quadratic curve = a + b*ffw + c*ffw**2

cubic curve = a + b*ffw + c*ffw**2 + d*ffw**3

ffw = Fraction of the full load Water Flow

Parameters:value (str) – value for IDD Field Speed 10 Energy Input Ratio Function of Water Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_10_energy_input_ratio_function_of_water_flow_fraction_curve_name or None if not set Return type:str

speed_10_heating_capacity_function_of_temperature_curve_name

field Speed 10 Heating Capacity Function of Temperature Curve Name

optional

curve = a + b*db + c*db**2 + d*ewt + e*ewt**2 + f*db*ewt

db = entering air dry-bulb temperature (C)

ewt = water entering temperature seen by the evaporator (C)

Parameters:value (str) – value for IDD Field Speed 10 Heating Capacity Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_10_heating_capacity_function_of_temperature_curve_name or None if not set Return type:str

speed_10_heating_capacity_function_of_water_flow_fraction_curve_name

field Speed 10 Heating Capacity Function of Water Flow Fraction Curve Name

optional

quadratic curve = a + b*ffw + c*ffw**2

cubic curve = a + b*ffw + c*ffw**2 + d*ffw**3

ffw = Fraction of the full load Water Flow

Parameters:value (str) – value for IDD Field Speed 10 Heating Capacity Function of Water Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_10_heating_capacity_function_of_water_flow_fraction_curve_name or None if not set Return type:str

speed_10_reference_unit_gross_rated_heating_capacity

field Speed 10 Reference Unit Gross Rated Heating Capacity

Heating capacity not accounting for the effect of supply air fan heat

Units: w

Parameters:value (float) – value for IDD Field Speed 10 Reference Unit Gross Rated Heating Capacity Raises:ValueError – if value is not a valid value Returns:the value of speed_10_reference_unit_gross_rated_heating_capacity or None if not set Return type:float

speed_10_reference_unit_gross_rated_heating_cop

field Speed 10 Reference Unit Gross Rated Heating COP

Units: dimensionless

Parameters:value (float) – value for IDD Field Speed 10 Reference Unit Gross Rated Heating COP Raises:ValueError – if value is not a valid value Returns:the value of speed_10_reference_unit_gross_rated_heating_cop or None if not set Return type:float

speed_10_reference_unit_rated_air_flow_rate

field Speed 10 Reference Unit Rated Air Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 10 Reference Unit Rated Air Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_10_reference_unit_rated_air_flow_rate or None if not set Return type:float

speed_10_reference_unit_rated_water_flow_rate

field Speed 10 Reference Unit Rated Water Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 10 Reference Unit Rated Water Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_10_reference_unit_rated_water_flow_rate or None if not set Return type:float

speed_10_reference_unit_waste_heat_fraction_of_input_power_at_rated_conditions

field Speed 10 Reference Unit Waste Heat Fraction of Input Power At Rated Conditions

Units: dimensionless

Parameters:value (float) – value for IDD Field Speed 10 Reference Unit Waste Heat Fraction of Input Power At Rated Conditions Raises:ValueError – if value is not a valid value Returns:the value of speed_10_reference_unit_waste_heat_fraction_of_input_power_at_rated_conditions or None if not set Return type:float

speed_10_total_heating_capacity_function_of_air_flow_fraction_curve_name

field Speed 10 Total Heating Capacity Function of Air Flow Fraction Curve Name

optional

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 10 Total Heating Capacity Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_10_total_heating_capacity_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_10_waste_heat_function_of_temperature_curve_name

field Speed 10 Waste Heat Function of Temperature Curve Name

optional

curve = a + b*db + c*db**2 + d*ewt + e*ewt**2 + f*db*ewt

db = entering air dry-bulb temperature (C)

ewt = water entering temperature seen by the evaporator (C)

Parameters:value (str) – value for IDD Field Speed 10 Waste Heat Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_10_waste_heat_function_of_temperature_curve_name or None if not set Return type:str

speed_1_energy_input_ratio_function_of_air_flow_fraction_curve_name

field Speed 1 Energy Input Ratio Function of Air Flow Fraction Curve Name

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 1 Energy Input Ratio Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_1_energy_input_ratio_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_1_energy_input_ratio_function_of_temperature_curve_name

field Speed 1 Energy Input Ratio Function of Temperature Curve Name

curve = a + b*db + c*db**2 + d*ewt + e*ewt**2 + f*db*ewt

db = entering air dry-bulb temperature (C)

ewt = water entering temperature seen by the evaporator (C)

Parameters:value (str) – value for IDD Field Speed 1 Energy Input Ratio Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_1_energy_input_ratio_function_of_temperature_curve_name or None if not set Return type:str

speed_1_energy_input_ratio_function_of_water_flow_fraction_curve_name

field Speed 1 Energy Input Ratio Function of Water Flow Fraction Curve Name

quadratic curve = a + b*ffw + c*ffw**2

cubic curve = a + b*ffw + c*ffw**2 + d*ffw**3

ffw = Fraction of the full load Water Flow

Parameters:value (str) – value for IDD Field Speed 1 Energy Input Ratio Function of Water Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_1_energy_input_ratio_function_of_water_flow_fraction_curve_name or None if not set Return type:str

speed_1_heating_capacity_function_of_temperature_curve_name

field Speed 1 Heating Capacity Function of Temperature Curve Name

curve = a + b*db + c*db**2 + d*ewt + e*ewt**2 + f*db*ewt

db = entering air dry-bulb temperature (C)

ewt = water entering temperature seen by the evaporator (C)

Parameters:value (str) – value for IDD Field Speed 1 Heating Capacity Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_1_heating_capacity_function_of_temperature_curve_name or None if not set Return type:str

speed_1_heating_capacity_function_of_water_flow_fraction_curve_name

field Speed 1 Heating Capacity Function of Water Flow Fraction Curve Name

quadratic curve = a + b*ffw + c*ffw**2

cubic curve = a + b*ffw + c*ffw**2 + d*ffw**3

ffw = Fraction of the full load Water Flow

Parameters:value (str) – value for IDD Field Speed 1 Heating Capacity Function of Water Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_1_heating_capacity_function_of_water_flow_fraction_curve_name or None if not set Return type:str

speed_1_reference_unit_gross_rated_heating_capacity

field Speed 1 Reference Unit Gross Rated Heating Capacity

Heating capacity not accounting for the effect of supply air fan heat

Units: w

Parameters:value (float) – value for IDD Field Speed 1 Reference Unit Gross Rated Heating Capacity Raises:ValueError – if value is not a valid value Returns:the value of speed_1_reference_unit_gross_rated_heating_capacity or None if not set Return type:float

speed_1_reference_unit_gross_rated_heating_cop

field Speed 1 Reference Unit Gross Rated Heating COP

Units: dimensionless

Parameters:value (float) – value for IDD Field Speed 1 Reference Unit Gross Rated Heating COP Raises:ValueError – if value is not a valid value Returns:the value of speed_1_reference_unit_gross_rated_heating_cop or None if not set Return type:float

speed_1_reference_unit_rated_air_flow

field Speed 1 Reference Unit Rated Air Flow

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 1 Reference Unit Rated Air Flow Raises:ValueError – if value is not a valid value Returns:the value of speed_1_reference_unit_rated_air_flow or None if not set Return type:float

speed_1_reference_unit_rated_water_flow_rate

field Speed 1 Reference Unit Rated Water Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 1 Reference Unit Rated Water Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_1_reference_unit_rated_water_flow_rate or None if not set Return type:float

speed_1_reference_unit_waste_heat_fraction_of_input_power_at_rated_conditions

field Speed 1 Reference Unit Waste Heat Fraction of Input Power At Rated Conditions

Units: dimensionless

Parameters:value (float) – value for IDD Field Speed 1 Reference Unit Waste Heat Fraction of Input Power At Rated Conditions Raises:ValueError – if value is not a valid value Returns:the value of speed_1_reference_unit_waste_heat_fraction_of_input_power_at_rated_conditions or None if not set Return type:float

speed_1_total_heating_capacity_function_of_air_flow_fraction_curve_name

field Speed 1 Total Heating Capacity Function of Air Flow Fraction Curve Name

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 1 Total Heating Capacity Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_1_total_heating_capacity_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_1_waste_heat_function_of_temperature_curve_name

field Speed 1 Waste Heat Function of Temperature Curve Name

curve = a + b*db + c*db**2 + d*ewt + e*ewt**2 + f*db*ewt

db = entering air dry-bulb temperature (C)

ewt = water entering temperature seen by the evaporator (C)

Parameters:value (str) – value for IDD Field Speed 1 Waste Heat Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_1_waste_heat_function_of_temperature_curve_name or None if not set Return type:str

speed_2_energy_input_ratio_function_of_air_flow_fraction_curve_name

field Speed 2 Energy Input Ratio Function of Air Flow Fraction Curve Name

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 2 Energy Input Ratio Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_2_energy_input_ratio_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_2_energy_input_ratio_function_of_temperature_curve_name

field Speed 2 Energy Input Ratio Function of Temperature Curve Name

curve = a + b*db + c*db**2 + d*ewt + e*ewt**2 + f*db*ewt

db = entering air dry-bulb temperature (C)

ewt = water entering temperature seen by the evaporator (C)

Parameters:value (str) – value for IDD Field Speed 2 Energy Input Ratio Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_2_energy_input_ratio_function_of_temperature_curve_name or None if not set Return type:str

speed_2_energy_input_ratio_function_of_water_flow_fraction_curve_name

field Speed 2 Energy Input Ratio Function of Water Flow Fraction Curve Name

optional

quadratic curve = a + b*ffw + c*ffw**2

cubic curve = a + b*ffw + c*ffw**2 + d*ffw**3

ffw = Fraction of the full load Water Flow

Parameters:value (str) – value for IDD Field Speed 2 Energy Input Ratio Function of Water Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_2_energy_input_ratio_function_of_water_flow_fraction_curve_name or None if not set Return type:str

speed_2_heating_capacity_function_of_temperature_curve_name

field Speed 2 Heating Capacity Function of Temperature Curve Name

curve = a + b*db + c*db**2 + d*ewt + e*ewt**2 + f*db*ewt

db = entering air dry-bulb temperature (C)

ewt = water entering temperature seen by the evaporator (C)

Parameters:value (str) – value for IDD Field Speed 2 Heating Capacity Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_2_heating_capacity_function_of_temperature_curve_name or None if not set Return type:str

speed_2_heating_capacity_function_of_water_flow_fraction_curve_name

field Speed 2 Heating Capacity Function of Water Flow Fraction Curve Name

quadratic curve = a + b*ffw + c*ffw**2

cubic curve = a + b*ffw + c*ffw**2 + d*ffw**3

ffw = Fraction of the full load Water Flow

Parameters:value (str) – value for IDD Field Speed 2 Heating Capacity Function of Water Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_2_heating_capacity_function_of_water_flow_fraction_curve_name or None if not set Return type:str

speed_2_reference_unit_gross_rated_heating_capacity

field Speed 2 Reference Unit Gross Rated Heating Capacity

Heating capacity not accounting for the effect of supply air fan heat

Units: w

Parameters:value (float) – value for IDD Field Speed 2 Reference Unit Gross Rated Heating Capacity Raises:ValueError – if value is not a valid value Returns:the value of speed_2_reference_unit_gross_rated_heating_capacity or None if not set Return type:float

speed_2_reference_unit_gross_rated_heating_cop

field Speed 2 Reference Unit Gross Rated Heating COP

Units: dimensionless

Parameters:value (float) – value for IDD Field Speed 2 Reference Unit Gross Rated Heating COP Raises:ValueError – if value is not a valid value Returns:the value of speed_2_reference_unit_gross_rated_heating_cop or None if not set Return type:float

speed_2_reference_unit_rated_air_flow_rate

field Speed 2 Reference Unit Rated Air Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 2 Reference Unit Rated Air Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_2_reference_unit_rated_air_flow_rate or None if not set Return type:float

speed_2_reference_unit_rated_water_flow_rate

field Speed 2 Reference Unit Rated Water Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 2 Reference Unit Rated Water Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_2_reference_unit_rated_water_flow_rate or None if not set Return type:float

speed_2_reference_unit_waste_heat_fraction_of_input_power_at_rated_conditions

field Speed 2 Reference Unit Waste Heat Fraction of Input Power At Rated Conditions

Units: dimensionless

Parameters:value (float) – value for IDD Field Speed 2 Reference Unit Waste Heat Fraction of Input Power At Rated Conditions Raises:ValueError – if value is not a valid value Returns:the value of speed_2_reference_unit_waste_heat_fraction_of_input_power_at_rated_conditions or None if not set Return type:float

speed_2_total_heating_capacity_function_of_air_flow_fraction_curve_name

field Speed 2 Total Heating Capacity Function of Air Flow Fraction Curve Name

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 2 Total Heating Capacity Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_2_total_heating_capacity_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_2_waste_heat_function_of_temperature_curve_name

field Speed 2 Waste Heat Function of Temperature Curve Name

curve = a + b*db + c*db**2 + d*ewt + e*ewt**2 + f*db*ewt

db = entering air dry-bulb temperature (C)

ewt = water entering temperature seen by the evaporator (C)

Parameters:value (str) – value for IDD Field Speed 2 Waste Heat Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_2_waste_heat_function_of_temperature_curve_name or None if not set Return type:str

speed_3_energy_input_ratio_function_of_air_flow_fraction_curve_name

field Speed 3 Energy Input Ratio Function of Air Flow Fraction Curve Name

optional

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 3 Energy Input Ratio Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_3_energy_input_ratio_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_3_energy_input_ratio_function_of_temperature_curve_name

field Speed 3 Energy Input Ratio Function of Temperature Curve Name

optional

curve = a + b*db + c*db**2 + d*ewt + e*ewt**2 + f*db*ewt

db = entering air dry-bulb temperature (C)

ewt = water entering temperature seen by the evaporator (C)

Parameters:value (str) – value for IDD Field Speed 3 Energy Input Ratio Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_3_energy_input_ratio_function_of_temperature_curve_name or None if not set Return type:str

speed_3_energy_input_ratio_function_of_water_flow_fraction_curve_name

field Speed 3 Energy Input Ratio Function of Water Flow Fraction Curve Name

optional

quadratic curve = a + b*ffw + c*ffw**2

cubic curve = a + b*ffw + c*ffw**2 + d*ffw**3

ffw = Fraction of the full load Water Flow

Parameters:value (str) – value for IDD Field Speed 3 Energy Input Ratio Function of Water Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_3_energy_input_ratio_function_of_water_flow_fraction_curve_name or None if not set Return type:str

speed_3_heating_capacity_function_of_temperature_curve_name

field Speed 3 Heating Capacity Function of Temperature Curve Name

optional

curve = a + b*db + c*db**2 + d*ewt + e*ewt**2 + f*db*ewt

db = entering air dry-bulb temperature (C)

ewt = water entering temperature seen by the evaporator (C)

Parameters:value (str) – value for IDD Field Speed 3 Heating Capacity Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_3_heating_capacity_function_of_temperature_curve_name or None if not set Return type:str

speed_3_heating_capacity_function_of_water_flow_fraction_curve_name

field Speed 3 Heating Capacity Function of Water Flow Fraction Curve Name

optional

quadratic curve = a + b*ffw + c*ffw**2

cubic curve = a + b*ffw + c*ffw**2 + d*ffw**3

ffw = Fraction of the full load Water Flow

Parameters:value (str) – value for IDD Field Speed 3 Heating Capacity Function of Water Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_3_heating_capacity_function_of_water_flow_fraction_curve_name or None if not set Return type:str

speed_3_reference_unit_gross_rated_heating_capacity

field Speed 3 Reference Unit Gross Rated Heating Capacity

Heating capacity not accounting for the effect of supply air fan heat

Units: w

Parameters:value (float) – value for IDD Field Speed 3 Reference Unit Gross Rated Heating Capacity Raises:ValueError – if value is not a valid value Returns:the value of speed_3_reference_unit_gross_rated_heating_capacity or None if not set Return type:float

speed_3_reference_unit_gross_rated_heating_cop

field Speed 3 Reference Unit Gross Rated Heating COP

Units: dimensionless

Parameters:value (float) – value for IDD Field Speed 3 Reference Unit Gross Rated Heating COP Raises:ValueError – if value is not a valid value Returns:the value of speed_3_reference_unit_gross_rated_heating_cop or None if not set Return type:float

speed_3_reference_unit_rated_air_flow_rate

field Speed 3 Reference Unit Rated Air Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 3 Reference Unit Rated Air Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_3_reference_unit_rated_air_flow_rate or None if not set Return type:float

speed_3_reference_unit_rated_water_flow_rate

field Speed 3 Reference Unit Rated Water Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 3 Reference Unit Rated Water Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_3_reference_unit_rated_water_flow_rate or None if not set Return type:float

speed_3_reference_unit_waste_heat_fraction_of_input_power_at_rated_conditions

field Speed 3 Reference Unit Waste Heat Fraction of Input Power At Rated Conditions

Units: dimensionless

Parameters:value (float) – value for IDD Field Speed 3 Reference Unit Waste Heat Fraction of Input Power At Rated Conditions Raises:ValueError – if value is not a valid value Returns:the value of speed_3_reference_unit_waste_heat_fraction_of_input_power_at_rated_conditions or None if not set Return type:float

speed_3_total_heating_capacity_function_of_air_flow_fraction_curve_name

field Speed 3 Total Heating Capacity Function of Air Flow Fraction Curve Name

optional

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 3 Total Heating Capacity Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_3_total_heating_capacity_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_3_waste_heat_function_of_temperature_curve_name

field Speed 3 Waste Heat Function of Temperature Curve Name

optional

curve = a + b*db + c*db**2 + d*ewt + e*ewt**2 + f*db*ewt

db = entering air dry-bulb temperature (C)

ewt = water entering temperature seen by the evaporator (C)

Parameters:value (str) – value for IDD Field Speed 3 Waste Heat Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_3_waste_heat_function_of_temperature_curve_name or None if not set Return type:str

speed_4_energy_input_ratio_function_of_air_flow_fraction_curve_name

field Speed 4 Energy Input Ratio Function of Air Flow Fraction Curve Name

optional

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 4 Energy Input Ratio Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_4_energy_input_ratio_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_4_energy_input_ratio_function_of_temperature_curve_name

field Speed 4 Energy Input Ratio Function of Temperature Curve Name

optional

curve = a + b*db + c*db**2 + d*ewt + e*ewt**2 + f*db*ewt

db = entering air dry-bulb temperature (C)

ewt = water entering temperature seen by the evaporator (C)

Parameters:value (str) – value for IDD Field Speed 4 Energy Input Ratio Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_4_energy_input_ratio_function_of_temperature_curve_name or None if not set Return type:str

speed_4_energy_input_ratio_function_of_water_flow_fraction_curve_name

field Speed 4 Energy Input Ratio Function of Water Flow Fraction Curve Name

optional

quadratic curve = a + b*ffw + c*ffw**2

cubic curve = a + b*ffw + c*ffw**2 + d*ffw**3

ffw = Fraction of the full load Water Flow

Parameters:value (str) – value for IDD Field Speed 4 Energy Input Ratio Function of Water Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_4_energy_input_ratio_function_of_water_flow_fraction_curve_name or None if not set Return type:str

speed_4_heating_capacity_function_of_temperature_curve_name

field Speed 4 Heating Capacity Function of Temperature Curve Name

optional

curve = a + b*db + c*db**2 + d*ewt + e*ewt**2 + f*db*ewt

db = entering air dry-bulb temperature (C)

ewt = water entering temperature seen by the evaporator (C)

Parameters:value (str) – value for IDD Field Speed 4 Heating Capacity Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_4_heating_capacity_function_of_temperature_curve_name or None if not set Return type:str

speed_4_heating_capacity_function_of_water_flow_fraction_curve_name

field Speed 4 Heating Capacity Function of Water Flow Fraction Curve Name

optional

quadratic curve = a + b*ffw + c*ffw**2

cubic curve = a + b*ffw + c*ffw**2 + d*ffw**3

ffw = Fraction of the full load Water Flow

Parameters:value (str) – value for IDD Field Speed 4 Heating Capacity Function of Water Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_4_heating_capacity_function_of_water_flow_fraction_curve_name or None if not set Return type:str

speed_4_reference_unit_gross_rated_heating_capacity

field Speed 4 Reference Unit Gross Rated Heating Capacity

Heating capacity not accounting for the effect of supply air fan heat

Units: w

Parameters:value (float) – value for IDD Field Speed 4 Reference Unit Gross Rated Heating Capacity Raises:ValueError – if value is not a valid value Returns:the value of speed_4_reference_unit_gross_rated_heating_capacity or None if not set Return type:float

speed_4_reference_unit_gross_rated_heating_cop

field Speed 4 Reference Unit Gross Rated Heating COP

Units: dimensionless

Parameters:value (float) – value for IDD Field Speed 4 Reference Unit Gross Rated Heating COP Raises:ValueError – if value is not a valid value Returns:the value of speed_4_reference_unit_gross_rated_heating_cop or None if not set Return type:float

speed_4_reference_unit_rated_air_flow_rate

field Speed 4 Reference Unit Rated Air Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 4 Reference Unit Rated Air Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_4_reference_unit_rated_air_flow_rate or None if not set Return type:float

speed_4_reference_unit_rated_water_flow_rate

field Speed 4 Reference Unit Rated Water Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 4 Reference Unit Rated Water Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_4_reference_unit_rated_water_flow_rate or None if not set Return type:float

speed_4_reference_unit_waste_heat_fraction_of_input_power_at_rated_conditions

field Speed 4 Reference Unit Waste Heat Fraction of Input Power At Rated Conditions

Units: dimensionless

Parameters:value (float) – value for IDD Field Speed 4 Reference Unit Waste Heat Fraction of Input Power At Rated Conditions Raises:ValueError – if value is not a valid value Returns:the value of speed_4_reference_unit_waste_heat_fraction_of_input_power_at_rated_conditions or None if not set Return type:float

speed_4_total_heating_capacity_function_of_air_flow_fraction_curve_name

field Speed 4 Total Heating Capacity Function of Air Flow Fraction Curve Name

optional

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 4 Total Heating Capacity Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_4_total_heating_capacity_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_4_waste_heat_function_of_temperature_curve_name

field Speed 4 Waste Heat Function of Temperature Curve Name

optional

curve = a + b*db + c*db**2 + d*ewt + e*ewt**2 + f*db*ewt

db = entering air dry-bulb temperature (C)

ewt = water entering temperature seen by the evaporator (C)

Parameters:value (str) – value for IDD Field Speed 4 Waste Heat Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_4_waste_heat_function_of_temperature_curve_name or None if not set Return type:str

speed_5_energy_input_ratio_function_of_air_flow_fraction_curve_name

field Speed 5 Energy Input Ratio Function of Air Flow Fraction Curve Name

optional

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 5 Energy Input Ratio Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_5_energy_input_ratio_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_5_energy_input_ratio_function_of_temperature_curve_name

field Speed 5 Energy Input Ratio Function of Temperature Curve Name

optional

curve = a + b*db + c*db**2 + d*ewt + e*ewt**2 + f*db*ewt

db = entering air dry-bulb temperature (C)

ewt = water entering temperature seen by the evaporator (C)

Parameters:value (str) – value for IDD Field Speed 5 Energy Input Ratio Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_5_energy_input_ratio_function_of_temperature_curve_name or None if not set Return type:str

speed_5_energy_input_ratio_function_of_water_flow_fraction_curve_name

field Speed 5 Energy Input Ratio Function of Water Flow Fraction Curve Name

optional

quadratic curve = a + b*ffw + c*ffw**2

cubic curve = a + b*ffw + c*ffw**2 + d*ffw**3

ffw = Fraction of the full load Water Flow

Parameters:value (str) – value for IDD Field Speed 5 Energy Input Ratio Function of Water Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_5_energy_input_ratio_function_of_water_flow_fraction_curve_name or None if not set Return type:str

speed_5_heating_capacity_function_of_temperature_curve_name

field Speed 5 Heating Capacity Function of Temperature Curve Name

optional

curve = a + b*db + c*db**2 + d*ewt + e*ewt**2 + f*db*ewt

db = entering air dry-bulb temperature (C)

ewt = water entering temperature seen by the evaporator (C)

Parameters:value (str) – value for IDD Field Speed 5 Heating Capacity Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_5_heating_capacity_function_of_temperature_curve_name or None if not set Return type:str

speed_5_heating_capacity_function_of_water_flow_fraction_curve_name

field Speed 5 Heating Capacity Function of Water Flow Fraction Curve Name

optional

quadratic curve = a + b*ffw + c*ffw**2

cubic curve = a + b*ffw + c*ffw**2 + d*ffw**3

ffw = Fraction of the full load Water Flow

Parameters:value (str) – value for IDD Field Speed 5 Heating Capacity Function of Water Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_5_heating_capacity_function_of_water_flow_fraction_curve_name or None if not set Return type:str

speed_5_reference_unit_gross_rated_heating_capacity

field Speed 5 Reference Unit Gross Rated Heating Capacity

Heating capacity not accounting for the effect of supply air fan heat

Units: w

Parameters:value (float) – value for IDD Field Speed 5 Reference Unit Gross Rated Heating Capacity Raises:ValueError – if value is not a valid value Returns:the value of speed_5_reference_unit_gross_rated_heating_capacity or None if not set Return type:float

speed_5_reference_unit_gross_rated_heating_cop

field Speed 5 Reference Unit Gross Rated Heating COP

Units: dimensionless

Parameters:value (float) – value for IDD Field Speed 5 Reference Unit Gross Rated Heating COP Raises:ValueError – if value is not a valid value Returns:the value of speed_5_reference_unit_gross_rated_heating_cop or None if not set Return type:float

speed_5_reference_unit_rated_air_flow_rate

field Speed 5 Reference Unit Rated Air Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 5 Reference Unit Rated Air Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_5_reference_unit_rated_air_flow_rate or None if not set Return type:float

speed_5_reference_unit_rated_water_flow_rate

field Speed 5 Reference Unit Rated Water Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 5 Reference Unit Rated Water Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_5_reference_unit_rated_water_flow_rate or None if not set Return type:float

speed_5_reference_unit_waste_heat_fraction_of_input_power_at_rated_conditions

field Speed 5 Reference Unit Waste Heat Fraction of Input Power At Rated Conditions

Units: dimensionless

Parameters:value (float) – value for IDD Field Speed 5 Reference Unit Waste Heat Fraction of Input Power At Rated Conditions Raises:ValueError – if value is not a valid value Returns:the value of speed_5_reference_unit_waste_heat_fraction_of_input_power_at_rated_conditions or None if not set Return type:float

speed_5_total_heating_capacity_function_of_air_flow_fraction_curve_name

field Speed 5 Total Heating Capacity Function of Air Flow Fraction Curve Name

optional

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 5 Total Heating Capacity Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_5_total_heating_capacity_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_5_waste_heat_function_of_temperature_curve_name

field Speed 5 Waste Heat Function of Temperature Curve Name

optional

curve = a + b*db + c*db**2 + d*ewt + e*ewt**2 + f*db*ewt

db = entering air dry-bulb temperature (C)

ewt = water entering temperature seen by the evaporator (C)

Parameters:value (str) – value for IDD Field Speed 5 Waste Heat Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_5_waste_heat_function_of_temperature_curve_name or None if not set Return type:str

speed_6_energy_input_ratio_function_of_air_flow_fraction_curve_name

field Speed 6 Energy Input Ratio Function of Air Flow Fraction Curve Name

optional

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 6 Energy Input Ratio Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_6_energy_input_ratio_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_6_energy_input_ratio_function_of_temperature_curve_name

field Speed 6 Energy Input Ratio Function of Temperature Curve Name

optional

curve = a + b*db + c*db**2 + d*ewt + e*ewt**2 + f*db*ewt

db = entering air dry-bulb temperature (C)

ewt = water entering temperature seen by the evaporator (C)

Parameters:value (str) – value for IDD Field Speed 6 Energy Input Ratio Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_6_energy_input_ratio_function_of_temperature_curve_name or None if not set Return type:str

speed_6_energy_input_ratio_function_of_water_flow_fraction_curve_name

field Speed 6 Energy Input Ratio Function of Water Flow Fraction Curve Name

optional

quadratic curve = a + b*ffw + c*ffw**2

cubic curve = a + b*ffw + c*ffw**2 + d*ffw**3

ffw = Fraction of the full load Water Flow

Parameters:value (str) – value for IDD Field Speed 6 Energy Input Ratio Function of Water Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_6_energy_input_ratio_function_of_water_flow_fraction_curve_name or None if not set Return type:str

speed_6_heating_capacity_function_of_temperature_curve_name

field Speed 6 Heating Capacity Function of Temperature Curve Name

optional

curve = a + b*db + c*db**2 + d*ewt + e*ewt**2 + f*db*ewt

db = entering air dry-bulb temperature (C)

ewt = water entering temperature seen by the evaporator (C)

Parameters:value (str) – value for IDD Field Speed 6 Heating Capacity Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_6_heating_capacity_function_of_temperature_curve_name or None if not set Return type:str

speed_6_heating_capacity_function_of_water_flow_fraction_curve_name

field Speed 6 Heating Capacity Function of Water Flow Fraction Curve Name

optional

quadratic curve = a + b*ffw + c*ffw**2

cubic curve = a + b*ffw + c*ffw**2 + d*ffw**3

ffw = Fraction of the full load Water Flow

Parameters:value (str) – value for IDD Field Speed 6 Heating Capacity Function of Water Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_6_heating_capacity_function_of_water_flow_fraction_curve_name or None if not set Return type:str

speed_6_reference_unit_gross_rated_heating_capacity

field Speed 6 Reference Unit Gross Rated Heating Capacity

Heating capacity not accounting for the effect of supply air fan heat

Units: w

Parameters:value (float) – value for IDD Field Speed 6 Reference Unit Gross Rated Heating Capacity Raises:ValueError – if value is not a valid value Returns:the value of speed_6_reference_unit_gross_rated_heating_capacity or None if not set Return type:float

speed_6_reference_unit_gross_rated_heating_cop

field Speed 6 Reference Unit Gross Rated Heating COP

Units: dimensionless

Parameters:value (float) – value for IDD Field Speed 6 Reference Unit Gross Rated Heating COP Raises:ValueError – if value is not a valid value Returns:the value of speed_6_reference_unit_gross_rated_heating_cop or None if not set Return type:float

speed_6_reference_unit_rated_air_flow_rate

field Speed 6 Reference Unit Rated Air Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 6 Reference Unit Rated Air Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_6_reference_unit_rated_air_flow_rate or None if not set Return type:float

speed_6_reference_unit_rated_water_flow_rate

field Speed 6 Reference Unit Rated Water Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 6 Reference Unit Rated Water Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_6_reference_unit_rated_water_flow_rate or None if not set Return type:float

speed_6_reference_unit_waste_heat_fraction_of_input_power_at_rated_conditions

field Speed 6 Reference Unit Waste Heat Fraction of Input Power At Rated Conditions

Units: dimensionless

Parameters:value (float) – value for IDD Field Speed 6 Reference Unit Waste Heat Fraction of Input Power At Rated Conditions Raises:ValueError – if value is not a valid value Returns:the value of speed_6_reference_unit_waste_heat_fraction_of_input_power_at_rated_conditions or None if not set Return type:float

speed_6_total_heating_capacity_function_of_air_flow_fraction_curve_name

field Speed 6 Total Heating Capacity Function of Air Flow Fraction Curve Name

optional

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 6 Total Heating Capacity Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_6_total_heating_capacity_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_6_waste_heat_function_of_temperature_curve_name

field Speed 6 Waste Heat Function of Temperature Curve Name

optional

curve = a + b*db + c*db**2 + d*ewt + e*ewt**2 + f*db*ewt

db = entering air dry-bulb temperature (C)

ewt = water entering temperature seen by the evaporator (C)

Parameters:value (str) – value for IDD Field Speed 6 Waste Heat Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_6_waste_heat_function_of_temperature_curve_name or None if not set Return type:str

speed_7_energy_input_ratio_function_of_air_flow_fraction_curve_name

field Speed 7 Energy Input Ratio Function of Air Flow Fraction Curve Name

optional

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 7 Energy Input Ratio Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_7_energy_input_ratio_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_7_energy_input_ratio_function_of_temperature_curve_name

field Speed 7 Energy Input Ratio Function of Temperature Curve Name

optional

curve = a + b*db + c*db**2 + d*ewt + e*ewt**2 + f*db*ewt

db = entering air dry-bulb temperature (C)

ewt = water entering temperature seen by the evaporator (C)

Parameters:value (str) – value for IDD Field Speed 7 Energy Input Ratio Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_7_energy_input_ratio_function_of_temperature_curve_name or None if not set Return type:str

speed_7_energy_input_ratio_function_of_water_flow_fraction_curve_name

field Speed 7 Energy Input Ratio Function of Water Flow Fraction Curve Name

optional

quadratic curve = a + b*ffw + c*ffw**2

cubic curve = a + b*ffw + c*ffw**2 + d*ffw**3

ffw = Fraction of the full load Water Flow

Parameters:value (str) – value for IDD Field Speed 7 Energy Input Ratio Function of Water Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_7_energy_input_ratio_function_of_water_flow_fraction_curve_name or None if not set Return type:str

speed_7_heating_capacity_function_of_temperature_curve_name

field Speed 7 Heating Capacity Function of Temperature Curve Name

optional

curve = a + b*db + c*db**2 + d*ewt + e*ewt**2 + f*db*ewt

db = entering air dry-bulb temperature (C)

ewt = water entering temperature seen by the evaporator (C)

Parameters:value (str) – value for IDD Field Speed 7 Heating Capacity Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_7_heating_capacity_function_of_temperature_curve_name or None if not set Return type:str

speed_7_heating_capacity_function_of_water_flow_fraction_curve_name

field Speed 7 Heating Capacity Function of Water Flow Fraction Curve Name

optional

quadratic curve = a + b*ffw + c*ffw**2

cubic curve = a + b*ffw + c*ffw**2 + d*ffw**3

ffw = Fraction of the full load Water Flow

Parameters:value (str) – value for IDD Field Speed 7 Heating Capacity Function of Water Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_7_heating_capacity_function_of_water_flow_fraction_curve_name or None if not set Return type:str

speed_7_reference_unit_gross_rated_heating_capacity

field Speed 7 Reference Unit Gross Rated Heating Capacity

Heating capacity not accounting for the effect of supply air fan heat

Units: w

Parameters:value (float) – value for IDD Field Speed 7 Reference Unit Gross Rated Heating Capacity Raises:ValueError – if value is not a valid value Returns:the value of speed_7_reference_unit_gross_rated_heating_capacity or None if not set Return type:float

speed_7_reference_unit_gross_rated_heating_cop

field Speed 7 Reference Unit Gross Rated Heating COP

Units: dimensionless

Parameters:value (float) – value for IDD Field Speed 7 Reference Unit Gross Rated Heating COP Raises:ValueError – if value is not a valid value Returns:the value of speed_7_reference_unit_gross_rated_heating_cop or None if not set Return type:float

speed_7_reference_unit_rated_air_flow_rate

field Speed 7 Reference Unit Rated Air Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 7 Reference Unit Rated Air Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_7_reference_unit_rated_air_flow_rate or None if not set Return type:float

speed_7_reference_unit_rated_water_flow_rate

field Speed 7 Reference Unit Rated Water Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 7 Reference Unit Rated Water Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_7_reference_unit_rated_water_flow_rate or None if not set Return type:float

speed_7_reference_unit_waste_heat_fraction_of_input_power_at_rated_conditions

field Speed 7 Reference Unit Waste Heat Fraction of Input Power At Rated Conditions

Units: dimensionless

Parameters:value (float) – value for IDD Field Speed 7 Reference Unit Waste Heat Fraction of Input Power At Rated Conditions Raises:ValueError – if value is not a valid value Returns:the value of speed_7_reference_unit_waste_heat_fraction_of_input_power_at_rated_conditions or None if not set Return type:float

speed_7_total_heating_capacity_function_of_air_flow_fraction_curve_name

field Speed 7 Total Heating Capacity Function of Air Flow Fraction Curve Name

optional

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 7 Total Heating Capacity Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_7_total_heating_capacity_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_7_waste_heat_function_of_temperature_curve_name

field Speed 7 Waste Heat Function of Temperature Curve Name

optional

curve = a + b*db + c*db**2 + d*ewt + e*ewt**2 + f*db*ewt

db = entering air dry-bulb temperature (C)

ewt = water entering temperature seen by the evaporator (C)

Parameters:value (str) – value for IDD Field Speed 7 Waste Heat Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_7_waste_heat_function_of_temperature_curve_name or None if not set Return type:str

speed_8_energy_input_ratio_function_of_air_flow_fraction_curve_name

field Speed 8 Energy Input Ratio Function of Air Flow Fraction Curve Name

optional

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 8 Energy Input Ratio Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_8_energy_input_ratio_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_8_energy_input_ratio_function_of_temperature_curve_name

field Speed 8 Energy Input Ratio Function of Temperature Curve Name

optional

curve = a + b*db + c*db**2 + d*ewt + e*ewt**2 + f*db*ewt

db = entering air dry-bulb temperature (C)

ewt = water entering temperature seen by the evaporator (C)

Parameters:value (str) – value for IDD Field Speed 8 Energy Input Ratio Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_8_energy_input_ratio_function_of_temperature_curve_name or None if not set Return type:str

speed_8_energy_input_ratio_function_of_water_flow_fraction_curve_name

field Speed 8 Energy Input Ratio Function of Water Flow Fraction Curve Name

optional

quadratic curve = a + b*ffw + c*ffw**2

cubic curve = a + b*ffw + c*ffw**2 + d*ffw**3

ffw = Fraction of the full load Water Flow

Parameters:value (str) – value for IDD Field Speed 8 Energy Input Ratio Function of Water Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_8_energy_input_ratio_function_of_water_flow_fraction_curve_name or None if not set Return type:str

speed_8_heating_capacity_function_of_temperature_curve_name

field Speed 8 Heating Capacity Function of Temperature Curve Name

optional

curve = a + b*db + c*db**2 + d*ewt + e*ewt**2 + f*db*ewt

db = entering air dry-bulb temperature (C)

ewt = water entering temperature seen by the evaporator (C)

Parameters:value (str) – value for IDD Field Speed 8 Heating Capacity Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_8_heating_capacity_function_of_temperature_curve_name or None if not set Return type:str

speed_8_heating_capacity_function_of_water_flow_fraction_curve_name

field Speed 8 Heating Capacity Function of Water Flow Fraction Curve Name

optional

quadratic curve = a + b*ffw + c*ffw**2

cubic curve = a + b*ffw + c*ffw**2 + d*ffw**3

ffw = Fraction of the full load Water Flow

Parameters:value (str) – value for IDD Field Speed 8 Heating Capacity Function of Water Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_8_heating_capacity_function_of_water_flow_fraction_curve_name or None if not set Return type:str

speed_8_reference_unit_gross_rated_heating_capacity

field Speed 8 Reference Unit Gross Rated Heating Capacity

Heating capacity not accounting for the effect of supply air fan heat

Units: w

Parameters:value (float) – value for IDD Field Speed 8 Reference Unit Gross Rated Heating Capacity Raises:ValueError – if value is not a valid value Returns:the value of speed_8_reference_unit_gross_rated_heating_capacity or None if not set Return type:float

speed_8_reference_unit_gross_rated_heating_cop

field Speed 8 Reference Unit Gross Rated Heating COP

Units: dimensionless

Parameters:value (float) – value for IDD Field Speed 8 Reference Unit Gross Rated Heating COP Raises:ValueError – if value is not a valid value Returns:the value of speed_8_reference_unit_gross_rated_heating_cop or None if not set Return type:float

speed_8_reference_unit_rated_air_flow_rate

field Speed 8 Reference Unit Rated Air Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 8 Reference Unit Rated Air Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_8_reference_unit_rated_air_flow_rate or None if not set Return type:float

speed_8_reference_unit_rated_water_flow_rate

field Speed 8 Reference Unit Rated Water Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 8 Reference Unit Rated Water Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_8_reference_unit_rated_water_flow_rate or None if not set Return type:float

speed_8_reference_unit_waste_heat_fraction_of_input_power_at_rated_conditions

field Speed 8 Reference Unit Waste Heat Fraction of Input Power At Rated Conditions

Units: dimensionless

Parameters:value (float) – value for IDD Field Speed 8 Reference Unit Waste Heat Fraction of Input Power At Rated Conditions Raises:ValueError – if value is not a valid value Returns:the value of speed_8_reference_unit_waste_heat_fraction_of_input_power_at_rated_conditions or None if not set Return type:float

speed_8_total_heating_capacity_function_of_air_flow_fraction_curve_name

field Speed 8 Total Heating Capacity Function of Air Flow Fraction Curve Name

optional

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 8 Total Heating Capacity Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_8_total_heating_capacity_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_8_waste_heat_function_of_temperature_curve_name

field Speed 8 Waste Heat Function of Temperature Curve Name

optional

curve = a + b*db + c*db**2 + d*ewt + e*ewt**2 + f*db*ewt

db = entering air dry-bulb temperature (C)

ewt = water entering temperature seen by the evaporator (C)

Parameters:value (str) – value for IDD Field Speed 8 Waste Heat Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_8_waste_heat_function_of_temperature_curve_name or None if not set Return type:str

speed_9_energy_input_ratio_function_of_air_flow_fraction_curve_name

field Speed 9 Energy Input Ratio Function of Air Flow Fraction Curve Name

optional

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 9 Energy Input Ratio Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_9_energy_input_ratio_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_9_energy_input_ratio_function_of_temperature_curve_name

field Speed 9 Energy Input Ratio Function of Temperature Curve Name

optional

curve = a + b*db + c*db**2 + d*ewt + e*ewt**2 + f*db*ewt

db = entering air dry-bulb temperature (C)

ewt = water entering temperature seen by the evaporator (C)

Parameters:value (str) – value for IDD Field Speed 9 Energy Input Ratio Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_9_energy_input_ratio_function_of_temperature_curve_name or None if not set Return type:str

speed_9_energy_input_ratio_function_of_water_flow_fraction_curve_name

field Speed 9 Energy Input Ratio Function of Water Flow Fraction Curve Name

optional

quadratic curve = a + b*ffw + c*ffw**2

cubic curve = a + b*ffw + c*ffw**2 + d*ffw**3

ffw = Fraction of the full load Water Flow

Parameters:value (str) – value for IDD Field Speed 9 Energy Input Ratio Function of Water Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_9_energy_input_ratio_function_of_water_flow_fraction_curve_name or None if not set Return type:str

speed_9_heating_capacity_function_of_temperature_curve_name

field Speed 9 Heating Capacity Function of Temperature Curve Name

optional

curve = a + b*db + c*db**2 + d*ewt + e*ewt**2 + f*db*ewt

db = entering air dry-bulb temperature (C)

ewt = water entering temperature seen by the evaporator (C)

Parameters:value (str) – value for IDD Field Speed 9 Heating Capacity Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_9_heating_capacity_function_of_temperature_curve_name or None if not set Return type:str

speed_9_heating_capacity_function_of_water_flow_fraction_curve_name

field Speed 9 Heating Capacity Function of Water Flow Fraction Curve Name

optional

quadratic curve = a + b*ffw + c*ffw**2

cubic curve = a + b*ffw + c*ffw**2 + d*ffw**3

ffw = Fraction of the full load Water Flow

Parameters:value (str) – value for IDD Field Speed 9 Heating Capacity Function of Water Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_9_heating_capacity_function_of_water_flow_fraction_curve_name or None if not set Return type:str

speed_9_reference_unit_gross_rated_heating_capacity

field Speed 9 Reference Unit Gross Rated Heating Capacity

Heating capacity not accounting for the effect of supply air fan heat

Units: w

Parameters:value (float) – value for IDD Field Speed 9 Reference Unit Gross Rated Heating Capacity Raises:ValueError – if value is not a valid value Returns:the value of speed_9_reference_unit_gross_rated_heating_capacity or None if not set Return type:float

speed_9_reference_unit_gross_rated_heating_cop

field Speed 9 Reference Unit Gross Rated Heating COP

Units: dimensionless

Parameters:value (float) – value for IDD Field Speed 9 Reference Unit Gross Rated Heating COP Raises:ValueError – if value is not a valid value Returns:the value of speed_9_reference_unit_gross_rated_heating_cop or None if not set Return type:float

speed_9_reference_unit_rated_air_flow_rate

field Speed 9 Reference Unit Rated Air Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 9 Reference Unit Rated Air Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_9_reference_unit_rated_air_flow_rate or None if not set Return type:float

speed_9_reference_unit_rated_water_flow_rate

field Speed 9 Reference Unit Rated Water Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 9 Reference Unit Rated Water Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_9_reference_unit_rated_water_flow_rate or None if not set Return type:float

speed_9_reference_unit_waste_heat_fraction_of_input_power_at_rated_conditions

field Speed 9 Reference Unit Waste Heat Fraction of Input Power At Rated Conditions

Units: dimensionless

Parameters:value (float) – value for IDD Field Speed 9 Reference Unit Waste Heat Fraction of Input Power At Rated Conditions Raises:ValueError – if value is not a valid value Returns:the value of speed_9_reference_unit_waste_heat_fraction_of_input_power_at_rated_conditions or None if not set Return type:float

speed_9_total_heating_capacity_function_of_air_flow_fraction_curve_name

field Speed 9 Total Heating Capacity Function of Air Flow Fraction Curve Name

optional

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 9 Total Heating Capacity Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_9_total_heating_capacity_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_9_waste_heat_function_of_temperature_curve_name

field Speed 9 Waste Heat Function of Temperature Curve Name

optional

curve = a + b*db + c*db**2 + d*ewt + e*ewt**2 + f*db*ewt

db = entering air dry-bulb temperature (C)

ewt = water entering temperature seen by the evaporator (C)

Parameters:value (str) – value for IDD Field Speed 9 Waste Heat Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_9_waste_heat_function_of_temperature_curve_name or None if not set Return type:str

watertorefrigerant_hx_water_inlet_node_name

field Water-to-Refrigerant HX Water Inlet Node Name

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

watertorefrigerant_hx_water_outlet_node_name

field Water-to-Refrigerant HX Water Outlet Node Name

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

class pyidf.coils.CoilPerformanceDxCooling

Bases: pyidf.helper.DataObject

Corresponds to IDD object CoilPerformance:DX:Cooling Used to specify DX cooling coil performance for one mode of operation for a Coil:Cooling:DX:TwoStageWithHumidityControlMode object which may reference one to four CoilPerformance:DX:Cooling objects depending on the specified number of stages and dehumidification modes. In nearly all cases, the Rated Air Flow Rate will be the same for all performance objects associated with a given coil. If bypass is specified, the Rated Air Flow Rate includes both the bypassed flow and the flow through the active part of the coil.

condenser_air_inlet_node_name

field Condenser Air Inlet Node Name

Enter the name of an outdoor air node. This node name is also specified in

an OutdoorAir:Node or OutdoorAir:NodeList object.

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

condenser_type

field Condenser Type

Default value: AirCooled

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

energy_input_ratio_function_of_flow_fraction_curve_name

field Energy Input Ratio Function of Flow Fraction Curve Name

quadratic curve = a + b*ff + c*ff**2

cubic curve = a + b*ff + c*ff**2 + d*ff**3

ff = fraction of the full load flow

Parameters:value (str) – value for IDD Field Energy Input Ratio Function of Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of energy_input_ratio_function_of_flow_fraction_curve_name or None if not set Return type:str

energy_input_ratio_function_of_temperature_curve_name

field Energy Input Ratio Function of Temperature Curve Name

curve = a + b*wb + c*wb**2 + d*edb + e*edb**2 + f*wb*edb

wb = entering wet-bulb temperature (C)

edb = dry-bulb temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Energy Input Ratio Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of energy_input_ratio_function_of_temperature_curve_name or None if not set Return type:str

evaporative_condenser_air_flow_rate

field Evaporative Condenser Air Flow Rate

Used to calculate evaporative condenser water use

Units: m3/s

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

evaporative_condenser_effectiveness

field Evaporative Condenser Effectiveness

Units: dimensionless

Default value: 0.9

value <= 1.0

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

evaporative_condenser_pump_rated_power_consumption

field Evaporative Condenser Pump Rated Power Consumption

Rated power consumed by the evaporative condenser’s water pump

Units: W

Parameters:value (float or “Autosize”) – value for IDD Field Evaporative Condenser Pump Rated Power Consumption Raises:ValueError – if value is not a valid value Returns:the value of evaporative_condenser_pump_rated_power_consumption or None if not set Return type:float or “Autosize”

fraction_of_air_flow_bypassed_around_coil

field Fraction of Air Flow Bypassed Around Coil

Fraction of Rated Air Flow Rate which bypasses the cooling coil

in this performance mode. The remaining portion of the flow

should be between 0.00004027 m3/s and .00006041 m3/s per watt of rated total cooling capacity.

This is used to model face-split coils on multi-stage units or bypass dampers.

If total flow rate varies during simulation, the same fraction is bypassed.

value < 1.0

Parameters:value (float) – value for IDD Field Fraction of Air Flow Bypassed Around Coil Raises:ValueError – if value is not a valid value Returns:the value of fraction_of_air_flow_bypassed_around_coil or None if not set Return type:float

gross_rated_cooling_cop

field Gross Rated Cooling COP

Gross cooling capacity divided by power input to the compressor and outdoor fan,

does not include supply fan heat or supply fan electrical energy input

Units: W/W

Default value: 3.0

Parameters:value (float) – value for IDD Field Gross Rated Cooling COP Raises:ValueError – if value is not a valid value Returns:the value of gross_rated_cooling_cop or None if not set Return type:float

gross_rated_sensible_heat_ratio

field Gross Rated Sensible Heat Ratio

Rated sensible heat ratio (gross sensible capacity/gross total capacity)

sensible and total capacities do not include supply fan heat

value >= 0.5

value <= 1.0

Parameters:value (float or “Autosize”) – value for IDD Field Gross Rated Sensible Heat Ratio Raises:ValueError – if value is not a valid value Returns:the value of gross_rated_sensible_heat_ratio or None if not set Return type:float or “Autosize”

gross_rated_total_cooling_capacity

field Gross Rated Total Cooling Capacity

Total cooling capacity not accounting for the effect of supply air fan heat

gross capacity excluding supply air fan heat

rating point: air entering the cooling coil at 26.7 C dry-bulb/19.4 C wet-bulb, and

air entering the outdoor condenser coil at 35 C dry-bulb/23.9 C wet-bulb

Units: W

Parameters:value (float or “Autosize”) – value for IDD Field Gross Rated Total Cooling Capacity Raises:ValueError – if value is not a valid value Returns:the value of gross_rated_total_cooling_capacity or None if not set Return type:float or “Autosize”

latent_capacity_time_constant

field Latent Capacity Time Constant

Time constant for the cooling coil’s latent capacity to reach steady state after

startup. Suggested value is 45; zero value means latent degradation model is disabled.

Units: s

value <= 500.0

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

maximum_cycling_rate

field Maximum Cycling Rate

The maximum on-off cycling rate for the compressor, which occurs at 50% run time

fraction. Suggested value is 3; zero value means latent degradation model is disabled.

Units: cycles/hr

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

name

field Name

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

nominal_time_for_condensate_removal_to_begin

field Nominal Time for Condensate Removal to Begin

The nominal time for condensate to begin leaving the coil’s condensate

drain line at the coil’s rated air flow rate and temperature conditions.

Nominal time is equal to the ratio of the energy of the coil’s maximum

condensate holding capacity (J) to the coil’s steady state latent capacity (W).

Suggested value is 1000; zero value means latent degradation model is disabled.

Units: s

value <= 3000.0

Parameters:value (float) – value for IDD Field Nominal Time for Condensate Removal to Begin Raises:ValueError – if value is not a valid value Returns:the value of nominal_time_for_condensate_removal_to_begin or None if not set Return type:float

part_load_fraction_correlation_curve_name

field Part Load Fraction Correlation Curve Name

quadratic curve = a + b*PLR + c*PLR**2

cubic curve = a + b*PLR + c*PLR**2 + d*PLR**3

PLR = part load ratio (cooling load/steady state capacity)

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

rated_air_flow_rate

field Rated Air Flow Rate

Flow rate corresponding to Rated total Cooling capacity, Rated SHR and Rated COP

Units: m3/s

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

ratio_of_initial_moisture_evaporation_rate_and_steady_state_latent_capacity

field Ratio of Initial Moisture Evaporation Rate and Steady State Latent Capacity

Ratio of the initial moisture evaporation rate from the cooling coil (when

the compressor first turns off) and the coil’s steady state latent capacity

at rated air flow rate and temperature conditions. Suggested value is 1.5; zero value

means latent degradation model is disabled.

Units: dimensionless

value <= 5.0

Parameters:value (float) – value for IDD Field Ratio of Initial Moisture Evaporation Rate and Steady State Latent Capacity Raises:ValueError – if value is not a valid value Returns:the value of ratio_of_initial_moisture_evaporation_rate_and_steady_state_latent_capacity or None if not set Return type:float

sensible_heat_ratio_function_of_flow_fraction_curve_name

field Sensible Heat Ratio Function of Flow Fraction Curve Name

quadratic curve = a + b*ff + c*ff**2

cubic curve = a + b*ff + c*ff**2 + d*ff**3

ff = fraction of the full load flow

Parameters:value (str) – value for IDD Field Sensible Heat Ratio Function of Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of sensible_heat_ratio_function_of_flow_fraction_curve_name or None if not set Return type:str

sensible_heat_ratio_function_of_temperature_curve_name

field Sensible Heat Ratio Function of Temperature Curve Name

curve = a + b*wb + c*wb**2 + d*db + e*db**2 + f*wb*db

wb = entering wet-bulb temperature seen by the DX cooling coil (C)

db = entering dry-bulb temperature seen by the DX cooling coil (C)

entering temperature can be outside air or pretreated air.

Parameters:value (str) – value for IDD Field Sensible Heat Ratio Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of sensible_heat_ratio_function_of_temperature_curve_name or None if not set Return type:str

total_cooling_capacity_function_of_flow_fraction_curve_name

field Total Cooling Capacity Function of Flow Fraction Curve Name

quadratic curve = a + b*ff + c*ff**2

cubic curve = a + b*ff + c*ff**2 + d*ff**3

ff = fraction of the full load flow

Parameters:value (str) – value for IDD Field Total Cooling Capacity Function of Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of total_cooling_capacity_function_of_flow_fraction_curve_name or None if not set Return type:str

total_cooling_capacity_function_of_temperature_curve_name

field Total Cooling Capacity Function of Temperature Curve Name

curve = a + b*wb + c*wb**2 + d*edb + e*edb**2 + f*wb*edb

wb = entering wet-bulb temperature (C)

edb = dry-bulb temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Total Cooling Capacity Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of total_cooling_capacity_function_of_temperature_curve_name or None if not set Return type:str

class pyidf.coils.CoilSystemCoolingDx

Bases: pyidf.helper.DataObject

Corresponds to IDD object CoilSystem:Cooling:DX Virtual container component that consists of a DX cooling coil and its associated controls. This control object supports several different types of DX cooling coils and may be placed directly in an air loop branch or outdoor air equipment list.

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

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

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

dehumidification_control_type

field Dehumidification Control Type

None = meet sensible load only

Multimode = activate enhanced dehumidification mode

as needed and meet sensible load. If no sensible load

exists, and Run on Latent Load = Yes, and a latent

load exists, the unit will operate to meet the latent load.

Valid only with Coil:Cooling:DX:TwoStageWithHumidityControlMode

or CoilSystem:Cooling:DX:HeatExchangerAssisted.

CoolReheat = cool beyond the dry-bulb setpoint.

as required to meet the humidity setpoint.

Valid for all coil types.

For all dehumidification controls, the max

humidity setpoint on the Sensor Node is used.

SetpointManager:SingleZone:Humidity:Maximum,

SetpointManager:MultiZone:Humidity:Maximum, or

SetpointManager:MultiZone:MaximumHumidity:Average, and

SetpointManager:OutdoorAirPretreat (optional) 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

dx_cooling_coil_system_inlet_node_name

field DX Cooling Coil System Inlet Node Name

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

dx_cooling_coil_system_outlet_node_name

field DX Cooling Coil System Outlet Node Name

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

dx_cooling_coil_system_sensor_node_name

field DX Cooling Coil System Sensor Node Name

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

name

field Name

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

outdoor_air_dx_cooling_coil_leaving_minimum_air_temperature

field Outdoor Air DX Cooling Coil Leaving Minimum Air Temperature

DX cooling coil leaving minimum air temperature defines the minimum 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 Outdoor Air DX Cooling Coil Leaving Minimum Air Temperature Raises:ValueError – if value is not a valid value Returns:the value of outdoor_air_dx_cooling_coil_leaving_minimum_air_temperature or None if not set Return type:float

run_on_latent_load

field Run on Latent Load

If Yes, unit will run if there is a latent load.

even if there is no sensible load.

If No, unit will not run only if there is a latent load.

Dehumidification controls will be active if specified.

Default value: No

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

run_on_sensible_load

field Run on Sensible Load

If Yes, unit will run if there is a sensible load.

If No, unit will not run if there is only a sensible load.

Dehumidification controls will be active if specified.

Default value: Yes

Parameters:value (str) – value for IDD Field Run on Sensible Load Raises:ValueError – if value is not a valid value Returns:the value of run_on_sensible_load or None if not set Return type:str

use_outdoor_air_dx_cooling_coil

field Use Outdoor Air DX Cooling Coil

This input field is designed for use with DX cooling coils with low air flow

to capacity ratio range (100 - 300 cfm/ton). Typical application is 100% dedicated

outdoor air system (DOAS). Other air loop or zone HVAC systems with low flow

to capacity ratio range may also use this input field. If Yes, the DX cooling

coil runs as 100% DOAS DX coil or low flow to capacity ratio range.

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 Outdoor Air DX Cooling Coil Raises:ValueError – if value is not a valid value Returns:the value of use_outdoor_air_dx_cooling_coil or None if not set Return type:str

class pyidf.coils.CoilSystemCoolingDxHeatExchangerAssisted

Bases: pyidf.helper.DataObject

Corresponds to IDD object CoilSystem:Cooling:DX:HeatExchangerAssisted Virtual component consisting of a direct expansion (DX) cooling coil and an air-to-air heat exchanger. The air-to-air heat exchanger precools the air entering the cooling coil and reuses this energy to reheat the supply air leaving the cooling coil. This heat exchange process improves the latent removal performance of the cooling coil (lower sensible heat ratio).

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

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

heat_exchanger_name

field Heat Exchanger Name

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

heat_exchanger_object_type

field Heat Exchanger Object Type

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

name

field Name

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

class pyidf.coils.CoilSystemCoolingWaterHeatExchangerAssisted

Bases: pyidf.helper.DataObject

Corresponds to IDD object CoilSystem:Cooling:Water:HeatExchangerAssisted Virtual component consisting of a chilled-water cooling coil and an air-to-air heat exchanger. The air-to-air heat exchanger precools the air entering the cooling coil and reuses this energy to reheat the supply air leaving the cooling coil. This heat exchange process improves the latent removal performance of the cooling coil (lower sensible heat ratio).

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

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

heat_exchanger_name

field Heat Exchanger Name

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

heat_exchanger_object_type

field Heat Exchanger Object Type

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

name

field Name

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

class pyidf.coils.CoilSystemHeatingDx

Bases: pyidf.helper.DataObject

Corresponds to IDD object CoilSystem:Heating:DX Virtual container component that consists of a DX heating coil (heat pump) and its associated controls. This control object supports two different types of DX heating coils and may be placed directly in an air loop branch or outdoor air equipment list.

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

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

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

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

class pyidf.coils.CoilWaterHeatingAirToWaterHeatPumpPumped

Bases: pyidf.helper.DataObject

Corresponds to IDD object Coil:WaterHeating:AirToWaterHeatPump:Pumped Heat pump water heater (HPWH) heating coil, air-to-water direct-expansion (DX) system which includes a water heating coil, evaporator air coil, evaporator fan, electric compressor, and water pump. Part of a WaterHeater:HeatPump:PumpedCondenser system.

condenser_pump_heat_included_in_rated_heating_capacity_and_rated_cop

field Condenser Pump Heat Included in Rated Heating Capacity and Rated COP

Select Yes if the condenser pump heat is included in the rated heating capacity and

rated COP. This choice field impacts the calculation of water heating capacity.

Default value: No

Parameters:value (str) – value for IDD Field Condenser Pump Heat Included in Rated Heating Capacity and Rated COP Raises:ValueError – if value is not a valid value Returns:the value of condenser_pump_heat_included_in_rated_heating_capacity_and_rated_cop or None if not set Return type:str

condenser_pump_power_included_in_rated_cop

field Condenser Pump Power Included in Rated COP

Select Yes if the condenser pump power is included in the rated COP. This choice field

impacts the calculation of compressor electric power.

Default value: No

Parameters:value (str) – value for IDD Field Condenser Pump Power Included in Rated COP Raises:ValueError – if value is not a valid value Returns:the value of condenser_pump_power_included_in_rated_cop or None if not set Return type:str

condenser_water_inlet_node_name

field Condenser Water Inlet Node Name

The node from which the DX coil condenser draws its inlet water.

This name should match the source side outlet node name in the associated

water heater tank object.

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

condenser_water_outlet_node_name

field Condenser Water Outlet Node Name

The node to which the DX coil condenser sends its outlet water.

This name should match the source side inlet node name in the associated

water heater tank object.

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

condenser_water_pump_power

field Condenser Water Pump Power

A warning message will be issued if the ratio of Condenser Water Pump Power to Rated

Heating Capacity exceeds 0.1422 W/W (41.67 Watts/MBH), but the simulation will continue.

Units: W

Parameters:value (float) – value for IDD Field Condenser Water Pump Power Raises:ValueError – if value is not a valid value Returns:the value of condenser_water_pump_power or None if not set Return type:float

crankcase_heater_capacity

field Crankcase Heater Capacity

The compressor crankcase heater only operates when the dry-bulb temperature of air

surrounding the compressor is below the Maximum Ambient Temperature for Crankcase

Heater Operation and the DX coil is off. The ambient temperature surrounding the

compressor is set by the WaterHeater:HeatPump:PumpedCondenser parent object (field Compressor Location).

Units: W

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

evaporator_air_inlet_node_name

field Evaporator Air Inlet Node Name

The node from which the DX coil draws its inlet air.

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

evaporator_air_outlet_node_name

field Evaporator Air Outlet Node Name

The node to which the DX coil sends its outlet air.

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

evaporator_air_temperature_type_for_curve_objects

field Evaporator Air Temperature Type for Curve Objects

Determines temperature type for heating capacity curves and

heating COP curves. This input determines whether

the inlet air dry-bulb or wet-bulb temperature is used to evaluate these curves.

Default value: WetBulbTemperature

Parameters:value (str) – value for IDD Field Evaporator Air Temperature Type for Curve Objects Raises:ValueError – if value is not a valid value Returns:the value of evaporator_air_temperature_type_for_curve_objects or None if not set Return type:str

evaporator_fan_power_included_in_rated_cop

field Evaporator Fan Power Included in Rated COP

Select Yes if the evaporator fan power is included in the rated COP. This choice field

impacts the calculation of compressor electric power.

Default value: Yes

Parameters:value (str) – value for IDD Field Evaporator Fan Power Included in Rated COP Raises:ValueError – if value is not a valid value Returns:the value of evaporator_fan_power_included_in_rated_cop or None if not set Return type:str

fraction_of_condenser_pump_heat_to_water

field Fraction of Condenser Pump Heat to Water

Fraction of pump heat transferred to the condenser water. The pump is assumed

to be located downstream of the condenser.

Default value: 0.2

value <= 1.0

Parameters:value (float) – value for IDD Field Fraction of Condenser Pump Heat to Water Raises:ValueError – if value is not a valid value Returns:the value of fraction_of_condenser_pump_heat_to_water or None if not set Return type:float

heating_capacity_function_of_air_flow_fraction_curve_name

field Heating Capacity Function of Air Flow Fraction Curve Name

Heating capacity modifier curve (function of air flow fraction) should be quadratic or cubic.

Quadratic curve = a + b(ff) + c(ff)^2.

Cubic curve = a + b(ff) + c(ff)^2 + d(ff)^3.

ff = fraction of the rated evaporator air flow rate.

Use curve coefficients of 1,0,0 or leave this field blank when neglecting performance impacts

due to variations in air flow rate fraction.

Parameters:value (str) – value for IDD Field Heating Capacity Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of heating_capacity_function_of_air_flow_fraction_curve_name or None if not set Return type:str

heating_capacity_function_of_temperature_curve_name

field Heating Capacity Function of Temperature Curve Name

Heating capacity modifier curve (function of temperature) should be biquadratic or cubic.

Biquadratic curve = a + b(ta) + c(ta)^2 + d(tw) + e(tw)^2 + f(ta)(tw).

Cubic curve = a + b(ta) + c(ta)^2 + d(ta)^3.

ta = evaporator inlet air [dry-bulb or wet-bulb] temperature (C).

tw = condenser inlet water temperature (C).

The field Evaporator Air Temperature Type for Curve Objects determines if dry-bulb or wet-bulb

is used as the evaporator inlet air temperature (ta).

Parameters:value (str) – value for IDD Field Heating Capacity Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of heating_capacity_function_of_temperature_curve_name or None if not set Return type:str

heating_capacity_function_of_water_flow_fraction_curve_name

field Heating Capacity Function of Water Flow Fraction Curve Name

Heating capacity modifier curve (function of water flow fraction) should be quadratic or cubic.

Quadratic curve = a + b(ff) + c(ff)^2.

Cubic curve = a + b(ff) + c(ff)^2 + d(ff)^3.

ff = fraction of the rated condenser water flow rate.

Use curve coefficients of 1,0,0 or leave this field blank when neglecting performance impacts

due to variations in water flow rate fraction.

Parameters:value (str) – value for IDD Field Heating Capacity Function of Water Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of heating_capacity_function_of_water_flow_fraction_curve_name or None if not set Return type:str

heating_cop_function_of_air_flow_fraction_curve_name

field Heating COP Function of Air Flow Fraction Curve Name

Heating COP modifier curve (function of air flow fraction) should be quadratic or cubic.

Quadratic curve = a + b(ff) + c(ff)^2.

Cubic curve = a + b(ff) + c(ff)^2 + d(ff)^3.

ff = fraction of the rated evaporator air flow rate.

Use curve coefficients of 1,0,0 or leave this field blank when neglecting performance impacts

due to variations in air flow rate fraction.

Parameters:value (str) – value for IDD Field Heating COP Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of heating_cop_function_of_air_flow_fraction_curve_name or None if not set Return type:str

heating_cop_function_of_temperature_curve_name

field Heating COP Function of Temperature Curve Name

Heating COP modifier curve (function of temperature) should be biquadratic or cubic.

Biquadratic curve = a + b(ta) + c(ta)^2 + d(tw) + e(tw)^2 + f(ta)(tw).

Cubic curve = a + b(ta) + c(ta)^2 + d(ta)^3.

ta = evaporator inlet air [dry-bulb or wet-bulb] temperature (C).

tw = condenser inlet water temperature (C).

The field Evaporator Air Temperature Type for Curve Objects determines if dry-bulb or wet-bulb

is used as the evaporator inlet air temperature (ta).

Parameters:value (str) – value for IDD Field Heating COP Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of heating_cop_function_of_temperature_curve_name or None if not set Return type:str

heating_cop_function_of_water_flow_fraction_curve_name

field Heating COP Function of Water Flow Fraction Curve Name

Heating COP modifier curve (function of water flow fraction) should be quadratic or cubic.

Quadratic curve = a + b(ff) + c(ff)^2.

Cubic curve = a + b(ff) + c(ff)^2 + d(ff)^3.

ff = fraction of the rated condenser water flow rate.

Use curve coefficients of 1,0,0 or leave this field blank when neglecting performance impacts

due to variations in water flow rate fraction.

Parameters:value (str) – value for IDD Field Heating COP Function of Water Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of heating_cop_function_of_water_flow_fraction_curve_name or None if not set Return type:str

maximum_ambient_temperature_for_crankcase_heater_operation

field Maximum Ambient Temperature for Crankcase Heater Operation

The compressor crankcase heater only operates when the dry-bulb temperature of air

surrounding the compressor is below the Maximum Outdoor Temperature for Crankcase

Heater Operation and the unit is off. The ambient temperature surrounding the

compressor is set by the WaterHeater:HeatPump:PumpedCondenser parent object (field Compressor Location).

Units: C

Default value: 10.0

Parameters:value (float) – value for IDD Field Maximum Ambient Temperature for Crankcase Heater Operation Raises:ValueError – if value is not a valid value Returns:the value of maximum_ambient_temperature_for_crankcase_heater_operation or None if not set Return type:float

name

field Name

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

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

part_load_fraction_correlation_curve_name

field Part Load Fraction Correlation Curve Name

Part Load Fraction Correlation (function of part load ratio) should be quadratic or cubic.

Quadratic curve = a + b(PLR) + c(PLR)^2.

Cubic curve = a + b(PLR) + c(PLR)^2 + d(PLR)^3.

PLR = part load ratio (heating delivered/steady state heating capacity).

Use curve coefficients of 1,0,0 or leave this field blank when neglecting performance impacts

due to variations in part load ratio.

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

rated_condenser_inlet_water_temperature

field Rated Condenser Inlet Water Temperature

Condenser inlet water temperature corresponding to rated coil performance

(heating capacity, COP and SHR).

Units: C

Default value: 57.5

value > 25.0

Parameters:value (float) – value for IDD Field Rated Condenser Inlet Water Temperature Raises:ValueError – if value is not a valid value Returns:the value of rated_condenser_inlet_water_temperature or None if not set Return type:float

rated_condenser_water_flow_rate

field Rated Condenser Water Flow Rate

Condenser water flow rate corresponding to rated coil performance

(heating capacity, COP and SHR).

Default is 4.487E-8 m3/s/W (0.208 gpm/MBH) of rated heating capacity when autocalculated.

A warning message will be issued if the ratio of Rated Condenser Water Flow Rate

to Heating Capacity is less than 1.79405E-8 m3/s/W (0.083 gpm/MBH)

or greater than 8.97024E-8 m3/s/W (0.417 gpm/MBH), but the simulation will continue.

Units: m3/s

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

rated_cop

field Rated COP

Heating coefficient of performance at the rated inlet air temperatures,

rated condenser inlet water temperature, rated air flow rate, and rated water flow rate.

Can optionally include condenser pump power and evaporator fan power (see fields below).

Units: W/W

Default value: 3.2

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

rated_evaporator_air_flow_rate

field Rated Evaporator Air Flow Rate

Evaporator air flow rate corresponding to rated coil performance

(heating capacity, COP and SHR).

Default is 5.035E-5 m3/s/W (31.25 cfm/MBH) of rated heating capacity when autocalculated.

Units: m3/s

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

rated_evaporator_inlet_air_drybulb_temperature

field Rated Evaporator Inlet Air Dry-Bulb Temperature

Evaporator inlet air dry-bulb temperature corresponding to rated coil performance

(heating capacity, COP and SHR).

Units: C

Default value: 19.7

value > 5.0

Parameters:value (float) – value for IDD Field Rated Evaporator Inlet Air Dry-Bulb Temperature Raises:ValueError – if value is not a valid value Returns:the value of rated_evaporator_inlet_air_drybulb_temperature or None if not set Return type:float

rated_evaporator_inlet_air_wetbulb_temperature

field Rated Evaporator Inlet Air Wet-Bulb Temperature

Evaporator inlet air wet-bulb temperature corresponding to rated coil performance

(heating capacity, COP and SHR).

Units: C

Default value: 13.5

value > 5.0

Parameters:value (float) – value for IDD Field Rated Evaporator Inlet Air Wet-Bulb Temperature Raises:ValueError – if value is not a valid value Returns:the value of rated_evaporator_inlet_air_wetbulb_temperature or None if not set Return type:float

rated_heating_capacity

field Rated Heating Capacity

Heating capacity at the rated inlet air temperatures, rated condenser inlet

water temperature, rated air flow rate, and rated water flow rate.

Can optionally include condenser pump heat.

Units: W

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

rated_sensible_heat_ratio

field Rated Sensible Heat Ratio

Gross air-side sensible heat ratio at the rated inlet air temperatures,

rated condenser inlet water temperature, rated air flow rate, and rated water flow rate.

Sensible heat ratio equals gross sensible cooling capacity divided by gross total cooling

capacity. Rated SHR (gross) should not include evaporator fan heat, only sensible cooling

and dehumidification by the coil alone.

Default value: 0.85

value >= 0.5

value <= 1.0

Parameters:value (float) – value for IDD Field Rated Sensible Heat Ratio Raises:ValueError – if value is not a valid value Returns:the value of rated_sensible_heat_ratio or None if not set Return type:float

class pyidf.coils.CoilWaterHeatingAirToWaterHeatPumpVariableSpeed

Bases: pyidf.helper.DataObject

Corresponds to IDD object Coil:WaterHeating:AirToWaterHeatPump:VariableSpeed vairlable-speed Heat pump water heater (VSHPWH) heating coil, air-to-water direct-expansion (DX) system which includes a variable-speed water heating coil, evaporator air coil, evaporator fan, electric compressor, and water pump. Part of a WaterHeater:HeatPump system.

condenser_pump_heat_included_in_rated_heating_capacity_and_rated_cop

field Condenser Pump Heat Included in Rated Heating Capacity and Rated COP

Select Yes if the condenser pump heat is included in the rated heating capacity and

rated COP. This choice field impacts the calculation of water heating capacity.

Default value: No

Parameters:value (str) – value for IDD Field Condenser Pump Heat Included in Rated Heating Capacity and Rated COP Raises:ValueError – if value is not a valid value Returns:the value of condenser_pump_heat_included_in_rated_heating_capacity_and_rated_cop or None if not set Return type:str

condenser_pump_power_included_in_rated_cop

field Condenser Pump Power Included in Rated COP

Select Yes if the condenser pump power is included in the rated COP. This choice field

impacts the calculation of compressor electric power.

Default value: No

Parameters:value (str) – value for IDD Field Condenser Pump Power Included in Rated COP Raises:ValueError – if value is not a valid value Returns:the value of condenser_pump_power_included_in_rated_cop or None if not set Return type:str

condenser_water_inlet_node_name

field Condenser Water Inlet Node Name

The node from which the DX coil condenser draws its inlet water.

This name should match the source side outlet node name in the associated

water heater tank object.

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

condenser_water_outlet_node_name

field Condenser Water Outlet Node Name

The node to which the DX coil condenser sends its outlet water.

This name should match the source side inlet node name in the associated

water heater tank object.

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

crankcase_heater_capacity

field Crankcase Heater Capacity

The compressor crankcase heater only operates when the dry-bulb temperature of air

surrounding the compressor is below the Maximum Ambient Temperature for Crankcase

Heater Operation and the DX coil is off. The ambient temperature surrounding the

compressor is set by the WaterHeater:HeatPump parent object (field Compressor Location).

Units: W

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

evaporator_air_inlet_node_name

field Evaporator Air Inlet Node Name

The node from which the DX coil draws its inlet air.

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

evaporator_air_outlet_node_name

field Evaporator Air Outlet Node Name

The node to which the DX coil sends its outlet air.

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

evaporator_air_temperature_type_for_curve_objects

field Evaporator Air Temperature Type for Curve Objects

Determines temperature type for heating capacity curves and

heating COP curves. This input determines whether

the inlet air dry-bulb or wet-bulb temperature is used to evaluate these curves.

Default value: WetBulbTemperature

Parameters:value (str) – value for IDD Field Evaporator Air Temperature Type for Curve Objects Raises:ValueError – if value is not a valid value Returns:the value of evaporator_air_temperature_type_for_curve_objects or None if not set Return type:str

evaporator_fan_power_included_in_rated_cop

field Evaporator Fan Power Included in Rated COP

Select Yes if the evaporator fan power is included in the rated COP. This choice field

impacts the calculation of compressor electric power.

Default value: Yes

Parameters:value (str) – value for IDD Field Evaporator Fan Power Included in Rated COP Raises:ValueError – if value is not a valid value Returns:the value of evaporator_fan_power_included_in_rated_cop or None if not set Return type:str

fraction_of_condenser_pump_heat_to_water

field Fraction of Condenser Pump Heat to Water

Fraction of pump heat transferred to the condenser water. The pump is assumed

to be located downstream of the condenser.

Default value: 0.2

value <= 1.0

Parameters:value (float) – value for IDD Field Fraction of Condenser Pump Heat to Water Raises:ValueError – if value is not a valid value Returns:the value of fraction_of_condenser_pump_heat_to_water or None if not set Return type:float

maximum_ambient_temperature_for_crankcase_heater_operation

field Maximum Ambient Temperature for Crankcase Heater Operation

The compressor crankcase heater only operates when the dry-bulb temperature of air

surrounding the compressor is below the Maximum Outdoor Temperature for Crankcase

Heater Operation and the unit is off. The ambient temperature surrounding the

compressor is set by the WaterHeater:HeatPump parent object (field Compressor Location).

Units: C

Default value: 10.0

Parameters:value (float) – value for IDD Field Maximum Ambient Temperature for Crankcase Heater Operation Raises:ValueError – if value is not a valid value Returns:the value of maximum_ambient_temperature_for_crankcase_heater_operation or None if not set Return type:float

name

field Name

Unique name for this instance of a variable-speed heat pump water heater DX coil.

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

nominal_speed_level

field Nominal Speed Level

must be lower than or equal to the highest speed number

Units: dimensionless

Default value: 1

Parameters:value (int) – value for IDD Field Nominal Speed Level Raises:ValueError – if value is not a valid value Returns:the value of nominal_speed_level or None if not set Return type:int

number_of_speeds

field Number of Speeds

Units: dimensionless

Default value: 1

value >= 1

value <= 10

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

part_load_fraction_correlation_curve_name

field Part Load Fraction Correlation Curve Name

Table:OneIndependentVariable object can also be used

Part Load Fraction Correlation (function of part load ratio) should be quadratic or cubic.

Quadratic curve = a + b(PLR) + c(PLR)^2.

Cubic curve = a + b(PLR) + c(PLR)^2 + d(PLR)^3.

PLR = part load ratio (heating delivered/steady state heating capacity).

Use curve coefficients of 1,0,0 or leave this field blank when neglecting performance impacts

due to variations in part load ratio.

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

rated_condenser_inlet_water_temperature

field Rated Condenser Inlet Water Temperature

Condenser inlet water temperature corresponding to rated coil performance

(heating capacity, COP and SHR).

Units: C

Default value: 57.5

value > 25.0

Parameters:value (float) – value for IDD Field Rated Condenser Inlet Water Temperature Raises:ValueError – if value is not a valid value Returns:the value of rated_condenser_inlet_water_temperature or None if not set Return type:float

rated_condenser_water_flow_rate

field Rated Condenser Water Flow Rate

Condenser water flow rate corresponding to rated coil performance

(heating capacity, COP and SHR).

Default is 4.487E-8 m3/s/W (0.208 gpm/MBH) of rated heating capacity when autocalculated.

A warning message will be issued if the ratio of Rated Condenser Water Flow Rate

to Heating Capacity is less than 1.79405E-8 m3/s/W (0.083 gpm/MBH)

or greater than 8.97024E-8 m3/s/W (0.417 gpm/MBH), but the simulation will continue.

Units: m3/s

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

rated_evaporator_air_flow_rate

field Rated Evaporator Air Flow Rate

Evaporator air flow rate corresponding to rated coil performance

(heating capacity, COP and SHR).

Default is 5.035E-5 m3/s/W (31.25 cfm/MBH) of rated heating capacity when autocalculated.

Units: m3/s

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

rated_evaporator_inlet_air_drybulb_temperature

field Rated Evaporator Inlet Air Dry-Bulb Temperature

Evaporator inlet air dry-bulb temperature corresponding to rated coil performance

(heating capacity, COP and SHR).

Units: C

Default value: 19.7

value > 5.0

Parameters:value (float) – value for IDD Field Rated Evaporator Inlet Air Dry-Bulb Temperature Raises:ValueError – if value is not a valid value Returns:the value of rated_evaporator_inlet_air_drybulb_temperature or None if not set Return type:float

rated_evaporator_inlet_air_wetbulb_temperature

field Rated Evaporator Inlet Air Wet-Bulb Temperature

Evaporator inlet air wet-bulb temperature corresponding to rated coil performance

(heating capacity, COP and SHR).

Units: C

Default value: 13.5

value > 5.0

Parameters:value (float) – value for IDD Field Rated Evaporator Inlet Air Wet-Bulb Temperature Raises:ValueError – if value is not a valid value Returns:the value of rated_evaporator_inlet_air_wetbulb_temperature or None if not set Return type:float

rated_sensible_heat_ratio_at_speed_1

field Rated Sensible Heat Ratio at Speed 1

Gross air-side sensible heat ratio at the rated inlet air temperatures,

rated condenser inlet water temperature, rated air flow rate, and rated water flow rate.

Sensible heat ratio equals gross sensible cooling capacity divided by gross total cooling

capacity. Rated SHR (gross) should not include evaporator fan heat, only sensible cooling

and dehumidification by the coil alone.

Default value: 0.85

value >= 0.5

value <= 1.0

Parameters:value (float) – value for IDD Field Rated Sensible Heat Ratio at Speed 1 Raises:ValueError – if value is not a valid value Returns:the value of rated_sensible_heat_ratio_at_speed_1 or None if not set Return type:float

rated_sensible_heat_ratio_at_speed_10

field Rated Sensible Heat Ratio at Speed 10

Gross air-side sensible heat ratio at the rated inlet air temperatures,

rated condenser inlet water temperature, rated air flow rate, and rated water flow rate.

Sensible heat ratio equals gross sensible cooling capacity divided by gross total cooling

capacity. Rated SHR (gross) should not include evaporator fan heat, only sensible cooling

and dehumidification by the coil alone.

Default value: 0.85

value >= 0.5

value <= 1.0

Parameters:value (float) – value for IDD Field Rated Sensible Heat Ratio at Speed 10 Raises:ValueError – if value is not a valid value Returns:the value of rated_sensible_heat_ratio_at_speed_10 or None if not set Return type:float

rated_sensible_heat_ratio_at_speed_2

field Rated Sensible Heat Ratio at Speed 2

Gross air-side sensible heat ratio at the rated inlet air temperatures,

rated condenser inlet water temperature, rated air flow rate, and rated water flow rate.

Sensible heat ratio equals gross sensible cooling capacity divided by gross total cooling

capacity. Rated SHR (gross) should not include evaporator fan heat, only sensible cooling

and dehumidification by the coil alone.

Default value: 0.85

value >= 0.5

value <= 1.0

Parameters:value (float) – value for IDD Field Rated Sensible Heat Ratio at Speed 2 Raises:ValueError – if value is not a valid value Returns:the value of rated_sensible_heat_ratio_at_speed_2 or None if not set Return type:float

rated_sensible_heat_ratio_at_speed_3

field Rated Sensible Heat Ratio at Speed 3

Gross air-side sensible heat ratio at the rated inlet air temperatures,

rated condenser inlet water temperature, rated air flow rate, and rated water flow rate.

Sensible heat ratio equals gross sensible cooling capacity divided by gross total cooling

capacity. Rated SHR (gross) should not include evaporator fan heat, only sensible cooling

and dehumidification by the coil alone.

Default value: 0.85

value >= 0.5

value <= 1.0

Parameters:value (float) – value for IDD Field Rated Sensible Heat Ratio at Speed 3 Raises:ValueError – if value is not a valid value Returns:the value of rated_sensible_heat_ratio_at_speed_3 or None if not set Return type:float

rated_sensible_heat_ratio_at_speed_4

field Rated Sensible Heat Ratio at Speed 4

Gross air-side sensible heat ratio at the rated inlet air temperatures,

rated condenser inlet water temperature, rated air flow rate, and rated water flow rate.

Sensible heat ratio equals gross sensible cooling capacity divided by gross total cooling

capacity. Rated SHR (gross) should not include evaporator fan heat, only sensible cooling

and dehumidification by the coil alone.

Default value: 0.85

value >= 0.5

value <= 1.0

Parameters:value (float) – value for IDD Field Rated Sensible Heat Ratio at Speed 4 Raises:ValueError – if value is not a valid value Returns:the value of rated_sensible_heat_ratio_at_speed_4 or None if not set Return type:float

rated_sensible_heat_ratio_at_speed_5

field Rated Sensible Heat Ratio at Speed 5

Gross air-side sensible heat ratio at the rated inlet air temperatures,

rated condenser inlet water temperature, rated air flow rate, and rated water flow rate.

Sensible heat ratio equals gross sensible cooling capacity divided by gross total cooling

capacity. Rated SHR (gross) should not include evaporator fan heat, only sensible cooling

and dehumidification by the coil alone.

Default value: 0.85

value >= 0.5

value <= 1.0

Parameters:value (float) – value for IDD Field Rated Sensible Heat Ratio at Speed 5 Raises:ValueError – if value is not a valid value Returns:the value of rated_sensible_heat_ratio_at_speed_5 or None if not set Return type:float

rated_sensible_heat_ratio_at_speed_6

field Rated Sensible Heat Ratio at Speed 6

Gross air-side sensible heat ratio at the rated inlet air temperatures,

rated condenser inlet water temperature, rated air flow rate, and rated water flow rate.

Sensible heat ratio equals gross sensible cooling capacity divided by gross total cooling

capacity. Rated SHR (gross) should not include evaporator fan heat, only sensible cooling

and dehumidification by the coil alone.

Default value: 0.85

value >= 0.5

value <= 1.0

Parameters:value (float) – value for IDD Field Rated Sensible Heat Ratio at Speed 6 Raises:ValueError – if value is not a valid value Returns:the value of rated_sensible_heat_ratio_at_speed_6 or None if not set Return type:float

rated_sensible_heat_ratio_at_speed_7

field Rated Sensible Heat Ratio at Speed 7

Gross air-side sensible heat ratio at the rated inlet air temperatures,

rated condenser inlet water temperature, rated air flow rate, and rated water flow rate.

Sensible heat ratio equals gross sensible cooling capacity divided by gross total cooling

capacity. Rated SHR (gross) should not include evaporator fan heat, only sensible cooling

and dehumidification by the coil alone.

Default value: 0.85

value >= 0.5

value <= 1.0

Parameters:value (float) – value for IDD Field Rated Sensible Heat Ratio at Speed 7 Raises:ValueError – if value is not a valid value Returns:the value of rated_sensible_heat_ratio_at_speed_7 or None if not set Return type:float

rated_sensible_heat_ratio_at_speed_8

field Rated Sensible Heat Ratio at Speed 8

Gross air-side sensible heat ratio at the rated inlet air temperatures,

rated condenser inlet water temperature, rated air flow rate, and rated water flow rate.

Sensible heat ratio equals gross sensible cooling capacity divided by gross total cooling

capacity. Rated SHR (gross) should not include evaporator fan heat, only sensible cooling

and dehumidification by the coil alone.

Default value: 0.85

value >= 0.5

value <= 1.0

Parameters:value (float) – value for IDD Field Rated Sensible Heat Ratio at Speed 8 Raises:ValueError – if value is not a valid value Returns:the value of rated_sensible_heat_ratio_at_speed_8 or None if not set Return type:float

rated_sensible_heat_ratio_at_speed_9

field Rated Sensible Heat Ratio at Speed 9

Gross air-side sensible heat ratio at the rated inlet air temperatures,

rated condenser inlet water temperature, rated air flow rate, and rated water flow rate.

Sensible heat ratio equals gross sensible cooling capacity divided by gross total cooling

capacity. Rated SHR (gross) should not include evaporator fan heat, only sensible cooling

and dehumidification by the coil alone.

Default value: 0.85

value >= 0.5

value <= 1.0

Parameters:value (float) – value for IDD Field Rated Sensible Heat Ratio at Speed 9 Raises:ValueError – if value is not a valid value Returns:the value of rated_sensible_heat_ratio_at_speed_9 or None if not set Return type:float

rated_water_heating_capacity

field Rated Water Heating Capacity

Water Heating capacity at the rated inlet air temperatures, rated condenser inlet

water temperature, rated air flow rate, and rated water flow rate.

Can optionally include condenser pump heat.

Units: W

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

rated_water_heating_capacity_at_speed_1

field Rated Water Heating Capacity at Speed 1

Heating capacity at the rated inlet air temperatures, rated condenser inlet

water temperature, rated air flow rate, and rated water flow rate.

Can optionally include condenser pump heat.

Units: W

Parameters:value (float) – value for IDD Field Rated Water Heating Capacity at Speed 1 Raises:ValueError – if value is not a valid value Returns:the value of rated_water_heating_capacity_at_speed_1 or None if not set Return type:float

rated_water_heating_capacity_at_speed_10

field Rated Water Heating Capacity at Speed 10

Heating capacity at the rated inlet air temperatures, rated condenser inlet

water temperature, rated air flow rate, and rated water flow rate.

Can optionally include condenser pump heat.

Units: W

Parameters:value (float) – value for IDD Field Rated Water Heating Capacity at Speed 10 Raises:ValueError – if value is not a valid value Returns:the value of rated_water_heating_capacity_at_speed_10 or None if not set Return type:float

rated_water_heating_capacity_at_speed_2

field Rated Water Heating Capacity at Speed 2

Heating capacity at the rated inlet air temperatures, rated condenser inlet

water temperature, rated air flow rate, and rated water flow rate.

Can optionally include condenser pump heat.

Units: W

Parameters:value (float) – value for IDD Field Rated Water Heating Capacity at Speed 2 Raises:ValueError – if value is not a valid value Returns:the value of rated_water_heating_capacity_at_speed_2 or None if not set Return type:float

rated_water_heating_capacity_at_speed_3

field Rated Water Heating Capacity at speed 3

Heating capacity at the rated inlet air temperatures, rated condenser inlet

water temperature, rated air flow rate, and rated water flow rate.

Can optionally include condenser pump heat.

Units: W

Parameters:value (float) – value for IDD Field Rated Water Heating Capacity at speed 3 Raises:ValueError – if value is not a valid value Returns:the value of rated_water_heating_capacity_at_speed_3 or None if not set Return type:float

rated_water_heating_capacity_at_speed_4

field Rated Water Heating Capacity at Speed 4

Heating capacity at the rated inlet air temperatures, rated condenser inlet

water temperature, rated air flow rate, and rated water flow rate.

Can optionally include condenser pump heat.

Units: W

Parameters:value (float) – value for IDD Field Rated Water Heating Capacity at Speed 4 Raises:ValueError – if value is not a valid value Returns:the value of rated_water_heating_capacity_at_speed_4 or None if not set Return type:float

rated_water_heating_capacity_at_speed_5

field Rated Water Heating Capacity at Speed 5

Heating capacity at the rated inlet air temperatures, rated condenser inlet

water temperature, rated air flow rate, and rated water flow rate.

Can optionally include condenser pump heat.

Units: W

Parameters:value (float) – value for IDD Field Rated Water Heating Capacity at Speed 5 Raises:ValueError – if value is not a valid value Returns:the value of rated_water_heating_capacity_at_speed_5 or None if not set Return type:float

rated_water_heating_capacity_at_speed_6

field Rated Water Heating Capacity at Speed 6

Heating capacity at the rated inlet air temperatures, rated condenser inlet

water temperature, rated air flow rate, and rated water flow rate.

Can optionally include condenser pump heat.

Units: W

Parameters:value (float) – value for IDD Field Rated Water Heating Capacity at Speed 6 Raises:ValueError – if value is not a valid value Returns:the value of rated_water_heating_capacity_at_speed_6 or None if not set Return type:float

rated_water_heating_capacity_at_speed_7

field Rated Water Heating Capacity at Speed 7

Heating capacity at the rated inlet air temperatures, rated condenser inlet

water temperature, rated air flow rate, and rated water flow rate.

Can optionally include condenser pump heat.

Units: W

Parameters:value (float) – value for IDD Field Rated Water Heating Capacity at Speed 7 Raises:ValueError – if value is not a valid value Returns:the value of rated_water_heating_capacity_at_speed_7 or None if not set Return type:float

rated_water_heating_capacity_at_speed_8

field Rated Water Heating Capacity at Speed 8

Heating capacity at the rated inlet air temperatures, rated condenser inlet

water temperature, rated air flow rate, and rated water flow rate.

Can optionally include condenser pump heat.

Units: W

Parameters:value (float) – value for IDD Field Rated Water Heating Capacity at Speed 8 Raises:ValueError – if value is not a valid value Returns:the value of rated_water_heating_capacity_at_speed_8 or None if not set Return type:float

rated_water_heating_capacity_at_speed_9

field Rated Water Heating Capacity at Speed 9

Heating capacity at the rated inlet air temperatures, rated condenser inlet

water temperature, rated air flow rate, and rated water flow rate.

Can optionally include condenser pump heat.

Units: W

Parameters:value (float) – value for IDD Field Rated Water Heating Capacity at Speed 9 Raises:ValueError – if value is not a valid value Returns:the value of rated_water_heating_capacity_at_speed_9 or None if not set Return type:float

rated_water_heating_cop_at_speed_1

field Rated Water Heating COP at Speed 1

Heating coefficient of performance at the rated inlet air and water temperatures,

rated condenser inlet water temperature, rated air flow rate, and rated water flow rate.

Can optionally include condenser pump power and evaporator fan power (see fields below).

Units: W/W

Default value: 3.2

Parameters:value (float) – value for IDD Field Rated Water Heating COP at Speed 1 Raises:ValueError – if value is not a valid value Returns:the value of rated_water_heating_cop_at_speed_1 or None if not set Return type:float

rated_water_heating_cop_at_speed_10

field Rated Water Heating COP at Speed 10

Heating coefficient of performance at the rated inlet air and water temperatures,

rated condenser inlet water temperature, rated air flow rate, and rated water flow rate.

Can optionally include condenser pump power and evaporator fan power (see fields below).

Units: W/W

Default value: 3.2

Parameters:value (float) – value for IDD Field Rated Water Heating COP at Speed 10 Raises:ValueError – if value is not a valid value Returns:the value of rated_water_heating_cop_at_speed_10 or None if not set Return type:float

rated_water_heating_cop_at_speed_2

field Rated Water Heating COP at Speed 2

Heating coefficient of performance at the rated inlet air and water temperatures,

rated condenser inlet water temperature, rated air flow rate, and rated water flow rate.

Can optionally include condenser pump power and evaporator fan power (see fields below).

Units: W/W

Default value: 3.2

Parameters:value (float) – value for IDD Field Rated Water Heating COP at Speed 2 Raises:ValueError – if value is not a valid value Returns:the value of rated_water_heating_cop_at_speed_2 or None if not set Return type:float

rated_water_heating_cop_at_speed_3

field Rated Water Heating COP at Speed 3

Heating coefficient of performance at the rated inlet air and water temperatures,

rated condenser inlet water temperature, rated air flow rate, and rated water flow rate.

Can optionally include condenser pump power and evaporator fan power (see fields below).

Units: W/W

Default value: 3.2

Parameters:value (float) – value for IDD Field Rated Water Heating COP at Speed 3 Raises:ValueError – if value is not a valid value Returns:the value of rated_water_heating_cop_at_speed_3 or None if not set Return type:float

rated_water_heating_cop_at_speed_4

field Rated Water Heating COP at Speed 4

Heating coefficient of performance at the rated inlet air and water temperatures,

rated condenser inlet water temperature, rated air flow rate, and rated water flow rate.

Can optionally include condenser pump power and evaporator fan power (see fields below).

Units: W/W

Default value: 3.2

Parameters:value (float) – value for IDD Field Rated Water Heating COP at Speed 4 Raises:ValueError – if value is not a valid value Returns:the value of rated_water_heating_cop_at_speed_4 or None if not set Return type:float

rated_water_heating_cop_at_speed_5

field Rated Water Heating COP at Speed 5

Heating coefficient of performance at the rated inlet air and water temperatures,

rated condenser inlet water temperature, rated air flow rate, and rated water flow rate.

Can optionally include condenser pump power and evaporator fan power (see fields below).

Units: W/W

Default value: 3.2

Parameters:value (float) – value for IDD Field Rated Water Heating COP at Speed 5 Raises:ValueError – if value is not a valid value Returns:the value of rated_water_heating_cop_at_speed_5 or None if not set Return type:float

rated_water_heating_cop_at_speed_6

field Rated Water Heating COP at Speed 6

Heating coefficient of performance at the rated inlet air and water temperatures,

rated condenser inlet water temperature, rated air flow rate, and rated water flow rate.

Can optionally include condenser pump power and evaporator fan power (see fields below).

Units: W/W

Default value: 3.2

Parameters:value (float) – value for IDD Field Rated Water Heating COP at Speed 6 Raises:ValueError – if value is not a valid value Returns:the value of rated_water_heating_cop_at_speed_6 or None if not set Return type:float

rated_water_heating_cop_at_speed_7

field Rated Water Heating COP at Speed 7

Heating coefficient of performance at the rated inlet air and water temperatures,

rated condenser inlet water temperature, rated air flow rate, and rated water flow rate.

Can optionally include condenser pump power and evaporator fan power (see fields below).

Units: W/W

Default value: 3.2

Parameters:value (float) – value for IDD Field Rated Water Heating COP at Speed 7 Raises:ValueError – if value is not a valid value Returns:the value of rated_water_heating_cop_at_speed_7 or None if not set Return type:float

rated_water_heating_cop_at_speed_8

field Rated Water Heating COP at Speed 8

Heating coefficient of performance at the rated inlet air and water temperatures,

rated condenser inlet water temperature, rated air flow rate, and rated water flow rate.

Can optionally include condenser pump power and evaporator fan power (see fields below).

Units: W/W

Default value: 3.2

Parameters:value (float) – value for IDD Field Rated Water Heating COP at Speed 8 Raises:ValueError – if value is not a valid value Returns:the value of rated_water_heating_cop_at_speed_8 or None if not set Return type:float

rated_water_heating_cop_at_speed_9

field Rated Water Heating COP at Speed 9

Heating coefficient of performance at the rated inlet air and water temperatures,

rated condenser inlet water temperature, rated air flow rate, and rated water flow rate.

Can optionally include condenser pump power and evaporator fan power (see fields below).

Units: W/W

Default value: 3.2

Parameters:value (float) – value for IDD Field Rated Water Heating COP at Speed 9 Raises:ValueError – if value is not a valid value Returns:the value of rated_water_heating_cop_at_speed_9 or None if not set Return type:float

speed_10_cop_function_of_air_flow_fraction_curve_name

field Speed 10 COP Function of Air Flow Fraction Curve Name

Table:OneIndependentVariable object can also be used

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 10 COP Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_10_cop_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_10_cop_function_of_temperature_curve_name

field Speed 10 COP Function of Temperature Curve Name

Table:TwoIndependentVariables object can also be used

curve = a + b*wb + c*wb**2 + d*ewt + e*ewt**2 + f*wb*ewt

wb = entering wet-bulb temperature or dry bulb temperature upon selection (C)

ewt = water entering temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Speed 10 COP Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_10_cop_function_of_temperature_curve_name or None if not set Return type:str

speed_10_cop_function_of_water_flow_fraction_curve_name

field Speed 10 COP Function of Water Flow Fraction Curve Name

Table:OneIndependentVariable object can also be used

quadratic curve = a + b*ffw + c*ffw**2

cubic curve = a + b*ffw + c*ffw**2 + d*ffw**3

ffw = Fraction of the full load Water Flow

Parameters:value (str) – value for IDD Field Speed 10 COP Function of Water Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_10_cop_function_of_water_flow_fraction_curve_name or None if not set Return type:str

speed_10_reference_unit_rated_air_flow_rate

field Speed 10 Reference Unit Rated Air Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 10 Reference Unit Rated Air Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_10_reference_unit_rated_air_flow_rate or None if not set Return type:float

speed_10_reference_unit_rated_water_flow_rate

field Speed 10 Reference Unit Rated Water Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 10 Reference Unit Rated Water Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_10_reference_unit_rated_water_flow_rate or None if not set Return type:float

speed_10_reference_unit_water_pump_input_power_at_rated_conditions

field Speed 10 Reference Unit Water Pump Input Power At Rated Conditions

Units: dimensionless

Parameters:value (float) – value for IDD Field Speed 10 Reference Unit Water Pump Input Power At Rated Conditions Raises:ValueError – if value is not a valid value Returns:the value of speed_10_reference_unit_water_pump_input_power_at_rated_conditions or None if not set Return type:float

speed_10_total_wh_capacity_function_of_air_flow_fraction_curve_name

field Speed 10 Total WH Capacity Function of Air Flow Fraction Curve Name

Table:OneIndependentVariable object can also be used

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 10 Total WH Capacity Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_10_total_wh_capacity_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_10_total_wh_capacity_function_of_temperature_curve_name

field Speed 10 Total WH Capacity Function of Temperature Curve Name

Table:TwoIndependentVariables object can also be used

curve = a + b*wb + c*wb**2 + d*ewt + e*ewt**2 + f*wb*ewt

wb = entering wet-bulb temperature or dry bulb temperature upon selection (C)

ewt = water entering temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Speed 10 Total WH Capacity Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_10_total_wh_capacity_function_of_temperature_curve_name or None if not set Return type:str

speed_10_total_wh_capacity_function_of_water_flow_fraction_curve_name

field Speed 10 Total WH Capacity Function of Water Flow Fraction Curve Name

Table:OneIndependentVariable object can also be used

quadratic curve = a + b*ffw + c*ffw**2

cubic curve = a + b*ffw + c*ffw**2 + d*ffw**3

ffw = Fraction of the full load Water Flow

Parameters:value (str) – value for IDD Field Speed 10 Total WH Capacity Function of Water Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_10_total_wh_capacity_function_of_water_flow_fraction_curve_name or None if not set Return type:str

speed_1_cop_function_of_air_flow_fraction_curve_name

field Speed 1 COP Function of Air Flow Fraction Curve Name

Table:OneIndependentVariable object can also be used

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 1 COP Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_1_cop_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_1_cop_function_of_temperature_curve_name

field Speed 1 COP Function of Temperature Curve Name

Table:TwoIndependentVariables object can also be used

curve = a + b*wb + c*wb**2 + d*ewt + e*ewt**2 + f*wb*ewt

wb = entering wet-bulb temperature or dry bulb temperature upon selection (C)

ewt = water entering temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Speed 1 COP Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_1_cop_function_of_temperature_curve_name or None if not set Return type:str

speed_1_cop_function_of_water_flow_fraction_curve_name

field Speed 1 COP Function of Water Flow Fraction Curve Name

Table:OneIndependentVariable object can also be used

quadratic curve = a + b*ffw + c*ffw**2

cubic curve = a + b*ffw + c*ffw**2 + d*ffw**3

ffw = Fraction of the full load Water Flow

Parameters:value (str) – value for IDD Field Speed 1 COP Function of Water Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_1_cop_function_of_water_flow_fraction_curve_name or None if not set Return type:str

speed_1_reference_unit_rated_air_flow_rate

field Speed 1 Reference Unit Rated Air Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 1 Reference Unit Rated Air Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_1_reference_unit_rated_air_flow_rate or None if not set Return type:float

speed_1_reference_unit_rated_water_flow_rate

field Speed 1 Reference Unit Rated Water Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 1 Reference Unit Rated Water Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_1_reference_unit_rated_water_flow_rate or None if not set Return type:float

speed_1_reference_unit_water_pump_input_power_at_rated_conditions

field Speed 1 Reference Unit Water Pump Input Power At Rated Conditions

Units: dimensionless

Parameters:value (float) – value for IDD Field Speed 1 Reference Unit Water Pump Input Power At Rated Conditions Raises:ValueError – if value is not a valid value Returns:the value of speed_1_reference_unit_water_pump_input_power_at_rated_conditions or None if not set Return type:float

speed_1_total_wh_capacity_function_of_air_flow_fraction_curve_name

field Speed 1 Total WH Capacity Function of Air Flow Fraction Curve Name

Table:OneIndependentVariable object can also be used

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 1 Total WH Capacity Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_1_total_wh_capacity_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_1_total_wh_capacity_function_of_temperature_curve_name

field Speed 1 Total WH Capacity Function of Temperature Curve Name

Table:TwoIndependentVariables object can also be used

curve = a + b*wb + c*wb**2 + d*ewt + e*ewt**2 + f*wb*ewt

wb = entering wet-bulb temperature or dry bulb temperature upon selection (C)

ewt = water entering temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Speed 1 Total WH Capacity Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_1_total_wh_capacity_function_of_temperature_curve_name or None if not set Return type:str

speed_1_total_wh_capacity_function_of_water_flow_fraction_curve_name

field Speed 1 Total WH Capacity Function of Water Flow Fraction Curve Name

Table:OneIndependentVariable object can also be used

quadratic curve = a + b*ffw + c*ffw**2

cubic curve = a + b*ffw + c*ffw**2 + d*ffw**3

ffw = Fraction of the full load Water Flow

Parameters:value (str) – value for IDD Field Speed 1 Total WH Capacity Function of Water Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_1_total_wh_capacity_function_of_water_flow_fraction_curve_name or None if not set Return type:str

speed_2_cop_function_of_air_flow_fraction_curve_name

field Speed 2 COP Function of Air Flow Fraction Curve Name

Table:OneIndependentVariable object can also be used

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 2 COP Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_2_cop_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_2_cop_function_of_temperature_curve_name

field Speed 2 COP Function of Temperature Curve Name

Table:TwoIndependentVariables object can also be used

curve = a + b*wb + c*wb**2 + d*ewt + e*ewt**2 + f*wb*ewt

wb = entering wet-bulb temperature or dry bulb temperature upon selection (C)

ewt = water entering temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Speed 2 COP Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_2_cop_function_of_temperature_curve_name or None if not set Return type:str

speed_2_cop_function_of_water_flow_fraction_curve_name

field Speed 2 COP Function of Water Flow Fraction Curve Name

Table:OneIndependentVariable object can also be used

quadratic curve = a + b*ffw + c*ffw**2

cubic curve = a + b*ffw + c*ffw**2 + d*ffw**3

ffw = Fraction of the full load Water Flow

Parameters:value (str) – value for IDD Field Speed 2 COP Function of Water Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_2_cop_function_of_water_flow_fraction_curve_name or None if not set Return type:str

speed_2_reference_unit_rated_air_flow_rate

field Speed 2 Reference Unit Rated Air Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 2 Reference Unit Rated Air Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_2_reference_unit_rated_air_flow_rate or None if not set Return type:float

speed_2_reference_unit_rated_water_flow_rate

field Speed 2 Reference Unit Rated Water Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 2 Reference Unit Rated Water Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_2_reference_unit_rated_water_flow_rate or None if not set Return type:float

speed_2_reference_unit_water_pump_input_power_at_rated_conditions

field Speed 2 Reference Unit Water Pump Input Power At Rated Conditions

Units: dimensionless

Parameters:value (float) – value for IDD Field Speed 2 Reference Unit Water Pump Input Power At Rated Conditions Raises:ValueError – if value is not a valid value Returns:the value of speed_2_reference_unit_water_pump_input_power_at_rated_conditions or None if not set Return type:float

speed_2_total_wh_capacity_function_of_air_flow_fraction_curve_name

field Speed 2 Total WH Capacity Function of Air Flow Fraction Curve Name

Table:OneIndependentVariable object can also be used

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 2 Total WH Capacity Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_2_total_wh_capacity_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_2_total_wh_capacity_function_of_temperature_curve_name

field Speed 2 Total WH Capacity Function of Temperature Curve Name

Table:TwoIndependentVariables object can also be used

curve = a + b*wb + c*wb**2 + d*ewt + e*ewt**2 + f*wb*ewt

wb = entering wet-bulb temperature or dry bulb temperature upon selection (C)

ewt = water entering temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Speed 2 Total WH Capacity Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_2_total_wh_capacity_function_of_temperature_curve_name or None if not set Return type:str

speed_2_total_wh_capacity_function_of_water_flow_fraction_curve_name

field Speed 2 Total WH Capacity Function of Water Flow Fraction Curve Name

Table:OneIndependentVariable object can also be used

quadratic curve = a + b*ffw + c*ffw**2

cubic curve = a + b*ffw + c*ffw**2 + d*ffw**3

ffw = Fraction of the full load Water Flow

Parameters:value (str) – value for IDD Field Speed 2 Total WH Capacity Function of Water Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_2_total_wh_capacity_function_of_water_flow_fraction_curve_name or None if not set Return type:str

speed_3_cop_function_of_air_flow_fraction_curve_name

field Speed 3 COP Function of Air Flow Fraction Curve Name

Table:OneIndependentVariable object can also be used

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 3 COP Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_3_cop_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_3_cop_function_of_temperature_curve_name

field Speed 3 COP Function of Temperature Curve Name

Table:TwoIndependentVariables object can also be used

curve = a + b*wb + c*wb**2 + d*ewt + e*ewt**2 + f*wb*ewt

wb = entering wet-bulb temperature or dry bulb temperature upon selection (C)

ewt = water entering temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Speed 3 COP Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_3_cop_function_of_temperature_curve_name or None if not set Return type:str

speed_3_cop_function_of_water_flow_fraction_curve_name

field Speed 3 COP Function of Water Flow Fraction Curve Name

Table:OneIndependentVariable object can also be used

quadratic curve = a + b*ffw + c*ffw**2

cubic curve = a + b*ffw + c*ffw**2 + d*ffw**3

ffw = Fraction of the full load Water Flow

Parameters:value (str) – value for IDD Field Speed 3 COP Function of Water Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_3_cop_function_of_water_flow_fraction_curve_name or None if not set Return type:str

speed_3_reference_unit_rated_air_flow_rate

field Speed 3 Reference Unit Rated Air Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 3 Reference Unit Rated Air Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_3_reference_unit_rated_air_flow_rate or None if not set Return type:float

speed_3_reference_unit_rated_water_flow_rate

field Speed 3 Reference Unit Rated Water Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 3 Reference Unit Rated Water Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_3_reference_unit_rated_water_flow_rate or None if not set Return type:float

speed_3_reference_unit_water_pump_input_power_at_rated_conditions

field Speed 3 Reference Unit Water Pump Input Power At Rated Conditions

Units: dimensionless

Parameters:value (float) – value for IDD Field Speed 3 Reference Unit Water Pump Input Power At Rated Conditions Raises:ValueError – if value is not a valid value Returns:the value of speed_3_reference_unit_water_pump_input_power_at_rated_conditions or None if not set Return type:float

speed_3_total_wh_capacity_function_of_air_flow_fraction_curve_name

field Speed 3 Total WH Capacity Function of Air Flow Fraction Curve Name

Table:OneIndependentVariable object can also be used

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 3 Total WH Capacity Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_3_total_wh_capacity_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_3_total_wh_capacity_function_of_temperature_curve_name

field Speed 3 Total WH Capacity Function of Temperature Curve Name

Table:TwoIndependentVariables object can also be used

curve = a + b*wb + c*wb**2 + d*ewt + e*ewt**2 + f*wb*ewt

wb = entering wet-bulb temperature or dry bulb temperature upon selection (C)

ewt = water entering temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Speed 3 Total WH Capacity Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_3_total_wh_capacity_function_of_temperature_curve_name or None if not set Return type:str

speed_3_total_wh_capacity_function_of_water_flow_fraction_curve_name

field Speed 3 Total WH Capacity Function of Water Flow Fraction Curve Name

Table:OneIndependentVariable object can also be used

quadratic curve = a + b*ffw + c*ffw**2

cubic curve = a + b*ffw + c*ffw**2 + d*ffw**3

ffw = Fraction of the full load Water Flow

Parameters:value (str) – value for IDD Field Speed 3 Total WH Capacity Function of Water Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_3_total_wh_capacity_function_of_water_flow_fraction_curve_name or None if not set Return type:str

speed_4_cop_function_of_air_flow_fraction_curve_name

field Speed 4 COP Function of Air Flow Fraction Curve Name

Table:OneIndependentVariable object can also be used

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 4 COP Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_4_cop_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_4_cop_function_of_temperature_curve_name

field Speed 4 COP Function of Temperature Curve Name

Table:TwoIndependentVariables object can also be used

curve = a + b*wb + c*wb**2 + d*ewt + e*ewt**2 + f*wb*ewt

wb = entering wet-bulb temperature or dry bulb temperature upon selection (C)

ewt = water entering temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Speed 4 COP Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_4_cop_function_of_temperature_curve_name or None if not set Return type:str

speed_4_cop_function_of_water_flow_fraction_curve_name

field Speed 4 COP Function of Water Flow Fraction Curve Name

Table:OneIndependentVariable object can also be used

quadratic curve = a + b*ffw + c*ffw**2

cubic curve = a + b*ffw + c*ffw**2 + d*ffw**3

ffw = Fraction of the full load Water Flow

Parameters:value (str) – value for IDD Field Speed 4 COP Function of Water Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_4_cop_function_of_water_flow_fraction_curve_name or None if not set Return type:str

speed_4_reference_unit_rated_air_flow_rate

field Speed 4 Reference Unit Rated Air Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 4 Reference Unit Rated Air Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_4_reference_unit_rated_air_flow_rate or None if not set Return type:float

speed_4_reference_unit_rated_water_flow_rate

field Speed 4 Reference Unit Rated Water Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 4 Reference Unit Rated Water Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_4_reference_unit_rated_water_flow_rate or None if not set Return type:float

speed_4_reference_unit_water_pump_input_power_at_rated_conditions

field Speed 4 Reference Unit Water Pump Input Power At Rated Conditions

Units: dimensionless

Parameters:value (float) – value for IDD Field Speed 4 Reference Unit Water Pump Input Power At Rated Conditions Raises:ValueError – if value is not a valid value Returns:the value of speed_4_reference_unit_water_pump_input_power_at_rated_conditions or None if not set Return type:float

speed_4_total_wh_capacity_function_of_air_flow_fraction_curve_name

field Speed 4 Total WH Capacity Function of Air Flow Fraction Curve Name

Table:OneIndependentVariable object can also be used

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 4 Total WH Capacity Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_4_total_wh_capacity_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_4_total_wh_capacity_function_of_temperature_curve_name

field Speed 4 Total WH Capacity Function of Temperature Curve Name

Table:TwoIndependentVariables object can also be used

curve = a + b*wb + c*wb**2 + d*ewt + e*ewt**2 + f*wb*ewt

wb = entering wet-bulb temperature or dry bulb temperature upon selection (C)

ewt = water entering temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Speed 4 Total WH Capacity Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_4_total_wh_capacity_function_of_temperature_curve_name or None if not set Return type:str

speed_4_total_wh_capacity_function_of_water_flow_fraction_curve_name

field Speed 4 Total WH Capacity Function of Water Flow Fraction Curve Name

Table:OneIndependentVariable object can also be used

quadratic curve = a + b*ffw + c*ffw**2

cubic curve = a + b*ffw + c*ffw**2 + d*ffw**3

ffw = Fraction of the full load Water Flow

Parameters:value (str) – value for IDD Field Speed 4 Total WH Capacity Function of Water Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_4_total_wh_capacity_function_of_water_flow_fraction_curve_name or None if not set Return type:str

speed_5_cop_function_of_air_flow_fraction_curve_name

field Speed 5 COP Function of Air Flow Fraction Curve Name

Table:OneIndependentVariable object can also be used

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 5 COP Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_5_cop_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_5_cop_function_of_temperature_curve_name

field Speed 5 COP Function of Temperature Curve Name

Table:TwoIndependentVariables object can also be used

curve = a + b*wb + c*wb**2 + d*ewt + e*ewt**2 + f*wb*ewt

wb = entering wet-bulb temperature or dry bulb temperature upon selection (C)

ewt = water entering temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Speed 5 COP Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_5_cop_function_of_temperature_curve_name or None if not set Return type:str

speed_5_cop_function_of_water_flow_fraction_curve_name

field Speed 5 COP Function of Water Flow Fraction Curve Name

Table:OneIndependentVariable object can also be used

quadratic curve = a + b*ffw + c*ffw**2

cubic curve = a + b*ffw + c*ffw**2 + d*ffw**3

ffw = Fraction of the full load Water Flow

Parameters:value (str) – value for IDD Field Speed 5 COP Function of Water Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_5_cop_function_of_water_flow_fraction_curve_name or None if not set Return type:str

speed_5_reference_unit_rated_air_flow_rate

field Speed 5 Reference Unit Rated Air Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 5 Reference Unit Rated Air Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_5_reference_unit_rated_air_flow_rate or None if not set Return type:float

speed_5_reference_unit_rated_water_flow_rate

field Speed 5 Reference Unit Rated Water Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 5 Reference Unit Rated Water Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_5_reference_unit_rated_water_flow_rate or None if not set Return type:float

speed_5_reference_unit_water_pump_input_power_at_rated_conditions

field Speed 5 Reference Unit Water Pump Input Power At Rated Conditions

Units: dimensionless

Parameters:value (float) – value for IDD Field Speed 5 Reference Unit Water Pump Input Power At Rated Conditions Raises:ValueError – if value is not a valid value Returns:the value of speed_5_reference_unit_water_pump_input_power_at_rated_conditions or None if not set Return type:float

speed_5_total_wh_capacity_function_of_air_flow_fraction_curve_name

field Speed 5 Total WH Capacity Function of Air Flow Fraction Curve Name

Table:OneIndependentVariable object can also be used

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 5 Total WH Capacity Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_5_total_wh_capacity_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_5_total_wh_capacity_function_of_temperature_curve_name

field Speed 5 Total WH Capacity Function of Temperature Curve Name

Table:TwoIndependentVariables object can also be used

curve = a + b*wb + c*wb**2 + d*ewt + e*ewt**2 + f*wb*ewt

wb = entering wet-bulb temperature or dry bulb temperature upon selection (C)

ewt = water entering temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Speed 5 Total WH Capacity Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_5_total_wh_capacity_function_of_temperature_curve_name or None if not set Return type:str

speed_5_total_wh_capacity_function_of_water_flow_fraction_curve_name

field Speed 5 Total WH Capacity Function of Water Flow Fraction Curve Name

Table:OneIndependentVariable object can also be used

quadratic curve = a + b*ffw + c*ffw**2

cubic curve = a + b*ffw + c*ffw**2 + d*ffw**3

ffw = Fraction of the full load Water Flow

Parameters:value (str) – value for IDD Field Speed 5 Total WH Capacity Function of Water Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_5_total_wh_capacity_function_of_water_flow_fraction_curve_name or None if not set Return type:str

speed_6_cop_function_of_air_flow_fraction_curve_name

field Speed 6 COP Function of Air Flow Fraction Curve Name

Table:OneIndependentVariable object can also be used

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 6 COP Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_6_cop_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_6_cop_function_of_temperature_curve_name

field Speed 6 COP Function of Temperature Curve Name

Table:TwoIndependentVariables object can also be used

curve = a + b*wb + c*wb**2 + d*ewt + e*ewt**2 + f*wb*ewt

wb = entering wet-bulb temperature or dry bulb temperature upon selection (C)

ewt = water entering temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Speed 6 COP Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_6_cop_function_of_temperature_curve_name or None if not set Return type:str

speed_6_cop_function_of_water_flow_fraction_curve_name

field Speed 6 COP Function of Water Flow Fraction Curve Name

Table:OneIndependentVariable object can also be used

quadratic curve = a + b*ffw + c*ffw**2

cubic curve = a + b*ffw + c*ffw**2 + d*ffw**3

ffw = Fraction of the full load Water Flow

Parameters:value (str) – value for IDD Field Speed 6 COP Function of Water Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_6_cop_function_of_water_flow_fraction_curve_name or None if not set Return type:str

speed_6_reference_unit_rated_air_flow_rate

field Speed 6 Reference Unit Rated Air Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 6 Reference Unit Rated Air Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_6_reference_unit_rated_air_flow_rate or None if not set Return type:float

speed_6_reference_unit_rated_water_flow_rate

field Speed 6 Reference Unit Rated Water Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 6 Reference Unit Rated Water Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_6_reference_unit_rated_water_flow_rate or None if not set Return type:float

speed_6_reference_unit_water_pump_input_power_at_rated_conditions

field Speed 6 Reference Unit Water Pump Input Power At Rated Conditions

Units: dimensionless

Parameters:value (float) – value for IDD Field Speed 6 Reference Unit Water Pump Input Power At Rated Conditions Raises:ValueError – if value is not a valid value Returns:the value of speed_6_reference_unit_water_pump_input_power_at_rated_conditions or None if not set Return type:float

speed_6_total_wh_capacity_function_of_air_flow_fraction_curve_name

field Speed 6 Total WH Capacity Function of Air Flow Fraction Curve Name

Table:OneIndependentVariable object can also be used

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 6 Total WH Capacity Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_6_total_wh_capacity_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_6_total_wh_capacity_function_of_temperature_curve_name

field Speed 6 Total WH Capacity Function of Temperature Curve Name

Table:TwoIndependentVariables object can also be used

curve = a + b*wb + c*wb**2 + d*ewt + e*ewt**2 + f*wb*ewt

wb = entering wet-bulb temperature or dry bulb temperature upon selection (C)

ewt = water entering temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Speed 6 Total WH Capacity Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_6_total_wh_capacity_function_of_temperature_curve_name or None if not set Return type:str

speed_6_total_wh_capacity_function_of_water_flow_fraction_curve_name

field Speed 6 Total WH Capacity Function of Water Flow Fraction Curve Name

Table:OneIndependentVariable object can also be used

quadratic curve = a + b*ffw + c*ffw**2

cubic curve = a + b*ffw + c*ffw**2 + d*ffw**3

ffw = Fraction of the full load Water Flow

Parameters:value (str) – value for IDD Field Speed 6 Total WH Capacity Function of Water Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_6_total_wh_capacity_function_of_water_flow_fraction_curve_name or None if not set Return type:str

speed_7_cop_function_of_air_flow_fraction_curve_name

field Speed 7 COP Function of Air Flow Fraction Curve Name

Table:OneIndependentVariable object can also be used

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 7 COP Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_7_cop_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_7_cop_function_of_temperature_curve_name

field Speed 7 COP Function of Temperature Curve Name

Table:TwoIndependentVariables object can also be used

curve = a + b*wb + c*wb**2 + d*ewt + e*ewt**2 + f*wb*ewt

wb = entering wet-bulb temperature or dry bulb temperature upon selection (C)

ewt = water entering temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Speed 7 COP Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_7_cop_function_of_temperature_curve_name or None if not set Return type:str

speed_7_cop_function_of_water_flow_fraction_curve_name

field Speed 7 COP Function of Water Flow Fraction Curve Name

Table:OneIndependentVariable object can also be used

quadratic curve = a + b*ffw + c*ffw**2

cubic curve = a + b*ffw + c*ffw**2 + d*ffw**3

ffw = Fraction of the full load Water Flow

Parameters:value (str) – value for IDD Field Speed 7 COP Function of Water Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_7_cop_function_of_water_flow_fraction_curve_name or None if not set Return type:str

speed_7_reference_unit_rated_air_flow_rate

field Speed 7 Reference Unit Rated Air Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 7 Reference Unit Rated Air Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_7_reference_unit_rated_air_flow_rate or None if not set Return type:float

speed_7_reference_unit_rated_water_flow_rate

field Speed 7 Reference Unit Rated Water Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 7 Reference Unit Rated Water Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_7_reference_unit_rated_water_flow_rate or None if not set Return type:float

speed_7_reference_unit_water_pump_input_power_at_rated_conditions

field Speed 7 Reference Unit Water Pump Input Power At Rated Conditions

Units: dimensionless

Parameters:value (float) – value for IDD Field Speed 7 Reference Unit Water Pump Input Power At Rated Conditions Raises:ValueError – if value is not a valid value Returns:the value of speed_7_reference_unit_water_pump_input_power_at_rated_conditions or None if not set Return type:float

speed_7_total_wh_capacity_function_of_air_flow_fraction_curve_name

field Speed 7 Total WH Capacity Function of Air Flow Fraction Curve Name

Table:OneIndependentVariable object can also be used

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 7 Total WH Capacity Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_7_total_wh_capacity_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_7_total_wh_capacity_function_of_temperature_curve_name

field Speed 7 Total WH Capacity Function of Temperature Curve Name

Table:TwoIndependentVariables object can also be used

curve = a + b*wb + c*wb**2 + d*ewt + e*ewt**2 + f*wb*ewt

wb = entering wet-bulb temperature or dry bulb temperature upon selection (C)

ewt = water entering temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Speed 7 Total WH Capacity Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_7_total_wh_capacity_function_of_temperature_curve_name or None if not set Return type:str

speed_7_total_wh_capacity_function_of_water_flow_fraction_curve_name

field Speed 7 Total WH Capacity Function of Water Flow Fraction Curve Name

Table:OneIndependentVariable object can also be used

quadratic curve = a + b*ffw + c*ffw**2

cubic curve = a + b*ffw + c*ffw**2 + d*ffw**3

ffw = Fraction of the full load Water Flow

Parameters:value (str) – value for IDD Field Speed 7 Total WH Capacity Function of Water Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_7_total_wh_capacity_function_of_water_flow_fraction_curve_name or None if not set Return type:str

speed_8_cop_function_of_air_flow_fraction_curve_name

field Speed 8 COP Function of Air Flow Fraction Curve Name

Table:OneIndependentVariable object can also be used

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 8 COP Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_8_cop_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_8_cop_function_of_temperature_curve_name

field Speed 8 COP Function of Temperature Curve Name

Table:TwoIndependentVariables object can also be used

curve = a + b*wb + c*wb**2 + d*ewt + e*ewt**2 + f*wb*ewt

wb = entering wet-bulb temperature or dry bulb temperature upon selection (C)

ewt = water entering temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Speed 8 COP Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_8_cop_function_of_temperature_curve_name or None if not set Return type:str

speed_8_cop_function_of_water_flow_fraction_curve_name

field Speed 8 COP Function of Water Flow Fraction Curve Name

Table:OneIndependentVariable object can also be used

quadratic curve = a + b*ffw + c*ffw**2

cubic curve = a + b*ffw + c*ffw**2 + d*ffw**3

ffw = Fraction of the full load Water Flow

Parameters:value (str) – value for IDD Field Speed 8 COP Function of Water Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_8_cop_function_of_water_flow_fraction_curve_name or None if not set Return type:str

speed_8_reference_unit_rated_air_flow_rate

field Speed 8 Reference Unit Rated Air Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 8 Reference Unit Rated Air Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_8_reference_unit_rated_air_flow_rate or None if not set Return type:float

speed_8_reference_unit_rated_water_flow_rate

field Speed 8 Reference Unit Rated Water Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 8 Reference Unit Rated Water Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_8_reference_unit_rated_water_flow_rate or None if not set Return type:float

speed_8_reference_unit_water_pump_input_power_at_rated_conditions

field Speed 8 Reference Unit Water Pump Input Power At Rated Conditions

Units: dimensionless

Parameters:value (float) – value for IDD Field Speed 8 Reference Unit Water Pump Input Power At Rated Conditions Raises:ValueError – if value is not a valid value Returns:the value of speed_8_reference_unit_water_pump_input_power_at_rated_conditions or None if not set Return type:float

speed_8_total_wh_capacity_function_of_air_flow_fraction_curve_name

field Speed 8 Total WH Capacity Function of Air Flow Fraction Curve Name

Table:OneIndependentVariable object can also be used

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 8 Total WH Capacity Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_8_total_wh_capacity_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_8_total_wh_capacity_function_of_temperature_curve_name

field Speed 8 Total WH Capacity Function of Temperature Curve Name

Table:TwoIndependentVariables object can also be used

curve = a + b*wb + c*wb**2 + d*ewt + e*ewt**2 + f*wb*ewt

wb = entering wet-bulb temperature or dry bulb temperature upon selection (C)

ewt = water entering temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Speed 8 Total WH Capacity Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_8_total_wh_capacity_function_of_temperature_curve_name or None if not set Return type:str

speed_8_total_wh_capacity_function_of_water_flow_fraction_curve_name

field Speed 8 Total WH Capacity Function of Water Flow Fraction Curve Name

Table:OneIndependentVariable object can also be used

quadratic curve = a + b*ffw + c*ffw**2

cubic curve = a + b*ffw + c*ffw**2 + d*ffw**3

ffw = Fraction of the full load Water Flow

Parameters:value (str) – value for IDD Field Speed 8 Total WH Capacity Function of Water Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_8_total_wh_capacity_function_of_water_flow_fraction_curve_name or None if not set Return type:str

speed_9_cop_function_of_air_flow_fraction_curve_name

field Speed 9 COP Function of Air Flow Fraction Curve Name

Table:OneIndependentVariable object can also be used

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 9 COP Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_9_cop_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_9_cop_function_of_temperature_curve_name

field Speed 9 COP Function of Temperature Curve Name

Table:TwoIndependentVariables object can also be used

curve = a + b*wb + c*wb**2 + d*ewt + e*ewt**2 + f*wb*ewt

wb = entering wet-bulb temperature or dry bulb temperature upon selection (C)

ewt = water entering temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Speed 9 COP Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_9_cop_function_of_temperature_curve_name or None if not set Return type:str

speed_9_cop_function_of_water_flow_fraction_curve_name

field Speed 9 COP Function of Water Flow Fraction Curve Name

Table:OneIndependentVariable object can also be used

quadratic curve = a + b*ffw + c*ffw**2

cubic curve = a + b*ffw + c*ffw**2 + d*ffw**3

ffw = Fraction of the full load Water Flow

Parameters:value (str) – value for IDD Field Speed 9 COP Function of Water Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_9_cop_function_of_water_flow_fraction_curve_name or None if not set Return type:str

speed_9_reference_unit_rated_air_flow_rate

field Speed 9 Reference Unit Rated Air Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 9 Reference Unit Rated Air Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_9_reference_unit_rated_air_flow_rate or None if not set Return type:float

speed_9_reference_unit_rated_water_flow_rate

field Speed 9 Reference Unit Rated Water Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Speed 9 Reference Unit Rated Water Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of speed_9_reference_unit_rated_water_flow_rate or None if not set Return type:float

speed_9_reference_unit_water_pump_input_power_at_rated_conditions

field Speed 9 Reference Unit Water Pump Input Power At Rated Conditions

Units: dimensionless

Parameters:value (float) – value for IDD Field Speed 9 Reference Unit Water Pump Input Power At Rated Conditions Raises:ValueError – if value is not a valid value Returns:the value of speed_9_reference_unit_water_pump_input_power_at_rated_conditions or None if not set Return type:float

speed_9_total_wh_capacity_function_of_air_flow_fraction_curve_name

field Speed 9 Total WH Capacity Function of Air Flow Fraction Curve Name

Table:OneIndependentVariable object can also be used

quadratic curve = a + b*ffa + c*ffa**2

cubic curve = a + b*ffa + c*ffa**2 + d*ffa**3

ffa = Fraction of the full load Air Flow

Parameters:value (str) – value for IDD Field Speed 9 Total WH Capacity Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_9_total_wh_capacity_function_of_air_flow_fraction_curve_name or None if not set Return type:str

speed_9_total_wh_capacity_function_of_temperature_curve_name

field Speed 9 Total WH Capacity Function of Temperature Curve Name

Table:TwoIndependentVariables object can also be used

curve = a + b*wb + c*wb**2 + d*ewt + e*ewt**2 + f*wb*ewt

wb = entering wet-bulb temperature or dry bulb temperature upon selection (C)

ewt = water entering temperature seen by the condenser (C)

Parameters:value (str) – value for IDD Field Speed 9 Total WH Capacity Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_9_total_wh_capacity_function_of_temperature_curve_name or None if not set Return type:str

speed_9_total_wh_capacity_function_of_water_flow_fraction_curve_name

field Speed 9 Total WH Capacity Function of Water Flow Fraction Curve Name

Table:OneIndependentVariable object can also be used

quadratic curve = a + b*ffw + c*ffw**2

cubic curve = a + b*ffw + c*ffw**2 + d*ffw**3

ffw = Fraction of the full load Water Flow

Parameters:value (str) – value for IDD Field Speed 9 Total WH Capacity Function of Water Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of speed_9_total_wh_capacity_function_of_water_flow_fraction_curve_name or None if not set Return type:str

class pyidf.coils.CoilWaterHeatingAirToWaterHeatPumpWrapped

Bases: pyidf.helper.DataObject

Corresponds to IDD object Coil:WaterHeating:AirToWaterHeatPump:Wrapped Heat pump water heater (HPWH) heating coil, air-to-water direct-expansion (DX) system which includes a water heating coil, evaporator air coil, evaporator fan, electric compressor, and water pump. Part of a WaterHeater:HeatPump:WrappedCondenser system.

crankcase_heater_capacity

field Crankcase Heater Capacity

The compressor crankcase heater only operates when the dry-bulb temperature of air

surrounding the compressor is below the Maximum Ambient Temperature for Crankcase

Heater Operation and the DX coil is off. The ambient temperature surrounding the

compressor is set by the WaterHeater:HeatPump:WrappedCondenser parent object (field Compressor Location).

Units: W

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

evaporator_air_inlet_node_name

field Evaporator Air Inlet Node Name

The node from which the DX coil draws its inlet air.

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

evaporator_air_outlet_node_name

field Evaporator Air Outlet Node Name

The node to which the DX coil sends its outlet air.

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

evaporator_air_temperature_type_for_curve_objects

field Evaporator Air Temperature Type for Curve Objects

Determines temperature type for heating capacity curves and

heating COP curves. This input determines whether

the inlet air dry-bulb or wet-bulb temperature is used to evaluate these curves.

Default value: WetBulbTemperature

Parameters:value (str) – value for IDD Field Evaporator Air Temperature Type for Curve Objects Raises:ValueError – if value is not a valid value Returns:the value of evaporator_air_temperature_type_for_curve_objects or None if not set Return type:str

evaporator_fan_power_included_in_rated_cop

field Evaporator Fan Power Included in Rated COP

Select Yes if the evaporator fan power is included in the rated COP. This choice field

impacts the calculation of compressor electric power.

Default value: Yes

Parameters:value (str) – value for IDD Field Evaporator Fan Power Included in Rated COP Raises:ValueError – if value is not a valid value Returns:the value of evaporator_fan_power_included_in_rated_cop or None if not set Return type:str

heating_capacity_function_of_air_flow_fraction_curve_name

field Heating Capacity Function of Air Flow Fraction Curve Name

Heating capacity modifier curve (function of air flow fraction) should be quadratic or cubic.

Quadratic curve = a + b(ff) + c(ff)^2.

Cubic curve = a + b(ff) + c(ff)^2 + d(ff)^3.

ff = fraction of the rated evaporator air flow rate.

Use curve coefficients of 1,0,0 or leave this field blank when neglecting performance impacts

due to variations in air flow rate fraction.

Parameters:value (str) – value for IDD Field Heating Capacity Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of heating_capacity_function_of_air_flow_fraction_curve_name or None if not set Return type:str

heating_capacity_function_of_temperature_curve_name

field Heating Capacity Function of Temperature Curve Name

Heating capacity modifier curve (function of temperature) should be biquadratic or cubic.

Biquadratic curve = a + b(ta) + c(ta)^2 + d(tw) + e(tw)^2 + f(ta)(tw).

Cubic curve = a + b(ta) + c(ta)^2 + d(ta)^3.

ta = evaporator inlet air [dry-bulb or wet-bulb] temperature (C).

tw = condenser inlet water temperature (C).

The field Evaporator Air Temperature Type for Curve Objects determines if dry-bulb or wet-bulb

is used as the evaporator inlet air temperature (ta).

Parameters:value (str) – value for IDD Field Heating Capacity Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of heating_capacity_function_of_temperature_curve_name or None if not set Return type:str

heating_cop_function_of_air_flow_fraction_curve_name

field Heating COP Function of Air Flow Fraction Curve Name

Heating COP modifier curve (function of air flow fraction) should be quadratic or cubic.

Quadratic curve = a + b(ff) + c(ff)^2.

Cubic curve = a + b(ff) + c(ff)^2 + d(ff)^3.

ff = fraction of the rated evaporator air flow rate.

Use curve coefficients of 1,0,0 or leave this field blank when neglecting performance impacts

due to variations in air flow rate fraction.

Parameters:value (str) – value for IDD Field Heating COP Function of Air Flow Fraction Curve Name Raises:ValueError – if value is not a valid value Returns:the value of heating_cop_function_of_air_flow_fraction_curve_name or None if not set Return type:str

heating_cop_function_of_temperature_curve_name

field Heating COP Function of Temperature Curve Name

Heating COP modifier curve (function of temperature) should be biquadratic or cubic.

Biquadratic curve = a + b(ta) + c(ta)^2 + d(tw) + e(tw)^2 + f(ta)(tw).

Cubic curve = a + b(ta) + c(ta)^2 + d(ta)^3.

ta = evaporator inlet air [dry-bulb or wet-bulb] temperature (C).

tw = condenser inlet water temperature (C).

The field Evaporator Air Temperature Type for Curve Objects determines if dry-bulb or wet-bulb

is used as the evaporator inlet air temperature (ta).

Parameters:value (str) – value for IDD Field Heating COP Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of heating_cop_function_of_temperature_curve_name or None if not set Return type:str

maximum_ambient_temperature_for_crankcase_heater_operation

field Maximum Ambient Temperature for Crankcase Heater Operation

The compressor crankcase heater only operates when the dry-bulb temperature of air

surrounding the compressor is below the Maximum Outdoor Temperature for Crankcase

Heater Operation and the unit is off. The ambient temperature surrounding the

compressor is set by the WaterHeater:HeatPump:WrappedCondenser parent object (field Compressor Location).

Units: C

Default value: 10.0

Parameters:value (float) – value for IDD Field Maximum Ambient Temperature for Crankcase Heater Operation Raises:ValueError – if value is not a valid value Returns:the value of maximum_ambient_temperature_for_crankcase_heater_operation or None if not set Return type:float

name

field Name

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

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

part_load_fraction_correlation_curve_name

field Part Load Fraction Correlation Curve Name

Part Load Fraction Correlation (function of part load ratio) should be quadratic or cubic.

Quadratic curve = a + b(PLR) + c(PLR)^2.

Cubic curve = a + b(PLR) + c(PLR)^2 + d(PLR)^3.

PLR = part load ratio (heating delivered/steady state heating capacity).

Use curve coefficients of 1,0,0 or leave this field blank when neglecting performance impacts

due to variations in part load ratio.

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

rated_condenser_water_temperature

field Rated Condenser Water Temperature

Condenser inlet water temperature corresponding to rated coil performance

(heating capacity, COP and SHR).

Units: C

Default value: 57.5

value > 25.0

Parameters:value (float) – value for IDD Field Rated Condenser Water Temperature Raises:ValueError – if value is not a valid value Returns:the value of rated_condenser_water_temperature or None if not set Return type:float

rated_cop

field Rated COP

Heating coefficient of performance at the rated inlet air temperatures,

rated condenser inlet water temperature, rated air flow rate, and rated water flow rate.

Can optionally include condenser pump power and evaporator fan power (see fields below).

Units: W/W

Default value: 3.2

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

rated_evaporator_air_flow_rate

field Rated Evaporator Air Flow Rate

Evaporator air flow rate corresponding to rated coil performance

(heating capacity, COP and SHR).

Default is 5.035E-5 m3/s/W (31.25 cfm/MBH) of rated heating capacity when autocalculated.

Units: m3/s

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

rated_evaporator_inlet_air_drybulb_temperature

field Rated Evaporator Inlet Air Dry-Bulb Temperature

Evaporator inlet air dry-bulb temperature corresponding to rated coil performance

(heating capacity, COP and SHR).

Units: C

Default value: 19.7

value > 5.0

Parameters:value (float) – value for IDD Field Rated Evaporator Inlet Air Dry-Bulb Temperature Raises:ValueError – if value is not a valid value Returns:the value of rated_evaporator_inlet_air_drybulb_temperature or None if not set Return type:float

rated_evaporator_inlet_air_wetbulb_temperature

field Rated Evaporator Inlet Air Wet-Bulb Temperature

Evaporator inlet air wet-bulb temperature corresponding to rated coil performance

(heating capacity, COP and SHR).

Units: C

Default value: 13.5

value > 5.0

Parameters:value (float) – value for IDD Field Rated Evaporator Inlet Air Wet-Bulb Temperature Raises:ValueError – if value is not a valid value Returns:the value of rated_evaporator_inlet_air_wetbulb_temperature or None if not set Return type:float

rated_heating_capacity

field Rated Heating Capacity

Heating capacity at the rated inlet air temperatures, rated condenser inlet

water temperature, rated air flow rate, and rated water flow rate.

Can optionally include condenser pump heat.

Units: W

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

rated_sensible_heat_ratio

field Rated Sensible Heat Ratio

Gross air-side sensible heat ratio at the rated inlet air temperatures,

rated condenser inlet water temperature, rated air flow rate, and rated water flow rate.

Sensible heat ratio equals gross sensible cooling capacity divided by gross total cooling

capacity. Rated SHR (gross) should not include evaporator fan heat, only sensible cooling

and dehumidification by the coil alone.

Default value: 0.85

value >= 0.5

value <= 1.0

Parameters:value (float) – value for IDD Field Rated Sensible Heat Ratio Raises:ValueError – if value is not a valid value Returns:the value of rated_sensible_heat_ratio or None if not set Return type:float

class pyidf.coils.CoilWaterHeatingDesuperheater

Bases: pyidf.helper.DataObject

Corresponds to IDD object Coil:WaterHeating:Desuperheater Desuperheater air heating coil. The heating energy provided by this coil is reclaimed from the superheated refrigerant gas leaving a compressor and does not impact the performance of the compressor. This coil must be used with a water heater tank, see Water Heater:Mixed.

availability_schedule_name

field Availability Schedule Name

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

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

Schedule values of 0 denote the desuperheater heating coil is off and the parasitic electric

energy is also off.

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

dead_band_temperature_difference

field Dead Band Temperature Difference

Setpoint temperature minus the dead band temperature difference defines

the cut-in temperature where the desuperheater water heating coil turns on.

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

should always be less than the desuperheater heating coil cut-in temperature.

Units: deltaC

Default value: 5.0

value <= 20.0

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

fraction_of_pump_heat_to_water

field Fraction of Pump Heat to Water

The fraction of pump heat transferred to the water. The pump is assumed to be downstream of

the desuperheater water heating coil.

Default value: 0.2

value <= 1.0

Parameters:value (float) – value for IDD Field Fraction of Pump Heat to Water Raises:ValueError – if value is not a valid value Returns:the value of fraction_of_pump_heat_to_water or None if not set Return type:float

heat_reclaim_efficiency_function_of_temperature_curve_name

field Heat Reclaim Efficiency Function of Temperature Curve Name

A biquadratic curve defining the performance of the desuperheater heating coil.

Performance can be specified as a function of inlet water temperature, outdoor air

dry-bulb temperature, or both.

Curve = a + b*Tw + c*Tw**2 + d*odb + e*odb**2 + f*Tw*odb.

Tw = desuperheater heating coil entering water temperature (C).

Odb = outdoor dry-bulb temperature at DX system condenser (C).

Parameters:value (str) – value for IDD Field Heat Reclaim Efficiency Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of heat_reclaim_efficiency_function_of_temperature_curve_name or None if not set Return type:str

heating_source_name

field Heating Source Name

The name of the DX system used for heat reclaim.

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

heating_source_object_type

field Heating Source Object Type

The type of DX system that is providing waste heat for reclaim.

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

maximum_inlet_water_temperature_for_heat_reclaim

field Maximum Inlet Water Temperature for Heat Reclaim

The desuperheater water heating coil is off when the inlet water temperature is above

the maximum inlet water temperature for heat reclaim.

Units: C

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

name

field Name

Unique name for this instance of a desuperheater water heating coil.

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

offcycle_parasitic_electric_load

field Off-Cycle Parasitic Electric Load

Parasitic electric load consumed when the desuperheater water heating coil is off.

Parasitic electric load does not contribute to water heating or the zone air heat balance.

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

Units: W

IP-Units: W

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

oncycle_parasitic_electric_load

field On-Cycle Parasitic Electric Load

Parasitic electric power consumed when the desuperheater water heating coil operates.

Parasitic electric load does not contribute to water heating or the zone air heat balance.

Units: W

IP-Units: W

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

rated_heat_reclaim_recovery_efficiency

field Rated Heat Reclaim Recovery Efficiency

Enter the fraction of waste heat reclaimed by the desuperheater water heating coil.

Parameters:value (float) – value for IDD Field Rated Heat Reclaim Recovery Efficiency Raises:ValueError – if value is not a valid value Returns:the value of rated_heat_reclaim_recovery_efficiency or None if not set Return type:float

rated_inlet_water_temperature

field Rated Inlet Water Temperature

The inlet water temperature corresponding to the rated heat reclaim recovery efficiency.

Units: C

Parameters:value (float) – value for IDD Field Rated Inlet Water Temperature Raises:ValueError – if value is not a valid value Returns:the value of rated_inlet_water_temperature or None if not set Return type:float

rated_outdoor_air_temperature

field Rated Outdoor Air Temperature

The outdoor air dry-bulb temperature corresponding to the

rated heat reclaim recovery efficiency.

Units: C

Parameters:value (float) – value for IDD Field Rated Outdoor Air Temperature Raises:ValueError – if value is not a valid value Returns:the value of rated_outdoor_air_temperature or None if not set Return type:float

setpoint_temperature_schedule_name

field Setpoint Temperature Schedule Name

Defines the cut-out temperature where the desuperheater water heating coil turns off.

The desuperheater heating coil setpoint temperature should always be greater

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

schedule values should be in degrees C.

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

tank_name

field Tank Name

The name of the water heater tank used by this desuperheater water heating coil.

Needs to match the name used in the corresponding water heater object.

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

tank_object_type

field Tank Object Type

Specify the type of water heater tank used by this desuperheater water heating coil.

Default value: WaterHeater:Mixed

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

water_flow_rate

field Water Flow Rate

The operating water flow rate.

Units: m3/s

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

water_inlet_node_name

field Water Inlet Node Name

The node from which the desuperheater heating coil draws its inlet water.

This name should match the source side outlet node name in the associated

water heater tank object.

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

water_outlet_node_name

field Water Outlet Node Name

The node to which the desuperheater heating coil sends its outlet water.

This name should match the source side inlet node name in the associated

water heater tank object.

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

water_pump_power

field Water Pump Power

The water circulation pump electric power.

Units: W

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