Refrigeration¶

18 object types from idfpy.models.refrigeration · EnergyPlus 26.2

Object	Summary
Refrigeration:AirChiller	Works in conjunction with a refrigeration chiller set, compressor rack, a refrigeration system, or a …
Refrigeration:Case	The Refrigeration Case object works in conjunction with a compressor rack, a refrigeration system, or a …
Refrigeration:CaseAndWalkInList	Provides a list of all the refrigerated cases, walk in coolers, or air chillers cooled by a single …
Refrigeration:Compressor	Refrigeration system compressor.
Refrigeration:CompressorList	List of all the compressors included within a single refrigeration system (Refrigeration:System).
Refrigeration:CompressorRack	Works in conjunction with the refrigeration case and walk-in objects to simulate the performance of a …
Refrigeration:Condenser:AirCooled	Air cooled condenser for a refrigeration system (Refrigeration:System).
Refrigeration:Condenser:Cascade	Cascade condenser for a refrigeration system (Refrigeration:System).
Refrigeration:Condenser:EvaporativeCooled	Evaporative-cooled condenser for a refrigeration system (Refrigeration:System).
Refrigeration:Condenser:WaterCooled	Water cooled condenser for a refrigeration system (Refrigeration:System).
Refrigeration:GasCooler:AirCooled	The transcritical refrigeration system requires a single gas cooler to reject the system heat.
Refrigeration:SecondarySystem	Works in conjunction with refrigerated cases and walkins to simulate the performance of a secondary loop …
Refrigeration:Subcooler	Two types of subcoolers are modeled by the detailed refrigeration system.
Refrigeration:System	Simulates the performance of a supermarket refrigeration system when used along with other objects to define …
Refrigeration:TranscriticalSystem	Detailed transcritical carbon dioxide (CO2) booster refrigeration systems used in supermarkets.
Refrigeration:TransferLoadList	A refrigeration system may provide cooling to other, secondary, systems through either a secondary loop or a …
Refrigeration:WalkIn	Works in conjunction with a compressor rack, a refrigeration system, or a refrigeration secondary system to …
ZoneHVAC:RefrigerationChillerSet	Works in conjunction with one or multiple air chillers, compressor racks, refrigeration systems, or …

Refrigeration:AirChiller¶

from idfpy.models import RefrigerationAirChiller

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.

Field	Type	Default	Details
`name` Name required	string
`availability_schedule_name` Availability Schedule Name	reference		Availability schedule name for this system. Schedule value > 0 means the system is available. If this field is blank, the system is always available. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`capacity_rating_type` Capacity Rating Type required	choice		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. One of `CapacityTotalSpecificConditions`, `EuropeanSC1NominalWet`, `EuropeanSC1Standard`, `EuropeanSC2NominalWet`, `EuropeanSC2Standard`, `EuropeanSC3NominalWet`, `EuropeanSC3Standard`, `EuropeanSC4NominalWet`, `EuropeanSC4Standard`, `EuropeanSC5NominalWet`, `EuropeanSC5Standard`, `FixedLinear`, `UnitLoadFactorSensibleOnly`
`rated_unit_load_factor` Rated Unit Load Factor	number W/K		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
`rated_capacity` Rated Capacity	number W		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
`rated_relative_humidity` Rated Relative Humidity	number percent	`85.0`	This field is ONLY used if the Capacity Rating Type is CapacityTotalSpecificConditions and represents the relative humidity at rated conditions. The default is 85. Range: ≤ 100
`rated_cooling_source_temperature` Rated Cooling Source Temperature required	number C		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 Range: ≥ -70, ≤ 40
`rated_temperature_difference_dt1` Rated Temperature Difference DT1 required	number deltaC		The rated difference between the air entering the refrigeration chiller and the cooling source temperature in degC. Range: ≥ 0, ≤ 20
`maximum_temperature_difference_between_inlet_air_and_evaporating_temperature` Maximum Temperature Difference Between Inlet Air and Evaporating Temperature	number deltaC		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 Range: ≥ 0, ≤ 25
`coil_material_correction_factor` Coil Material Correction Factor	number dimensionless	`1.0`	This is the manufacturer's correction factor for coil material corresponding to rating
`refrigerant_correction_factor` Refrigerant Correction Factor	number dimensionless	`1.0`	This is the manufacturer's correction factor for refrigerant corresponding to rating
`capacity_correction_curve_type` Capacity Correction Curve Type	choice		In each case, select the correction curve type that corresponds to the rating type. default LinearSHR60 unless Capacity Rating Type = CapacityTotalSpecificConditions One of `European`, `LinearSHR60`, `QuadraticSHR`, `TabularRHxDT1xTRoom`
`capacity_correction_curve_name` Capacity Correction Curve Name	reference		Should be blank for LinearSHR60 correction curve type Names a Curve:ChillerPartLoadWithLift, Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2 and 3 more
`shr60_correction_factor` SHR60 Correction Factor	number dimensionless	`1.48`	only used when the capacity correction curve type is LinearSHR60 Range: ≤ 1.67
`rated_total_heating_power` Rated Total Heating Power required	number W		Include total for all heater power Do not include defrost heater power
`heating_power_schedule_name` Heating Power Schedule Name	reference		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. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`fan_speed_control_type` Fan Speed Control Type	choice	`Fixed`	One of `Fixed`, `FixedLinear`, `TwoSpeed`, `VariableSpeed`
`rated_fan_power` Rated Fan Power	number W	`375.0`	Range: ≥ 0
`rated_air_flow` Rated Air Flow required	number m3/s
`minimum_fan_air_flow_ratio` Minimum Fan Air Flow Ratio	number dimensionless	`0.2`	Minimum air flow fraction through fan Range: ≥ 0
`defrost_type` Defrost Type	choice	`Electric`	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 One of `Electric`, `HotFluid`, `None`, `OffCycle`
`defrost_control_type` Defrost Control Type	choice	`TimeSchedule`	One of `TemperatureTermination`, `TimeSchedule`
`defrost_schedule_name` Defrost Schedule Name required	reference		The schedule values should be 0 (off) or 1 (on) Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`defrost_drip_down_schedule_name` Defrost Drip-Down Schedule Name	reference		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. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`defrost_power` Defrost Power	number W		needed for all defrost types except none and offcycle Range: ≥ 0
`temperature_termination_defrost_fraction_to_ice` Temperature Termination Defrost Fraction to Ice	number dimensionless		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 Range: > 0, ≤ 1
`vertical_location` Vertical Location	choice	`Middle`	One of `Ceiling`, `Floor`, `Middle`
`average_refrigerant_charge_inventory` Average Refrigerant Charge Inventory	number kg	`0.0`	This value is only used if the Cooling Source Type is DXEvaporator

