pyidf.refrigeration module

Data objects in group “Refrigeration”

class pyidf.refrigeration.RefrigerationAirChiller

Bases: pyidf.helper.DataObject

Corresponds to IDD object Refrigeration:AirChiller Works in conjunction with a refrigeration chiller set, compressor rack, a refrigeration system, or a refrigeration secondary system to simulate the performance of an air chiller, similar to one found in a refrigerated warehouse. Energy use for fans and heaters is modeled based on inputs for nominal power, schedules, and control type. The air chiller model accounts for the sensible and latent heat exchange with the surrounding environment.

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

average_refrigerant_charge_inventory

field Average Refrigerant Charge Inventory

This value is only used if the Cooling Source Type is DXEvaporator

Units: kg

Parameters:value (float) – value for IDD Field Average Refrigerant Charge Inventory Raises:ValueError – if value is not a valid value Returns:the value of average_refrigerant_charge_inventory or None if not set Return type:float

capacity_correction_curve_name

field Capacity Correction Curve Name

Can also be the name of a “Table:OneIndependentVariable” or a “Table:MultiVariableLookup”

Should be blank for LinearSHR60 correction curve type

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

capacity_correction_curve_type

field Capacity Correction Curve Type

In each case, select the correction curve type that corresponds to the rating type.

default LinearSHR60 unless Capacity Rating Type = CapacityTotalSpecificConditions

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

capacity_rating_type

field Capacity Rating Type

In each case, select the rating option that corresponds to the expected service conditions.

For example, U.S. manufacturers quote a separate Unit Load Factor for wet or frosted coils.

If the evaporating temperature is less than 0C, input the frosted coil value.

Within the European convention, select SC1, 2, 3, 4, or 5 depending upon the expected evaporating temperature.

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

coil_material_correction_factor

field Coil Material Correction Factor

This is the manufacturer’s correction factor for coil material corresponding to rating

Units: dimensionless

Default value: 1.0

Parameters:value (float) – value for IDD Field Coil Material Correction Factor Raises:ValueError – if value is not a valid value Returns:the value of coil_material_correction_factor or None if not set Return type:float

defrost_control_type

field Defrost Control Type

Default value: TimeSchedule

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

defrost_dripdown_schedule_name

field Defrost Drip-Down Schedule Name

The schedule values should be 0 (off) or 1 (on)

The start time for each defrost period in this drip-down schedule should coincide with

the start time for each defrost period in the defrost schedule (previous input

field).The length of each defrost drip-down period must be greater than or equal to the

corresponding defrost period specified in the defrost schedule. This extra time

allows the melted frost to drip from the coil before refrigeration is restarted.

Parameters:value (str) – value for IDD Field Defrost Drip-Down Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of defrost_dripdown_schedule_name or None if not set Return type:str

defrost_power

field Defrost Power

needed for all defrost types except none and offcycle

Units: W

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

defrost_schedule_name

field Defrost Schedule Name

The schedule values should be 0 (off) or 1 (on)

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

defrost_type

field Defrost Type

HotFluid includes either hot gas defrost for a DX system or

Hot Brine defrost if this walk in is cooled by brine from a secondary chiller

Default value: Electric

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

fan_speed_control_type

field Fan Speed Control Type

Default value: Fixed

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

heating_power_schedule_name

field Heating Power Schedule Name

Values will be used to multiply the total heating power

Values in the schedule should be between 0.0 and 1.0

Defaults to always on if schedule name left blank.

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

maximum_temperature_difference_between_inlet_air_and_evaporating_temperature

field Maximum Temperature Difference Between Inlet Air and Evaporating Temperature

The maximum difference between the air entering the refrigeration chiller and the

cooling source temperature in degC used to limit capacity during pull-down.

defaults to 1.3 times the Rated Temperature Difference DT1

Units: deltaC

value <= 25.0

Parameters:value (float) – value for IDD Field Maximum Temperature Difference Between Inlet Air and Evaporating Temperature Raises:ValueError – if value is not a valid value Returns:the value of maximum_temperature_difference_between_inlet_air_and_evaporating_temperature or None if not set Return type:float

minimum_fan_air_flow_ratio

field Minimum Fan Air Flow Ratio

Minimum air flow fraction through fan

Units: dimensionless

Default value: 0.2

Parameters:value (float) – value for IDD Field Minimum Fan Air Flow Ratio Raises:ValueError – if value is not a valid value Returns:the value of minimum_fan_air_flow_ratio 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

field Rated Air Flow

Units: m3/s

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

rated_capacity

field Rated Capacity

This value is only used if the Capacity Rating Type is NOT UnitLoadFactorSensibleOnly.

For CapacityTotalSpecificConditions, this capacity includes both sensible and latent

at the conditions given in the next two fields.

Note that the European Standard ratings are sensible only and

the European Nominal ratings include latent capacity as well.

The value given here must correspond to the capacity rating type given previously

Units: W

Parameters:value (float) – 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

rated_cooling_source_temperature

field Rated Cooling Source Temperature

If DXEvaporator, use evaporating temperature (saturated suction temperature)

If BrineCoil, use Brine entering temperature

used to set minimum suction pressure for DX systems and

minimum brine temp for secondary systems

Units: C

value >= -70.0

value <= 40.0

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

rated_fan_power

field Rated Fan Power

Units: W

Default value: 375.0

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

rated_relative_humidity

field Rated Relative Humidity

This field is ONLY used if the Capacity Rating Type is CapacityTotalSpecificConditions and

represents the relative humidity at rated conditions. The default is 85.

Units: percent

Default value: 85.0

value <= 100.0

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

rated_temperature_difference_dt1

field Rated Temperature Difference DT1

The rated difference between the air entering the refrigeration chiller and the

cooling source temperature in degC.

Units: deltaC

value <= 20.0

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

rated_total_heating_power

field Rated Total Heating Power

Include total for all heater power

Do not include defrost heater power

Units: W

Parameters:value (float) – value for IDD Field Rated Total Heating Power Raises:ValueError – if value is not a valid value Returns:the value of rated_total_heating_power or None if not set Return type:float

rated_unit_load_factor

field Rated Unit Load Factor

The sensible cooling capacity in watts (W/C) at rated conditions.

The value entered for this field must be greater than zero, with no default value.

This value is only used if the Capacity Rating Type is UnitLoadFactorSensibleOnly.

The value given must be based upon the difference between the chiller inlet and

outlet air temperatures, not on the difference between the zone mean temperature

and the outlet air temperature

Units: W/K

Parameters:value (float) – value for IDD Field Rated Unit Load Factor Raises:ValueError – if value is not a valid value Returns:the value of rated_unit_load_factor or None if not set Return type:float

refrigerant_correction_factor

field Refrigerant Correction Factor

This is the manufacturer’s correction factor for refrigerant corresponding to rating

Units: dimensionless

Default value: 1.0

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

shr60_correction_factor

field SHR60 Correction Factor

only used when the capacity correction curve type is LinearSHR60

Units: dimensionless

Default value: 1.48

value <= 1.67

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

temperature_termination_defrost_fraction_to_ice

field Temperature Termination Defrost Fraction to Ice

This is the portion of the defrost energy that is available to melt frost

Needed only for defrost control type TemperatureTermination

defaults to 0.7 for electric defrost and to 0.3 for hot fluid defrost

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Temperature Termination Defrost Fraction to Ice Raises:ValueError – if value is not a valid value Returns:the value of temperature_termination_defrost_fraction_to_ice or None if not set Return type:float

vertical_location

field Vertical Location

Default value: Middle

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

class pyidf.refrigeration.RefrigerationCase

Bases: pyidf.helper.DataObject

Corresponds to IDD object Refrigeration:Case The Refrigeration Case object works in conjunction with a compressor rack, a refrigeration system, or a secondary loop to simulate the performance of a refrigerated case system. The object calculates the energy use for lights, fans and anti-sweat heaters and accounts for the sensible and latent heat exchange with the surrounding environment (termed “case credits”) which impacts the temperature and humidity in the zone where the case is located.

antisweat_heater_control_type

field Anti-Sweat Heater Control Type

Default value: None

Parameters:value (str) – value for IDD Field Anti-Sweat Heater Control Type Raises:ValueError – if value is not a valid value Returns:the value of antisweat_heater_control_type 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

average_refrigerant_charge_inventory

field Average Refrigerant Charge Inventory

Units: kg/m

Parameters:value (float) – value for IDD Field Average Refrigerant Charge Inventory Raises:ValueError – if value is not a valid value Returns:the value of average_refrigerant_charge_inventory or None if not set Return type:float

case_antisweat_heater_power_per_unit_length

field Case Anti-Sweat Heater Power per Unit Length

Units: W/m

Parameters:value (float) – value for IDD Field Case Anti-Sweat Heater Power per Unit Length Raises:ValueError – if value is not a valid value Returns:the value of case_antisweat_heater_power_per_unit_length or None if not set Return type:float

case_credit_fraction_schedule_name

field Case Credit Fraction Schedule Name

Schedule values should be from 0 to 1

Leave this field blank if no case credit fraction is to be applied

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

case_defrost_dripdown_schedule_name

field Case Defrost Drip-Down Schedule Name

If left blank, the defrost schedule will be used

The start time for each defrost period in this drip-down schedule should coincide with

the start time for each defrost period in the case defrost schedule (previous input

field).The length of each defrost drip-down period must be greater than or equal to the

corresponding defrost period specified in the case defrost schedule. This extra time

allows the melted frost to drip from the coil before refrigeration is restarted.

