pyidf.variable_refrigerant_flow_equipment module

Data objects in group “Variable Refrigerant Flow Equipment”

class pyidf.variable_refrigerant_flow_equipment.AirConditionerVariableRefrigerantFlow

Bases: pyidf.helper.DataObject

Corresponds to IDD object AirConditioner:VariableRefrigerantFlow Variable refrigerant flow (VRF) air-to-air heat pump condensing unit (includes one or more electric compressors and outdoor fan). Serves one or more VRF zone terminal units. See ZoneHVAC:TerminalUnit:VariableRefrigerantFlow and ZoneTerminalUnitList.

availability_schedule_name

field Availability Schedule Name

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

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

Enter the name of a schedule that defines the availability of the unit.

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

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

condenser_inlet_node_name

field Condenser Inlet Node Name

Choose an outside air node name or leave this field blank to use weather data.

If this field is blank, the Condenser Type is assumed to be AirCooled.

This input must be specified if Condenser Type = WaterCooled.

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

condenser_outlet_node_name

field Condenser Outlet Node Name

Enter a water outlet node name if Condenser Type = WaterCooled.

Leave this field blank if Condenser Type = Air or EvaporativelyCooled.

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

condenser_type

field Condenser Type

Select either an air-cooled, evaporatively-cooled or water-cooled condenser.

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_capacity_ratio_boundary_curve_name

field Cooling Capacity Ratio Boundary Curve Name

This curve object is used to allow separate low and high cooling capacity ratio

performance curves. This curve represents a line passing through the points where

performance changes. The curve calculates outdoor dry-bulb temperature given weighted

average indoor wet-bulb temperature. If a single performance curve is used,

leave this field blank.

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

cooling_capacity_ratio_modifier_function_of_high_temperature_curve_name

field Cooling Capacity Ratio Modifier Function of High Temperature Curve Name

This curve object is used to describe the high outdoor temperature

performance curve used to describe cooling capacity ratio.

This curve is used when a single performance curve does not accurately describe

cooling capacity ratio as a function of temperature.

If a single performance curve is used, leave this field blank.

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

cooling_capacity_ratio_modifier_function_of_low_temperature_curve_name

field Cooling Capacity Ratio Modifier Function of Low Temperature Curve Name

Enter a curve name that represents full load cooling capacity ratio as a

function of outdoor dry-bulb temperature and indoor wet-bulb temperature.

Up to two curves are allowed if the performance cannot be represented by a single curve.

The following two fields are used if two curves are required.

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

cooling_combination_ratio_correction_factor_curve_name

field Cooling Combination Ratio Correction Factor Curve Name

This curve defines how rated capacity changes when the total indoor terminal unit cooling

capacity is greater than the Gross Rated Total Cooling Capacity defined in this object.

If this field is left blank, the model assumes total indoor terminal unit cooling

capacity is equal to the Gross Rated Total Cooling Capacity defined above.

Parameters:value (str) – value for IDD Field Cooling Combination Ratio Correction Factor Curve Name Raises:ValueError – if value is not a valid value Returns:the value of cooling_combination_ratio_correction_factor_curve_name or None if not set Return type:str

cooling_energy_input_ratio_boundary_curve_name

field Cooling Energy Input Ratio Boundary Curve Name

This curve object is used to allow separate low and high cooling energy input ratio

performance curves. This curve represents a line passing through the points where

performance changes. The curve calculates outdoor dry-bulb temperature given weighted

average indoor wet-bulb temperature. If a single performance curve is used,

leave this field blank.

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

cooling_energy_input_ratio_modifier_function_of_high_partload_ratio_curve_name

field Cooling Energy Input Ratio Modifier Function of High Part-Load Ratio Curve Name

Enter a curve name that represents cooling energy ratio as a function of

part-load ratio for part-load ratios greater than 1. Part-load ratios

can exceed 1 in variable speed compression systems.

If this field is left blank, the model assumes energy is proportional to

part-load ratio.

Parameters:value (str) – value for IDD Field Cooling Energy Input Ratio Modifier Function of High Part-Load Ratio Curve Name Raises:ValueError – if value is not a valid value Returns:the value of cooling_energy_input_ratio_modifier_function_of_high_partload_ratio_curve_name or None if not set Return type:str

cooling_energy_input_ratio_modifier_function_of_high_temperature_curve_name

field Cooling Energy Input Ratio Modifier Function of High Temperature Curve Name

This curve object is used to describe the high outdoor temperature

performance curve used to describe cooling energy ratio.

This curve is used when a single performance curve does not accurately describe

cooling energy ratio as a function of temperature

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

cooling_energy_input_ratio_modifier_function_of_low_partload_ratio_curve_name

field Cooling Energy Input Ratio Modifier Function of Low Part-Load Ratio Curve Name

Enter a curve name that represents cooling energy ratio as a function of

part-load ratio for part-load ratios less than or equal to 1.

If this field is left blank, the model assumes energy is proportional to

part-load ratio.

Parameters:value (str) – value for IDD Field Cooling Energy Input Ratio Modifier Function of Low Part-Load Ratio Curve Name Raises:ValueError – if value is not a valid value Returns:the value of cooling_energy_input_ratio_modifier_function_of_low_partload_ratio_curve_name or None if not set Return type:str

cooling_energy_input_ratio_modifier_function_of_low_temperature_curve_name

field Cooling Energy Input Ratio Modifier Function of Low Temperature Curve Name

Enter a curve name that represents cooling energy ratio as a function of

outdoor dry-bulb temperature and indoor wet-bulb temperature

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

cooling_partload_fraction_correlation_curve_name

field Cooling Part-Load Fraction Correlation Curve Name

This curve defines the cycling losses when the heat pump compressor cycles on and off

below the Minimum Heat Pump Part-Load Ratio specified in the field below.

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

crankcase_heater_power_per_compressor

field Crankcase Heater Power per Compressor

Enter the value of the resistive heater located in the compressor(s). This heater

is used to warm the refrigerant and oil when the compressor is off.

Units: W

Default value: 33.0

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

defrost_control

field Defrost Control

Choose a defrost control type. Either use a fixed Timed defrost period or select

OnDemand to defrost only when necessary.

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_modifier_function_of_temperature_curve_name

field Defrost Energy Input Ratio Modifier Function of Temperature Curve Name

A valid performance curve must be used if reversecycle defrost strategy is selected.

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

defrost_strategy

field Defrost Strategy

Select a defrost strategy. Reverse cycle reverses the operating mode from heating to cooling

to melt frost formation on the condenser coil. The resistive strategy uses a resistive heater

to melt the frost.

Default value: Resistive

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.

Units: dimensionless

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

equivalent_piping_length_used_for_piping_correction_factor_in_cooling_mode

field Equivalent Piping Length used for Piping Correction Factor in Cooling Mode

Enter the equivalent length of the farthest terminal unit from the condenser

Units: m