Referenced by 6 object types

Refrigeration:CaseAndWalkInList, Refrigeration:CompressorRack, Refrigeration:SecondarySystem, Refrigeration:System, Refrigeration:TranscriticalSystem, ZoneHVAC:RefrigerationChillerSet

Refrigeration:Case¶

from idfpy.models import RefrigerationCase

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.

Field	Type	Default	Details
`name` Name required	string
`availability_schedule_name` Availability Schedule Name	reference		Availability schedule name for this system. Schedule value > 0 means the system is available. If this field is blank, the system is always available. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`zone_name` Zone Name required	reference		This must be a controlled zone and appear in a ZoneHVAC:EquipmentConnections object. Names a Zone
`rated_ambient_temperature` Rated Ambient Temperature	number C	`23.9`	Range: > 0
`rated_ambient_relative_humidity` Rated Ambient Relative Humidity	number percent	`55.0`	Range: > 0, < 100
`rated_total_cooling_capacity_per_unit_length` Rated Total Cooling Capacity per Unit Length	number W/m	`1900.0`	Range: > 0
`rated_latent_heat_ratio` Rated Latent Heat Ratio	number	`0.3`	Range: ≥ 0, ≤ 1
`rated_runtime_fraction` Rated Runtime Fraction	number	`0.85`	Range: > 0, ≤ 1
`case_length` Case Length	number m	`3.0`	Range: > 0
`case_operating_temperature` Case Operating Temperature	number C	`1.1`	Range: < 20
`latent_case_credit_curve_type` Latent Case Credit Curve Type	choice	`CaseTemperatureMethod`	One of `CaseTemperatureMethod`, `DewpointMethod`, `RelativeHumidityMethod`
`latent_case_credit_curve_name` Latent Case Credit Curve Name required	reference		Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more
`standard_case_fan_power_per_unit_length` Standard Case Fan Power per Unit Length	number W/m	`75.0`	Range: ≥ 0
`operating_case_fan_power_per_unit_length` Operating Case Fan Power per Unit Length	number W/m	`75.0`	Range: ≥ 0
`standard_case_lighting_power_per_unit_length` Standard Case Lighting Power per Unit Length	number W/m	`90.0`
`installed_case_lighting_power_per_unit_length` Installed Case Lighting Power per Unit Length	number W/m		default set equal to Standard Case Lighting Power per Unit Length
`case_lighting_schedule_name` Case Lighting Schedule Name	reference		Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`fraction_of_lighting_energy_to_case` Fraction of Lighting Energy to Case	number	`1.0`	Range: ≥ 0, ≤ 1
`case_anti_sweat_heater_power_per_unit_length` Case Anti-Sweat Heater Power per Unit Length	number W/m	`0.0`	Range: ≥ 0
`minimum_anti_sweat_heater_power_per_unit_length` Minimum Anti-Sweat Heater Power per Unit Length	number W/m	`0.0`	This field is only applicable to the Linear, Dewpoint Method, and Heat Balance Method anti-sweat heater control types Range: ≥ 0
`anti_sweat_heater_control_type` Anti-Sweat Heater Control Type	choice	`None`	One of `Constant`, `DewpointMethod`, `HeatBalanceMethod`, `Linear`, `None`
`humidity_at_zero_anti_sweat_heater_energy` Humidity at Zero Anti-Sweat Heater Energy	number percent	`-10.0`	This field is only applicable to Linear AS heater control type Zone relative humidity (%) where anti-sweat heater energy is zero
`case_height` Case Height	number m	`1.5`	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 Range: ≥ 0
`fraction_of_anti_sweat_heater_energy_to_case` Fraction of Anti-Sweat Heater Energy to Case	number	`1.0`	Range: ≥ 0, ≤ 1
`case_defrost_power_per_unit_length` Case Defrost Power per Unit Length	number W/m	`0.0`	Used to evaluate load on case as well as power or heat consumption Range: ≥ 0
`case_defrost_type` Case Defrost Type	choice	`OffCycle`	One of `Electric`, `ElectricWithTemperatureTermination`, `HotFluid`, `HotFluidWithTemperatureTermination`, `HotGas`, `HotGasWithTemperatureTermination`, `None`, `OffCycle`
`case_defrost_schedule_name` Case Defrost Schedule Name	reference		A case defrost schedule name is required unless case defrost type = None Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`case_defrost_drip_down_schedule_name` Case Defrost Drip-Down Schedule Name	reference		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. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`defrost_energy_correction_curve_type` Defrost Energy Correction Curve Type	choice	`None`	Case Temperature, Relative Humidity, and Dewpoint Method are applicable to case defrost types with temperature termination only. One of `CaseTemperatureMethod`, `DewpointMethod`, `None`, `RelativeHumidityMethod`
`defrost_energy_correction_curve_name` Defrost Energy Correction Curve Name	reference		Defrost Energy Correction Curve Name is applicable to case defrost types with temperature termination only. Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more
`under_case_hvac_return_air_fraction` Under Case HVAC Return Air Fraction	number	`0.0`	Range: ≥ 0, ≤ 1
`refrigerated_case_restocking_schedule_name` Refrigerated Case Restocking Schedule Name	reference		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 Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`case_credit_fraction_schedule_name` Case Credit Fraction Schedule Name	reference		Schedule values should be from 0 to 1 Leave this field blank if no case credit fraction is to be applied Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`design_evaporator_temperature_or_brine_inlet_temperature` Design Evaporator Temperature or Brine Inlet Temperature	number C		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 Range: ≥ -70, ≤ 40
`average_refrigerant_charge_inventory` Average Refrigerant Charge Inventory	number kg/m	`0.0`
`under_case_hvac_return_air_node_name` Under Case HVAC Return Air Node Name	string		Name of the return air node for this case. If left blank, defaults to the first return air node for this zone.