Parameters:value (str) – value for IDD Field Case Defrost Drip-Down Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of case_defrost_dripdown_schedule_name or None if not set Return type:str

case_defrost_power_per_unit_length

field Case Defrost Power per Unit Length

Used to evaluate load on case as well as power or heat consumption

Units: W/m

Parameters:value (float) – value for IDD Field Case Defrost Power per Unit Length Raises:ValueError – if value is not a valid value Returns:the value of case_defrost_power_per_unit_length or None if not set Return type:float

case_defrost_schedule_name

field Case Defrost Schedule Name

A case defrost schedule name is required unless case defrost type = None

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

case_defrost_type

field Case Defrost Type

Default value: OffCycle

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

case_height

field Case Height

This field only applicable to Heat Balance Method AS heater control type

Height must be greater than zero if Heat Balance Method AS heater control is selected

Units: m

Default value: 1.5

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

case_length

field Case Length

Units: m

Default value: 3.0

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

case_lighting_schedule_name

field Case Lighting Schedule Name

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

case_operating_temperature

field Case Operating Temperature

Units: C

Default value: 1.1

value < 20.0

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

defrost_energy_correction_curve_name

field Defrost Energy Correction Curve Name

Defrost Energy Correction Curve Name is applicable to case defrost types

with temperature termination only.

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

defrost_energy_correction_curve_type

field Defrost Energy Correction Curve Type

Case Temperature, Relative Humidity, and Dewpoint Method are applicable to case defrost

types with temperature termination only.

Default value: None

Parameters:value (str) – value for IDD Field Defrost Energy Correction Curve Type Raises:ValueError – if value is not a valid value Returns:the value of defrost_energy_correction_curve_type or None if not set Return type:str

design_evaporator_temperature_or_brine_inlet_temperature

field Design Evaporator Temperature or Brine Inlet Temperature

Required for detailed refrigeration system, not for compressor rack

For a DX system, enter the saturated temperature for refrigerant pressure leaving case

For a brine-cooled cooled (secondary system) case, enter the brine inlet temperature

Default is 5 C less than case operating temperature

Units: C

value >= -70.0

value <= 40.0

Parameters:value (float) – value for IDD Field Design Evaporator Temperature or Brine Inlet Temperature Raises:ValueError – if value is not a valid value Returns:the value of design_evaporator_temperature_or_brine_inlet_temperature or None if not set Return type:float

fraction_of_antisweat_heater_energy_to_case

field Fraction of Anti-Sweat Heater Energy to Case

Default value: 1.0

value <= 1.0

Parameters:value (float) – value for IDD Field Fraction of Anti-Sweat Heater Energy to Case Raises:ValueError – if value is not a valid value Returns:the value of fraction_of_antisweat_heater_energy_to_case or None if not set Return type:float

fraction_of_lighting_energy_to_case

field Fraction of Lighting Energy to Case

Default value: 1.0

value <= 1.0

Parameters:value (float) – value for IDD Field Fraction of Lighting Energy to Case Raises:ValueError – if value is not a valid value Returns:the value of fraction_of_lighting_energy_to_case or None if not set Return type:float

humidity_at_zero_antisweat_heater_energy

field Humidity at Zero Anti-Sweat Heater Energy

This field is only applicable to Linear AS heater control type

Zone relative humidity (%) where anti-sweat heater energy is zero

Units: percent

Default value: -10.0

Parameters:value (float) – value for IDD Field Humidity at Zero Anti-Sweat Heater Energy Raises:ValueError – if value is not a valid value Returns:the value of humidity_at_zero_antisweat_heater_energy or None if not set Return type:float

installed_case_lighting_power_per_unit_length

field Installed Case Lighting Power per Unit Length

default set equal to Standard Case Lighting Power per Unit Length

Units: W/m

Parameters:value (float) – value for IDD Field Installed Case Lighting Power per Unit Length Raises:ValueError – if value is not a valid value Returns:the value of installed_case_lighting_power_per_unit_length or None if not set Return type:float

latent_case_credit_curve_name

field Latent Case Credit Curve Name

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

latent_case_credit_curve_type

field Latent Case Credit Curve Type

Default value: CaseTemperatureMethod

Parameters:value (str) – value for IDD Field Latent Case Credit Curve Type Raises:ValueError – if value is not a valid value Returns:the value of latent_case_credit_curve_type or None if not set Return type:str

minimum_antisweat_heater_power_per_unit_length

field Minimum Anti-Sweat Heater Power per Unit Length

This field is only applicable to the Linear, Dewpoint Method, and

Heat Balance Method anti-sweat heater control types

Units: W/m

Parameters:value (float) – value for IDD Field Minimum Anti-Sweat Heater Power per Unit Length Raises:ValueError – if value is not a valid value Returns:the value of minimum_antisweat_heater_power_per_unit_length 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

operating_case_fan_power_per_unit_length

field Operating Case Fan Power per Unit Length

Units: W/m

Default value: 75.0

Parameters:value (float) – value for IDD Field Operating Case Fan Power per Unit Length Raises:ValueError – if value is not a valid value Returns:the value of operating_case_fan_power_per_unit_length or None if not set Return type:float

rated_ambient_relative_humidity

field Rated Ambient Relative Humidity

Units: percent

Default value: 55.0

value < 100.0

Parameters:value (float) – value for IDD Field Rated Ambient Relative Humidity Raises:ValueError – if value is not a valid value Returns:the value of rated_ambient_relative_humidity or None if not set Return type:float

rated_ambient_temperature

field Rated Ambient Temperature

Units: C

Default value: 23.9

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

rated_latent_heat_ratio

field Rated Latent Heat Ratio

Default value: 0.3

value <= 1.0

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

rated_runtime_fraction

field Rated Runtime Fraction

Default value: 0.85

value <= 1.0

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

rated_total_cooling_capacity_per_unit_length

field Rated Total Cooling Capacity per Unit Length

Units: W/m

Default value: 1900.0

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

refrigerated_case_restocking_schedule_name

field Refrigerated Case Restocking Schedule Name

Schedule values should be in units of Watts per unit case length (W/m)

Leave this field blank if no restocking is to be modeled

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

standard_case_fan_power_per_unit_length

field Standard Case Fan Power per Unit Length

Units: W/m

Default value: 75.0

Parameters:value (float) – value for IDD Field Standard Case Fan Power per Unit Length Raises:ValueError – if value is not a valid value Returns:the value of standard_case_fan_power_per_unit_length or None if not set Return type:float

standard_case_lighting_power_per_unit_length

field Standard Case Lighting Power per Unit Length

Units: W/m

Default value: 90.0

Parameters:value (float) – value for IDD Field Standard Case Lighting Power per Unit Length Raises:ValueError – if value is not a valid value Returns:the value of standard_case_lighting_power_per_unit_length or None if not set Return type:float

under_case_hvac_return_air_fraction

field Under Case HVAC Return Air Fraction

value <= 1.0

Parameters:value (float) – value for IDD Field Under Case HVAC Return Air Fraction Raises:ValueError – if value is not a valid value Returns:the value of under_case_hvac_return_air_fraction or None if not set Return type:float

zone_name

field Zone Name

This must be a controlled zone and appear in a ZoneHVAC:EquipmentConnections object.

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

class pyidf.refrigeration.RefrigerationCaseAndWalkInList

Bases: pyidf.helper.DataObject

Corresponds to IDD object Refrigeration:CaseAndWalkInList Provides a list of all the refrigerated cases, walk in coolers, or air chillers cooled by a single refrigeration system. Note that the names of all cases, walk-ins ,air chillers, and CaseAndWalkInLists must be unique. That is, you cannot give a list the same name as one of list items. This list may contain a combination of case and walk-in names OR a list of air chiller names. Air chillers may not be included in any list that also includes cases or walk-ins.

add_extensible(case_or_walkin_1_name=None)

Add values for extensible fields

Parameters:case_or_walkin_1_name (str) – value for IDD Field Case or WalkIn 1 Name if value is None it will not be checked against the specification and is assumed to be a missing value

extensibles

Get list of all extensibles

name

field Name

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

class pyidf.refrigeration.RefrigerationCompressor

Bases: pyidf.helper.DataObject

Corresponds to IDD object Refrigeration:Compressor Refrigeration system compressor. Data is available for many compressors in the RefrigerationCompressor.idf dataset

enduse_subcategory

field End-Use Subcategory

Default value: General

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

mode_of_operation

field Mode of Operation

Default value: Subcritical

Parameters:value (str) – value for IDD Field Mode of Operation Raises:ValueError – if value is not a valid value Returns:the value of mode_of_operation 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_liquid_temperature

field Rated Liquid Temperature

Use this input field OR the next, not both

This is used if the compressor rating is based upon

rated liquid temperature at the expansion valve

Units: C

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

rated_return_gas_temperature

field Rated Return Gas Temperature

Use this input field OR the previous, not both

This is used if the compressor rating is based upon

rated return gas temperature (Rated Suction Temperature)

Units: C

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

rated_subcooling

field Rated Subcooling

Use this input field OR the previous, not both

This is used if the compressor rating is based upon

degrees of subcooling

Units: deltaC

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

rated_superheat

field Rated Superheat

Use this input field OR the next, not both

This is used if the compressor rating is based upon

degrees of superheat

Units: deltaC

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

refrigeration_compressor_capacity_curve_name

field Refrigeration Compressor Capacity Curve Name

the input order for the Curve:Bicubic does not

match the ARI 540-2004 Eq. 1 coefficient order

N1 is ARI_C1, N2 is ARI_C2, N3 is ARI_C4, N4 is ARI_C3,