Parameters:value (float) – value for IDD Field Equivalent Piping Length used for Piping Correction Factor in Cooling Mode Raises:ValueError – if value is not a valid value Returns:the value of equivalent_piping_length_used_for_piping_correction_factor_in_cooling_mode or None if not set Return type:float

equivalent_piping_length_used_for_piping_correction_factor_in_heating_mode

field Equivalent Piping Length used for Piping Correction Factor in Heating Mode

Enter the equivalent length of the farthest terminal unit from the condenser

Units: m

Parameters:value (float) – value for IDD Field Equivalent Piping Length used for Piping Correction Factor in Heating Mode Raises:ValueError – if value is not a valid value Returns:the value of equivalent_piping_length_used_for_piping_correction_factor_in_heating_mode or None if not set Return type:float

evaporative_condenser_air_flow_rate

field Evaporative Condenser Air Flow Rate

Used to calculate evaporative condenser water use.

This field is only used when the Condenser Type = EvaporativelyCooled.

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

Enter the effectiveness of the evaporatively cooled condenser.

This field is only used when the Condenser Type = EvaporativelyCooled.

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.

This field is only used when the Condenser Type = EvaporativelyCooled.

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”

fuel_type

field Fuel Type

Default value: Electricity

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

gross_rated_cooling_cop

field Gross Rated Cooling COP

Enter the coefficient of performance at rated conditions or leave blank to use default.

COP includes compressor and condenser fan electrical energy input

COP does not include supply fan heat or supply fan electric power input

Units: W/W

Default value: 3.3

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_heating_capacity

field Gross Rated Heating Capacity

Enter the heating capacity in watts at rated conditions or set to autosize.

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

COP includes compressor and condenser fan electrical energy input

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

Units: W/W

Default value: 3.4

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

gross_rated_total_cooling_capacity

field Gross Rated Total Cooling Capacity

Enter the total cooling capacity in watts at rated conditions or set to autosize.

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”

heat_pump_name

field Heat Pump Name

Enter a unique name for this variable refrigerant flow heat pump.

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

heat_pump_waste_heat_recovery

field Heat Pump Waste Heat Recovery

This field enables heat recovery operation within this VRF outdoor unit.

Default value: No

Parameters:value (str) – value for IDD Field Heat Pump Waste Heat Recovery Raises:ValueError – if value is not a valid value Returns:the value of heat_pump_waste_heat_recovery or None if not set Return type:str

heat_recovery_cooling_capacity_modifier_curve_name

field Heat Recovery Cooling Capacity Modifier Curve Name

Enter the name of a performance curve which represents

the change in cooling capacity when heat recovery is active

A default constant of 0.9 is used if this input is blank

Parameters:value (str) – value for IDD Field Heat Recovery Cooling Capacity Modifier Curve Name Raises:ValueError – if value is not a valid value Returns:the value of heat_recovery_cooling_capacity_modifier_curve_name or None if not set Return type:str

heat_recovery_cooling_capacity_time_constant

field Heat Recovery Cooling Capacity Time Constant

Enter the time constant used to model the transition

from cooling only mode to heat recovery mode

Units: hr

Default value: 0.15

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

heat_recovery_cooling_energy_modifier_curve_name

field Heat Recovery Cooling Energy Modifier Curve Name

Enter the name of a performance curve which represents

the change in cooling energy when heat recovery is active

A default constant of 1.1 is used if this input is blank

Parameters:value (str) – value for IDD Field Heat Recovery Cooling Energy Modifier Curve Name Raises:ValueError – if value is not a valid value Returns:the value of heat_recovery_cooling_energy_modifier_curve_name or None if not set Return type:str

heat_recovery_cooling_energy_time_constant

field Heat Recovery Cooling Energy Time Constant

Enter the time constant used to model the transition

from cooling only mode to heat recovery mode

Units: hr

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

heat_recovery_heating_capacity_modifier_curve_name

field Heat Recovery Heating Capacity Modifier Curve Name

Enter the name of a performance curve which represents

the change in heating capacity when heat recovery is active

A default constant of 1.1 is used if this input is blank

Parameters:value (str) – value for IDD Field Heat Recovery Heating Capacity Modifier Curve Name Raises:ValueError – if value is not a valid value Returns:the value of heat_recovery_heating_capacity_modifier_curve_name or None if not set Return type:str

heat_recovery_heating_capacity_time_constant

field Heat Recovery Heating Capacity Time Constant

Enter the time constant used to model the transition

from cooling only mode to heat recovery mode

Units: hr

Default value: 0.15

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

heat_recovery_heating_energy_modifier_curve_name

field Heat Recovery Heating Energy Modifier Curve Name

Enter the name of a performance curve which represents

the change in heating electric consumption rate when heat recovery is active

A default constant of 1.1 is used if this input is blank

Parameters:value (str) – value for IDD Field Heat Recovery Heating Energy Modifier Curve Name Raises:ValueError – if value is not a valid value Returns:the value of heat_recovery_heating_energy_modifier_curve_name or None if not set Return type:str

heat_recovery_heating_energy_time_constant

field Heat Recovery Heating Energy Time Constant

Enter the time constant used to model the transition

from cooling only mode to heat recovery mode

Units: hr

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

heating_capacity_ratio_boundary_curve_name

field Heating Capacity Ratio Boundary Curve Name

This curve object is used to allow separate low and high heating capacity ratio

performance curves. This curve represents a line passing through the points where

performance changes. The curve calculates outdoor dry-bulb or wet-bulb temperature

given weighted average indoor dry-bulb temperature. See Heating Performance Curve

Outdoor Temperature Type input below to determine which outdoor temperature type to use.

If a single performance curve is used, leave this field blank.

Parameters:value (str) – value for IDD Field Heating Capacity Ratio Boundary Curve Name Raises:ValueError – if value is not a valid value Returns:the value of heating_capacity_ratio_boundary_curve_name or None if not set Return type:str

heating_capacity_ratio_modifier_function_of_high_temperature_curve_name

field Heating Capacity Ratio Modifier Function of High Temperature Curve Name

This curve object is used to describe the high outdoor temperature

performance curve used to describe heating capacity ratio.

This curve is used when a single performance curve does not accurately describe

heating capacity ratio as a function of temperature.

If a single performance curve is used, leave this field blank.

Parameters:value (str) – value for IDD Field Heating Capacity Ratio Modifier Function of High Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of heating_capacity_ratio_modifier_function_of_high_temperature_curve_name or None if not set Return type:str

heating_capacity_ratio_modifier_function_of_low_temperature_curve_name

field Heating Capacity Ratio Modifier Function of Low Temperature Curve Name

Enter a curve name that represents full load heating capacity ratio as a

function of outdoor wet-bulb temperature and indoor dry-bulb temperature.

Outdoor dry-bulb temperature may be used if wet-bulb temperature data is unavailable.

See Heating Performance Curve Outdoor Temperature Type input below to determine which

outdoor temperature type to use.

Up to two curves are allowed if the performance cannot be represented by a single curve.

The following two fields are used if two curves are required.