Referenced by 5 object types

Refrigeration:CaseAndWalkInList, Refrigeration:CompressorRack, Refrigeration:SecondarySystem, Refrigeration:System, Refrigeration:TranscriticalSystem

Refrigeration:CaseAndWalkInList¶

from idfpy.models import RefrigerationCaseAndWalkInList extensible

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.

Field	Type	Default	Details
`name` Name required	string
`cases_and_walkins`	list		Each item: `case_or_walkin_name`

Referenced by 4 object types

Refrigeration:CompressorRack, Refrigeration:SecondarySystem, Refrigeration:System, Refrigeration:TranscriticalSystem

Refrigeration:Compressor¶

from idfpy.models import RefrigerationCompressor

Refrigeration system compressor. Data is available for many compressors in the RefrigerationCompressor.idf dataset

Field	Type	Default	Details
`name` Name required	string
`refrigeration_compressor_power_curve_name` Refrigeration Compressor Power Curve Name required	reference		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 Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup
`refrigeration_compressor_capacity_curve_name` Refrigeration Compressor Capacity Curve Name required	reference		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 Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup
`rated_superheat` Rated Superheat	number deltaC		Use this input field OR the next, not both This is used if the compressor rating is based upon degrees of superheat
`rated_return_gas_temperature` Rated Return Gas Temperature	number C		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)
`rated_liquid_temperature` Rated Liquid Temperature	number C		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
`rated_subcooling` Rated Subcooling	number deltaC		Use this input field OR the previous, not both This is used if the compressor rating is based upon degrees of subcooling
`end_use_subcategory` End-Use Subcategory	string	`General`	Any text may be used here to categorize the end-uses in the ABUPS End Uses by Subcategory table.
`mode_of_operation` Mode of Operation	choice	`Subcritical`	One of `Subcritical`, `Transcritical`
`transcritical_compressor_power_curve_name` Transcritical Compressor Power Curve Name	reference		Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup
`transcritical_compressor_capacity_curve_name` Transcritical Compressor Capacity Curve Name	reference		Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup

Referenced by 3 object types

Refrigeration:CompressorList, Refrigeration:System, Refrigeration:TranscriticalSystem

Refrigeration:CompressorList¶

from idfpy.models import RefrigerationCompressorList extensible

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

Field	Type	Default	Details
`name` Name required	string
`compressors`	list		Each item: `refrigeration_compressor_name`

Referenced by 2 object types

Refrigeration:System, Refrigeration:TranscriticalSystem

Refrigeration:CompressorRack¶

from idfpy.models import RefrigerationCompressorRack

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

Field	Type	Default	Details
`name` Name required	string
`heat_rejection_location` Heat Rejection Location	choice	`Outdoors`	One of `Outdoors`, `Zone`
`design_compressor_rack_cop` Design Compressor Rack COP	number W/W	`2.0`	It is important that this COP correspond to the lowest saturated suction temperature needed to serve all refrigeration loads Range: > 0
`compressor_rack_cop_function_of_temperature_curve_name` Compressor Rack COP Function of Temperature Curve Name required	reference		It is important that this COP curve correspond to the lowest saturated suction temperature needed to serve all refrigeration loads Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more
`design_condenser_fan_power` Design Condenser Fan Power	number W	`250.0`	Design power for condenser fan(s). Range: ≥ 0
`condenser_fan_power_function_of_temperature_curve_name` Condenser Fan Power Function of Temperature Curve Name	reference		Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more
`condenser_type` Condenser Type	choice	`AirCooled`	Applicable only when Heat Rejection Location is Outdoors. One of `AirCooled`, `EvaporativelyCooled`, `WaterCooled`
`water_cooled_condenser_inlet_node_name` Water-Cooled Condenser Inlet Node Name	string
`water_cooled_condenser_outlet_node_name` Water-Cooled Condenser Outlet Node Name	string
`water_cooled_loop_flow_type` Water-Cooled Loop Flow Type	choice	`VariableFlow`	Applicable only when Condenser Type is WaterCooled. One of `ConstantFlow`, `VariableFlow`
`water_cooled_condenser_outlet_temperature_schedule_name` Water-Cooled Condenser Outlet Temperature Schedule Name	reference		Applicable only when loop Flow type is VariableFlow. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`water_cooled_condenser_design_flow_rate` Water-Cooled Condenser Design Flow Rate	number m3/s		Applicable only when loop flow type is ConstantFlow. Range: > 0
`water_cooled_condenser_maximum_flow_rate` Water-Cooled Condenser Maximum Flow Rate	number m3/s		Range: > 0
`water_cooled_condenser_maximum_water_outlet_temperature` Water-Cooled Condenser Maximum Water Outlet Temperature	number C	`55.0`	Range: ≥ 10, ≤ 60
`water_cooled_condenser_minimum_water_inlet_temperature` Water-Cooled Condenser Minimum Water Inlet Temperature	number C	`10.0`	Range: ≥ 10, ≤ 30
`evaporative_condenser_availability_schedule_name` Evaporative Condenser Availability Schedule Name	reference		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. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`evaporative_condenser_effectiveness` Evaporative Condenser Effectiveness	number dimensionless	`0.9`	Applicable only for Condenser Type = EvaporativlyCooled. Range: ≥ 0, ≤ 1
`evaporative_condenser_air_flow_rate` Evaporative Condenser Air Flow Rate	number or `Autocalculate` m3/s	`Autocalculate`	Applicable only for Condenser Type = EvaporativelyCooled. Used to calculate evaporative condenser water use.
`basin_heater_capacity` Basin Heater Capacity	number W/K	`200.0`	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). Range: ≥ 0
`basin_heater_setpoint_temperature` Basin Heater Setpoint Temperature	number C	`2.0`	Enter the outdoor dry-bulb temperature at which the basin heater turns on. Range: ≥ 2
`design_evaporative_condenser_water_pump_power` Design Evaporative Condenser Water Pump Power	number or `Autocalculate` W	`1000.0`	Design recirc water pump power for Condenser Type = EvaporativelyCooled. Applicable only for Condenser Type = EvaporativelyCooled.
`evaporative_water_supply_tank_name` Evaporative Water Supply Tank Name	reference		If blank, water supply is from Mains. Applicable only for Condenser Type = EvaporativelyCooled. Names a WaterUse:Storage
`condenser_air_inlet_node_name` Condenser Air Inlet Node Name	string		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).
`end_use_subcategory` End-Use Subcategory	string	`General`	Any text may be used here to categorize the end-uses in the ABUPS End Uses by Subcategory table.
`refrigeration_case_name_or_walkin_name_or_caseandwalkinlist_name` Refrigeration Case Name or WalkIn Name or CaseAndWalkInList Name	reference		Enter the name of a Refrigeration:Case or Refrigeration:Walkin or Refrigeration:CaseAndWalkinList object. Names a Refrigeration:AirChiller, Refrigeration:Case, Refrigeration:CaseAndWalkInList, Refrigeration:WalkIn
`heat_rejection_zone_name` Heat Rejection Zone Name	reference		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" Names a Zone