N5 is ARI_C6, N6 is ARI_C5, N7 is ARI_C7, N8 is ARI_C10,

N9 is ARI_C8, N10 is ARI_C9,

N11 is Minimum Suction dewpoint temperature,

N12 is Maximum Suction dewpoint temperature,

N13 is Minimum Discharge dewpoint temperature,

N14 is Maximum Discharge dewpoint temperature

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

refrigeration_compressor_power_curve_name

field Refrigeration Compressor Power Curve Name

the input order for the Curve:Bicubic does not

match the ARI 540-2004 Eq. 1 coefficient order

N1 is ARI_C1, N2 is ARI_C2, N3 is ARI_C4, N4 is ARI_C3,

N5 is ARI_C6, N6 is ARI_C5, N7 is ARI_C7, N8 is ARI_C10,

N9 is ARI_C8, N10 is ARI_C9,

N11 is Minimum Suction dewpoint temperature,

N12 is Maximum Suction dewpoint temperature,

N13 is Minimum Discharge dewpoint temperature,

N14 is Maximum Discharge dewpoint temperature

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

transcritical_compressor_capacity_curve_name

field Transcritical Compressor Capacity Curve Name

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

transcritical_compressor_power_curve_name

field Transcritical Compressor Power Curve Name

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

class pyidf.refrigeration.RefrigerationCompressorList

Bases: pyidf.helper.DataObject

Corresponds to IDD object Refrigeration:CompressorList List of all the compressors included within a single refrigeration system (Refrigeration:System). Each list must contain at least one compressor. The order in which the individual compressors are listed here will be the order in which the compressors are dispatched to meet the system load. IMPORTANT: List compressor names in the order in which the compressors will be loaded Data is available for many compressors in the RefrigerationCompressor.idf dataset

add_extensible(refrigeration_compressor_1_name=None)

Add values for extensible fields

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

extensibles

Get list of all extensibles

name

field Name

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

class pyidf.refrigeration.RefrigerationCompressorRack

Bases: pyidf.helper.DataObject

Corresponds to IDD object Refrigeration:CompressorRack Works in conjunction with the refrigeration case and walk-in objects to simulate the performance of a refrigerated case system. This object models the electric consumption of the rack compressors and the condenser fans. Heat can be rejected either outdoors or to a zone. Compressor rack waste heat can also be reclaimed for use by an optional air- or water-heating coil (Coil:Heating:Desuperheater and Coil:WaterHeating:Desuperheater).

basin_heater_capacity

field Basin Heater Capacity

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

when the evaporatively cooled condenser is available (field Evaporative Condenser Availability

Schedule Name). For this situation, the heater heats the basin water when the

outdoor air dry-bulb temperature falls below the setpoint temperature, but

only when the condenser fans are off (i.e., no refrigerated case load).

Units: W/K

Default value: 200.0

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

Enter the outdoor dry-bulb temperature at which 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

compressor_rack_cop_function_of_temperature_curve_name

field Compressor Rack COP Function of Temperature Curve Name

It is important that this COP curve correspond to the lowest saturated suction

temperature needed to serve all refrigeration loads

Parameters:value (str) – value for IDD Field Compressor Rack COP Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of compressor_rack_cop_function_of_temperature_curve_name or None if not set Return type:str

condenser_air_inlet_node_name

field Condenser Air Inlet Node Name

Applicable only when Heat Rejection Location is Outdoors and Condenser Type is

not WaterCooled; otherwise, leave field blank. If field is left blank with

Heat Rejection Location = Outdoors, then the model assumes that the Inlet Air

conditions are the outdoor air conditions for the current timestep

(e.g., no adjustment for height above ground).

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_fan_power_function_of_temperature_curve_name

field Condenser Fan Power Function of Temperature Curve Name

Parameters:value (str) – value for IDD Field Condenser Fan Power Function of Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of condenser_fan_power_function_of_temperature_curve_name or None if not set Return type:str

condenser_type

field Condenser Type

Applicable only when Heat Rejection Location is Outdoors.

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

design_compressor_rack_cop

field Design Compressor Rack COP

It is important that this COP correspond to the lowest saturated suction

temperature needed to serve all refrigeration loads

Units: W/W

Default value: 2.0

Parameters:value (float) – value for IDD Field Design Compressor Rack COP Raises:ValueError – if value is not a valid value Returns:the value of design_compressor_rack_cop or None if not set Return type:float

design_condenser_fan_power

field Design Condenser Fan Power

Design power for condenser fan(s).

Units: W

Default value: 250.0

Parameters:value (float) – value for IDD Field Design Condenser Fan Power Raises:ValueError – if value is not a valid value Returns:the value of design_condenser_fan_power or None if not set Return type:float

design_evaporative_condenser_water_pump_power

field Design Evaporative Condenser Water Pump Power

Design recirc water pump power for Condenser Type = EvaporativelyCooled.

Applicable only for Condenser Type = EvaporativelyCooled.

Units: W

Default value: 1000.0

Parameters:value (float or “Autocalculate”) – value for IDD Field Design Evaporative Condenser Water Pump Power Raises:ValueError – if value is not a valid value Returns:the value of design_evaporative_condenser_water_pump_power or None if not set Return type:float or “Autocalculate”

enduse_subcategory

field End-Use Subcategory

Default value: General

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

evaporative_condenser_air_flow_rate

field Evaporative Condenser Air Flow Rate

Applicable only for Condenser Type = EvaporativelyCooled.

Used to calculate evaporative condenser water use.

Units: m3/s

Default value: “Autocalculate”

Parameters:value (float or “Autocalculate”) – 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 “Autocalculate”

evaporative_condenser_availability_schedule_name

field Evaporative Condenser Availability Schedule Name

This field is only used for Condenser Type = EvaporativelyCooled.

Schedule values greater than 0 indicate that evaporative cooling of the

condenser is available. This schedule allows the user to define seasonal

shutdown/draining of the water cooling system in cold climate applications.

For periods with schedule values of 0, the condenser operates as AirCooled.

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

evaporative_condenser_effectiveness

field Evaporative Condenser Effectiveness

Applicable only for Condenser Type = EvaporativlyCooled.

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_water_supply_tank_name

field Evaporative Water Supply Tank Name

If blank, water supply is from Mains.

Applicable only for Condenser Type = EvaporativelyCooled.

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

heat_rejection_location

field Heat Rejection Location

Default value: Outdoors

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

heat_rejection_zone_name

field Heat Rejection Zone Name

This must be a controlled zone and appear in a ZoneHVAC:EquipmentConnections object.

Required only if walk-in[s] are connected to this rack

AND the heat rejection location is “Zone”

Parameters:value (str) – value for IDD Field Heat Rejection Zone Name Raises:ValueError – if value is not a valid value Returns:the value of heat_rejection_zone_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

refrigeration_case_name_or_walkin_name_or_caseandwalkinlist_name

field Refrigeration Case Name or WalkIn Name or CaseAndWalkInList Name

Enter the name of a Refrigeration:Case or Refrigeration:Walkin or

Refrigeration:CaseAndWalkinList object.

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

watercooled_condenser_design_flow_rate

field Water-Cooled Condenser Design Flow Rate

Applicable only when loop flow type is ConstantFlow.

Units: m3/s

Parameters:value (float) – value for IDD Field Water-Cooled Condenser Design Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of watercooled_condenser_design_flow_rate or None if not set Return type:float

watercooled_condenser_inlet_node_name

field Water-Cooled Condenser Inlet Node Name

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

watercooled_condenser_maximum_flow_rate

field Water-Cooled Condenser Maximum Flow Rate

Units: m3/s

Parameters:value (float) – value for IDD Field Water-Cooled Condenser Maximum Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of watercooled_condenser_maximum_flow_rate or None if not set Return type:float

watercooled_condenser_maximum_water_outlet_temperature

field Water-Cooled Condenser Maximum Water Outlet Temperature

Units: C

Default value: 55.0

value >= 10.0

value <= 60.0

Parameters:value (float) – value for IDD Field Water-Cooled Condenser Maximum Water Outlet Temperature Raises:ValueError – if value is not a valid value Returns:the value of watercooled_condenser_maximum_water_outlet_temperature or None if not set Return type:float

watercooled_condenser_minimum_water_inlet_temperature

field Water-Cooled Condenser Minimum Water Inlet Temperature

Units: C

Default value: 10.0

value >= 10.0

value <= 30.0

Parameters:value (float) – value for IDD Field Water-Cooled Condenser Minimum Water Inlet Temperature Raises:ValueError – if value is not a valid value Returns:the value of watercooled_condenser_minimum_water_inlet_temperature or None if not set Return type:float

watercooled_condenser_outlet_node_name

field Water-Cooled Condenser Outlet Node Name

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

watercooled_condenser_outlet_temperature_schedule_name

field Water-Cooled Condenser Outlet Temperature Schedule Name

Applicable only when loop Flow type is VariableFlow.

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

watercooled_loop_flow_type

field Water-Cooled Loop Flow Type

Applicable only when Condenser Type is WaterCooled.

Default value: VariableFlow

Parameters:value (str) – value for IDD Field Water-Cooled Loop Flow Type Raises:ValueError – if value is not a valid value Returns:the value of watercooled_loop_flow_type or None if not set Return type:str

class pyidf.refrigeration.RefrigerationCondenserAirCooled

Bases: pyidf.helper.DataObject

Corresponds to IDD object Refrigeration:Condenser:AirCooled Air cooled condenser for a refrigeration system (Refrigeration:System).

air_inlet_node_name_or_zone_name

field Air Inlet Node Name or Zone Name