Parameters:value (str) – value for IDD Field Heating Capacity Ratio Modifier Function of Low Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of heating_capacity_ratio_modifier_function_of_low_temperature_curve_name or None if not set Return type:str

heating_combination_ratio_correction_factor_curve_name

field Heating Combination Ratio Correction Factor Curve Name

This curve defines how rated capacity changes when the total indoor terminal unit heating

capacity is greater than the Gross Rated Heating Capacity defined in this object.

If this field is left blank, the model assumes total indoor terminal unit heating

capacity is equal to the Gross Rated Heating Capacity defined above.

Parameters:value (str) – value for IDD Field Heating Combination Ratio Correction Factor Curve Name Raises:ValueError – if value is not a valid value Returns:the value of heating_combination_ratio_correction_factor_curve_name or None if not set Return type:str

heating_energy_input_ratio_boundary_curve_name

field Heating Energy Input Ratio Boundary Curve Name

This curve object is used to allow separate low and high heating energy input ratio

performance curves. This curve represents a line passing through the points where

performance changes. The curve calculates outdoor dry-bulb or wet-bulb temperature

given weighted average indoor dry-bulb temperature. See Heating Performance Curve

Outdoor Temperature Type input below to determine which outdoor temperature type to use.

If a single performance curve is used, leave this field blank.

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

heating_energy_input_ratio_modifier_function_of_high_partload_ratio_curve_name

field Heating Energy Input Ratio Modifier Function of High Part-Load Ratio Curve Name

This curve represents the heating energy input ratio for part-load ratios greater than 1.

Parameters:value (str) – value for IDD Field Heating Energy Input Ratio Modifier Function of High Part-Load Ratio Curve Name Raises:ValueError – if value is not a valid value Returns:the value of heating_energy_input_ratio_modifier_function_of_high_partload_ratio_curve_name or None if not set Return type:str

heating_energy_input_ratio_modifier_function_of_high_temperature_curve_name

field Heating Energy Input Ratio Modifier Function of High Temperature Curve Name

This curve object is used to allow separate performance curves for heating energy.

If a single performance curve is used, leave this field blank.

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

heating_energy_input_ratio_modifier_function_of_low_partload_ratio_curve_name

field Heating Energy Input Ratio Modifier Function of Low Part-Load Ratio Curve Name

This curve represents the heating energy input ratio for part-load ratios less than 1.

Parameters:value (str) – value for IDD Field Heating Energy Input Ratio Modifier Function of Low Part-Load Ratio Curve Name Raises:ValueError – if value is not a valid value Returns:the value of heating_energy_input_ratio_modifier_function_of_low_partload_ratio_curve_name or None if not set Return type:str

heating_energy_input_ratio_modifier_function_of_low_temperature_curve_name

field Heating Energy Input Ratio Modifier Function of Low Temperature Curve Name

Enter a curve name that represents heating energy ratio as a function of

outdoor wet-bulb temperature and indoor dry-bulb temperature

Outdoor dry-bulb temperature may be used if wet-bulb temperature data is unavailable.

See Heating Performance Curve Outdoor Temperature Type input below to determine which

outdoor temperature type to use.

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

heating_partload_fraction_correlation_curve_name

field Heating Part-Load Fraction Correlation Curve Name

This curve defines the cycling losses when the heat pump compressor cycles on and off

below the Minimum Heat Pump Part-Load Ratio specified in the following field.

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

heating_performance_curve_outdoor_temperature_type

field Heating Performance Curve Outdoor Temperature Type

Determines temperature type for heating capacity curves and heating energy curves.

This input determines whether the outdoor air dry-bulb or wet-bulb temperature

is used to evaluate these curves.

Default value: WetBulbTemperature

Parameters:value (str) – value for IDD Field Heating Performance Curve Outdoor Temperature Type Raises:ValueError – if value is not a valid value Returns:the value of heating_performance_curve_outdoor_temperature_type or None if not set Return type:str

initial_heat_recovery_cooling_capacity_fraction

field Initial Heat Recovery Cooling Capacity Fraction

Enter the fractional capacity available at the start

of heat recovery mode. The capacity exponentially approaches

the steady-state value according to the inputs for

Heat Recovery Cooling Capacity Modifier and Heat Recovery

Cooling Capacity Time Constant

Units: W/W

Default value: 0.5

Parameters:value (float) – value for IDD Field Initial Heat Recovery Cooling Capacity Fraction Raises:ValueError – if value is not a valid value Returns:the value of initial_heat_recovery_cooling_capacity_fraction or None if not set Return type:float

initial_heat_recovery_cooling_energy_fraction

field Initial Heat Recovery Cooling Energy Fraction

Enter the fractional electric consumption rate at the start

of heat recovery mode. The electric consumption rate exponentially

approaches the steady-state value according to the inputs for

Heat Recovery Cooling Energy Modifier and Heat Recovery

Cooling Energy Time Constant

Units: W/W

Default value: 1.0

Parameters:value (float) – value for IDD Field Initial Heat Recovery Cooling Energy Fraction Raises:ValueError – if value is not a valid value Returns:the value of initial_heat_recovery_cooling_energy_fraction or None if not set Return type:float

initial_heat_recovery_heating_capacity_fraction

field Initial Heat Recovery Heating Capacity Fraction

Enter the fractional capacity available at the start

of heat recovery mode. The capacity exponentially approaches

the steady-state value according to the inputs for

Heat Recovery Heating Capacity Modifier and Heat Recovery

Heating Capacity Time Constant

Units: W/W

Default value: 1.0

Parameters:value (float) – value for IDD Field Initial Heat Recovery Heating Capacity Fraction Raises:ValueError – if value is not a valid value Returns:the value of initial_heat_recovery_heating_capacity_fraction or None if not set Return type:float

initial_heat_recovery_heating_energy_fraction

field Initial Heat Recovery Heating Energy Fraction

Enter the fractional electric consumption rate at the start

of heat recovery mode. The electric consumption rate exponentially

approaches the steady-state value according to the inputs for

Heat Recovery Cooling Energy Modifier and Heat Recovery

Cooling Energy Time Constant

Units: W/W

Default value: 1.0

Parameters:value (float) – value for IDD Field Initial Heat Recovery Heating Energy Fraction Raises:ValueError – if value is not a valid value Returns:the value of initial_heat_recovery_heating_energy_fraction or None if not set Return type:float

master_thermostat_priority_control_type

field Master Thermostat Priority Control Type

Choose a thermostat control logic scheme. If these control types fail to control zone

temperature within a reasonable limit, consider using multiple VRF systems

Default value: MasterThermostatPriority

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

maximum_outdoor_drybulb_temperature_for_crankcase_heater

field Maximum Outdoor Dry-Bulb Temperature for Crankcase Heater

Enter the maximum outdoor temperature above which the crankcase heaters are disabled.

Units: C

Default value: 5.0

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

maximum_outdoor_drybulb_temperature_for_defrost_operation

field Maximum Outdoor Dry-bulb Temperature for Defrost Operation