Referenced by 4 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, Branch, Coil:Heating:Desuperheater, Coil:WaterHeating:Desuperheater

Refrigeration:Condenser:AirCooled¶

from idfpy.models import RefrigerationCondenserAirCooled

Air cooled condenser for a refrigeration system (Refrigeration:System).

Field	Type	Default	Details
`name` Name required	string
`rated_effective_total_heat_rejection_rate_curve_name` Rated Effective Total Heat Rejection Rate Curve Name	reference		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 Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more
`rated_subcooling_temperature_difference` Rated Subcooling Temperature Difference	number deltaC	`0.0`	must correspond to rating given for total heat rejection effect Range: ≥ 0
`condenser_fan_speed_control_type` Condenser Fan Speed Control Type	choice	`Fixed`	One of `Fixed`, `FixedLinear`, `TwoSpeed`, `VariableSpeed`
`rated_fan_power` Rated Fan Power	number W	`250.0`	Power for condenser fan(s) corresponding to rated total heat rejection effect. Range: ≥ 0
`minimum_fan_air_flow_ratio` Minimum Fan Air Flow Ratio	number dimensionless	`0.2`	Minimum air flow fraction through condenser fan Range: ≥ 0
`air_inlet_node_name_or_zone_name` Air Inlet Node Name or Zone Name	string		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.
`end_use_subcategory` End-Use Subcategory	string	`General`	Any text may be used here to categorize the end-uses in the ABUPS End Uses by Subcategory table.
`condenser_refrigerant_operating_charge_inventory` Condenser Refrigerant Operating Charge Inventory	number kg	`0.0`	optional input
`condensate_receiver_refrigerant_inventory` Condensate Receiver Refrigerant Inventory	number kg	`0.0`	optional input
`condensate_piping_refrigerant_inventory` Condensate Piping Refrigerant Inventory	number kg	`0.0`	optional input

Referenced by 3 object types

Coil:Heating:Desuperheater, Coil:WaterHeating:Desuperheater, Refrigeration:System

Refrigeration:Condenser:Cascade¶

from idfpy.models import RefrigerationCondenserCascade

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.

Field	Type	Default	Details
`name` Name required	string
`rated_condensing_temperature` Rated Condensing Temperature required	number C		This is the condensing temperature for the lower temperature secondary loop
`rated_approach_temperature_difference` Rated Approach Temperature Difference	number deltaC	`3.0`	This is the difference between the condensing and evaporating temperatures Range: > 0
`rated_effective_total_heat_rejection_rate` Rated Effective Total Heat Rejection Rate required	number W		used for identification and rough system size error checking Range: > 0
`condensing_temperature_control_type` Condensing Temperature Control Type	choice	`Fixed`	Fixed keeps condensing temperature constant Float sets the condensing temperature according to the other loads on the higher temperature system One of `Fixed`, `Float`
`condenser_refrigerant_operating_charge_inventory` Condenser Refrigerant Operating Charge Inventory	number kg		optional input
`condensate_receiver_refrigerant_inventory` Condensate Receiver Refrigerant Inventory	number kg		optional input
`condensate_piping_refrigerant_inventory` Condensate Piping Refrigerant Inventory	number kg		optional input

Referenced by 2 object types

Refrigeration:System, Refrigeration:TransferLoadList

Refrigeration:Condenser:EvaporativeCooled¶

from idfpy.models import RefrigerationCondenserEvaporativeCooled

Evaporative-cooled condenser for a refrigeration system (Refrigeration:System).