If field is left blank,

then the model assumes that the inlet air

conditions are the outdoor air conditions for the current timestep

(e.g., no adjustment for height above ground).

If the condenser rejects heat to a conditioned zone, enter the zone name here.

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

condensate_piping_refrigerant_inventory

field Condensate Piping Refrigerant Inventory

optional input

Units: kg

Parameters:value (float) – value for IDD Field Condensate Piping Refrigerant Inventory Raises:ValueError – if value is not a valid value Returns:the value of condensate_piping_refrigerant_inventory or None if not set Return type:float

condensate_receiver_refrigerant_inventory

field Condensate Receiver Refrigerant Inventory

optional input

Units: kg

Parameters:value (float) – value for IDD Field Condensate Receiver Refrigerant Inventory Raises:ValueError – if value is not a valid value Returns:the value of condensate_receiver_refrigerant_inventory or None if not set Return type:float

condenser_fan_speed_control_type

field Condenser Fan Speed Control Type

Default value: Fixed

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

condenser_refrigerant_operating_charge_inventory

field Condenser Refrigerant Operating Charge Inventory

optional input

Units: kg

Parameters:value (float) – value for IDD Field Condenser Refrigerant Operating Charge Inventory Raises:ValueError – if value is not a valid value Returns:the value of condenser_refrigerant_operating_charge_inventory or None if not set Return type:float

enduse_subcategory

field End-Use Subcategory

Default value: General

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

minimum_fan_air_flow_ratio

field Minimum Fan Air Flow Ratio

Minimum air flow fraction through condenser fan

Units: dimensionless

Default value: 0.2

Parameters:value (float) – value for IDD Field Minimum Fan Air Flow Ratio Raises:ValueError – if value is not a valid value Returns:the value of minimum_fan_air_flow_ratio 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_effective_total_heat_rejection_rate_curve_name

field Rated Effective Total Heat Rejection Rate Curve Name

Rating as per ARI 460

Be sure the rating corresponds to the correct refrigerant

HeatRejection(W)=C1 +C2(Condensing Temp - Entering Air Temp, deg C)

Will be adjusted for elevation automatically

Parameters:value (str) – value for IDD Field Rated Effective Total Heat Rejection Rate Curve Name Raises:ValueError – if value is not a valid value Returns:the value of rated_effective_total_heat_rejection_rate_curve_name or None if not set Return type:str

rated_fan_power

field Rated Fan Power

Power for condenser fan(s) corresponding to rated total heat rejection effect.

Units: W

Default value: 250.0

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

rated_subcooling_temperature_difference

field Rated Subcooling Temperature Difference

must correspond to rating given for total heat rejection effect

Units: deltaC

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

class pyidf.refrigeration.RefrigerationCondenserCascade

Bases: pyidf.helper.DataObject

Corresponds to IDD object Refrigeration:Condenser:Cascade Cascade condenser for a refrigeration system (Refrigeration:System). The cascade condenser is unlike the other condenser options because it rejects heat to another, higher-temperature, refrigeration system. That is, the cascade condenser acts as a heat rejection object for one system, but acts as a refrigeration load for another system.

condensate_piping_refrigerant_inventory

field Condensate Piping Refrigerant Inventory

optional input

Units: kg

Parameters:value (float) – value for IDD Field Condensate Piping Refrigerant Inventory Raises:ValueError – if value is not a valid value Returns:the value of condensate_piping_refrigerant_inventory or None if not set Return type:float

condensate_receiver_refrigerant_inventory

field Condensate Receiver Refrigerant Inventory

optional input

Units: kg

Parameters:value (float) – value for IDD Field Condensate Receiver Refrigerant Inventory Raises:ValueError – if value is not a valid value Returns:the value of condensate_receiver_refrigerant_inventory or None if not set Return type:float

condenser_refrigerant_operating_charge_inventory

field Condenser Refrigerant Operating Charge Inventory

optional input

Units: kg

Parameters:value (float) – value for IDD Field Condenser Refrigerant Operating Charge Inventory Raises:ValueError – if value is not a valid value Returns:the value of condenser_refrigerant_operating_charge_inventory or None if not set Return type:float

condensing_temperature_control_type

field Condensing Temperature Control Type

Fixed keeps condensing temperature constant

Float sets the condensing temperature according to

the other loads on the higher temperature system

Default value: Fixed

Parameters:value (str) – value for IDD Field Condensing Temperature Control Type Raises:ValueError – if value is not a valid value Returns:the value of condensing_temperature_control_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

rated_approach_temperature_difference

field Rated Approach Temperature Difference

This is the difference between the condensing and evaporating temperatures

Units: deltaC

Default value: 3.0

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

rated_condensing_temperature

field Rated Condensing Temperature

This is the condensing temperature for the lower temperature secondary loop

Units: C

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

rated_effective_total_heat_rejection_rate

field Rated Effective Total Heat Rejection Rate

used for identification and rough system size error checking

Units: W

Parameters:value (float) – value for IDD Field Rated Effective Total Heat Rejection Rate Raises:ValueError – if value is not a valid value Returns:the value of rated_effective_total_heat_rejection_rate or None if not set Return type:float

class pyidf.refrigeration.RefrigerationCondenserEvaporativeCooled

Bases: pyidf.helper.DataObject

Corresponds to IDD object Refrigeration:Condenser:EvaporativeCooled Evaporative-cooled condenser for a refrigeration system (Refrigeration:System).

air_inlet_node_name

field Air Inlet Node Name

If field is left blank,

then the model assumes that the inlet air

conditions are the outdoor air conditions for the current timestep

(e.g., no adjustment for height above ground).

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

approach_temperature_coefficient_2

field Approach Temperature Coefficient 2

A2 in delta T = A1 + A2(hrcf) +A3/(hrcf) +A4(Twb)

Units: C

Default value: 0.468

value <= 20.0

Parameters:value (float) – value for IDD Field Approach Temperature Coefficient 2 Raises:ValueError – if value is not a valid value Returns:the value of approach_temperature_coefficient_2 or None if not set Return type:float

approach_temperature_coefficient_3

field Approach Temperature Coefficient 3

A3 in delta T = A1 + A2(hrcf) +A3/(hrcf) +A4(Twb)

Units: C

Default value: 17.93

value <= 30.0

Parameters:value (float) – value for IDD Field Approach Temperature Coefficient 3 Raises:ValueError – if value is not a valid value Returns:the value of approach_temperature_coefficient_3 or None if not set Return type:float

approach_temperature_coefficient_4

field Approach Temperature Coefficient 4

A4 in deltaT=A1 + A2(hrcf) +A3/(hrcf) +A4(Twb)

Units: dimensionless

Default value: -0.322

value >= -20.0

value <= 20.0

Parameters:value (float) – value for IDD Field Approach Temperature Coefficient 4 Raises:ValueError – if value is not a valid value Returns:the value of approach_temperature_coefficient_4 or None if not set Return type:float

approach_temperature_constant_term

field Approach Temperature Constant Term

A1 in delta T = A1 + A2(hrcf) + A3/(hrcf) + A4(Twb)

Units: C

Default value: 6.63

value <= 20.0

Parameters:value (float) – value for IDD Field Approach Temperature Constant Term Raises:ValueError – if value is not a valid value Returns:the value of approach_temperature_constant_term or None if not set Return type:float

basin_heater_capacity

field Basin Heater Capacity

This field is only used for periods

when the evap condenser is available (field Evaporative Condenser Availability

Schedule). For this situation, the heater heats the basin water when the

outdoor air dry-bulb temperature falls below the set point temperature, but

only when the condenser fans are off (i.e., no refrigerated case load).

Units: W/K

Default value: 200.0

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

Enter the outdoor dry-bulb temperature at which 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_piping_refrigerant_inventory

field Condensate Piping Refrigerant Inventory

optional input

Units: kg

Parameters:value (float) – value for IDD Field Condensate Piping Refrigerant Inventory Raises:ValueError – if value is not a valid value Returns:the value of condensate_piping_refrigerant_inventory or None if not set Return type:float

condensate_receiver_refrigerant_inventory

field Condensate Receiver Refrigerant Inventory

optional input

Units: kg

Parameters:value (float) – value for IDD Field Condensate Receiver Refrigerant Inventory Raises:ValueError – if value is not a valid value Returns:the value of condensate_receiver_refrigerant_inventory or None if not set Return type:float

condenser_refrigerant_operating_charge_inventory

field Condenser Refrigerant Operating Charge Inventory

optional input

Units: kg

Parameters:value (float) – value for IDD Field Condenser Refrigerant Operating Charge Inventory Raises:ValueError – if value is not a valid value Returns:the value of condenser_refrigerant_operating_charge_inventory or None if not set Return type:float

enduse_subcategory

field End-Use Subcategory

Default value: General

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

evaporative_condenser_availability_schedule_name

field Evaporative Condenser Availability Schedule Name

Schedule values greater than 0 indicate that evaporative cooling of the

condenser is available. This schedule allows the user to define seasonal

shutdown/draining of the water cooling system in cold climate applications.

For periods with schedule values of 0, the condenser operates as Air Cooled.

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

evaporative_water_supply_tank_name

field Evaporative Water Supply Tank Name

If blank, water supply is from Mains.

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

fan_speed_control_type

field Fan Speed Control Type

Default value: Fixed

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

maximum_capacity_factor

field Maximum Capacity Factor

taken from manufacturer’s Heat Rejection Capacity Factor Table

Units: dimensionless

Default value: 5.0

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

minimum_capacity_factor

field Minimum Capacity Factor