Enter the maximum outdoor temperature above which defrost operation is disabled.

Units: C

Default value: 5.0

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

maximum_outdoor_temperature_in_cooling_mode

field Maximum Outdoor Temperature in Cooling Mode

Enter the maximum outdoor temperature allowed for cooling operation.

Cooling is disabled above this temperature.

Units: C

Default value: 43.0

Parameters:value (float) – value for IDD Field Maximum Outdoor Temperature in Cooling Mode Raises:ValueError – if value is not a valid value Returns:the value of maximum_outdoor_temperature_in_cooling_mode or None if not set Return type:float

maximum_outdoor_temperature_in_heat_recovery_mode

field Maximum Outdoor Temperature in Heat Recovery Mode

The maximum outdoor temperature above which heat

recovery mode will not operate.

Units: C

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

maximum_outdoor_temperature_in_heating_mode

field Maximum Outdoor Temperature in Heating Mode

Enter the maximum outdoor temperature allowed for heating operation.

Units: C

Default value: 16.0

Parameters:value (float) – value for IDD Field Maximum Outdoor Temperature in Heating Mode Raises:ValueError – if value is not a valid value Returns:the value of maximum_outdoor_temperature_in_heating_mode or None if not set Return type:float

minimum_heat_pump_partload_ratio

field Minimum Heat Pump Part-Load Ratio

Enter the minimum heat pump part-load ratio (PLR). When the cooling or heating PLR is

below this value, the heat pump compressor will cycle to meet the cooling or heating

demand.

Units: dimensionless

Default value: 0.15

Parameters:value (float) – value for IDD Field Minimum Heat Pump Part-Load Ratio Raises:ValueError – if value is not a valid value Returns:the value of minimum_heat_pump_partload_ratio or None if not set Return type:float

minimum_outdoor_temperature_in_cooling_mode

field Minimum Outdoor Temperature in Cooling Mode

Enter the minimum outdoor temperature allowed for cooling operation.

Cooling is disabled below this temperature.

Units: C

Default value: -6.0

Parameters:value (float) – value for IDD Field Minimum Outdoor Temperature in Cooling Mode Raises:ValueError – if value is not a valid value Returns:the value of minimum_outdoor_temperature_in_cooling_mode or None if not set Return type:float

minimum_outdoor_temperature_in_heat_recovery_mode

field Minimum Outdoor Temperature in Heat Recovery Mode

The minimum outdoor temperature below which heat

recovery mode will not operate.

Units: C

Parameters:value (float) – value for IDD Field Minimum Outdoor Temperature in Heat Recovery Mode Raises:ValueError – if value is not a valid value Returns:the value of minimum_outdoor_temperature_in_heat_recovery_mode or None if not set Return type:float

minimum_outdoor_temperature_in_heating_mode

field Minimum Outdoor Temperature in Heating Mode

Enter the minimum outdoor temperature allowed for heating operation.

Units: C

Default value: -20.0

Parameters:value (float) – value for IDD Field Minimum Outdoor Temperature in Heating Mode Raises:ValueError – if value is not a valid value Returns:the value of minimum_outdoor_temperature_in_heating_mode or None if not set Return type:float

number_of_compressors

field Number of Compressors

Enter the total number of compressor. This input is used only for crankcase

heater calculations.

Units: dimensionless

Default value: 2

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

piping_correction_factor_for_height_in_cooling_mode_coefficient

field Piping Correction Factor for Height in Cooling Mode Coefficient

PCF = a0 + a1*L + a2*L^2 + a3*L^3 + a4*H

PCF = a0 + a1*L + a2*L^2 + a3*CR + a4*CR^2 + a5*(L)(CR) + a6*H

where L = length, H = height, and CR = combination ratio

specifies coefficient a4 (or a6 for biquadratic) in the PCF equation

Units: 1/m

Parameters:value (float) – value for IDD Field Piping Correction Factor for Height in Cooling Mode Coefficient Raises:ValueError – if value is not a valid value Returns:the value of piping_correction_factor_for_height_in_cooling_mode_coefficient or None if not set Return type:float

piping_correction_factor_for_height_in_heating_mode_coefficient

field Piping Correction Factor for Height in Heating Mode Coefficient

PCF = a0 + a1*L + a2*L^2 + a3*L^3 + a4*H

PCF = a0 + a1*L + a2*L^2 + a3*CR + a4*CR^2 + a5*(L)(CR) + a6*H

where L = length, H = height, and CR = combination ratio

specifies coefficient a4 (or a6 for biquadratic) in the PCF equation

Units: 1/m

Parameters:value (float) – value for IDD Field Piping Correction Factor for Height in Heating Mode Coefficient Raises:ValueError – if value is not a valid value Returns:the value of piping_correction_factor_for_height_in_heating_mode_coefficient or None if not set Return type:float

piping_correction_factor_for_length_in_cooling_mode_curve_name

field Piping Correction Factor for Length in Cooling Mode Curve Name

PCF = a0 + a1*L + a2*L^2 + a3*L^3 + a4*H

PCF = a0 + a1*L + a2*L^2 + a3*CR + a4*CR^2 + a5*(L)(CR)

where L = length and CR = combination ratio

specifies coefficients for a0, a1, a2, and a3 in the PCF equation

Parameters:value (str) – value for IDD Field Piping Correction Factor for Length in Cooling Mode Curve Name Raises:ValueError – if value is not a valid value Returns:the value of piping_correction_factor_for_length_in_cooling_mode_curve_name or None if not set Return type:str

piping_correction_factor_for_length_in_heating_mode_curve_name

field Piping Correction Factor for Length in Heating Mode Curve Name

PCF = a0 + a1*L + a2*L^2 + a3*L^3 + a4*H

PCF = a0 + a1*L + a2*L^2 + a3*CR + a4*CR^2 + a5*(L)(CR) + a6*H

where L = length and CR = combination ratio

specifies coefficients for a0, a1, a2, and a3 (or a0-a5 for biquadratic) in the PCF equation

Parameters:value (str) – value for IDD Field Piping Correction Factor for Length in Heating Mode Curve Name Raises:ValueError – if value is not a valid value Returns:the value of piping_correction_factor_for_length_in_heating_mode_curve_name or None if not set Return type:str

rated_heating_capacity_sizing_ratio

field Rated Heating Capacity Sizing Ratio

If the Gross Rated Heating Capacity is autosized, the heating capacity is sized

to be equal to the cooling capacity multiplied by this sizing ratio. The zone

terminal unit heating coils are also sized using this ratio unless the sizing

ratio input in the ZoneHVAC:TerminalUnit:VariableRefrigerantFlow object is entered.

Units: W/W

Default value: 1.0

value >= 1.0

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

ratio_of_compressor_size_to_total_compressor_capacity

field Ratio of Compressor Size to Total Compressor Capacity

Enter the ratio of the first stage compressor to total compressor capacity.

All other compressors are assumed to be equally sized. This inputs is used