Field	Type	Default	Details
`name` Name required	string
`rated_effective_total_heat_rejection_rate` Rated Effective Total Heat Rejection Rate required	number W		Rating as per ARI 490 Be sure the rating corresponds to the correct refrigerant Range: ≥ 0
`rated_subcooling_temperature_difference` Rated Subcooling Temperature Difference	number deltaC	`0.0`	must correspond to rating given for total heat rejection effect Range: ≥ 0
`fan_speed_control_type` Fan Speed Control Type	choice	`Fixed`	One of `Fixed`, `FixedLinear`, `TwoSpeed`, `VariableSpeed`
`rated_fan_power` Rated Fan Power required	number W		Power for condenser fan(s) corresponding to rated total heat rejection effect. Range: ≥ 0
`minimum_fan_air_flow_ratio` Minimum Fan Air Flow Ratio	number dimensionless	`0.2`	Minimum air flow fraction through condenser fan Range: ≥ 0
`approach_temperature_constant_term` Approach Temperature Constant Term	number C	`6.63`	A1 in delta T = A1 + A2(hrcf) + A3/(hrcf) + A4(Twb) Range: ≥ 0, ≤ 20
`approach_temperature_coefficient_2` Approach Temperature Coefficient 2	number C	`0.468`	A2 in delta T = A1 + A2(hrcf) +A3/(hrcf) +A4(Twb) Range: ≥ 0, ≤ 20
`approach_temperature_coefficient_3` Approach Temperature Coefficient 3	number C	`17.93`	A3 in delta T = A1 + A2(hrcf) +A3/(hrcf) +A4(Twb) Range: ≥ 0, ≤ 30
`approach_temperature_coefficient_4` Approach Temperature Coefficient 4	number dimensionless	`-0.322`	A4 in deltaT=A1 + A2(hrcf) +A3/(hrcf) +A4(Twb) Range: ≥ -20, ≤ 20
`minimum_capacity_factor` Minimum Capacity Factor	number dimensionless	`0.5`	taken from manufacturer's Heat Rejection Capacity Factor Table
`maximum_capacity_factor` Maximum Capacity Factor	number dimensionless	`5.0`	taken from manufacturer's Heat Rejection Capacity Factor Table
`air_inlet_node_name` Air Inlet Node Name	string		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).
`rated_air_flow_rate` Rated Air Flow Rate	number or `Autocalculate` m3/s	`Autocalculate`	Used to calculate evaporative condenser water use and fan energy use.
`basin_heater_capacity` Basin Heater Capacity	number W/K	`200.0`	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). Range: ≥ 0
`basin_heater_setpoint_temperature` Basin Heater Setpoint Temperature	number C	`2.0`	Enter the outdoor dry-bulb temperature at which the basin heater turns on. Range: ≥ 2
`rated_water_pump_power` Rated Water Pump Power	number or `Autocalculate` W	`1000.0`	Design recirculating water pump power.
`evaporative_water_supply_tank_name` Evaporative Water Supply Tank Name	reference		If blank, water supply is from Mains. Names a WaterUse:Storage
`evaporative_condenser_availability_schedule_name` Evaporative Condenser Availability Schedule Name	reference		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. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`end_use_subcategory` End-Use Subcategory	string	`General`	Any text may be used here to categorize the end-uses in the ABUPS End Uses by Subcategory table.
`condenser_refrigerant_operating_charge_inventory` Condenser Refrigerant Operating Charge Inventory	number kg	`0.0`	optional input
`condensate_receiver_refrigerant_inventory` Condensate Receiver Refrigerant Inventory	number kg	`0.0`	optional input
`condensate_piping_refrigerant_inventory` Condensate Piping Refrigerant Inventory	number kg	`0.0`	optional input

Referenced by 3 object types

Coil:Heating:Desuperheater, Coil:WaterHeating:Desuperheater, Refrigeration:System

Refrigeration:Condenser:WaterCooled¶

from idfpy.models import RefrigerationCondenserWaterCooled

Water cooled condenser for a refrigeration system (Refrigeration:System).

Field	Type	Default	Details
`name` Name required	string
`rated_effective_total_heat_rejection_rate` Rated Effective Total Heat Rejection Rate	number W		Rating as per ARI 450 Be sure the rating corresponds to the correct refrigerant not used in calculations, only for identification and output Range: > 0
`rated_condensing_temperature` Rated Condensing Temperature required	number C		must correspond to rating given for total heat rejection effect Range: > 0
`rated_subcooling_temperature_difference` Rated Subcooling Temperature Difference	number deltaC	`0.0`	must correspond to rating given for total heat rejection effect Range: ≥ 0
`rated_water_inlet_temperature` Rated Water Inlet Temperature required	number C		must correspond to rating given for total heat rejection effect Range: > 0
`water_inlet_node_name` Water Inlet Node Name	string
`water_outlet_node_name` Water Outlet Node Name	string
`water_cooled_loop_flow_type` Water-Cooled Loop Flow Type	choice	`VariableFlow`	One of `ConstantFlow`, `VariableFlow`
`water_outlet_temperature_schedule_name` Water Outlet Temperature Schedule Name	reference		Applicable only when loop flow type is Variable Flow. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`water_design_flow_rate` Water Design Flow Rate	number m3/s		note required units must be converted from L/s as specified in ARI 450-2007 Applicable only when loop flow type is Constant Flow. Range: > 0
`water_maximum_flow_rate` Water Maximum Flow Rate	number m3/s		Range: > 0
`water_maximum_water_outlet_temperature` Water Maximum Water Outlet Temperature	number C	`55.0`	Range: ≥ 10, ≤ 60
`water_minimum_water_inlet_temperature` Water Minimum Water Inlet Temperature	number C	`10.0`	related to the minimum allowed refrigeration system condensing temperature Range: ≥ 10, ≤ 30
`end_use_subcategory` End-Use Subcategory	string	`General`	Any text may be used here to categorize the end-uses in the ABUPS End Uses by Subcategory table.
`condenser_refrigerant_operating_charge_inventory` Condenser Refrigerant Operating Charge Inventory	number kg		optional input
`condensate_receiver_refrigerant_inventory` Condensate Receiver Refrigerant Inventory	number kg		optional input
`condensate_piping_refrigerant_inventory` Condensate Piping Refrigerant Inventory	number kg		optional input