taken from manufacturer’s Heat Rejection Capacity Factor Table

Units: dimensionless

Default value: 0.5

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

minimum_fan_air_flow_ratio

field Minimum Fan Air Flow Ratio

Minimum air flow fraction through condenser fan

Units: dimensionless

Default value: 0.2

Parameters:value (float) – value for IDD Field Minimum Fan Air Flow Ratio Raises:ValueError – if value is not a valid value Returns:the value of minimum_fan_air_flow_ratio 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

Used to calculate evaporative condenser water use and fan energy use.

Units: m3/s

Default value: “autocalculate”

Parameters:value (float or “Autocalculate”) – 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 “Autocalculate”

rated_effective_total_heat_rejection_rate

field Rated Effective Total Heat Rejection Rate

Rating as per ARI 490

Be sure the rating corresponds to the correct refrigerant

Units: W

Parameters:value (float) – value for IDD Field Rated Effective Total Heat Rejection Rate Raises:ValueError – if value is not a valid value Returns:the value of rated_effective_total_heat_rejection_rate or None if not set Return type:float

rated_fan_power

field Rated Fan Power

Power for condenser fan(s) corresponding to rated total heat rejection effect.

Units: W

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

rated_subcooling_temperature_difference

field Rated Subcooling Temperature Difference

must correspond to rating given for total heat rejection effect

Units: deltaC

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

rated_water_pump_power

field Rated Water Pump Power

Design recirculating water pump power.

Units: W

Default value: 1000.0

Parameters:value (float or “Autocalculate”) – value for IDD Field Rated Water Pump Power Raises:ValueError – if value is not a valid value Returns:the value of rated_water_pump_power or None if not set Return type:float or “Autocalculate”

class pyidf.refrigeration.RefrigerationCondenserWaterCooled

Bases: pyidf.helper.DataObject

Corresponds to IDD object Refrigeration:Condenser:WaterCooled Water cooled condenser for a refrigeration system (Refrigeration:System).

condensate_piping_refrigerant_inventory

field Condensate Piping Refrigerant Inventory

optional input

Units: kg

Parameters:value (float) – value for IDD Field Condensate Piping Refrigerant Inventory Raises:ValueError – if value is not a valid value Returns:the value of condensate_piping_refrigerant_inventory or None if not set Return type:float

condensate_receiver_refrigerant_inventory

field Condensate Receiver Refrigerant Inventory

optional input

Units: kg

Parameters:value (float) – value for IDD Field Condensate Receiver Refrigerant Inventory Raises:ValueError – if value is not a valid value Returns:the value of condensate_receiver_refrigerant_inventory or None if not set Return type:float

condenser_refrigerant_operating_charge_inventory

field Condenser Refrigerant Operating Charge Inventory

optional input

Units: kg

Parameters:value (float) – value for IDD Field Condenser Refrigerant Operating Charge Inventory Raises:ValueError – if value is not a valid value Returns:the value of condenser_refrigerant_operating_charge_inventory or None if not set Return type:float

enduse_subcategory

field End-Use Subcategory

Default value: General

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

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_condensing_temperature

field Rated Condensing Temperature

must correspond to rating given for total heat rejection effect

Units: C

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

rated_effective_total_heat_rejection_rate

field Rated Effective Total Heat Rejection Rate

Rating as per ARI 450

Be sure the rating corresponds to the correct refrigerant

not used in calculations, only for identification and output

Units: W

Parameters:value (float) – value for IDD Field Rated Effective Total Heat Rejection Rate Raises:ValueError – if value is not a valid value Returns:the value of rated_effective_total_heat_rejection_rate or None if not set Return type:float

rated_subcooling_temperature_difference

field Rated Subcooling Temperature Difference

must correspond to rating given for total heat rejection effect

Units: deltaC

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

rated_water_inlet_temperature

field Rated Water Inlet Temperature

must correspond to rating given for total heat rejection effect

Units: C

Parameters:value (float) – value for IDD Field Rated Water Inlet Temperature Raises:ValueError – if value is not a valid value Returns:the value of rated_water_inlet_temperature or None if not set Return type:float

water_design_flow_rate

field Water Design Flow Rate

note required units must be converted from L/s as specified in ARI 450-2007

Applicable only when loop flow type is Constant Flow.

Units: m3/s

Parameters:value (float) – value for IDD Field Water Design Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of water_design_flow_rate 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_maximum_flow_rate

field Water Maximum Flow Rate

Units: m3/s

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

water_maximum_water_outlet_temperature

field Water Maximum Water Outlet Temperature

Units: C

Default value: 55.0

value >= 10.0

value <= 60.0

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

water_minimum_water_inlet_temperature

field Water Minimum Water Inlet Temperature

related to the minimum allowed refrigeration system condensing temperature

Units: C

Default value: 10.0

value >= 10.0

value <= 30.0

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

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

water_outlet_temperature_schedule_name

field Water Outlet Temperature Schedule Name

Applicable only when loop flow type is Variable Flow.

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

watercooled_loop_flow_type

field Water-Cooled Loop Flow Type

Default value: VariableFlow

Parameters:value (str) – value for IDD Field Water-Cooled Loop Flow Type Raises:ValueError – if value is not a valid value Returns:the value of watercooled_loop_flow_type or None if not set Return type:str

class pyidf.refrigeration.RefrigerationGasCoolerAirCooled

Bases: pyidf.helper.DataObject

Corresponds to IDD object Refrigeration:GasCooler:AirCooled The transcritical refrigeration system requires a single gas cooler to reject the system heat.

air_inlet_node_name

field Air Inlet Node Name

If field is left blank,

then the model assumes that the inlet air

conditions are the outdoor air conditions for the current timestep

(e.g., no adjustment for height above ground).

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

enduse_subcategory

field End-Use Subcategory

Default value: General

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

gas_cooler_fan_speed_control_type

field Gas Cooler Fan Speed Control Type

Default value: Fixed

Parameters:value (str) – value for IDD Field Gas Cooler Fan Speed Control Type Raises:ValueError – if value is not a valid value Returns:the value of gas_cooler_fan_speed_control_type or None if not set Return type:str

gas_cooler_outlet_piping_refrigerant_inventory

field Gas Cooler Outlet Piping Refrigerant Inventory

optional input

Units: kg

Parameters:value (float) – value for IDD Field Gas Cooler Outlet Piping Refrigerant Inventory Raises:ValueError – if value is not a valid value Returns:the value of gas_cooler_outlet_piping_refrigerant_inventory or None if not set Return type:float

gas_cooler_receiver_refrigerant_inventory

field Gas Cooler Receiver Refrigerant Inventory

optional input

Units: kg

Parameters:value (float) – value for IDD Field Gas Cooler Receiver Refrigerant Inventory Raises:ValueError – if value is not a valid value Returns:the value of gas_cooler_receiver_refrigerant_inventory or None if not set Return type:float

gas_cooler_refrigerant_operating_charge_inventory

field Gas Cooler Refrigerant Operating Charge Inventory

optional input

Units: kg

Parameters:value (float) – value for IDD Field Gas Cooler Refrigerant Operating Charge Inventory Raises:ValueError – if value is not a valid value Returns:the value of gas_cooler_refrigerant_operating_charge_inventory or None if not set Return type:float

minimum_condensing_temperature

field Minimum Condensing Temperature

Minimum saturated condensing temperature during subcritical operation.

Units: C

Default value: 10.0

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

minimum_fan_air_flow_ratio

field Minimum Fan Air Flow Ratio

Minimum air flow fraction through gas cooler fan

Units: dimensionless

Default value: 0.2

Parameters:value (float) – value for IDD Field Minimum Fan Air Flow Ratio Raises:ValueError – if value is not a valid value Returns:the value of minimum_fan_air_flow_ratio 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_fan_power

field Rated Fan Power

Power for gas cooler fan(s) corresponding to rated total heat rejection effect.

Units: W

Default value: 5000.0

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

rated_total_heat_rejection_rate_curve_name

field Rated Total Heat Rejection Rate Curve Name

Be sure the rating corresponds to the correct refrigerant (R744)

HeatRejection(W)=C1 +C2(Gas Cooler Outlet Temp - Entering Air Temp, deg C)

Will be adjusted for elevation automatically

Parameters:value (str) – value for IDD Field Rated Total Heat Rejection Rate Curve Name Raises:ValueError – if value is not a valid value Returns:the value of rated_total_heat_rejection_rate_curve_name or None if not set Return type:str

subcritical_temperature_difference

field Subcritical Temperature Difference

Temperature difference between the saturated condensing temperature and the air

temperature during subcritical operation.

Units: deltaC

Default value: 10.0

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

transcritical_approach_temperature

field Transcritical Approach Temperature

Temperature difference between the CO2 exiting the gas cooler and the air entering the

gas cooler during transcritical operation.

Units: deltaC

Default value: 3.0

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

transition_temperature

field Transition Temperature

Temperature at which system transitions between subcritical and transcritical operation.

Units: C

Default value: 27.0

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

class pyidf.refrigeration.RefrigerationSecondarySystem

Bases: pyidf.helper.DataObject

Corresponds to IDD object Refrigeration:SecondarySystem Works in conjunction with refrigerated cases and walkins to simulate the performance of a secondary loop supermarket refrigeration system. Heat from the refrigeration loads served by the secondary loop is absorbed by a primary refrigeration system (Refrigeration:System). The SecondarySystem object simulates a heat exchanger that is an evaporator, or refrigeration load, on the primary refrigeration system.

circulating_fluid_name

field Circulating Fluid Name

This must correspond to a name in the FluidProperties:Name object.

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