only for crankcase heater calculations.

Units: W/W

Default value: 0.5

Parameters:value (float) – value for IDD Field Ratio of Compressor Size to Total Compressor Capacity Raises:ValueError – if value is not a valid value Returns:the value of ratio_of_compressor_size_to_total_compressor_capacity or None if not set Return type:float

resistive_defrost_heater_capacity

field Resistive Defrost Heater Capacity

Enter the size of the resistive defrost heating element.

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”

supply_water_storage_tank_name

field Supply Water Storage Tank Name

A separate storage tank may be used to supply an evaporatively cooled condenser.

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

thermostat_priority_schedule_name

field Thermostat Priority Schedule Name

this field is required if Master Thermostat Priority Control Type is Scheduled.

Schedule values of 0 denote cooling, 1 for heating, and all other values disable the system.

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

vertical_height_used_for_piping_correction_factor

field Vertical Height used for Piping Correction Factor

Enter the height difference between the highest and lowest terminal unit

Units: m

Parameters:value (float) – value for IDD Field Vertical Height used for Piping Correction Factor Raises:ValueError – if value is not a valid value Returns:the value of vertical_height_used_for_piping_correction_factor or None if not set Return type:float

water_condenser_volume_flow_rate

field Water Condenser Volume Flow Rate

Only used when Condenser Type = WaterCooled.

Units: m3/s

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

zone_name_for_master_thermostat_location

field Zone Name for Master Thermostat Location

Enter the name of the zone where the master thermostat is located.

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

zone_terminal_unit_list_name

field Zone Terminal Unit List Name

Enter the name of a ZoneTerminalUnitList. This list connects zone terminal units to this

heat pump.

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

class pyidf.variable_refrigerant_flow_equipment.AirConditionerVariableRefrigerantFlowFluidTemperatureControl

Bases: pyidf.helper.DataObject

Corresponds to IDD object AirConditioner:VariableRefrigerantFlow:FluidTemperatureControl This is a key object in the new physics based VRF model applicable for Fluid Temperature Control It describes the Variable Refrigerant Flow system excluding the performance of indoor units Indoor units are modeled separately, see ZoneHVAC:TerminalUnit:VariableRefrigerantFlow

availability_schedule_name

field Availability Schedule Name

Enter the name of a schedule that defines the availability of the unit

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

compressor_maximum_delta_pressure

field Compressor maximum delta Pressure

Units: Pa

Default value: 4500000.0

value <= 50000000.0

Parameters:value (float) – value for IDD Field Compressor maximum delta Pressure Raises:ValueError – if value is not a valid value Returns:the value of compressor_maximum_delta_pressure or None if not set Return type:float

compressor_speed_at_loading_index_1

field Compressor Speed at Loading Index 1

Minimum compressor speed

Units: rev/min

Parameters:value (float) – value for IDD Field Compressor Speed at Loading Index 1 Raises:ValueError – if value is not a valid value Returns:the value of compressor_speed_at_loading_index_1 or None if not set Return type:float

compressor_speed_at_loading_index_2

field Compressor Speed at Loading Index 2

Units: rev/min

Parameters:value (float) – value for IDD Field Compressor Speed at Loading Index 2 Raises:ValueError – if value is not a valid value Returns:the value of compressor_speed_at_loading_index_2 or None if not set Return type:float

compressor_speed_at_loading_index_3

field Compressor Speed at Loading Index 3

Units: rev/min

Parameters:value (float) – value for IDD Field Compressor Speed at Loading Index 3 Raises:ValueError – if value is not a valid value Returns:the value of compressor_speed_at_loading_index_3 or None if not set Return type:float

compressor_speed_at_loading_index_4

field Compressor Speed at Loading Index 4

Units: rev/min

Parameters:value (float) – value for IDD Field Compressor Speed at Loading Index 4 Raises:ValueError – if value is not a valid value Returns:the value of compressor_speed_at_loading_index_4 or None if not set Return type:float

compressor_speed_at_loading_index_5

field Compressor Speed at Loading Index 5

Units: rev/min

Parameters:value (float) – value for IDD Field Compressor Speed at Loading Index 5 Raises:ValueError – if value is not a valid value Returns:the value of compressor_speed_at_loading_index_5 or None if not set Return type:float

compressor_speed_at_loading_index_6

field Compressor Speed at Loading Index 6

Units: rev/min

Parameters:value (float) – value for IDD Field Compressor Speed at Loading Index 6 Raises:ValueError – if value is not a valid value Returns:the value of compressor_speed_at_loading_index_6 or None if not set Return type:float

compressor_speed_at_loading_index_7

field Compressor Speed at Loading Index 7

Units: rev/min

Parameters:value (float) – value for IDD Field Compressor Speed at Loading Index 7 Raises:ValueError – if value is not a valid value Returns:the value of compressor_speed_at_loading_index_7 or None if not set Return type:float

compressor_speed_at_loading_index_8

field Compressor Speed at Loading Index 8

Units: rev/min

Parameters:value (float) – value for IDD Field Compressor Speed at Loading Index 8 Raises:ValueError – if value is not a valid value Returns:the value of compressor_speed_at_loading_index_8 or None if not set Return type:float

compressor_speed_at_loading_index_9

field Compressor Speed at Loading Index 9

Units: rev/min

Parameters:value (float) – value for IDD Field Compressor Speed at Loading Index 9 Raises:ValueError – if value is not a valid value Returns:the value of compressor_speed_at_loading_index_9 or None if not set Return type:float

crankcase_heater_power_per_compressor

field Crankcase Heater Power per Compressor

Enter the value of the resistive heater located in the compressor(s). This heater

is used to warm the refrigerant and oil when the compressor is off

Units: W

Default value: 33.0

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

defrost_control

field Defrost Control

Choose a defrost control type

Either use a fixed Timed defrost period or select

OnDemand to defrost only when necessary

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_modifier_function_of_temperature_curve_name

field Defrost Energy Input Ratio Modifier Function of Temperature Curve Name

A valid performance curve must be used if ReverseCycle defrost strategy is selected

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

defrost_strategy

field Defrost Strategy

Select a defrost strategy.

Reverse cycle reverses the operating mode from heating to

cooling to melt frost formation on the condenser coil

The resistive strategy uses a resistive heater

to melt the frost.

Default value: Resistive

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

diameter_of_main_pipe_connecting_outdoor_unit_to_indoor_units

field Diameter of Main Pipe Connecting Outdoor Unit to Indoor Units

used to calculate the piping loss

Units: m

Default value: 0.0762

Parameters:value (float) – value for IDD Field Diameter of Main Pipe Connecting Outdoor Unit to Indoor Units Raises:ValueError – if value is not a valid value Returns:the value of diameter_of_main_pipe_connecting_outdoor_unit_to_indoor_units or None if not set Return type:float

equivalent_length_of_main_pipe_connecting_outdoor_unit_to_indoor_units

field Equivalent Length of Main Pipe Connecting Outdoor Unit to Indoor Units