Referenced by 5 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, Branch, Coil:Heating:Desuperheater, Coil:WaterHeating:Desuperheater, Refrigeration:System

Refrigeration:GasCooler:AirCooled¶

from idfpy.models import RefrigerationGasCoolerAirCooled

The transcritical refrigeration system requires a single gas cooler to reject the system heat.

Field	Type	Default	Details
`name` Name required	string
`rated_total_heat_rejection_rate_curve_name` Rated Total Heat Rejection Rate Curve Name required	reference		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 Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more
`gas_cooler_fan_speed_control_type` Gas Cooler Fan Speed Control Type	choice	`Fixed`	One of `Fixed`, `FixedLinear`, `TwoSpeed`, `VariableSpeed`
`rated_fan_power` Rated Fan Power	number W	`5000.0`	Power for gas cooler fan(s) corresponding to rated total heat rejection effect. Range: ≥ 0
`minimum_fan_air_flow_ratio` Minimum Fan Air Flow Ratio	number dimensionless	`0.2`	Minimum air flow fraction through gas cooler fan Range: ≥ 0
`transition_temperature` Transition Temperature	number C	`27.0`	Temperature at which system transitions between subcritical and transcritical operation.
`transcritical_approach_temperature` Transcritical Approach Temperature	number deltaC	`3.0`	Temperature difference between the CO2 exiting the gas cooler and the air entering the gas cooler during transcritical operation.
`subcritical_temperature_difference` Subcritical Temperature Difference	number deltaC	`10.0`	Temperature difference between the saturated condensing temperature and the air temperature during subcritical operation.
`minimum_condensing_temperature` Minimum Condensing Temperature	number C	`10.0`	Minimum saturated condensing temperature during subcritical operation.
`air_inlet_node_name` Air Inlet Node Name	string		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).
`end_use_subcategory` End-Use Subcategory	string	`General`	Any text may be used here to categorize the end-uses in the ABUPS End Uses by Subcategory table.
`gas_cooler_refrigerant_operating_charge_inventory` Gas Cooler Refrigerant Operating Charge Inventory	number kg	`0.0`	optional input
`gas_cooler_receiver_refrigerant_inventory` Gas Cooler Receiver Refrigerant Inventory	number kg	`0.0`	optional input
`gas_cooler_outlet_piping_refrigerant_inventory` Gas Cooler Outlet Piping Refrigerant Inventory	number kg	`0.0`	optional input

Referenced by 1 object types

Refrigeration:TranscriticalSystem

Refrigeration:SecondarySystem¶

from idfpy.models import RefrigerationSecondarySystem

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.

Field	Type	Default	Details
`name` Name required	string
`refrigerated_case_or_walkin_or_caseandwalkinlist_name` Refrigerated Case or Walkin or CaseAndWalkInList Name required	reference		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. Names a Refrigeration:AirChiller, Refrigeration:Case, Refrigeration:CaseAndWalkInList, Refrigeration:WalkIn
`circulating_fluid_type` Circulating Fluid Type required	choice		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. One of `FluidAlwaysLiquid`, `FluidPhaseChange`
`circulating_fluid_name` Circulating Fluid Name required	reference		This must correspond to a name in the FluidProperties:Name object. Names a FluidProperties:GlycolConcentration, FluidProperties:Name
`evaporator_capacity` Evaporator Capacity	number W		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. Range: ≥ 0
`evaporator_flow_rate_for_secondary_fluid` Evaporator Flow Rate for Secondary Fluid	number m3/s		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) Range: ≥ 0
`evaporator_evaporating_temperature` Evaporator Evaporating Temperature required	number C		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.
`evaporator_approach_temperature_difference` Evaporator Approach Temperature Difference required	number deltaC		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.
`evaporator_range_temperature_difference` Evaporator Range Temperature Difference	number deltaC		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.
`number_of_pumps_in_loop` Number of Pumps in Loop	integer	`1`
`total_pump_flow_rate` Total Pump Flow Rate	number m3/s		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. Range: ≥ 0
`total_pump_power` Total Pump Power	number W		Either the Total Pump Power or the Total Pump Head is required. Range: ≥ 0
`total_pump_head` Total Pump Head	number Pa		Either the Total Pump Power or the Total Pump Head is required. Range: ≥ 0
`phasechange_circulating_rate` PhaseChange Circulating Rate	number dimensionless	`2.5`	This is the total mass flow at the pump divided by the gaseous mass flow leaving the refrigeration load. Range: ≥ 1
`pump_drive_type` Pump Drive Type	choice	`Constant`	One of `Constant`, `Variable`
`variable_speed_pump_cubic_curve_name` Variable Speed Pump Cubic Curve Name	reference		Variable Speed Pump Curve Name is applicable to variable speed pumps only. Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more
`pump_motor_heat_to_fluid` Pump Motor Heat to Fluid	number dimensionless	`0.85`	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. Range: ≥ 0.5, ≤ 1
`sum_ua_distribution_piping` Sum UA Distribution Piping	number W/K	`0.0`	Use only if you want to include distribution piping heat gain in refrigeration load.
`distribution_piping_zone_name` Distribution Piping Zone Name	reference		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 Names a Zone
`sum_ua_receiver_separator_shell` Sum UA Receiver/Separator Shell	number W/K	`0.0`	Use only if you want to include Receiver/Separator Shell heat gain in refrigeration load.
`receiver_separator_zone_name` Receiver/Separator Zone Name	reference		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 Names a Zone
`evaporator_refrigerant_inventory` Evaporator Refrigerant Inventory	number kg	`0.0`	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.
`end_use_subcategory` End-Use Subcategory	string	`General`	Any text may be used here to categorize the end-uses in the ABUPS End Uses by Subcategory table.