circulating_fluid_type

field Circulating Fluid Type

If “FluidAlwaysLiquid” is selected, the fluid properties

must be input using the objects: FluidProperties:Name,

FluidProperties:GlycolConcentration, and, if user defined fluid type,

FluidProperties:Temperatures and FluidProperties:Concentration.

Many sets of fluid properties can be found in GlycolPropertiesRefData.idf.

If “FluidPhaseChange” is selected, the refrigerant properties

must be input using the objects: (if user defined fluid type): FluidProperties:Name,

FluidProperties:Temperatures, FluidProperties:Saturated, and

FluidProperties:Superheated.

Many sets of refrigerant data can be found in FluidPropertiesRefData.idf.

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

distribution_piping_zone_name

field Distribution Piping Zone Name

This will be used to determine the temperature used for distribution piping heat gain.

The pipe heat gains are also counted as cooling credit for the zone.

Required only if Sum UA Distribution Piping >0.0

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

enduse_subcategory

field End-Use Subcategory

Default value: General

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

evaporator_approach_temperature_difference

field Evaporator Approach Temperature Difference

For “FluidAlwaysLiquid”, this is the rated difference between the temperature of the

circulating fluid leaving the heat exchanger

and the heat exchanger’s rated evaporating temperature.

For “FluidPhaseChange”, this is the difference between the temperature of the

evaporating and condensing temperatures in the heat exchanger.

Units: deltaC

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

evaporator_capacity

field Evaporator Capacity

For “FluidAlwaysLiquid”, at least one of the two, Evaporator Capacity OR

Evaporator Flow Rate for Secondary Fluid, is required.

For “FluidPhaseChange”, the default capacity is the sum of the rated capacities of the

Cases and Walk-ins served by the secondary loop.

Units: W

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

evaporator_evaporating_temperature

field Evaporator Evaporating Temperature

This is the evaporating temperature in the heat exchanger

used to chill or condense the secondary loop circulating fluid.

It is NOT the temperature in any cases or walk-ins served by the

secondary loop.

Units: C

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

evaporator_flow_rate_for_secondary_fluid

field Evaporator Flow Rate for Secondary Fluid

For “FluidAlwaysLiquid”, at least one of the two, Evaporator Capacity OR

Evaporator Flow Rate for Secondary Fluid, is required.

For “FluidPhaseChange” loops, this input is not used. (see PhaseChange Circulating

Rate)

Units: M3/s

Parameters:value (float) – value for IDD Field Evaporator Flow Rate for Secondary Fluid Raises:ValueError – if value is not a valid value Returns:the value of evaporator_flow_rate_for_secondary_fluid or None if not set Return type:float

evaporator_range_temperature_difference

field Evaporator Range Temperature Difference

For “FluidAlwaysLiquid”, this is the rated difference between the temperature of the

circulating fluid entering the heat exchanger and the temperature of the

circulating fluid leaving the heat exchanger, and is Required.

For “FluidPhaseChange”, this input is not used.

Units: deltaC

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

evaporator_refrigerant_inventory

field Evaporator Refrigerant Inventory

This value refers to the refrigerant circulating within the primary system providing

cooling to the chiller for the secondary loop, not to the fluid circulating

within the secondary loop itself.

Units: kg

Parameters:value (float) – value for IDD Field Evaporator Refrigerant Inventory Raises:ValueError – if value is not a valid value Returns:the value of evaporator_refrigerant_inventory 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_pumps_in_loop

field Number of Pumps in Loop

Default value: 1

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

phasechange_circulating_rate

field PhaseChange Circulating Rate

This is the total mass flow at the pump divided by the gaseous mass flow

leaving the refrigeration load.

Units: dimensionless

Default value: 2.5

value >= 1.0

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

pump_drive_type

field Pump Drive Type

Default value: Constant

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

pump_motor_heat_to_fluid

field Pump Motor Heat to Fluid

This is the portion of the pump motor heat added to secondary circulating fluid

and is equal to the motor efficiency for non-hermetic motor.

Enter 1.0 for a semi-hermetic motor.

Units: dimensionless

Default value: 0.85

value >= 0.5

value <= 1.0

Parameters:value (float) – value for IDD Field Pump Motor Heat to Fluid Raises:ValueError – if value is not a valid value Returns:the value of pump_motor_heat_to_fluid or None if not set Return type:float

receiver_or_separator_zone_name

field Receiver/Separator Zone Name

This will be used to determine the temperature used for Receiver/Separator Shell heat gain.

The shell heat gains are also counted as cooling credit for the zone.

Required only if Sum UA Receiver/Separator Shell >0.0

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

refrigerated_case_or_walkin_or_caseandwalkinlist_name

field Refrigerated Case or Walkin or CaseAndWalkInList Name

Enter the name of a Refrigeration:Case or Refrigeration:WalkIn object.

If there is more than one refrigerated case or walk-in served by this secondary system,

enter the name of a Refrigeration:CaseAndWalkInList object.

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

sum_ua_distribution_piping

field Sum UA Distribution Piping

Use only if you want to include distribution piping heat gain in refrigeration load.

Units: W/K

Parameters:value (float) – value for IDD Field Sum UA Distribution Piping Raises:ValueError – if value is not a valid value Returns:the value of sum_ua_distribution_piping or None if not set Return type:float

sum_ua_receiver_or_separator_shell

field Sum UA Receiver/Separator Shell

Use only if you want to include Receiver/Separator Shell heat gain in refrigeration load.

Units: W/K

Parameters:value (float) – value for IDD Field Sum UA Receiver/Separator Shell Raises:ValueError – if value is not a valid value Returns:the value of sum_ua_receiver_or_separator_shell or None if not set Return type:float

total_pump_flow_rate

field Total Pump Flow Rate

For “FluidAlwaysLiquid”,if not input, Evaporator Flow Rate for Secondary Fluid

will be used.

For “FluidPhaseChange”, if not input, this will be calculated using the

PhaseChange Circulating Rate.

Units: M3/s

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

total_pump_head

field Total Pump Head

Either the Total Pump Power or the Total Pump Head is required.

Units: Pa

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

total_pump_power

field Total Pump Power

Either the Total Pump Power or the Total Pump Head is required.

Units: W

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

variable_speed_pump_cubic_curve_name

field Variable Speed Pump Cubic Curve Name

Variable Speed Pump Curve Name is applicable to variable speed pumps

only.

Parameters:value (str) – value for IDD Field Variable Speed Pump Cubic Curve Name Raises:ValueError – if value is not a valid value Returns:the value of variable_speed_pump_cubic_curve_name or None if not set Return type:str

class pyidf.refrigeration.RefrigerationSubcooler

Bases: pyidf.helper.DataObject

Corresponds to IDD object Refrigeration:Subcooler Two types of subcoolers are modeled by the detailed refrigeration system. The liquid suction heat exchanger uses cool suction gas to subcool the hot condensate after it leaves the condenser and before it reaches the thermal expansion valve. A mechanical subcooler is used to transfer cooling capacity from one refrigeration system to another.

capacityproviding_system

field Capacity-Providing System

Name of the Detailed Refrigeration System providing cooling capacity

Applicable only and required for mechanical subcoolers

Parameters:value (str) – value for IDD Field Capacity-Providing System Raises:ValueError – if value is not a valid value Returns:the value of capacityproviding_system or None if not set Return type:str

design_liquid_inlet_temperature

field Design Liquid Inlet Temperature

design inlet temperature on liquid side

Applicable only and required for liquid suction heat exchangers (LSHX)

Units: C

Parameters:value (float) – value for IDD Field Design Liquid Inlet Temperature Raises:ValueError – if value is not a valid value Returns:the value of design_liquid_inlet_temperature or None if not set Return type:float

design_vapor_inlet_temperature

field Design Vapor Inlet Temperature

design inlet temperature on vapor side

Applicable only and required for liquid suction heat exchangers (LSHX)

Design vapor inlet temperature must be less than or equal to

the Liquid inlet design temp

Units: C

Parameters:value (float) – value for IDD Field Design Vapor Inlet Temperature Raises:ValueError – if value is not a valid value Returns:the value of design_vapor_inlet_temperature or None if not set Return type:float

liquid_suction_design_subcooling_temperature_difference

field Liquid Suction Design Subcooling Temperature Difference

Applicable only and required for liquid suction heat exchangers

design liquid suction subcooling

Units: deltaC

Parameters:value (float) – value for IDD Field Liquid Suction Design Subcooling Temperature Difference Raises:ValueError – if value is not a valid value Returns:the value of liquid_suction_design_subcooling_temperature_difference 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

outlet_control_temperature

field Outlet Control Temperature

Control Temperature Out for subcooled liquid

Applicable only and required for mechanical subcoolers

Units: C

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

subcooler_type

field Subcooler Type

plan to add ambient subcoolers at future time

Default value: LiquidSuction

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

class pyidf.refrigeration.RefrigerationSystem

Bases: pyidf.helper.DataObject

Corresponds to IDD object Refrigeration:System Simulates the performance of a supermarket refrigeration system when used along with other objects to define the refrigeration load(s), the compressor(s), and the condenser.

compressor_or_compressorlist_name

field Compressor or CompressorList Name

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

enduse_subcategory

field End-Use Subcategory

Default value: General

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

highstage_compressor_or_compressorlist_name

field High-Stage Compressor or CompressorList Name

Parameters:value (str) – value for IDD Field High-Stage Compressor or CompressorList Name Raises:ValueError – if value is not a valid value Returns:the value of highstage_compressor_or_compressorlist_name or None if not set Return type:str