used to calculate the refrigerant pressure drop of the main pipe

Units: m

Default value: 36.0

Parameters:value (float) – value for IDD Field Equivalent Length of Main Pipe Connecting Outdoor Unit to Indoor Units Raises:ValueError – if value is not a valid value Returns:the value of equivalent_length_of_main_pipe_connecting_outdoor_unit_to_indoor_units or None if not set Return type:float

heat_pump_name

field Heat Pump Name

Enter a unique name for this variable refrigerant flow heat pump

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

height_difference_between_outdoor_unit_and_indoor_units

field Height Difference Between Outdoor Unit and Indoor Units

Difference between outdoor unit height and indoor unit height

Positive means outdoor unit is higher than indoor unit

Negative means outdoor unit is lower than indoor unit

Units: m

Default value: 5.0

Parameters:value (float) – value for IDD Field Height Difference Between Outdoor Unit and Indoor Units Raises:ValueError – if value is not a valid value Returns:the value of height_difference_between_outdoor_unit_and_indoor_units or None if not set Return type:float

length_of_main_pipe_connecting_outdoor_unit_to_indoor_units

field Length of Main Pipe Connecting Outdoor Unit to Indoor Units

used to calculate the heat loss of the main pipe

Units: m

Default value: 30.0

Parameters:value (float) – value for IDD Field Length of Main Pipe Connecting Outdoor Unit to Indoor Units Raises:ValueError – if value is not a valid value Returns:the value of length_of_main_pipe_connecting_outdoor_unit_to_indoor_units or None if not set Return type:float

loading_index_1_compressor_power_multiplier_function_of_temperature_curve_name

field Loading Index 1 Compressor Power Multiplier Function of Temperature Curve Name

Parameters:value (str) – value for IDD Field Loading Index 1 Compressor Power Multiplier Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of loading_index_1_compressor_power_multiplier_function_of_temperature_curve_name or None if not set Return type:str

loading_index_1_evaporative_capacity_multiplier_function_of_temperature_curve_name

field Loading Index 1 Evaporative Capacity Multiplier Function of Temperature Curve Name

Parameters:value (str) – value for IDD Field Loading Index 1 Evaporative Capacity Multiplier Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of loading_index_1_evaporative_capacity_multiplier_function_of_temperature_curve_name or None if not set Return type:str

loading_index_2_compressor_power_multiplier_function_of_temperature_curve_name

field Loading Index 2 Compressor Power Multiplier Function of Temperature Curve Name

Parameters:value (str) – value for IDD Field Loading Index 2 Compressor Power Multiplier Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of loading_index_2_compressor_power_multiplier_function_of_temperature_curve_name or None if not set Return type:str

loading_index_2_evaporative_capacity_multiplier_function_of_temperature_curve_name

field Loading Index 2 Evaporative Capacity Multiplier Function of Temperature Curve Name

Parameters:value (str) – value for IDD Field Loading Index 2 Evaporative Capacity Multiplier Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of loading_index_2_evaporative_capacity_multiplier_function_of_temperature_curve_name or None if not set Return type:str

loading_index_3_compressor_power_multiplier_function_of_temperature_curve_name

field Loading Index 3 Compressor Power Multiplier Function of Temperature Curve Name

Parameters:value (str) – value for IDD Field Loading Index 3 Compressor Power Multiplier Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of loading_index_3_compressor_power_multiplier_function_of_temperature_curve_name or None if not set Return type:str

loading_index_3_evaporative_capacity_multiplier_function_of_temperature_curve_name

field Loading Index 3 Evaporative Capacity Multiplier Function of Temperature Curve Name

Parameters:value (str) – value for IDD Field Loading Index 3 Evaporative Capacity Multiplier Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of loading_index_3_evaporative_capacity_multiplier_function_of_temperature_curve_name or None if not set Return type:str

loading_index_4_compressor_power_multiplier_function_of_temperature_curve_name

field Loading Index 4 Compressor Power Multiplier Function of Temperature Curve Name

Parameters:value (str) – value for IDD Field Loading Index 4 Compressor Power Multiplier Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of loading_index_4_compressor_power_multiplier_function_of_temperature_curve_name or None if not set Return type:str

loading_index_4_evaporative_capacity_multiplier_function_of_temperature_curve_name

field Loading Index 4 Evaporative Capacity Multiplier Function of Temperature Curve Name

Parameters:value (str) – value for IDD Field Loading Index 4 Evaporative Capacity Multiplier Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of loading_index_4_evaporative_capacity_multiplier_function_of_temperature_curve_name or None if not set Return type:str

loading_index_5_compressor_power_multiplier_function_of_temperature_curve_name

field Loading Index 5 Compressor Power Multiplier Function of Temperature Curve Name

Parameters:value (str) – value for IDD Field Loading Index 5 Compressor Power Multiplier Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of loading_index_5_compressor_power_multiplier_function_of_temperature_curve_name or None if not set Return type:str

loading_index_5_evaporative_capacity_multiplier_function_of_temperature_curve_name

field Loading Index 5 Evaporative Capacity Multiplier Function of Temperature Curve Name

Parameters:value (str) – value for IDD Field Loading Index 5 Evaporative Capacity Multiplier Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of loading_index_5_evaporative_capacity_multiplier_function_of_temperature_curve_name or None if not set Return type:str

loading_index_6_compressor_power_multiplier_function_of_temperature_curve_name

field Loading Index 6 Compressor Power Multiplier Function of Temperature Curve Name

Parameters:value (str) – value for IDD Field Loading Index 6 Compressor Power Multiplier Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of loading_index_6_compressor_power_multiplier_function_of_temperature_curve_name or None if not set Return type:str

loading_index_6_evaporative_capacity_multiplier_function_of_temperature_curve_name

field Loading Index 6 Evaporative Capacity Multiplier Function of Temperature Curve Name

Parameters:value (str) – value for IDD Field Loading Index 6 Evaporative Capacity Multiplier Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of loading_index_6_evaporative_capacity_multiplier_function_of_temperature_curve_name or None if not set Return type:str

loading_index_7_evaporative_capacity_multiplier_function_of_temperature_curve_name

field Loading Index 7 Evaporative Capacity Multiplier Function of Temperature Curve Name

Parameters:value (str) – value for IDD Field Loading Index 7 Evaporative Capacity Multiplier Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of loading_index_7_evaporative_capacity_multiplier_function_of_temperature_curve_name or None if not set Return type:str

loading_index_7_list

field Loading Index 7 list

Parameters:value (str) – value for IDD Field Loading Index 7 list Raises:ValueError – if value is not a valid value Returns:the value of loading_index_7_list or None if not set Return type:str

loading_index_8_compressor_power_multiplier_function_of_temperature_curve_name

field Loading Index 8 Compressor Power Multiplier Function of Temperature Curve Name

Parameters:value (str) – value for IDD Field Loading Index 8 Compressor Power Multiplier Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of loading_index_8_compressor_power_multiplier_function_of_temperature_curve_name or None if not set Return type:str