Referenced by 2 object types

Refrigeration:System, Refrigeration:TransferLoadList

Refrigeration:Subcooler¶

from idfpy.models import RefrigerationSubcooler

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.

Field	Type	Default	Details
`name` Name required	string
`subcooler_type` Subcooler Type	choice	`LiquidSuction`	plan to add ambient subcoolers at future time One of `LiquidSuction`, `Mechanical`
`liquid_suction_design_subcooling_temperature_difference` Liquid Suction Design Subcooling Temperature Difference	number deltaC		Applicable only and required for liquid suction heat exchangers design liquid suction subcooling
`design_liquid_inlet_temperature` Design Liquid Inlet Temperature	number C		design inlet temperature on liquid side Applicable only and required for liquid suction heat exchangers (LSHX)
`design_vapor_inlet_temperature` Design Vapor Inlet Temperature	number C		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
`capacity_providing_system` Capacity-Providing System	reference		Name of the Detailed Refrigeration System providing cooling capacity Applicable only and required for mechanical subcoolers Names a Refrigeration:System, Refrigeration:TranscriticalSystem
`outlet_control_temperature` Outlet Control Temperature	number C		Control Temperature Out for subcooled liquid Applicable only and required for mechanical subcoolers

Referenced by 1 object types

Refrigeration:System

Refrigeration:System¶

from idfpy.models import RefrigerationSystem

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.

Field	Type	Default	Details
`name` Name required	string
`refrigerated_case_or_walkin_or_caseandwalkinlist_name` Refrigerated Case or Walkin or CaseAndWalkInList Name	reference		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 Names a Refrigeration:AirChiller, Refrigeration:Case, Refrigeration:CaseAndWalkInList, Refrigeration:WalkIn
`refrigeration_transfer_load_or_transferload_list_name` Refrigeration Transfer Load or TransferLoad List Name	reference		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. Names a Refrigeration:Condenser:Cascade, Refrigeration:SecondarySystem, Refrigeration:TransferLoadList
`refrigeration_condenser_name` Refrigeration Condenser Name required	reference		Names a Refrigeration:Condenser:AirCooled, Refrigeration:Condenser:Cascade, Refrigeration:Condenser:EvaporativeCooled, Refrigeration:Condenser:WaterCooled
`compressor_or_compressorlist_name` Compressor or CompressorList Name required	reference		Names a Refrigeration:Compressor, Refrigeration:CompressorList
`minimum_condensing_temperature` Minimum Condensing Temperature required	number C		related to the proper operation of the thermal expansion valves and compressors
`refrigeration_system_working_fluid_type` Refrigeration System Working Fluid Type required	reference		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 Names a FluidProperties:Name
`suction_temperature_control_type` Suction Temperature Control Type	choice	`ConstantSuctionTemperature`	One of `ConstantSuctionTemperature`, `FloatSuctionTemperature`
`mechanical_subcooler_name` Mechanical Subcooler Name	reference		Optional Field Recipient of refrigeration capacity, that is receives cool liquid from another refrigeration system to help meet aggregate case loads Names a Refrigeration:Subcooler
`liquid_suction_heat_exchanger_subcooler_name` Liquid Suction Heat Exchanger Subcooler Name	reference		Optional Field Liquid Suction Heat Exchanger Name, or leave blank Names a Refrigeration:Subcooler
`sum_ua_suction_piping` Sum UA Suction Piping	number W/K	`0.0`	Use only if you want to include suction piping heat gain in refrigeration load
`suction_piping_zone_name` Suction Piping Zone Name	reference		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 Names a Zone
`end_use_subcategory` End-Use Subcategory	string	`General`	Any text may be used here to categorize the end-uses in the ABUPS End Uses by Subcategory table.
`number_of_compressor_stages` Number of Compressor Stages	`1` or `2`	`1.0`
`intercooler_type` Intercooler Type	choice	`None`	One of `Flash Intercooler`, `None`, `Shell-and-Coil Intercooler`
`shell_and_coil_intercooler_effectiveness` Shell-and-Coil Intercooler Effectiveness	number	`0.8`
`high_stage_compressor_or_compressorlist_name` High-Stage Compressor or CompressorList Name	reference		Names a Refrigeration:Compressor, Refrigeration:CompressorList

Referenced by 1 object types

Refrigeration:Subcooler

Refrigeration:TranscriticalSystem¶

from idfpy.models import RefrigerationTranscriticalSystem

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.

Field	Type	Default	Details
`name` Name required	string
`system_type` System Type required	choice		One of `SingleStage`, `TwoStage`
`medium_temperature_refrigerated_case_or_walkin_or_caseandwalkinlist_name` Medium Temperature Refrigerated Case or Walkin or CaseAndWalkInList Name required	reference		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. Names a Refrigeration:AirChiller, Refrigeration:Case, Refrigeration:CaseAndWalkInList, Refrigeration:WalkIn
`low_temperature_refrigerated_case_or_walkin_or_caseandwalkinlist_name` Low Temperature Refrigerated Case or Walkin or CaseAndWalkInList Name	reference		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. Names a Refrigeration:AirChiller, Refrigeration:Case, Refrigeration:CaseAndWalkInList, Refrigeration:WalkIn
`refrigeration_gas_cooler_name` Refrigeration Gas Cooler Name required	reference		Names a Refrigeration:GasCooler:AirCooled
`high_pressure_compressor_or_compressorlist_name` High Pressure Compressor or CompressorList Name required	reference		Names a Refrigeration:Compressor, Refrigeration:CompressorList
`low_pressure_compressor_or_compressorlist_name` Low Pressure Compressor or CompressorList Name	reference		Names a Refrigeration:Compressor, Refrigeration:CompressorList
`receiver_pressure` Receiver Pressure	number Pa	`4000000.0`
`subcooler_effectiveness` Subcooler Effectiveness	number	`0.4`
`refrigeration_system_working_fluid_type` Refrigeration System Working Fluid Type required	reference		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 Names a FluidProperties:Name
`sum_ua_suction_piping_for_medium_temperature_loads` Sum UA Suction Piping for Medium Temperature Loads	number W/K	`0.0`	Use only if you want to include suction piping heat gain in refrigeration load
`medium_temperature_suction_piping_zone_name` Medium Temperature Suction Piping Zone Name	reference		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 Names a Zone
`sum_ua_suction_piping_for_low_temperature_loads` Sum UA Suction Piping for Low Temperature Loads	number W/K	`0.0`	Use only if you want to include suction piping heat gain in refrigeration load
`low_temperature_suction_piping_zone_name` Low Temperature Suction Piping Zone Name	reference		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 Names a Zone
`end_use_subcategory` End-Use Subcategory	string	`General`	Any text may be used here to categorize the end-uses in the ABUPS End Uses by Subcategory table.