intercooler_type

field Intercooler Type

Default value: None

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

liquid_suction_heat_exchanger_subcooler_name

field Liquid Suction Heat Exchanger Subcooler Name

Optional Field

Liquid Suction Heat Exchanger Name, or leave blank

Parameters:value (str) – value for IDD Field Liquid Suction Heat Exchanger Subcooler Name Raises:ValueError – if value is not a valid value Returns:the value of liquid_suction_heat_exchanger_subcooler_name or None if not set Return type:str

mechanical_subcooler_name

field Mechanical Subcooler Name

Optional Field

Recipient of refrigeration capacity, that is receives cool liquid

from another refrigeration system to help meet aggregate case loads

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

minimum_condensing_temperature

field Minimum Condensing Temperature

related to the proper operation of the thermal expansion

valves and compressors

Units: C

Parameters:value (float) – value for IDD Field Minimum Condensing Temperature Raises:ValueError – if value is not a valid value Returns:the value of minimum_condensing_temperature 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_compressor_stages

field Number of Compressor Stages

Default value: 1

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

refrigerated_case_or_walkin_or_caseandwalkinlist_name

field Refrigerated Case or Walkin or CaseAndWalkInList Name

Enter the name of a Refrigeration:Case or Refrigeration:WalkIn object.

If there is more than one refrigerated case or walk-in served by this system,

enter the name of a Refrigeration:CaseAndWalkInList object.

Only cases and walkins served directly by the system should be included in this list.

Any cases served indirectly via a secondary chiller should NOT be included in this list

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

refrigeration_condenser_name

field Refrigeration Condenser Name

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

refrigeration_system_working_fluid_type

field Refrigeration System Working Fluid Type

Fluid property data for the refrigerant must be entered.

The fluid property data, including the objects:

FluidProperties:Name, FluidProperties:Temperatures,

FluidProperties:Saturated and FluidProperties:Superheated

can be copied from the FluidPropertiesRefData.idf dataset

Parameters:value (str) – value for IDD Field Refrigeration System Working Fluid Type Raises:ValueError – if value is not a valid value Returns:the value of refrigeration_system_working_fluid_type or None if not set Return type:str

refrigeration_transfer_load_or_transferload_list_name

field Refrigeration Transfer Load or TransferLoad List Name

Enter the name of a Refrigeration:SecondarySystem object OR

a Refrigeration:Condenser:Cascade object OR,

a Refrigeration:TransferLoadList object.

A transfer load is identified as one which moves the load from one system to another.

So if you have more than one such load (including cascade condensers and secondary

loops) served by the same system, use a TransferLoadList object.

Parameters:value (str) – value for IDD Field Refrigeration Transfer Load or TransferLoad List Name Raises:ValueError – if value is not a valid value Returns:the value of refrigeration_transfer_load_or_transferload_list_name or None if not set Return type:str

shellandcoil_intercooler_effectiveness

field Shell-and-Coil Intercooler Effectiveness

Default value: 0.8

Parameters:value (float) – value for IDD Field Shell-and-Coil Intercooler Effectiveness Raises:ValueError – if value is not a valid value Returns:the value of shellandcoil_intercooler_effectiveness or None if not set Return type:float

suction_piping_zone_name

field Suction Piping Zone Name

This will be used to determine the temperature used for distribution piping heat gain

and the pipe heat gains as cooling credit for the zone.

Required only if Sum UA Distribution Piping >0.0

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

suction_temperature_control_type

field Suction Temperature Control Type

Default value: ConstantSuctionTemperature

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

sum_ua_suction_piping

field Sum UA Suction Piping

Use only if you want to include suction piping heat gain in refrigeration load

Units: W/K

Parameters:value (float) – value for IDD Field Sum UA Suction Piping Raises:ValueError – if value is not a valid value Returns:the value of sum_ua_suction_piping or None if not set Return type:float

class pyidf.refrigeration.RefrigerationTranscriticalSystem

Bases: pyidf.helper.DataObject

Corresponds to IDD object Refrigeration:TranscriticalSystem Detailed transcritical carbon dioxide (CO2) booster refrigeration systems used in supermarkets. The object allows for modeling either a single stage system with medium-temperature loads or a two stage system with both medium- and low-temperature loads.

enduse_subcategory

field End-Use Subcategory

Default value: General

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

high_pressure_compressor_or_compressorlist_name

field High Pressure Compressor or CompressorList Name

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

low_pressure_compressor_or_compressorlist_name

field Low Pressure Compressor or CompressorList Name

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

low_temperature_refrigerated_case_or_walkin_or_caseandwalkinlist_name

field Low Temperature Refrigerated Case or Walkin or CaseAndWalkInList Name

Enter the name of a Refrigeration:Case or Refrigeration:WalkIn object.

If there is more than one refrigerated case or walk-in served by this system,

enter the name of a Refrigeration:CaseAndWalkInList object.

Only low temperature cases and walkins served directly by the system should be

included in this list.

Parameters:value (str) – value for IDD Field Low Temperature Refrigerated Case or Walkin or CaseAndWalkInList Name Raises:ValueError – if value is not a valid value Returns:the value of low_temperature_refrigerated_case_or_walkin_or_caseandwalkinlist_name or None if not set Return type:str

low_temperature_suction_piping_zone_name

field Low Temperature Suction Piping Zone Name

This will be used to determine the temperature used for distribution piping heat

gain and the pipe heat gains as cooling credit for the zone.

Required only if Sum UA Distribution Piping for Low Temperature Loads > 0.0

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

medium_temperature_refrigerated_case_or_walkin_or_caseandwalkinlist_name

field Medium Temperature Refrigerated Case or Walkin or CaseAndWalkInList Name

Enter the name of a Refrigeration:Case or Refrigeration:WalkIn object.

If there is more than one refrigerated case or walk-in served by this system,

enter the name of a Refrigeration:CaseAndWalkInList object.

Only medium temperature cases and walk-ins served directly by the system should

be included in this list.

Parameters:value (str) – value for IDD Field Medium Temperature Refrigerated Case or Walkin or CaseAndWalkInList Name Raises:ValueError – if value is not a valid value Returns:the value of medium_temperature_refrigerated_case_or_walkin_or_caseandwalkinlist_name or None if not set Return type:str

medium_temperature_suction_piping_zone_name

field Medium Temperature Suction Piping Zone Name

This will be used to determine the temperature used for distribution piping heat

gain and the pipe heat gains as cooling credit for the zone.

Required only if Sum UA Distribution Piping for Medium Temperature Loads > 0.0

Parameters:value (str) – value for IDD Field Medium Temperature Suction Piping Zone Name Raises:ValueError – if value is not a valid value Returns:the value of medium_temperature_suction_piping_zone_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

receiver_pressure

field Receiver Pressure

Units: Pa

Default value: 4000000.0

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

refrigeration_gas_cooler_name

field Refrigeration Gas Cooler Name

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

refrigeration_system_working_fluid_type

field Refrigeration System Working Fluid Type

Fluid property data for the refrigerant must be entered.

The fluid property data, including the objects:

FluidProperties:Name, FluidProperties:Temperatures,

FluidProperties:Saturated and FluidProperties:Superheated

can be copied from the FluidPropertiesRefData.idf dataset

Parameters:value (str) – value for IDD Field Refrigeration System Working Fluid Type Raises:ValueError – if value is not a valid value Returns:the value of refrigeration_system_working_fluid_type or None if not set Return type:str

subcooler_effectiveness

field Subcooler Effectiveness

Default value: 0.4

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

sum_ua_suction_piping_for_low_temperature_loads

field Sum UA Suction Piping for Low Temperature Loads

Use only if you want to include suction piping heat gain in refrigeration load

Units: W/K

Parameters:value (float) – value for IDD Field Sum UA Suction Piping for Low Temperature Loads Raises:ValueError – if value is not a valid value Returns:the value of sum_ua_suction_piping_for_low_temperature_loads or None if not set Return type:float

sum_ua_suction_piping_for_medium_temperature_loads

field Sum UA Suction Piping for Medium Temperature Loads

Use only if you want to include suction piping heat gain in refrigeration load

Units: W/K

Parameters:value (float) – value for IDD Field Sum UA Suction Piping for Medium Temperature Loads Raises:ValueError – if value is not a valid value Returns:the value of sum_ua_suction_piping_for_medium_temperature_loads or None if not set Return type:float

system_type

field System Type

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

class pyidf.refrigeration.RefrigerationTransferLoadList

Bases: pyidf.helper.DataObject

Corresponds to IDD object Refrigeration:TransferLoadList A refrigeration system may provide cooling to other, secondary, systems through either a secondary loop or a cascade condenser. If multiple transfer loads are served by a single primary system, use this list to group them together for reference by the primary system (see the field “Refrigeration Transfer Load or TransferLoad List Name” in the Refrigeration:System object).

add_extensible(cascade_condenser_name_or_secondary_system_1_name=None)

Add values for extensible fields

Parameters:cascade_condenser_name_or_secondary_system_1_name (str) – value for IDD Field Cascade Condenser Name or Secondary System 1 Name if value is None it will not be checked against the specification and is assumed to be a missing value

extensibles

Get list of all extensibles

name

field Name

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

class pyidf.refrigeration.RefrigerationWalkIn

Bases: pyidf.helper.DataObject

Corresponds to IDD object Refrigeration:WalkIn Works in conjunction with a compressor rack, a refrigeration system, or a refrigeration secondary system to simulate the performance of a walk-in cooler. The walk-in cooler model uses information at rated conditions along with input descriptions for heat transfer surfaces facing multiple zones to determine performance.