loading_index_8_evaporative_capacity_multiplier_function_of_temperature_curve_name

field Loading Index 8 Evaporative Capacity Multiplier Function of Temperature Curve Name

Parameters:value (str) – value for IDD Field Loading Index 8 Evaporative Capacity Multiplier Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of loading_index_8_evaporative_capacity_multiplier_function_of_temperature_curve_name or None if not set Return type:str

loading_index_9_compressor_power_multiplier_function_of_temperature_curve_name

field Loading Index 9 Compressor Power Multiplier Function of Temperature Curve Name

Parameters:value (str) – value for IDD Field Loading Index 9 Compressor Power Multiplier Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of loading_index_9_compressor_power_multiplier_function_of_temperature_curve_name or None if not set Return type:str

loading_index_9_evaporative_capacity_multiplier_function_of_temperature_curve_name

field Loading Index 9 Evaporative Capacity Multiplier Function of Temperature Curve Name

Parameters:value (str) – value for IDD Field Loading Index 9 Evaporative Capacity Multiplier Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of loading_index_9_evaporative_capacity_multiplier_function_of_temperature_curve_name or None if not set Return type:str

main_pipe_insulation_thermal_conductivity

field Main Pipe Insulation Thermal Conductivity

Units: W/m-K

Default value: 0.032

Parameters:value (float) – value for IDD Field Main Pipe Insulation Thermal Conductivity Raises:ValueError – if value is not a valid value Returns:the value of main_pipe_insulation_thermal_conductivity or None if not set Return type:float

main_pipe_insulation_thickness

field Main Pipe Insulation Thickness

Units: m

Default value: 0.02

Parameters:value (float) – value for IDD Field Main Pipe Insulation Thickness Raises:ValueError – if value is not a valid value Returns:the value of main_pipe_insulation_thickness or None if not set Return type:float

maximum_outdoor_air_temperature_in_cooling_mode

field Maximum Outdoor Air Temperature in Cooling Mode

Enter the maximum outdoor temperature allowed for cooling operation

Cooling is disabled above this temperature

Units: C

Default value: 43.0

Parameters:value (float) – value for IDD Field Maximum Outdoor Air Temperature in Cooling Mode Raises:ValueError – if value is not a valid value Returns:the value of maximum_outdoor_air_temperature_in_cooling_mode or None if not set Return type:float

maximum_outdoor_air_temperature_in_heating_mode

field Maximum Outdoor Air Temperature in Heating Mode

Enter the maximum outdoor temperature allowed for heating operation

Heating is disabled below this temperature

Units: C

Default value: 16.0

Parameters:value (float) – value for IDD Field Maximum Outdoor Air Temperature in Heating Mode Raises:ValueError – if value is not a valid value Returns:the value of maximum_outdoor_air_temperature_in_heating_mode or None if not set Return type:float

maximum_outdoor_drybulb_temperature_for_crankcase_heater

field Maximum Outdoor Dry-Bulb Temperature for Crankcase Heater

Enter the maximum outdoor temperature above which the crankcase heaters are disabled

Units: C

Default value: 5.0

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

maximum_outdoor_drybulb_temperature_for_defrost_operation

field Maximum Outdoor Dry-bulb Temperature for Defrost Operation

Enter the maximum outdoor temperature above which the defrost operation is disabled

Units: C

Default value: 5.0

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_air_temperature_in_cooling_mode

field Minimum Outdoor Air Temperature in Cooling Mode

Enter the minimum outdoor temperature allowed for cooling operation

Cooling is disabled below this temperature

Units: C

Default value: -6.0

Parameters:value (float) – value for IDD Field Minimum Outdoor Air Temperature in Cooling Mode Raises:ValueError – if value is not a valid value Returns:the value of minimum_outdoor_air_temperature_in_cooling_mode or None if not set Return type:float

minimum_outdoor_air_temperature_in_heating_mode

field Minimum Outdoor Air Temperature in Heating Mode

Enter the minimum outdoor temperature allowed for heating operation

Heating is disabled below this temperature

Units: C

Default value: -20.0

Parameters:value (float) – value for IDD Field Minimum Outdoor Air Temperature in Heating Mode Raises:ValueError – if value is not a valid value Returns:the value of minimum_outdoor_air_temperature_in_heating_mode or None if not set Return type:float

number_of_compressor_loading_index_entries

field Number of Compressor Loading Index Entries

First index represents minimal capacity operation

Last index represents full capacity operation

Default value: 2

value >= 2

value <= 9

Parameters:value (int) – value for IDD Field Number of Compressor Loading Index Entries Raises:ValueError – if value is not a valid value Returns:the value of number_of_compressor_loading_index_entries or None if not set Return type:int

number_of_compressors

field Number of Compressors

Enter the total number of compressor. This input is used only for crankcase

heater calculations.

Units: dimensionless

Default value: 2

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

outdoor_unit_condensing_temperature_function_of_subcooling_curve_name

field Outdoor Unit Condensing Temperature Function of Subcooling Curve Name

Parameters:value (str) – value for IDD Field Outdoor Unit Condensing Temperature Function of Subcooling Curve Name Raises:ValueError – if value is not a valid value Returns:the value of outdoor_unit_condensing_temperature_function_of_subcooling_curve_name or None if not set Return type:str

outdoor_unit_evaporating_temperature_function_of_superheating_curve_name

field Outdoor Unit Evaporating Temperature Function of Superheating Curve Name

Parameters:value (str) – value for IDD Field Outdoor Unit Evaporating Temperature Function of Superheating Curve Name Raises:ValueError – if value is not a valid value Returns:the value of outdoor_unit_evaporating_temperature_function_of_superheating_curve_name or None if not set Return type:str

outdoor_unit_fan_flow_rate_per_unit_of_rated_evaporative_capacity

field Outdoor Unit Fan Flow Rate Per Unit of Rated Evaporative Capacity

This field is only used if the previous is set to autocalculate and performance input method is NominalCapacity

Units: m3/s-W

Default value: 7.5e-05

Parameters:value (float) – value for IDD Field Outdoor Unit Fan Flow Rate Per Unit of Rated Evaporative Capacity Raises:ValueError – if value is not a valid value Returns:the value of outdoor_unit_fan_flow_rate_per_unit_of_rated_evaporative_capacity or None if not set Return type:float

outdoor_unit_fan_power_per_unit_of_rated_evaporative_capacity

field Outdoor Unit Fan Power Per Unit of Rated Evaporative Capacity

Enter the outdoor unit fan power per Watt of rated evaporative capacity [W/W]

Units: dimensionless

Default value: 0.00425

Parameters:value (float) – value for IDD Field Outdoor Unit Fan Power Per Unit of Rated Evaporative Capacity Raises:ValueError – if value is not a valid value Returns:the value of outdoor_unit_fan_power_per_unit_of_rated_evaporative_capacity or None if not set Return type:float

rated_compressor_power_per_unit_of_rated_evaporative_capacity