Referenced by 1 object types

Refrigeration:Subcooler

Refrigeration:TransferLoadList¶

from idfpy.models import RefrigerationTransferLoadList extensible

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

Field	Type	Default	Details
`name` Name required	string
`transfer_loads`	list		Each item: `cascade_condenser_name_or_secondary_system_name`

Referenced by 1 object types

Refrigeration:System

Refrigeration:WalkIn¶

from idfpy.models import RefrigerationWalkIn extensible

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.

Field	Type	Default	Details
`name` Name required	string
`availability_schedule_name` Availability Schedule Name	reference		Availability schedule name for this system. Schedule value > 0 means the system is available. If this field is blank, the system is always available. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`rated_coil_cooling_capacity` Rated Coil Cooling Capacity required	number W
`operating_temperature` Operating Temperature required	number C		Range: < 20
`rated_cooling_source_temperature` Rated Cooling Source Temperature required	number C		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 Range: ≥ -70, ≤ 40
`rated_total_heating_power` Rated Total Heating Power required	number W		Include total for all anti-sweat, door, drip-pan, and floor heater power Do not include defrost heater power
`heating_power_schedule_name` Heating Power Schedule Name	reference		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. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`rated_cooling_coil_fan_power` Rated Cooling Coil Fan Power	number W	`375.0`	Range: ≥ 0
`rated_circulation_fan_power` Rated Circulation Fan Power	number W	`0.0`	Range: ≥ 0
`rated_total_lighting_power` Rated Total Lighting Power required	number W		Enter the total (display + task) installed lighting power.
`lighting_schedule_name` Lighting Schedule Name	reference		The schedule should contain values between 0 and 1 Defaults to always on if schedule name left blank. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`defrost_type` Defrost Type	choice	`Electric`	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 One of `Electric`, `HotFluid`, `None`, `OffCycle`
`defrost_control_type` Defrost Control Type	choice	`TimeSchedule`	One of `TemperatureTermination`, `TimeSchedule`
`defrost_schedule_name` Defrost Schedule Name required	reference		The schedule values should be 0 (off) or 1 (on) Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`defrost_drip_down_schedule_name` Defrost Drip-Down Schedule Name	reference		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. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`defrost_power` Defrost Power	number W		needed for all defrost types except none and offcycle Range: ≥ 0
`temperature_termination_defrost_fraction_to_ice` Temperature Termination Defrost Fraction to Ice	number dimensionless		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 Range: > 0, ≤ 1
`restocking_schedule_name` Restocking Schedule Name	reference		Schedule values should be in units of Watts Leave this field blank if no restocking is to be modeled Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`average_refrigerant_charge_inventory` Average Refrigerant Charge Inventory	number kg	`0.0`	This value is only used if the Cooling Source Type is DXEvaporator
`insulated_floor_surface_area` Insulated Floor Surface Area required	number m2		floor area of walk-in cooler Range: > 0
`insulated_floor_u_value` Insulated Floor U-Value	number W/m2-K	`0.3154`	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 Range: > 0
`zone_data`	list		Each item: `zone_name`, `total_insulated_surface_area_facing_zone` (m2), `insulated_surface_u_value_facing_zone` (W/m2-K), `area_of_glass_reach_in_doors_facing_zone` (m2), `height_of_glass_reach_in_doors_facing_zone` (m), `glass_reach_in_door_u_value_facing_zone` (W/m2-K), `glass_reach_in_door_opening_schedule_name_facing_zone`, `area_of_stocking_doors_facing_zone` (m2), `height_of_stocking_doors_facing_zone` (m), `stocking_door_u_value_facing_zone` (W/m2-K), `stocking_door_opening_schedule_name_facing_zone`, `stocking_door_opening_protection_type_facing_zone`

Referenced by 5 object types

Refrigeration:CaseAndWalkInList, Refrigeration:CompressorRack, Refrigeration:SecondarySystem, Refrigeration:System, Refrigeration:TranscriticalSystem

ZoneHVAC:RefrigerationChillerSet¶

from idfpy.models import ZoneHVACRefrigerationChillerSet extensible

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.

Field	Type	Details
`name` Name required	string
`availability_schedule_name` Availability Schedule Name	reference	Availability schedule name for this system. Schedule value > 0 means the system is available. If this field is blank, the system is always available. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`zone_name` Zone Name	reference	This must be a controlled zone and appear in a ZoneHVAC:EquipmentConnections object. Names a Zone
`air_inlet_node_name` Air Inlet Node Name	string	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.
`air_outlet_node_name` Air Outlet Node Name	string	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.
`chillers`	list	Each item: `air_chiller_name`

Referenced by 2 object types

SpaceHVAC:ZoneEquipmentSplitter, ZoneHVAC:EquipmentList