add_extensible(zone_1_name=None, total_insulated_surface_area_facing_zone_1=None, insulated_surface_uvalue_facing_zone_1=0.3154, area_of_glass_reach_in_doors_facing_zone_1=None, height_of_glass_reach_in_doors_facing_zone_1=1.5, glass_reach_in_door_u_value_facing_zone_1=1.136, glass_reach_in_door_opening_schedule_name_facing_zone_1=None, area_of_stocking_doors_facing_zone_1=None, height_of_stocking_doors_facing_zone_1=3.0, stocking_door_u_value_facing_zone_1=0.3785, stocking_door_opening_schedule_name_facing_zone_1=None, stocking_door_opening_protection_type_facing_zone_1='AirCurtain')

Add values for extensible fields

Parameters:

• zone_1_name (str) – value for IDD Field Zone 1 Name if value is None it will not be checked against the specification and is assumed to be a missing value
• total_insulated_surface_area_facing_zone_1 (float) – value for IDD Field Total Insulated Surface Area Facing Zone 1 Units: m2 if value is None it will not be checked against the specification and is assumed to be a missing value
• insulated_surface_uvalue_facing_zone_1 (float) – value for IDD Field Insulated Surface U-Value Facing Zone 1 Units: W/m2-K Default value: 0.3154 if value is None it will not be checked against the specification and is assumed to be a missing value
• area_of_glass_reach_in_doors_facing_zone_1 (float) – value for IDD Field Area of Glass Reach In Doors Facing Zone 1 Units: m2 if value is None it will not be checked against the specification and is assumed to be a missing value
• height_of_glass_reach_in_doors_facing_zone_1 (float) – value for IDD Field Height of Glass Reach In Doors Facing Zone 1 Units: m Default value: 1.5 if value is None it will not be checked against the specification and is assumed to be a missing value
• glass_reach_in_door_u_value_facing_zone_1 (float) – value for IDD Field Glass Reach In Door U Value Facing Zone 1 Units: W/m2-K Default value: 1.136 if value is None it will not be checked against the specification and is assumed to be a missing value
• glass_reach_in_door_opening_schedule_name_facing_zone_1 (str) – value for IDD Field Glass Reach In Door Opening Schedule Name Facing Zone 1 if value is None it will not be checked against the specification and is assumed to be a missing value
• area_of_stocking_doors_facing_zone_1 (float) – value for IDD Field Area of Stocking Doors Facing Zone 1 Units: m2 if value is None it will not be checked against the specification and is assumed to be a missing value
• height_of_stocking_doors_facing_zone_1 (float) – value for IDD Field Height of Stocking Doors Facing Zone 1 Units: m Default value: 3.0 if value is None it will not be checked against the specification and is assumed to be a missing value
• stocking_door_u_value_facing_zone_1 (float) – value for IDD Field Stocking Door U Value Facing Zone 1 Units: W/m2-K Default value: 0.3785 if value is None it will not be checked against the specification and is assumed to be a missing value
• stocking_door_opening_schedule_name_facing_zone_1 (str) – value for IDD Field Stocking Door Opening Schedule Name Facing Zone 1 if value is None it will not be checked against the specification and is assumed to be a missing value
• stocking_door_opening_protection_type_facing_zone_1 (str) – value for IDD Field Stocking Door Opening Protection Type Facing Zone 1 Default value: AirCurtain if value is None it will not be checked against the specification and is assumed to be a missing value

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

average_refrigerant_charge_inventory

field Average Refrigerant Charge Inventory

This value is only used if the Cooling Source Type is DXEvaporator

Units: kg

Parameters:value (float) – value for IDD Field Average Refrigerant Charge Inventory Raises:ValueError – if value is not a valid value Returns:the value of average_refrigerant_charge_inventory or None if not set Return type:float

defrost_control_type

field Defrost Control Type

Default value: TimeSchedule

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

defrost_dripdown_schedule_name

field Defrost Drip-Down Schedule Name

The schedule values should be 0 (off) or 1 (on)

The start time for each defrost period in this drip-down schedule should coincide with

the start time for each defrost period in the defrost schedule (previous input

field).The length of each defrost drip-down period must be greater than or equal to the

corresponding defrost period specified in the defrost schedule. This extra time

allows the melted frost to drip from the coil before refrigeration is restarted.

Parameters:value (str) – value for IDD Field Defrost Drip-Down Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of defrost_dripdown_schedule_name or None if not set Return type:str

defrost_power

field Defrost Power

needed for all defrost types except none and offcycle

Units: W

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

defrost_schedule_name

field Defrost Schedule Name

The schedule values should be 0 (off) or 1 (on)

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

defrost_type

field Defrost Type

HotFluid includes either hot gas defrost for a DX system or

Hot Brine defrost if this walk in is cooled by brine from a secondary chiller

Default value: Electric

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

extensibles

Get list of all extensibles

heating_power_schedule_name

field Heating Power Schedule Name

Values will be used to multiply the total heating power

Values in the schedule should be between 0.0 and 1.0

For example, this could be used if display door antisweat heaters

are turned off at night

Defaults to always on if schedule name left blank.

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

insulated_floor_surface_area

field Insulated Floor Surface Area

floor area of walk-in cooler

Units: m2

Parameters:value (float) – value for IDD Field Insulated Floor Surface Area Raises:ValueError – if value is not a valid value Returns:the value of insulated_floor_surface_area or None if not set Return type:float

insulated_floor_uvalue

field Insulated Floor U-Value

The default value corresponds to R18 [ft2-F-hr/Btu]

To convert other IP R-values to U, divide 5.678 by the R-value

Some examples:

R15 is U 0.3785 W/m2-K

R5 is U 1.136 W/m2-K

Units: W/m2-K

Default value: 0.3154

Parameters:value (float) – value for IDD Field Insulated Floor U-Value Raises:ValueError – if value is not a valid value Returns:the value of insulated_floor_uvalue or None if not set Return type:float

lighting_schedule_name

field Lighting Schedule Name

The schedule should contain values between 0 and 1

Defaults to always on if schedule name left blank.

Parameters:value (str) – value for IDD Field Lighting Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of lighting_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

operating_temperature

field Operating Temperature

Units: C

value < 20.0

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

rated_circulation_fan_power

field Rated Circulation Fan Power

Units: W

Parameters:value (float) – value for IDD Field Rated Circulation Fan Power Raises:ValueError – if value is not a valid value Returns:the value of rated_circulation_fan_power or None if not set Return type:float

rated_coil_cooling_capacity

field Rated Coil Cooling Capacity

Units: W

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

rated_cooling_coil_fan_power

field Rated Cooling Coil Fan Power

Units: W

Default value: 375.0

Parameters:value (float) – value for IDD Field Rated Cooling Coil Fan Power Raises:ValueError – if value is not a valid value Returns:the value of rated_cooling_coil_fan_power or None if not set Return type:float

rated_cooling_source_temperature

field Rated Cooling Source Temperature

If DXEvaporator, use evaporating temperature (saturated suction temperature)

If BrineCoil, use Brine entering temperature

used to set minimum suction pressure for DX systems and

minimum brine temp for secondary systems

Units: C

value >= -70.0

value <= 40.0

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

rated_total_heating_power

field Rated Total Heating Power

Include total for all anti-sweat, door, drip-pan, and floor heater power

Do not include defrost heater power

Units: W

Parameters:value (float) – value for IDD Field Rated Total Heating Power Raises:ValueError – if value is not a valid value Returns:the value of rated_total_heating_power or None if not set Return type:float

rated_total_lighting_power

field Rated Total Lighting Power

Enter the total (display + task) installed lighting power.

Units: W

Parameters:value (float) – value for IDD Field Rated Total Lighting Power Raises:ValueError – if value is not a valid value Returns:the value of rated_total_lighting_power or None if not set Return type:float

restocking_schedule_name

field Restocking Schedule Name

Schedule values should be in units of Watts

Leave this field blank if no restocking is to be modeled

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

temperature_termination_defrost_fraction_to_ice

field Temperature Termination Defrost Fraction to Ice

This is the portion of the defrost energy that is available to melt frost

Needed only for defrost control type TemperatureTermination

defaults to 0.7 for electric defrost and to 0.3 for hot fluid defrost

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Temperature Termination Defrost Fraction to Ice Raises:ValueError – if value is not a valid value Returns:the value of temperature_termination_defrost_fraction_to_ice or None if not set Return type:float

class pyidf.refrigeration.ZoneHvacRefrigerationChillerSet

Bases: pyidf.helper.DataObject

Corresponds to IDD object ZoneHVAC:RefrigerationChillerSet Works in conjunction with one or multiple air chillers, compressor racks, refrigeration systems, or refrigeration secondary system objects to simulate the performance of a group of air chillers cooling a single zone. The chiller set model passes information about the zone conditions to determine the performance of individual chiller coils within the set, thus providing the sensible and latent heat exchange with the zone environment.

add_extensible(air_chiller_1_name=None)

Add values for extensible fields

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

air_inlet_node_name

field Air Inlet Node Name

Not used - reserved for future use

Name of the zone exhaust node (see Node) from which the refrigeration chiller

draws its indoor air.

This should be one of the zone exhaust nodes for the zone cooled by the chiller set.

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

Not used - reserved for future use

The name of the node where the chiller coil sends its outlet air,

which must be one of the inlet air nodes for the zone which is being cooled.

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

extensibles

Get list of all extensibles

name

field Name

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

zone_name

field Zone Name

This must be a controlled zone and appear in a ZoneHVAC:EquipmentConnections object.

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