field Rated Compressor Power Per Unit of Rated Evaporative Capacity

Enter the rated compressor power per Watt of rated evaporative capacity [W/W]

Rated compressor power corresponds to the max compressor speed at rated conditions

The actual compressor power is obtained by multiplying the

rated power with the modification factor calculated by Compressor

Power Multiplier Function of Temperature Curve

Units: dimensionless

Default value: 0.35

Parameters:value (float) – value for IDD Field Rated Compressor Power Per Unit of Rated Evaporative Capacity Raises:ValueError – if value is not a valid value Returns:the value of rated_compressor_power_per_unit_of_rated_evaporative_capacity or None if not set Return type:float

rated_evaporative_capacity

field Rated Evaporative Capacity

Enter the total evaporative capacity in watts at rated conditions

This is the capacity corresponding to the max compressor speed at rated conditions

The actual evaporative capacity is obtained by multiplying the

rated capacity with the modification factor calculated by Evaporative

Capacity Multiplier Function of Temperature Curve

Units: W

Default value: 40000.0

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

ratio_of_compressor_size_to_total_compressor_capacity

field Ratio of Compressor Size to Total Compressor Capacity

Enter the ratio of the first stage compressor to total compressor capacity

All other compressors are assumed to be equally sized. This inputs is used

only for crankcase heater calculations

Units: W/W

Default value: 0.5

Parameters:value (float) – value for IDD Field Ratio of Compressor Size to Total Compressor Capacity Raises:ValueError – if value is not a valid value Returns:the value of ratio_of_compressor_size_to_total_compressor_capacity or None if not set Return type:float

reference_condensing_temperature_for_indoor_unit

field Reference Condensing Temperature for Indoor Unit

This field is used if Refrigerant Temperature Control Algorithm

is ConstantTemp

Condensing temperature is the refrigerant temperature, not air temperature

Units: C

Default value: 44.0

Parameters:value (float) – value for IDD Field Reference Condensing Temperature for Indoor Unit Raises:ValueError – if value is not a valid value Returns:the value of reference_condensing_temperature_for_indoor_unit or None if not set Return type:float

reference_evaporating_temperature_for_indoor_unit

field Reference Evaporating Temperature for Indoor Unit

This field is used if Refrigerant Temperature Control Algorithm

is ConstantTemp

Evaporating temperature is the refrigerant temperature, not air temperature

Units: C

Default value: 6.0

Parameters:value (float) – value for IDD Field Reference Evaporating Temperature for Indoor Unit Raises:ValueError – if value is not a valid value Returns:the value of reference_evaporating_temperature_for_indoor_unit or None if not set Return type:float

reference_outdoor_unit_subcooling

field Reference Outdoor Unit Subcooling

Units: deltaC

Default value: 5.0

Parameters:value (float) – value for IDD Field Reference Outdoor Unit Subcooling Raises:ValueError – if value is not a valid value Returns:the value of reference_outdoor_unit_subcooling or None if not set Return type:float

reference_outdoor_unit_superheating

field Reference Outdoor Unit Superheating

Units: deltaC

Default value: 3.0

Parameters:value (float) – value for IDD Field Reference Outdoor Unit Superheating Raises:ValueError – if value is not a valid value Returns:the value of reference_outdoor_unit_superheating or None if not set Return type:float

refrigerant_temperature_control_algorithm_for_indoor_unit

field Refrigerant Temperature Control Algorithm for Indoor Unit

Default value: VariableTemp

Parameters:value (str) – value for IDD Field Refrigerant Temperature Control Algorithm for Indoor Unit Raises:ValueError – if value is not a valid value Returns:the value of refrigerant_temperature_control_algorithm_for_indoor_unit or None if not set Return type:str

refrigerant_type

field Refrigerant Type

Default value: R410A

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

resistive_defrost_heater_capacity

field Resistive Defrost Heater Capacity

Enter the size of the resistive defrost heating element

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”

variable_condensing_temperature_maximum_for_indoor_unit

field Variable Condensing Temperature Maximum for Indoor Unit

This field is used if Refrigerant Temperature Control Algorithm

is VariableTemp

Condensing temperature is the refrigerant temperature, not air temperature

Units: C

Default value: 46.0

Parameters:value (float) – value for IDD Field Variable Condensing Temperature Maximum for Indoor Unit Raises:ValueError – if value is not a valid value Returns:the value of variable_condensing_temperature_maximum_for_indoor_unit or None if not set Return type:float

variable_condensing_temperature_minimum_for_indoor_unit

field Variable Condensing Temperature Minimum for Indoor Unit

This field is used if Refrigerant Temperature Control Algorithm

is VariableTemp

Condensing temperature is the refrigerant temperature, not air temperature

Units: C

Default value: 42.0

Parameters:value (float) – value for IDD Field Variable Condensing Temperature Minimum for Indoor Unit Raises:ValueError – if value is not a valid value Returns:the value of variable_condensing_temperature_minimum_for_indoor_unit or None if not set Return type:float

variable_evaporating_temperature_maximum_for_indoor_unit

field Variable Evaporating Temperature Maximum for Indoor Unit

This field is used if Refrigerant Temperature Control Algorithm

is VariableTemp

Evaporating temperature is the refrigerant temperature, not air temperature

Units: C

Default value: 13.0

Parameters:value (float) – value for IDD Field Variable Evaporating Temperature Maximum for Indoor Unit Raises:ValueError – if value is not a valid value Returns:the value of variable_evaporating_temperature_maximum_for_indoor_unit or None if not set Return type:float

variable_evaporating_temperature_minimum_for_indoor_unit

field Variable Evaporating Temperature Minimum for Indoor Unit

This field is used if Refrigerant Temperature Control Algorithm

is VariableTemp

Evaporating temperature is the refrigerant temperature, not air temperature

Units: C

Default value: 4.0

Parameters:value (float) – value for IDD Field Variable Evaporating Temperature Minimum for Indoor Unit Raises:ValueError – if value is not a valid value Returns:the value of variable_evaporating_temperature_minimum_for_indoor_unit or None if not set Return type:float

zone_terminal_unit_list_name

field Zone Terminal Unit List Name

Enter the name of a ZoneTerminalUnitList. This list connects zone terminal units to this

heat pump

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

class pyidf.variable_refrigerant_flow_equipment.ZoneTerminalUnitList

Bases: pyidf.helper.DataObject

Corresponds to IDD object ZoneTerminalUnitList List of variable refrigerant flow (VRF) terminal units served by a given VRF condensing unit. See ZoneHVAC:TerminalUnit:VariableRefrigerantFlow and AirConditioner:VariableRefrigerantFlow.

add_extensible(zone_terminal_unit_name_1=None)

Add values for extensible fields

Parameters:zone_terminal_unit_name_1 (str) – value for IDD Field Zone Terminal Unit Name 1 if value is None it will not be checked against the specification and is assumed to be a missing value

extensibles

Get list of all extensibles

zone_terminal_unit_list_name

field Zone Terminal Unit List Name

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