pyidf.condenser_equipment_and_heat_exchangers module

Data objects in group “Condenser Equipment and Heat Exchangers”

class pyidf.condenser_equipment_and_heat_exchangers.CoolingTowerPerformanceCoolTools

Bases: pyidf.helper.DataObject

Corresponds to IDD object CoolingTowerPerformance:CoolTools This object is used to define coefficients for the approach temperature correlation for a variable speed cooling tower when tower Model Type is specified as CoolToolsUserDefined in the object CoolingTower:VariableSpeed.

coefficient_1

field Coefficient 1

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

coefficient_10

field Coefficient 10

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

coefficient_11

field Coefficient 11

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

coefficient_12

field Coefficient 12

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

coefficient_13

field Coefficient 13

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

coefficient_14

field Coefficient 14

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

coefficient_15

field Coefficient 15

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

coefficient_16

field Coefficient 16

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

coefficient_17

field Coefficient 17

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

coefficient_18

field Coefficient 18

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

coefficient_19

field Coefficient 19

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

coefficient_2

field Coefficient 2

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

coefficient_20

field Coefficient 20

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

coefficient_21

field Coefficient 21

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

coefficient_22

field Coefficient 22

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

coefficient_23

field Coefficient 23

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

coefficient_24

field Coefficient 24

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

coefficient_25

field Coefficient 25

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

coefficient_26

field Coefficient 26

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

coefficient_27

field Coefficient 27

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

coefficient_28

field Coefficient 28

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

coefficient_29

field Coefficient 29

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

coefficient_3

field Coefficient 3

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

coefficient_30

field Coefficient 30

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

coefficient_31

field Coefficient 31

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

coefficient_32

field Coefficient 32

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

coefficient_33

field Coefficient 33

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

coefficient_34

field Coefficient 34

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

coefficient_35

field Coefficient 35

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

coefficient_4

field Coefficient 4

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

coefficient_5

field Coefficient 5

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

coefficient_6

field Coefficient 6

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

coefficient_7

field Coefficient 7

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

coefficient_8

field Coefficient 8

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

coefficient_9

field Coefficient 9

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

maximum_approach_temperature

field Maximum Approach Temperature

Maximum valid approach temperature for this correlation.

Units: deltaC

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

maximum_inlet_air_wetbulb_temperature

field Maximum Inlet Air Wet-Bulb Temperature

Maximum valid inlet air wet-bulb temperature for this approach

temperature correlation.

Units: C

Parameters:value (float) – value for IDD Field Maximum Inlet Air Wet-Bulb Temperature Raises:ValueError – if value is not a valid value Returns:the value of maximum_inlet_air_wetbulb_temperature or None if not set Return type:float

maximum_range_temperature

field Maximum Range Temperature

Maximum valid range temperature for this approach temperature

correlation.

Units: deltaC

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

maximum_water_flow_rate_ratio

field Maximum Water Flow Rate Ratio

Maximum valid water flow rate ratio for this approach

temperature correlation.

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

minimum_approach_temperature

field Minimum Approach Temperature

Minimum valid approach temperature for this correlation.

Units: deltaC

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

minimum_inlet_air_wetbulb_temperature

field Minimum Inlet Air Wet-Bulb Temperature

Minimum valid inlet air wet-bulb temperature for this approach

temperature correlation.

Units: C

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

minimum_range_temperature

field Minimum Range Temperature

Minimum valid range temperature for this approach temperature

correlation.

Units: deltaC

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

minimum_water_flow_rate_ratio

field Minimum Water Flow Rate Ratio

Minimum valid water flow rate ratio for this approach

temperature correlation.

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

class pyidf.condenser_equipment_and_heat_exchangers.CoolingTowerPerformanceYorkCalc

Bases: pyidf.helper.DataObject

Corresponds to IDD object CoolingTowerPerformance:YorkCalc This object is used to define coefficients for the approach temperature correlation for a variable speed cooling tower when tower Model Type is specified as YorkCalcUserDefined in the object CoolingTower:VariableSpeed.

coefficient_1

field Coefficient 1

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

coefficient_10

field Coefficient 10

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

coefficient_11

field Coefficient 11

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

coefficient_12

field Coefficient 12

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

coefficient_13

field Coefficient 13

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

coefficient_14

field Coefficient 14

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

coefficient_15

field Coefficient 15

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

coefficient_16

field Coefficient 16

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

coefficient_17

field Coefficient 17

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

coefficient_18

field Coefficient 18

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

coefficient_19

field Coefficient 19

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

coefficient_2

field Coefficient 2

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

coefficient_20

field Coefficient 20

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

coefficient_21

field Coefficient 21

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

coefficient_22

field Coefficient 22

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

coefficient_23

field Coefficient 23

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

coefficient_24

field Coefficient 24

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

coefficient_25

field Coefficient 25

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

coefficient_26

field Coefficient 26

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

coefficient_27

field Coefficient 27

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

coefficient_3

field Coefficient 3

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

coefficient_4

field Coefficient 4

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

coefficient_5

field Coefficient 5

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

coefficient_6

field Coefficient 6

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

coefficient_7

field Coefficient 7

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

coefficient_8

field Coefficient 8

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

coefficient_9

field Coefficient 9

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

maximum_approach_temperature

field Maximum Approach Temperature

Maximum valid approach temperature for this correlation.

Units: deltaC

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

maximum_inlet_air_wetbulb_temperature

field Maximum Inlet Air Wet-Bulb Temperature

Maximum valid inlet air wet-bulb temperature for this approach

temperature correlation.

Units: C

Parameters:value (float) – value for IDD Field Maximum Inlet Air Wet-Bulb Temperature Raises:ValueError – if value is not a valid value Returns:the value of maximum_inlet_air_wetbulb_temperature or None if not set Return type:float

maximum_liquid_to_gas_ratio

field Maximum Liquid to Gas Ratio

Maximum liquid (water) to gas (air) ratio for this approach

temperature correlation.

Parameters:value (float) – value for IDD Field Maximum Liquid to Gas Ratio Raises:ValueError – if value is not a valid value Returns:the value of maximum_liquid_to_gas_ratio or None if not set Return type:float

maximum_range_temperature

field Maximum Range Temperature

Maximum valid range temperature for this approach temperature

correlation.

Units: deltaC

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

maximum_water_flow_rate_ratio

field Maximum Water Flow Rate Ratio

Maximum valid water flow rate ratio for this approach

temperature correlation.

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

minimum_approach_temperature

field Minimum Approach Temperature

Minimum valid approach temperature for this correlation.

Units: deltaC

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

minimum_inlet_air_wetbulb_temperature

field Minimum Inlet Air Wet-Bulb Temperature

Minimum valid inlet air wet-bulb temperature for this approach

temperature correlation.

Units: C

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

minimum_range_temperature

field Minimum Range Temperature

Minimum valid range temperature for this approach temperature

correlation.

Units: deltaC

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

minimum_water_flow_rate_ratio

field Minimum Water Flow Rate Ratio

Minimum valid water flow rate ratio for this approach

temperature correlation.

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

class pyidf.condenser_equipment_and_heat_exchangers.CoolingTowerSingleSpeed

Bases: pyidf.helper.DataObject

Corresponds to IDD object CoolingTower:SingleSpeed This tower model is based on Merkel’s theory, which is also the basis for the tower model in ASHRAE’s HVAC1 Toolkit. The open wet cooling tower is modeled as a counter flow heat exchanger with a single-speed fan drawing air through the tower (induced-draft configuration). Added fluid bypass as an additional capacity control. 8/2008. For a multi-cell tower, the capacity and air/water flow rate inputs are for the entire tower.

basin_heater_capacity

field Basin Heater Capacity

This heater maintains the basin water temperature at the basin heater setpoint

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

The basin heater only operates when water is not flowing through the tower.

Units: W/K

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

basin_heater_operating_schedule_name

field Basin Heater Operating Schedule Name

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

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

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

throughout the entire simulation.

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

basin_heater_setpoint_temperature

field Basin Heater Setpoint Temperature

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

Units: C

Default value: 2.0

value >= 2.0

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

blowdown_calculation_mode

field Blowdown Calculation Mode

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

blowdown_concentration_ratio

field Blowdown Concentration Ratio

Characterizes the rate of blowdown in the cooling tower.

Blowdown is water intentionally drained from the tower in order to offset the build up

of solids in the water that would otherwise occur because of evaporation.

Ratio of solids in the blowdown water to solids in the make up water.

Typical values for tower operation are 3 to 5. The default value is 3.

Default value: 3.0

value >= 2.0

Parameters:value (float) – value for IDD Field Blowdown Concentration Ratio Raises:ValueError – if value is not a valid value Returns:the value of blowdown_concentration_ratio or None if not set Return type:float

blowdown_makeup_water_usage_schedule_name

field Blowdown Makeup Water Usage Schedule Name

Makeup water usage due to blowdown results from occasionally draining a small amount

of water in the tower basin to purge scale or other contaminants to reduce their

concentration in order to maintain an acceptable level of water quality.

Schedule values should reflect water usage in m3/s.

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

capacity_control

field Capacity Control

Default value: FanCycling

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

cell_control

field Cell Control

Default value: MinimalCell

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

cell_maximum_water_flow_rate_fraction

field Cell Maximum Water Flow Rate Fraction

The allowable maximal fraction of the nominal flow rate per cell

Default value: 2.5

value >= 1.0

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

cell_minimum_water_flow_rate_fraction

field Cell Minimum Water Flow Rate Fraction

The allowable minimal fraction of the nominal flow rate per cell

Default value: 0.33

value <= 1.0

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

design_air_flow_rate

field Design Air Flow Rate

Units: m3/s

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

design_fan_power

field Design Fan Power

This is the fan motor electric input power

Units: W

IP-Units: W

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

design_ufactor_times_area_value

field Design U-Factor Times Area Value

Leave field blank if tower performance input method is NominalCapacity

Units: W/K

value <= 2100000.0

Parameters:value (float or “Autosize”) – value for IDD Field Design U-Factor Times Area Value Raises:ValueError – if value is not a valid value Returns:the value of design_ufactor_times_area_value or None if not set Return type:float or “Autosize”

design_water_flow_rate

field Design Water Flow Rate

Leave field blank if tower performance input method is NominalCapacity

Units: m3/s

IP-Units: gal/min

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

drift_loss_percent

field Drift Loss Percent

Rate of drift loss as a percentage of circulating condenser water flow rate

Typical values are between 0.002 and 0.2% The default value is 0.008%

Units: percent

Default value: 0.008

Parameters:value (float) – value for IDD Field Drift Loss Percent Raises:ValueError – if value is not a valid value Returns:the value of drift_loss_percent or None if not set Return type:float

evaporation_loss_factor

field Evaporation Loss Factor

Rate of water evaporation from the cooling tower and lost to the outdoor air [%/K]

Evaporation loss is calculated as percentage of the circulating condenser water rate

Value entered here is percent-per-degree K of temperature drop in the condenser water

Typical values are from 0.15 to 0.27 [%/K].

Units: percent/K

Default value: 0.2

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

evaporation_loss_mode

field Evaporation Loss Mode

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

free_convection_air_flow_rate

field Free Convection Air Flow Rate

Units: m3/s

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

free_convection_air_flow_rate_sizing_factor

field Free Convection Air Flow Rate Sizing Factor

This field is only used if the previous field is set to autocalculate.

Default value: 0.1

value < 1.0

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

free_convection_capacity

field Free Convection Capacity

Tower capacity in free convection regime with entering water at 35C (95F),

leaving water at 29.44C (85F), entering air at 25.56C (78F) wet-bulb temperature

and 35C (95F) dry-bulb temperature. Design water flow rate assumed to be

5.382E-8 m3/s per watt of nominal tower capacity (3 gpm/ton). Tower free

convection capacity times (1.25) gives the actual tower heat rejection at these

operating conditions.

Units: W

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

free_convection_nominal_capacity_sizing_factor

field Free Convection Nominal Capacity Sizing Factor

This field is only used if the previous field is set to autocalculate

Default value: 0.1

value < 1.0

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

free_convection_ufactor_times_area_value

field Free Convection U-Factor Times Area Value

Units: W/K

value <= 300000.0

Parameters:value (float or “Autocalculate”) – value for IDD Field Free Convection U-Factor Times Area Value Raises:ValueError – if value is not a valid value Returns:the value of free_convection_ufactor_times_area_value or None if not set Return type:float or “Autocalculate”

free_convection_ufactor_times_area_value_sizing_factor

field Free Convection U-Factor Times Area Value Sizing Factor

This field is only used if the previous field is set to autocalculate and

the Performance Input Method is UFactorTimesAreaAndDesignWaterFlowRate

Default value: 0.1

value < 1.0

Parameters:value (float) – value for IDD Field Free Convection U-Factor Times Area Value Sizing Factor Raises:ValueError – if value is not a valid value Returns:the value of free_convection_ufactor_times_area_value_sizing_factor or None if not set Return type:float

heat_rejection_capacity_and_nominal_capacity_sizing_ratio

field Heat Rejection Capacity and Nominal Capacity Sizing Ratio

Default value: 1.25

Parameters:value (float) – value for IDD Field Heat Rejection Capacity and Nominal Capacity Sizing Ratio Raises:ValueError – if value is not a valid value Returns:the value of heat_rejection_capacity_and_nominal_capacity_sizing_ratio or None if not set Return type:float

name

field Name

Tower Name

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

nominal_capacity

field Nominal Capacity

Nominal tower capacity with entering water at 35C (95F), leaving water at

29.44C (85F), entering air at 25.56C (78F) wet-bulb temperature and 35C (95F)

dry-bulb temperature. Design water flow rate assumed to be 5.382E-8 m3/s per watt

(3 gpm/ton). Nominal tower capacity times (1.25) gives the actual tower

heat rejection at these operating conditions.

Units: W

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

number_of_cells

field Number of Cells

Default value: 1

value >= 1

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

outdoor_air_inlet_node_name

field Outdoor Air Inlet Node Name

Enter the name of an outdoor air node

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

performance_input_method

field Performance Input Method

User can define tower thermal performance by specifying the tower UA,

the Design Air Flow Rate and the Design Water Flow Rate,

or by specifying the tower nominal capacity

Default value: UFactorTimesAreaAndDesignWaterFlowRate

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

sizing_factor

field Sizing Factor

Multiplies the autosized capacity and flow rates

Default value: 1.0

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

supply_water_storage_tank_name

field Supply Water Storage Tank Name

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

water_inlet_node_name

field Water Inlet Node Name

Name of tower water inlet node

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

water_outlet_node_name

field Water Outlet Node Name

Name of tower water outlet node

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

class pyidf.condenser_equipment_and_heat_exchangers.CoolingTowerTwoSpeed

Bases: pyidf.helper.DataObject

Corresponds to IDD object CoolingTower:TwoSpeed This tower model is based on Merkel’s theory, which is also the basis for the tower model in ASHRAE’s HVAC1 Toolkit. The open wet cooling tower is modeled as a counter flow heat exchanger with a two-speed fan drawing air through the tower (induced-draft configuration). For a multi-cell tower, the capacity and air/water flow rate inputs are for the entire tower.

basin_heater_capacity

field Basin Heater Capacity

This heater maintains the basin water temperature at the basin heater setpoint

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

The basin heater only operates when water is not flowing through the tower.

Units: W/K

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

basin_heater_operating_schedule_name

field Basin Heater Operating Schedule Name

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

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

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

throughout the entire simulation.

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

basin_heater_setpoint_temperature

field Basin Heater Setpoint Temperature

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

Units: C

Default value: 2.0

value >= 2.0

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

blowdown_calculation_mode

field Blowdown Calculation Mode

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

blowdown_concentration_ratio

field Blowdown Concentration Ratio

Characterizes the rate of blowdown in the cooling tower.

Blowdown is water intentionally drained from the tower in order to offset the build up

of solids in the water that would otherwise occur because of evaporation.

Ratio of solids in the blowdown water to solids in the make up water.

Typical values for tower operation are 3 to 5. The default value is 3.

Default value: 3.0

value >= 2.0

Parameters:value (float) – value for IDD Field Blowdown Concentration Ratio Raises:ValueError – if value is not a valid value Returns:the value of blowdown_concentration_ratio or None if not set Return type:float

blowdown_makeup_water_usage_schedule_name

field Blowdown Makeup Water Usage Schedule Name

Makeup water usage due to blowdown results from occasionally draining some amount

of water in the tower basin to purge scale or other contaminants to reduce their

concentration in order to maintain an acceptable level of water quality.

Schedule values should reflect water usage in m3/s.

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

cell_control

field Cell Control

Default value: MinimalCell

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

cell_maximum_water_flow_rate_fraction

field Cell Maximum Water Flow Rate Fraction

The allowable maximal fraction of the nominal flow rate per cell

Default value: 2.5

value >= 1.0

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

cell_minimum_water_flow_rate_fraction

field Cell Minimum Water Flow Rate Fraction

The allowable minimal fraction of the nominal flow rate per cell

Default value: 0.33

value <= 1.0

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

design_water_flow_rate

field Design Water Flow Rate

Leave field blank if Tower Performance Input Method is NominalCapacity

Units: m3/s

IP-Units: gal/min

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

drift_loss_percent

field Drift Loss Percent

Rate of drift loss as a percentage of circulating condenser water flow rate

Typical values are between 0.002 and 0.2% The default value is 0.008%

Units: percent

Default value: 0.008

Parameters:value (float) – value for IDD Field Drift Loss Percent Raises:ValueError – if value is not a valid value Returns:the value of drift_loss_percent or None if not set Return type:float

evaporation_loss_factor

field Evaporation Loss Factor

Rate of water evaporated from the cooling tower and lost to the outdoor air [%/K]

Evaporation loss is calculated as percentage of the circulating condenser water rate

Value entered here is percent-per-degree K of temperature drop in the condenser water

Typical values are from 0.15 to 0.27 [%/K].

Units: percent/K

Default value: 0.2

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

evaporation_loss_mode

field Evaporation Loss Mode

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

free_convection_nominal_capacity

field Free Convection Nominal Capacity

Tower capacity in free convection regime with entering water at 35C (95F),

leaving water at 29.44C (85F), entering air at 25.56C (78F) wet-bulb temperature

and 35C (95F) dry-bulb temperature. Design water flow rate assumed to be

5.382E-8 m3/s per watt of tower high-speed nominal capacity (3 gpm/ton). Tower

free convection capacity times the Heat Rejection Capacity and Nominal Capacity Sizing Ratio

(e.g. 1.25) gives the actual tower heat rejection at these operating conditions

Units: W

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

free_convection_nominal_capacity_sizing_factor

field Free Convection Nominal Capacity Sizing Factor

This field is only used if the previous field is set to autocalculate

Default value: 0.1

value < 1.0

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

free_convection_regime_air_flow_rate

field Free Convection Regime Air Flow Rate

Units: m3/s

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

free_convection_regime_air_flow_rate_sizing_factor

field Free Convection Regime Air Flow Rate Sizing Factor

This field is only used if the previous field is set to autocalculate.

Default value: 0.1

value < 1.0

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

free_convection_regime_ufactor_times_area_value

field Free Convection Regime U-Factor Times Area Value

Leave field blank if Tower Performance Input Method is NominalCapacity

Units: W/K

value <= 300000.0

Parameters:value (float or “Autocalculate”) – value for IDD Field Free Convection Regime U-Factor Times Area Value Raises:ValueError – if value is not a valid value Returns:the value of free_convection_regime_ufactor_times_area_value or None if not set Return type:float or “Autocalculate”

free_convection_ufactor_times_area_value_sizing_factor

field Free Convection U-Factor Times Area Value Sizing Factor

This field is only used if the previous field is set to autocalculate and

the Performance Input Method is UFactorTimesAreaAndDesignWaterFlowRate

Default value: 0.1

value < 1.0

Parameters:value (float) – value for IDD Field Free Convection U-Factor Times Area Value Sizing Factor Raises:ValueError – if value is not a valid value Returns:the value of free_convection_ufactor_times_area_value_sizing_factor or None if not set Return type:float

heat_rejection_capacity_and_nominal_capacity_sizing_ratio

field Heat Rejection Capacity and Nominal Capacity Sizing Ratio

Default value: 1.25

Parameters:value (float) – value for IDD Field Heat Rejection Capacity and Nominal Capacity Sizing Ratio Raises:ValueError – if value is not a valid value Returns:the value of heat_rejection_capacity_and_nominal_capacity_sizing_ratio or None if not set Return type:float

high_fan_speed_air_flow_rate

field High Fan Speed Air Flow Rate

Units: m3/s

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

high_fan_speed_fan_power

field High Fan Speed Fan Power

This is the fan motor electric input power at high speed

Units: W

IP-Units: W

Parameters:value (float or “Autosize”) – value for IDD Field High Fan Speed Fan Power Raises:ValueError – if value is not a valid value Returns:the value of high_fan_speed_fan_power or None if not set Return type:float or “Autosize”

high_fan_speed_ufactor_times_area_value

field High Fan Speed U-Factor Times Area Value

Leave field blank if Tower Performance Input Method is NominalCapacity

Units: W/K

value <= 2100000.0

Parameters:value (float or “Autosize”) – value for IDD Field High Fan Speed U-Factor Times Area Value Raises:ValueError – if value is not a valid value Returns:the value of high_fan_speed_ufactor_times_area_value or None if not set Return type:float or “Autosize”

high_speed_nominal_capacity

field High Speed Nominal Capacity

Nominal tower capacity with entering water at 35C (95F), leaving water at

29.44C (85F), entering air at 25.56C (78F) wet-bulb temperature and 35C (95F)

dry-bulb temperature, with the tower fan operating at high speed. Design water

flow rate assumed to be 5.382E-8 m3/s per watt(3 gpm/ton). Nominal tower capacity

times the Heat Rejection Capacity and Nominal Capacity Sizing Ratio (e.g. 1.25)

gives the actual tower heat rejection at these operating conditions.

Units: W

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

low_fan_speed_air_flow_rate

field Low Fan Speed Air Flow Rate

Low speed air flow rate must be less than high speed air flow rate

Low speed air flow rate must be greater than free convection air flow rate

Units: m3/s

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

low_fan_speed_air_flow_rate_sizing_factor

field Low Fan Speed Air Flow Rate Sizing Factor

This field is only used if the previous field is set to autocalculate.

Default value: 0.5

value < 1.0

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

low_fan_speed_fan_power

field Low Fan Speed Fan Power

This is the fan motor electric input power at low speed

Units: W

IP-Units: W

Parameters:value (float or “Autocalculate”) – value for IDD Field Low Fan Speed Fan Power Raises:ValueError – if value is not a valid value Returns:the value of low_fan_speed_fan_power or None if not set Return type:float or “Autocalculate”

low_fan_speed_fan_power_sizing_factor

field Low Fan Speed Fan Power Sizing Factor

This field is only used if the previous field is set to autocalculate.

Default value: 0.16

value < 1.0

Parameters:value (float) – value for IDD Field Low Fan Speed Fan Power Sizing Factor Raises:ValueError – if value is not a valid value Returns:the value of low_fan_speed_fan_power_sizing_factor or None if not set Return type:float

low_fan_speed_ufactor_times_area_sizing_factor

field Low Fan Speed U-Factor Times Area Sizing Factor

This field is only used if the previous field is set to autocalculate and

the Performance Input Method is UFactorTimesAreaAndDesignWaterFlowRate

Default value: 0.6

value < 1.0

Parameters:value (float) – value for IDD Field Low Fan Speed U-Factor Times Area Sizing Factor Raises:ValueError – if value is not a valid value Returns:the value of low_fan_speed_ufactor_times_area_sizing_factor or None if not set Return type:float

low_fan_speed_ufactor_times_area_value

field Low Fan Speed U-Factor Times Area Value

Leave field blank if tower Performance Input Method is NominalCapacity

Low speed tower UA must be less than high speed tower UA

Low speed tower UA must be greater than free convection tower UA

Units: W/K

value <= 300000.0

Parameters:value (float or “Autocalculate”) – value for IDD Field Low Fan Speed U-Factor Times Area Value Raises:ValueError – if value is not a valid value Returns:the value of low_fan_speed_ufactor_times_area_value or None if not set Return type:float or “Autocalculate”

low_speed_nominal_capacity

field Low Speed Nominal Capacity

Nominal tower capacity with entering water at 35C (95F), leaving water at

29.44C (85F), entering air at 25.56C (78F) wet-bulb temperature and 35C (95F)

dry-bulb temperature, with the tower fan operating at low speed. Design water flow

rate assumed to be 5.382E-8 m3/s per watt of tower high-speed nominal capacity

(3 gpm/ton). Nominal tower capacity times the Heat Rejection Capacity and Nominal

Capacity Sizing Ratio (e.g. 1.25) gives the actual tower heat

rejection at these operating conditions.

Units: W

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

low_speed_nominal_capacity_sizing_factor

field Low Speed Nominal Capacity Sizing Factor

This field is only used if the previous field is set to autocalculate

Default value: 0.5

value < 1.0

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

name

field Name

Tower 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_cells

field Number of Cells

Default value: 1

value >= 1

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

outdoor_air_inlet_node_name

field Outdoor Air Inlet Node Name

Enter the name of an outdoor air node

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

performance_input_method

field Performance Input Method

User can define tower thermal performance by specifying the tower UA,

the Design Air Flow Rate and the Design Water Flow Rate,

or by specifying the tower nominal capacity

Default value: UFactorTimesAreaAndDesignWaterFlowRate

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

sizing_factor

field Sizing Factor

Multiplies the autosized capacity and flow rates

Default value: 1.0

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

supply_water_storage_tank_name

field Supply Water Storage Tank Name

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

water_inlet_node_name

field Water Inlet Node Name

Name of tower Water Inlet Node

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

water_outlet_node_name

field Water Outlet Node Name

Name of tower Water Outlet Node

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

class pyidf.condenser_equipment_and_heat_exchangers.CoolingTowerVariableSpeed

Bases: pyidf.helper.DataObject

Corresponds to IDD object CoolingTower:VariableSpeed This open wet tower model is based on purely empirical algorithms derived from manufacturer’s performance data or field measurements. The user can select from two existing algorithms (CoolTools or YorkCalc), or they can enter their own correlation for approach temperature by using a variable speed tower model coefficient object. For a multi-cell tower, the capacity and air/water flow rate inputs are for the entire tower.

basin_heater_capacity

field Basin Heater Capacity

This heater maintains the basin water temperature at the basin heater setpoint

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

The basin heater only operates when water is not flowing through the tower.

Units: W/K

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

basin_heater_operating_schedule_name

field Basin Heater Operating Schedule Name

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

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

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

throughout the entire simulation.

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

basin_heater_setpoint_temperature

field Basin Heater Setpoint Temperature

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

Units: C

Default value: 2.0

value >= 2.0

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

blowdown_calculation_mode

field Blowdown Calculation Mode

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

blowdown_concentration_ratio

field Blowdown Concentration Ratio

Characterizes the rate of blowdown in the cooling tower.

Blowdown is water intentionally drained from the tower in order to offset the build up

of solids in the water that would otherwise occur because of evaporation.

Ratio of solids in the blowdown water to solids in the make up water.

Typical values for tower operation are 3 to 5. The default value is 3.

Default value: 3.0

value >= 2.0

Parameters:value (float) – value for IDD Field Blowdown Concentration Ratio Raises:ValueError – if value is not a valid value Returns:the value of blowdown_concentration_ratio or None if not set Return type:float

blowdown_makeup_water_usage_schedule_name

field Blowdown Makeup Water Usage Schedule Name

Makeup water usage due to blowdown results from occasionally draining a small amount

of water in the tower basin to purge scale or other contaminants to reduce their

concentration in order to maintain an acceptable level of water quality.

Schedule values should reflect water usage in m3/s.

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

cell_control

field Cell Control

Default value: MinimalCell

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

cell_maximum_water_flow_rate_fraction

field Cell Maximum Water Flow Rate Fraction

The allowable maximal fraction of the nominal flow rate per cell

Default value: 2.5

value >= 1.0

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

cell_minimum_water_flow_rate_fraction

field Cell Minimum Water Flow Rate Fraction

The allowable minimal fraction of the nominal flow rate per cell

Default value: 0.33

value <= 1.0

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

design_air_flow_rate

field Design Air Flow Rate

Design (maximum) air flow rate through the tower

Units: m3/s

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

design_approach_temperature

field Design Approach Temperature

Enter the approach temperature corresponding to the design inlet air

wet-bulb temperature and design range temperature.

Design approach temp = outlet water temperature minus inlet air wet-bulb temperature

at design conditions.

Units: deltaC

Default value: 3.9

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

design_fan_power

field Design Fan Power

Enter the fan motor electric input power at design (max) air flow through the tower

Standard conversion for horsepower is 1 HP = 745.7 W

Units: W

IP-Units: W

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

design_inlet_air_wetbulb_temperature

field Design Inlet Air Wet-Bulb Temperature

Enter the tower’s design inlet air wet-bulb temperature

Units: C

Default value: 25.6

value >= 20.0

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

design_range_temperature

field Design Range Temperature

Enter the range temperature corresponding to the design inlet air

wet-bulb temperature and design approach temperature.

Design range = inlet water temperature minus outlet water temperature

at design conditions.

Units: deltaC

Default value: 5.6

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

design_water_flow_rate

field Design Water Flow Rate

Water flow rate through the tower at design conditions

Units: m3/s

IP-Units: gal/min

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

drift_loss_percent

field Drift Loss Percent

Rate of drift loss as a percentage of circulating condenser water flow rate

Typical values are between 0.002 and 0.2% The default value is 0.008%

Units: percent

Parameters:value (float) – value for IDD Field Drift Loss Percent Raises:ValueError – if value is not a valid value Returns:the value of drift_loss_percent or None if not set Return type:float

evaporation_loss_factor

field Evaporation Loss Factor

Rate of water evaporated from the cooling tower and lost to the outdoor air [%/K]

Evaporation loss is calculated as percentage of the circulating condenser water rate

Value entered here is percent-per-degree K of temperature drop in the condenser water

Typical values are from 0.15 to 0.27 [percent/K].

Units: percent/K

Default value: 0.2

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

evaporation_loss_mode

field Evaporation Loss Mode

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

fan_power_ratio_function_of_air_flow_rate_ratio_curve_name

field Fan Power Ratio Function of Air Flow Rate Ratio Curve Name

FPR = a + b*AFR + c*AFR**2 + d*AFR**3

FPR = fraction of the design fan power

AFR = fraction of the design air flow rate

If left blank, then fan power is assumed to be proportional to

(air flow rate ratio)^3

Parameters:value (str) – value for IDD Field Fan Power Ratio Function of Air Flow Rate Ratio Curve Name Raises:ValueError – if value is not a valid value Returns:the value of fan_power_ratio_function_of_air_flow_rate_ratio_curve_name or None if not set Return type:str

fraction_of_tower_capacity_in_free_convection_regime

field Fraction of Tower Capacity in Free Convection Regime

Enter the fraction of tower capacity in the free convection regime. This is the

fraction of the tower capacity, at the current inlet air wet-bulb temperature,

that is available when the tower fan is off. Manufacturers typically estimate the

free convection capacity at approximately 10-15%. Values are entered as a fraction

and can range from 0 to 0.2.

Default value: 0.125

value <= 0.2

Parameters:value (float) – value for IDD Field Fraction of Tower Capacity in Free Convection Regime Raises:ValueError – if value is not a valid value Returns:the value of fraction_of_tower_capacity_in_free_convection_regime or None if not set Return type:float

minimum_air_flow_rate_ratio

field Minimum Air Flow Rate Ratio

Enter the minimum air flow rate ratio. This is typically determined by the variable

speed drive that controls the fan motor speed. Valid entries are from 0.2 to 0.5.

Default value: 0.2

value >= 0.2

value <= 0.5

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

model_coefficient_name

field Model Coefficient Name

Name of the tower model coefficient object.

Used only when tower Model Type is either CoolToolsUserDefined or YorkCalcUserDefined.

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

model_type

field Model Type

Determines the coefficients and form of the equation for calculating

approach temperature

Default value: YorkCalc

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

name

field Name

Tower 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_cells

field Number of Cells

Default value: 1

value >= 1

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

outdoor_air_inlet_node_name

field Outdoor Air Inlet Node Name

Enter the name of an outdoor air node

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

sizing_factor

field Sizing Factor

Multiplies the autosized capacity and flow rates

Default value: 1.0

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

supply_water_storage_tank_name

field Supply Water Storage Tank Name

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

water_inlet_node_name

field Water Inlet Node Name

Name of tower water inlet node

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

water_outlet_node_name

field Water Outlet Node Name

Name of tower water outlet node

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

class pyidf.condenser_equipment_and_heat_exchangers.CoolingTowerVariableSpeedMerkel

Bases: pyidf.helper.DataObject

Corresponds to IDD object CoolingTower:VariableSpeed:Merkel This tower model is based on Merkel’s theory, which is also the basis for the tower model in ASHRAE’s HVAC1 Toolkit. The open wet cooling tower is modeled as a counter flow heat exchanger with a variable-speed fan drawing air through the tower (induced-draft configuration). For a multi-cell tower, the capacity and air/water flow rate inputs are for the entire tower.

basin_heater_capacity

field Basin Heater Capacity

This heater maintains the basin water temperature at the basin heater setpoint

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

The basin heater only operates when water is not flowing through the tower.

Units: W/K

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

basin_heater_operating_schedule_name

field Basin Heater Operating Schedule Name

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

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

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

throughout the entire simulation.

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

basin_heater_setpoint_temperature

field Basin Heater Setpoint Temperature

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

Units: C

Default value: 2.0

value >= 2.0

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

blowdown_calculation_mode

field Blowdown Calculation Mode

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

blowdown_concentration_ratio

field Blowdown Concentration Ratio

Characterizes the rate of blowdown in the cooling tower.

Blowdown is water intentionally drained from the tower in order to offset the build up

of solids in the water that would otherwise occur because of evaporation.

Ratio of solids in the blowdown water to solids in the make up water.

Typical values for tower operation are 3 to 5. The default value is 3.

Default value: 3.0

value >= 2.0

Parameters:value (float) – value for IDD Field Blowdown Concentration Ratio Raises:ValueError – if value is not a valid value Returns:the value of blowdown_concentration_ratio or None if not set Return type:float

blowdown_makeup_water_usage_schedule_name

field Blowdown Makeup Water Usage Schedule Name

Makeup water usage due to blowdown results from occasionally draining some amount

of water in the tower basin to purge scale or other contaminants to reduce their

concentration in order to maintain an acceptable level of water quality.

Schedule values should reflect water usage in m3/s.

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

cell_control

field Cell Control

Default value: MinimalCell

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

cell_maximum_water_flow_rate_fraction

field Cell Maximum Water Flow Rate Fraction

The allowable maximal fraction of the nominal flow rate per cell

Default value: 2.5

value >= 1.0

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

cell_minimum_water_flow_rate_fraction

field Cell Minimum Water Flow Rate Fraction

The allowable minimal fraction of the nominal flow rate per cell

Default value: 0.33

value <= 1.0

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

design_air_flow_rate

field Design Air Flow Rate

This is the air flow rate at full fan speed

Units: m3/s

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

design_air_flow_rate_per_unit_of_nominal_capacity

field Design Air Flow Rate Per Unit of Nominal Capacity

This field is only used if the previous is set to autocalculate

When field is left blank the default scaling factor is adjusted for elevation to increase volume flow at altitude

When field has a value the scaling factor is used without adjusting for elevation

Units: m3/s-W

Default value: 2.76316e-05

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

design_air_flow_rate_ufactor_times_area_value

field Design Air Flow Rate U-Factor Times Area Value

required field when performance method is UFactorTimesAreaAndDesignWaterFlowRate

when performance method is NominalCapacity the program will solve for this UA

Units: W/K

Parameters:value (float or “Autosize”) – value for IDD Field Design Air Flow Rate U-Factor Times Area Value Raises:ValueError – if value is not a valid value Returns:the value of design_air_flow_rate_ufactor_times_area_value or None if not set Return type:float or “Autosize”

design_fan_power

field Design Fan Power

This is the fan motor electric input power at high speed

Units: W

IP-Units: W

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

design_fan_power_per_unit_of_nominal_capacity

field Design Fan Power Per Unit of Nominal Capacity

This field is only used if the previous is set to autocalculate

[W/W] Watts of fan power per Watt of tower nominal capacity

Units: dimensionless

Default value: 0.0105

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

design_water_flow_rate

field Design Water Flow Rate

Units: m3/s

IP-Units: gal/min

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

design_water_flow_rate_per_unit_of_nominal_capacity

field Design Water Flow Rate per Unit of Nominal Capacity

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

Units: m3/s-W

Default value: 5.382e-08

Parameters:value (float) – value for IDD Field Design Water Flow Rate per Unit of Nominal Capacity Raises:ValueError – if value is not a valid value Returns:the value of design_water_flow_rate_per_unit_of_nominal_capacity or None if not set Return type:float

drift_loss_percent

field Drift Loss Percent

Rate of drift loss as a percentage of circulating condenser water flow rate

Typical values are between 0.002 and 0.2% The default value is 0.008%

Units: percent

Default value: 0.008

Parameters:value (float) – value for IDD Field Drift Loss Percent Raises:ValueError – if value is not a valid value Returns:the value of drift_loss_percent or None if not set Return type:float

evaporation_loss_factor

field Evaporation Loss Factor

Rate of water evaporated from the cooling tower and lost to the outdoor air [%/K]

Evaporation loss is calculated as percentage of the circulating condenser water rate

Value entered here is percent-per-degree K of temperature drop in the condenser water

Typical values are from 0.15 to 0.27 [%/K].

Units: percent/K

Default value: 0.2

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

evaporation_loss_mode

field Evaporation Loss Mode

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

fan_power_modifier_function_of_air_flow_rate_ratio_curve_name

field Fan Power Modifier Function of Air Flow Rate Ratio Curve Name

Any curve or table with one independent variable can be used

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

quartic curve = a + b*AFR + c*AFR**2 + d*AFR**3 + e*AFR**4

x = AFR = Ratio of current operating air flow rate to Design Air Flow Rate

Parameters:value (str) – value for IDD Field Fan Power Modifier Function of Air Flow Rate Ratio Curve Name Raises:ValueError – if value is not a valid value Returns:the value of fan_power_modifier_function_of_air_flow_rate_ratio_curve_name or None if not set Return type:str

free_convection_nominal_capacity

field Free Convection Nominal Capacity

required field when performance method is NominalCapacity

Tower capacity in free convection regime with entering water at 35C (95F),

leaving water at 29.44C (85F), entering air at 25.56C (78F) wet-bulb temperature

and 35C (95F) dry-bulb temperature. Design water flow rate is as set

in Design Water Flow Rate per Unit of Nominal Capacity. Tower

free convection capacity times the Heat Rejection Capacity and Nominal Capacity Sizing Ratio

(e.g. 1.25) gives the actual tower heat rejection at these operating conditions

Units: W

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

free_convection_nominal_capacity_sizing_factor

field Free Convection Nominal Capacity Sizing Factor

This field is only used if the previous field is set to autocalculate

Default value: 0.1

value < 1.0

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

free_convection_regime_air_flow_rate

field Free Convection Regime Air Flow Rate

Units: m3/s

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

free_convection_regime_air_flow_rate_sizing_factor

field Free Convection Regime Air Flow Rate Sizing Factor

This field is only used if the previous field is set to autocalculate.

Default value: 0.1

value < 1.0

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

free_convection_regime_ufactor_times_area_value

field Free Convection Regime U-Factor Times Area Value

required field when performance input method is UFactorTimesAreaAndDesignWaterFlowRate

Leave field blank if performance input method is NominalCapacity

Units: W/K

value <= 300000.0

Parameters:value (float or “Autocalculate”) – value for IDD Field Free Convection Regime U-Factor Times Area Value Raises:ValueError – if value is not a valid value Returns:the value of free_convection_regime_ufactor_times_area_value or None if not set Return type:float or “Autocalculate”

free_convection_ufactor_times_area_value_sizing_factor

field Free Convection U-Factor Times Area Value Sizing Factor

required field when performance input method is UFactorTimesAreaAndDesignWaterFlowRate

This field is only used if the previous field is set to autocalculate and

the performance input method is UFactorTimesAreaAndDesignWaterFlowRate

Default value: 0.1

value < 1.0

Parameters:value (float) – value for IDD Field Free Convection U-Factor Times Area Value Sizing Factor Raises:ValueError – if value is not a valid value Returns:the value of free_convection_ufactor_times_area_value_sizing_factor or None if not set Return type:float

heat_rejection_capacity_and_nominal_capacity_sizing_ratio

field Heat Rejection Capacity and Nominal Capacity Sizing Ratio

Default value: 1.25

Parameters:value (float) – value for IDD Field Heat Rejection Capacity and Nominal Capacity Sizing Ratio Raises:ValueError – if value is not a valid value Returns:the value of heat_rejection_capacity_and_nominal_capacity_sizing_ratio or None if not set Return type:float

minimum_air_flow_rate_ratio

field Minimum Air Flow Rate Ratio

Enter the minimum air flow rate ratio. This is typically determined by the variable

speed drive that controls the fan motor speed. Valid entries are from 0.1 to 0.5.

Default value: 0.2

value >= 0.1

value <= 0.5

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

name

field Name

Tower Name

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

nominal_capacity

field Nominal Capacity

Nominal tower capacity with entering water at 35C (95F), leaving water at

29.44C (85F), entering air at 25.56C (78F) wet-bulb temperature and 35C (95F)

dry-bulb temperature, with the tower fan operating at Design Air Flow Rate (full speed). Design water

flow rate is as set in Design Water Flow Rate per Unit of Nominal Capacity. Nominal tower capacity

times the Heat Rejection Capacity and Nominal Capacity Sizing Ratio (e.g. 1.25)

gives the actual tower heat rejection at these operating conditions.

Units: W

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

number_of_cells

field Number of Cells

Default value: 1

value >= 1

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

outdoor_air_inlet_node_name

field Outdoor Air Inlet Node Name

Enter the name of an outdoor air node

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

performance_input_method

field Performance Input Method

User can define tower thermal performance by specifying the tower UA,

the Design Air Flow Rate and the Design Water Flow Rate,

or by specifying the tower nominal capacity

Default value: NominalCapacity

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

sizing_factor

field Sizing Factor

Multiplies the autosized capacity and flow rates

Default value: 1.0

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

supply_water_storage_tank_name

field Supply Water Storage Tank Name

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

ufactor_times_area_modifier_function_of_air_flow_ratio_curve_name

field U-Factor Times Area Modifier Function of Air Flow Ratio Curve Name

This curve describes how tower’s design UA changes with variable air flow rate

Any curve or table with one independent variable can be used

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

quartic curve = a + b*AFR + c*AFR**2 + d*AFR**3 + e*AFR**4

x = AFR = Ratio of current operating air flow rate to Design Air Flow Rate

Parameters:value (str) – value for IDD Field U-Factor Times Area Modifier Function of Air Flow Ratio Curve Name Raises:ValueError – if value is not a valid value Returns:the value of ufactor_times_area_modifier_function_of_air_flow_ratio_curve_name or None if not set Return type:str

ufactor_times_area_modifier_function_of_water_flow_ratio_curve_name

field U-Factor Times Area Modifier Function of Water Flow Ratio Curve Name

curve describes how tower UA changes with the flow rate of condenser water through the tower

Any curve or table with one independent variable can be used

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

quartic curve = a + b*WFR + c*WFR**2 + d*WFR**3 + e*WFR**4

x = WFR = Ratio of current operating water flow rate to Design Water Flow Rate

Parameters:value (str) – value for IDD Field U-Factor Times Area Modifier Function of Water Flow Ratio Curve Name Raises:ValueError – if value is not a valid value Returns:the value of ufactor_times_area_modifier_function_of_water_flow_ratio_curve_name or None if not set Return type:str

ufactor_times_area_modifier_function_of_wetbulb_temperature_difference_curve_name

field U-Factor Times Area Modifier Function of Wetbulb Temperature Difference Curve Name

curve describes how tower UA changes with outdoor air wet-bulb temperature difference from design wet-bulb

Any curve or table with one independent variable can be used

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

quartic curve = a + b*DeltaWB + c*DeltaWB**2 + d*DeltaWB**3 + e*DeltaWB**4

x = DeltaWB = (design wet-bulb temperature in C - current wet-bulb temperature in C)

where design wet-bulb temperature of entering air is 25.56C (78F)

Parameters:value (str) – value for IDD Field U-Factor Times Area Modifier Function of Wetbulb Temperature Difference Curve Name Raises:ValueError – if value is not a valid value Returns:the value of ufactor_times_area_modifier_function_of_wetbulb_temperature_difference_curve_name or None if not set Return type:str

water_inlet_node_name

field Water Inlet Node Name

Name of tower water inlet node

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

water_outlet_node_name

field Water Outlet Node Name

Name of tower water outlet node

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

class pyidf.condenser_equipment_and_heat_exchangers.EvaporativeFluidCoolerSingleSpeed

Bases: pyidf.helper.DataObject

Corresponds to IDD object EvaporativeFluidCooler:SingleSpeed This model is based on Merkel’s theory, which is also the basis for the cooling tower model in EnergyPlus. The Evaporative fluid cooler is modeled as a counter flow heat exchanger.

blowdown_calculation_mode

field Blowdown Calculation Mode

Default value: ConcentrationRatio

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

blowdown_concentration_ratio

field Blowdown Concentration Ratio

Characterizes the rate of blowdown in the Evaporative Fluid Cooler.

Blowdown is water intentionally drained from the basin in order to offset the build

up of solids in the water that would otherwise occur because of evaporation.

Ratio of solids in the blowdown water to solids in the make up water.

Default value for this field in under investigation. For now Cooling tower’s

Blowdown Concentration Ratio percent default value is taken here.

Default value: 3.0

value >= 2.0

Parameters:value (float) – value for IDD Field Blowdown Concentration Ratio Raises:ValueError – if value is not a valid value Returns:the value of blowdown_concentration_ratio or None if not set Return type:float

blowdown_makeup_water_usage_schedule_name

field Blowdown Makeup Water Usage Schedule Name

Makeup water usage due to blowdown results from occasionally draining a small

amount of water in the Fluid Cooler basin to purge scale or other contaminants to

reduce their concentration in order to maintain an acceptable level of water quality.

Schedule values should reflect water usage in m3/s.

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

capacity_control

field Capacity Control

Default value: FanCycling

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

design_air_flow_rate

field Design Air Flow Rate

Units: m3/s

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

design_air_flow_rate_fan_power

field Design Air Flow Rate Fan Power

This is the fan motor electric input power

Units: W

IP-Units: W

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

design_air_flow_rate_ufactor_times_area_value

field Design Air Flow Rate U-factor Times Area Value

Only used for Performance Input Method = UFactorTimesAreaAndDesignWaterFlowRate;

for other Performance Input Methods, this field is ignored.

Units: W/K

value <= 2100000.0

Parameters:value (float or “Autosize”) – value for IDD Field Design Air Flow Rate U-factor Times Area Value Raises:ValueError – if value is not a valid value Returns:the value of design_air_flow_rate_ufactor_times_area_value or None if not set Return type:float or “Autosize”

design_entering_air_temperature

field Design Entering Air Temperature

Only used for Performance Input Method = UserSpecifiedDesignCapacity;

for other Performance Input Methods, this field is ignored.

Design Entering Air Temperature must be greater than Design Entering Air Wet-bulb

Temperature.

Units: C

IP-Units: F

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

design_entering_air_wetbulb_temperature

field Design Entering Air Wet-bulb Temperature

Only used for Performance Input Method = UserSpecifiedDesignCapacity;

for other Performance Input Methods, this field is ignored.

Design Entering Air Wet-bulb Temperature must be less than Design Entering Air

Temperature.

Units: C

IP-Units: F

Parameters:value (float) – value for IDD Field Design Entering Air Wet-bulb Temperature Raises:ValueError – if value is not a valid value Returns:the value of design_entering_air_wetbulb_temperature or None if not set Return type:float

design_entering_water_temperature

field Design Entering Water Temperature

Only used for Performance Input Method = UserSpecifiedDesignCapacity;

for other Performance Input Methods, this field is ignored.

Design Entering Water Temperature must be greater than Design Entering Air Temperature.

Units: C

IP-Units: F

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

design_spray_water_flow_rate

field Design Spray Water Flow Rate

Units: m3/s

IP-Units: gal/min

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

design_water_flow_rate

field Design Water Flow Rate

Input value is ignored if fluid cooler Performance Input Method= StandardDesignCapacity.

Units: m3/s

IP-Units: gal/min

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

drift_loss_percent

field Drift Loss Percent

Rate of drift loss as a percentage of circulating spray water flow rate

Default value for this field in under investigation. For now Cooling tower’s drift loss

percent default value is taken here.

Units: percent

Default value: 0.008

Parameters:value (float) – value for IDD Field Drift Loss Percent Raises:ValueError – if value is not a valid value Returns:the value of drift_loss_percent or None if not set Return type:float

evaporation_loss_factor

field Evaporation Loss Factor

Rate of water evaporation from the Fluid Cooler and lost to the outdoor air [%/K]

Empirical correlation is used to calculate default loss factor if it not explicitly provided.

Units: percent/K

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

evaporation_loss_mode

field Evaporation Loss Mode

Default value: SaturatedExit

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

heat_rejection_capacity_and_nominal_capacity_sizing_ratio

field Heat Rejection Capacity and Nominal Capacity Sizing Ratio

Default value: 1.25

Parameters:value (float) – value for IDD Field Heat Rejection Capacity and Nominal Capacity Sizing Ratio Raises:ValueError – if value is not a valid value Returns:the value of heat_rejection_capacity_and_nominal_capacity_sizing_ratio or None if not set Return type:float

name

field Name

Fluid Cooler Name

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

outdoor_air_inlet_node_name

field Outdoor Air Inlet Node Name

Enter the name of an outdoor air node

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

performance_input_method

field Performance Input Method

User can define fluid cooler thermal performance by specifying the fluid cooler UA

and the Design Water Flow Rate, or by specifying the fluid cooler Standard Design

Capacity or by specifying Design Capacity for Non standard conditions.

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

sizing_factor

field Sizing Factor

Multiplies the autosized capacity and flow rates

Default value: 1.0

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

standard_design_capacity

field Standard Design Capacity

Standard design capacity with entering water at 35C (95F), leaving water at

29.44C (85F), entering air at 25.56C (78F) wet-bulb temperature and 35C (95F)

dry-bulb temperature. Design water flow rate assumed to be 5.382E-8 m3/s per watt

(3 gpm/ton). Standard design capacity times the Heat Rejection Capacity and

Nominal Capacity Sizing Ratio (e.g. 1.25) gives the actual fluid cooler

heat rejection at these operating conditions.

Only used for Performance Input Method = StandardDesignCapacity;

for other input methods, this field is ignored.

The standard conditions mentioned above for Standard design capacity are already

specified in the EnergyPlus. So the input fields such as design entering water

temp., design entering air wet-bulb and dry-bulb temp. and design water flow rate, if

provided in the input, will be ignored for the StandardDesignCapacity performance input

method. Also, the standard conditions are for water as a fluid type so this performance input

method can only be used with water as a fluid type (as specified in CondenserLoop object).

Units: W

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

supply_water_storage_tank_name

field Supply Water Storage Tank Name

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

user_specified_design_capacity

field User Specified Design Capacity

Only used for Performance Input Method = UserSpecifiedDesignCapacity;

for other Performance Input Methods, this field is ignored.

Units: W

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

water_inlet_node_name

field Water Inlet Node Name

Name of Fluid Cooler water inlet node

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

water_outlet_node_name

field Water Outlet Node Name

Name of Fluid Cooler water outlet node

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

class pyidf.condenser_equipment_and_heat_exchangers.EvaporativeFluidCoolerTwoSpeed

Bases: pyidf.helper.DataObject

Corresponds to IDD object EvaporativeFluidCooler:TwoSpeed This model is based on Merkel’s theory, which is also the basis for the cooling tower model in EnergyPlus. The Evaporative fluid cooler is modeled as a counter flow heat exchanger.

blowdown_calculation_mode

field Blowdown Calculation Mode

Default value: ConcentrationRatio

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

blowdown_concentration_ratio

field Blowdown Concentration Ratio

Characterizes the rate of blowdown in the Evaporative Fluid Cooler.

Blowdown is water intentionally drained from the Evaporative Fluid Cooler in order to offset the

build up of solids in the water that would otherwise occur because of evaporation.

Ratio of solids in the blowdown water to solids in the make up water.

Default value is under investigation. For now cooling tower’s default value is taken.

Default value: 3.0

value >= 2.0

Parameters:value (float) – value for IDD Field Blowdown Concentration Ratio Raises:ValueError – if value is not a valid value Returns:the value of blowdown_concentration_ratio or None if not set Return type:float

blowdown_makeup_water_usage_schedule_name

field Blowdown Makeup Water Usage Schedule Name

Makeup water usage due to blowdown results from occasionally draining some amount

of water in the Evaporative Fluid Cooler basin to purge scale or other contaminants to reduce

their concentration in order to maintain an acceptable level of water quality.

Schedule values should reflect water usage in m3/s.

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

design_entering_air_temperature

field Design Entering Air Temperature

Only used for Performance Input Method = UserSpecifiedDesignCapacity;

for other Performance Input Methods, this field is ignored.

Design Entering Air Temperature must be greater than Design Entering Air Wet-bulb

Temperature.

Units: C

IP-Units: F

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

design_entering_air_wetbulb_temperature

field Design Entering Air Wet-bulb Temperature

Only used for Performance Input Method = UserSpecifiedDesignCapacity;

for other Performance Input Methods, this field is ignored.

Design Entering Air Wet-bulb Temperature must be less than Design Entering Air

Temperature.

Units: C

IP-Units: F

Parameters:value (float) – value for IDD Field Design Entering Air Wet-bulb Temperature Raises:ValueError – if value is not a valid value Returns:the value of design_entering_air_wetbulb_temperature or None if not set Return type:float

design_entering_water_temperature

field Design Entering Water Temperature

Only used for Performance Input Method = UserSpecifiedDesignCapacity;

for other Performance Input Methods, this field is ignored.

Design Entering Water Temperature must be greater than Design Entering Air Temperature.

Units: C

IP-Units: F

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

design_spray_water_flow_rate

field Design Spray Water Flow Rate

Units: m3/s

IP-Units: gal/min

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

design_water_flow_rate

field Design Water Flow Rate

Input value is ignored if fluid cooler Performance Input Method= StandardDesignCapacity

Units: m3/s

IP-Units: gal/min

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

drift_loss_percent

field Drift Loss Percent

Default value is under investigation. For now cooling tower’s default value is taken.

Units: percent

Default value: 0.008

Parameters:value (float) – value for IDD Field Drift Loss Percent Raises:ValueError – if value is not a valid value Returns:the value of drift_loss_percent or None if not set Return type:float

evaporation_loss_factor

field Evaporation Loss Factor

Rate of water evaporation from the Fluid Cooler and lost to the outdoor air [%/K]

Empirical correlation is used to calculate default loss factor if it not explicitly provided.

Units: percent/K

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

evaporation_loss_mode

field Evaporation Loss Mode

Default value: SaturatedExit

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

heat_rejection_capacity_and_nominal_capacity_sizing_ratio

field Heat Rejection Capacity and Nominal Capacity Sizing Ratio

Default value: 1.25

Parameters:value (float) – value for IDD Field Heat Rejection Capacity and Nominal Capacity Sizing Ratio Raises:ValueError – if value is not a valid value Returns:the value of heat_rejection_capacity_and_nominal_capacity_sizing_ratio or None if not set Return type:float

high_fan_speed_air_flow_rate

field High Fan Speed Air Flow Rate

Units: m3/s

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

high_fan_speed_fan_power

field High Fan Speed Fan Power

This is the fan motor electric input power at high speed

Units: W

IP-Units: W

Parameters:value (float or “Autosize”) – value for IDD Field High Fan Speed Fan Power Raises:ValueError – if value is not a valid value Returns:the value of high_fan_speed_fan_power or None if not set Return type:float or “Autosize”

high_fan_speed_ufactor_times_area_value

field High Fan Speed U-factor Times Area Value

Only used for Performance Input Method = UFactorTimesAreaAndDesignWaterFlowRate;

for other Performance Input Methods, this field is ignored.

Units: W/K

value <= 2100000.0

Parameters:value (float or “Autosize”) – value for IDD Field High Fan Speed U-factor Times Area Value Raises:ValueError – if value is not a valid value Returns:the value of high_fan_speed_ufactor_times_area_value or None if not set Return type:float or “Autosize”

high_speed_sizing_factor

field High Speed Sizing Factor

Multiplies the autosized capacity and flow rates

Default value: 1.0

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

high_speed_standard_design_capacity

field High Speed Standard Design Capacity

Standard design capacity with entering water at 35C (95F), leaving water at

29.44C (85F), entering air at 25.56C (78F) wet-bulb temperature and 35C (95F)

dry-bulb temperature. Design water flow rate assumed to be 5.382E-8 m3/s per watt

(3 gpm/ton). Standard design capacity times the Heat Rejection Capacity and

Nominal Capacity Sizing Ratio (e.g. 1.25) gives the actual fluid cooler

heat rejection at these operating conditions.

Only used for Performance Input Method = StandardDesignCapacity;

for other input methods, this field is ignored.

The standard conditions mentioned above for Standard design capacity are already

specified in the EnergyPlus. So the input fields such as design entering water

temp., design entering air wet-bulb and dry-bulb temp. and design water flow rate, if

provided in the input, will be ignored for the StandardDesignCapacity performance input

method. Also, the standard conditions are for water as a fluid type so this performance input

method can only be used with water as a fluid type (as specified in CondenserLoop object).

Units: W

Parameters:value (float) – value for IDD Field High Speed Standard Design Capacity Raises:ValueError – if value is not a valid value Returns:the value of high_speed_standard_design_capacity or None if not set Return type:float

high_speed_user_specified_design_capacity

field High Speed User Specified Design Capacity

Only used for Performance Input Method = UserSpecifiedDesignCapacity;

for other Performance Input Methods, this field is ignored.

Units: W

Parameters:value (float) – value for IDD Field High Speed User Specified Design Capacity Raises:ValueError – if value is not a valid value Returns:the value of high_speed_user_specified_design_capacity or None if not set Return type:float

low_fan_speed_air_flow_rate

field Low Fan Speed Air Flow Rate

Low speed air flow rate must be less than high speed air flow rate

Units: m3/s

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

low_fan_speed_air_flow_rate_sizing_factor

field Low Fan Speed Air Flow Rate Sizing Factor

This field is only used if the previous field is set to autocalculate

Default value: 0.5

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

low_fan_speed_fan_power

field Low Fan Speed Fan Power

This is the fan motor electric input power at low speed

Units: W

IP-Units: W

Parameters:value (float or “Autocalculate”) – value for IDD Field Low Fan Speed Fan Power Raises:ValueError – if value is not a valid value Returns:the value of low_fan_speed_fan_power or None if not set Return type:float or “Autocalculate”

low_fan_speed_fan_power_sizing_factor

field Low Fan Speed Fan Power Sizing Factor

This field is only used if the previous field is set to autocalculate.

Default value: 0.16

Parameters:value (float) – value for IDD Field Low Fan Speed Fan Power Sizing Factor Raises:ValueError – if value is not a valid value Returns:the value of low_fan_speed_fan_power_sizing_factor or None if not set Return type:float

low_fan_speed_ufactor_times_area_sizing_factor

field Low Fan Speed U-Factor Times Area Sizing Factor

This field is only used if the previous field is set to autocalculate and

the Performance Input Method is UFactorTimesAreaAndDesignWaterFlowRate

Default value: 0.6

Parameters:value (float) – value for IDD Field Low Fan Speed U-Factor Times Area Sizing Factor Raises:ValueError – if value is not a valid value Returns:the value of low_fan_speed_ufactor_times_area_sizing_factor or None if not set Return type:float

low_fan_speed_ufactor_times_area_value

field Low Fan Speed U-factor Times Area Value

Only used for Performance Input Method = UFactorTimesAreaAndDesignWaterFlowRate;

for other input methods, this field is ignored.

Low speed fluid cooler UA must be less than high speed fluid cooler UA

Units: W/K

value <= 300000.0

Parameters:value (float or “Autocalculate”) – value for IDD Field Low Fan Speed U-factor Times Area Value Raises:ValueError – if value is not a valid value Returns:the value of low_fan_speed_ufactor_times_area_value or None if not set Return type:float or “Autocalculate”

low_speed_standard_capacity_sizing_factor

field Low Speed Standard Capacity Sizing Factor

This field is only used if the previous field is set to autocalculate

Default value: 0.5

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

low_speed_standard_design_capacity

field Low Speed Standard Design Capacity

Standard design capacity with entering water at 35C (95F), leaving water at

29.44C (85F), entering air at 25.56C (78F) wet-bulb temperature and 35C (95F)

dry-bulb temperature. Design water flow rate assumed to be 5.382E-8 m3/s per watt

(3 gpm/ton). Standard design capacity times the Heat Rejection Capacity and

Nominal Capacity Sizing Ratio (e.g. 1.25) gives the actual fluid cooler

heat rejection at these operating conditions.

Only used for Performance Input Method = StandardDesignCapacity;

for other input methods, this field is ignored.

The standard conditions mentioned above for Standard design capacity are already

specified in the EnergyPlus. So the input fields such as design entering water

temp., design entering air wet-bulb and dry-bulb temp. and design water flow rate, if

provided in the input, will be ignored for the StandardDesignCapacity performance input

method. Also, the standard conditions are for water as a fluid type so this performance input

method can only be used with water as a fluid type (as specified in CondenserLoop object).

Units: W

Parameters:value (float or “Autocalculate”) – value for IDD Field Low Speed Standard Design Capacity Raises:ValueError – if value is not a valid value Returns:the value of low_speed_standard_design_capacity or None if not set Return type:float or “Autocalculate”

low_speed_user_specified_design_capacity

field Low Speed User Specified Design Capacity

Only used for Performance Input Method = UserSpecifiedDesignCapacity;

for other Performance Input Methods, this field is ignored.

Units: W

Parameters:value (float or “Autocalculate”) – value for IDD Field Low Speed User Specified Design Capacity Raises:ValueError – if value is not a valid value Returns:the value of low_speed_user_specified_design_capacity or None if not set Return type:float or “Autocalculate”

low_speed_user_specified_design_capacity_sizing_factor

field Low Speed User Specified Design Capacity Sizing Factor

This field is only used if the previous field is set to autocalculate

Default value: 0.5

Parameters:value (float) – value for IDD Field Low Speed User Specified Design Capacity Sizing Factor Raises:ValueError – if value is not a valid value Returns:the value of low_speed_user_specified_design_capacity_sizing_factor or None if not set Return type:float

name

field Name

fluid cooler name

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

outdoor_air_inlet_node_name

field Outdoor Air Inlet Node Name

Enter the name of an outdoor air node

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

performance_input_method

field Performance Input Method

User can define fluid cooler thermal performance by specifying the fluid cooler UA

and the Design Water Flow Rate, or by specifying the fluid cooler Standard Design

Capacity or by specifying Design Capacity for Non standard conditions.

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

supply_water_storage_tank_name

field Supply Water Storage Tank Name

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

water_inlet_node_name

field Water Inlet Node Name

Name of fluid cooler water inlet node

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

water_outlet_node_name

field Water Outlet Node Name

Name of fluid cooler water outlet node

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

class pyidf.condenser_equipment_and_heat_exchangers.FluidCoolerSingleSpeed

Bases: pyidf.helper.DataObject

Corresponds to IDD object FluidCooler:SingleSpeed The fluid cooler is modeled as a cross flow heat exchanger (both streams unmixed) with single-speed fans (induced draft configuration).

design_air_flow_rate

field Design Air Flow Rate

Units: m3/s

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

design_air_flow_rate_fan_power

field Design Air Flow Rate Fan Power

This is the fan motor electric input power

Units: W

IP-Units: W

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

design_air_flow_rate_ufactor_times_area_value

field Design Air Flow Rate U-factor Times Area Value

Leave field blank if fluid cooler Performance Input Method is NominalCapacity

Units: W/K

value <= 2100000.0

Parameters:value (float or “Autosize”) – value for IDD Field Design Air Flow Rate U-factor Times Area Value Raises:ValueError – if value is not a valid value Returns:the value of design_air_flow_rate_ufactor_times_area_value or None if not set Return type:float or “Autosize”

design_entering_air_temperature

field Design Entering Air Temperature

Design Entering Air Temperature must be specified for both the performance input methods and

its value must be greater than Design Entering Air Wet-bulb Temperature.

Units: C

IP-Units: F

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

design_entering_air_wetbulb_temperature

field Design Entering Air Wetbulb Temperature

Design Entering Air Wet-bulb Temperature must be specified for both the performance input methods and

its value must be less than Design Entering Air Temperature.

Units: C

IP-Units: F

Parameters:value (float) – value for IDD Field Design Entering Air Wetbulb Temperature Raises:ValueError – if value is not a valid value Returns:the value of design_entering_air_wetbulb_temperature or None if not set Return type:float

design_entering_water_temperature

field Design Entering Water Temperature

Design Entering Water Temperature must be specified for both the performance input methods and

its value must be greater than Design Entering Air Temperature.

Units: C

IP-Units: F

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

design_water_flow_rate

field Design Water Flow Rate

Units: m3/s

IP-Units: gal/min

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

name

field Name

fluid cooler name

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

nominal_capacity

field Nominal Capacity

Nominal fluid cooler capacity

Units: W

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

outdoor_air_inlet_node_name

field Outdoor Air Inlet Node Name

Enter the name of an outdoor air node

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

performance_input_method

field Performance Input Method

User can define fluid cooler thermal performance by specifying the fluid cooler UA

and the Design Water Flow Rate, or by specifying the fluid cooler nominal capacity

Default value: NominalCapacity

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

water_inlet_node_name

field Water Inlet Node Name

Name of fluid cooler water inlet node

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

water_outlet_node_name

field Water Outlet Node Name

Name of fluid cooler water outlet node

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

class pyidf.condenser_equipment_and_heat_exchangers.FluidCoolerTwoSpeed

Bases: pyidf.helper.DataObject

Corresponds to IDD object FluidCooler:TwoSpeed The fluid cooler is modeled as a cross flow heat exchanger (both streams unmixed) with two-speed fans (induced draft configuration).

design_entering_air_temperature

field Design Entering Air Temperature

Design Entering Air Temperature must be specified for both the performance input methods and

its value must be greater than Design Entering Air Wet-bulb Temperature.

Units: C

IP-Units: F

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

design_entering_air_wetbulb_temperature

field Design Entering Air Wet-bulb Temperature

Design Entering Air Wet-bulb Temperature must be specified for both the performance input methods and

its value must be less than Design Entering Air Temperature.

Units: C

IP-Units: F

Parameters:value (float) – value for IDD Field Design Entering Air Wet-bulb Temperature Raises:ValueError – if value is not a valid value Returns:the value of design_entering_air_wetbulb_temperature or None if not set Return type:float

design_entering_water_temperature

field Design Entering Water Temperature

Design Entering Water Temperature must be specified for both the performance input methods and

its value must be greater than Design Entering Air Temperature.

Units: C

IP-Units: F

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

design_water_flow_rate

field Design Water Flow Rate

Units: m3/s

IP-Units: gal/min

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

high_fan_speed_air_flow_rate

field High Fan Speed Air Flow Rate

Air Flow Rate at High Fan Speed must be greater than Air Flow Rate at Low Fan Speed

Units: m3/s

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

high_fan_speed_fan_power

field High Fan Speed Fan Power

This is the fan motor electric input power at high speed

Units: W

IP-Units: W

Parameters:value (float or “Autosize”) – value for IDD Field High Fan Speed Fan Power Raises:ValueError – if value is not a valid value Returns:the value of high_fan_speed_fan_power or None if not set Return type:float or “Autosize”

high_fan_speed_ufactor_times_area_value

field High Fan Speed U-factor Times Area Value

Leave field blank if fluid cooler Performance Input Method is NominalCapacity

Units: W/K

value <= 2100000.0

Parameters:value (float or “Autosize”) – value for IDD Field High Fan Speed U-factor Times Area Value Raises:ValueError – if value is not a valid value Returns:the value of high_fan_speed_ufactor_times_area_value or None if not set Return type:float or “Autosize”

high_speed_nominal_capacity

field High Speed Nominal Capacity

Nominal fluid cooler capacity at high fan speed

Units: W

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

low_fan_speed_air_flow_rate

field Low Fan Speed Air Flow Rate

Air Flow Rate at Low Fan Speed must be less than Air Flow Rate at High Fan Speed

Units: m3/s

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

low_fan_speed_air_flow_rate_sizing_factor

field Low Fan Speed Air Flow Rate Sizing Factor

This field is only used if the previous field is set to autocalculate.

Default value: 0.5

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

low_fan_speed_fan_power

field Low Fan Speed Fan Power

This is the fan motor electric input power at low speed

Units: W

IP-Units: W

Parameters:value (float or “Autocalculate”) – value for IDD Field Low Fan Speed Fan Power Raises:ValueError – if value is not a valid value Returns:the value of low_fan_speed_fan_power or None if not set Return type:float or “Autocalculate”

low_fan_speed_fan_power_sizing_factor

field Low Fan Speed Fan Power Sizing Factor

This field is only used if the previous field is set to autocalculate.

Default value: 0.16

Parameters:value (float) – value for IDD Field Low Fan Speed Fan Power Sizing Factor Raises:ValueError – if value is not a valid value Returns:the value of low_fan_speed_fan_power_sizing_factor or None if not set Return type:float

low_fan_speed_ufactor_times_area_sizing_factor

field Low Fan Speed U-Factor Times Area Sizing Factor

This field is only used if the previous field is set to autocalculate and

the Performance Input Method is UFactorTimesAreaAndDesignWaterFlowRate

Default value: 0.6

Parameters:value (float) – value for IDD Field Low Fan Speed U-Factor Times Area Sizing Factor Raises:ValueError – if value is not a valid value Returns:the value of low_fan_speed_ufactor_times_area_sizing_factor or None if not set Return type:float

low_fan_speed_ufactor_times_area_value

field Low Fan Speed U-factor Times Area Value

Leave field blank if fluid cooler Performance Input Method is NominalCapacity

Low speed fluid cooler UA must be less than high speed fluid cooler UA

Low speed fluid cooler UA must be greater than free convection fluid cooler UA

Units: W/K

value <= 300000.0

Parameters:value (float or “Autocalculate”) – value for IDD Field Low Fan Speed U-factor Times Area Value Raises:ValueError – if value is not a valid value Returns:the value of low_fan_speed_ufactor_times_area_value or None if not set Return type:float or “Autocalculate”

low_speed_nominal_capacity

field Low Speed Nominal Capacity

Nominal fluid cooler capacity at low fan speed

Units: W

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

low_speed_nominal_capacity_sizing_factor

field Low Speed Nominal Capacity Sizing Factor

This field is only used if the previous field is set to autocalculate and

the Performance Input Method is NominalCapacity

Default value: 0.5

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

name

field Name

fluid cooler name

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

outdoor_air_inlet_node_name

field Outdoor Air Inlet Node Name

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

performance_input_method

field Performance Input Method

User can define fluid cooler thermal performance by specifying the fluid cooler UA

and the Design Water Flow Rate, or by specifying the fluid cooler nominal capacity

Default value: NominalCapacity

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

water_inlet_node_name

field Water Inlet Node Name

Name of fluid cooler water inlet node

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

water_outlet_node_name

field Water Outlet Node Name

Name of fluid cooler water outlet node

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

class pyidf.condenser_equipment_and_heat_exchangers.GroundHeatExchangerHorizontalTrench

Bases: pyidf.helper.DataObject

Corresponds to IDD object GroundHeatExchanger:HorizontalTrench This models a horizontal heat exchanger placed in a series of trenches The model uses the PipingSystem:Underground underlying algorithms, but provides a more usable input interface.

burial_depth

field Burial Depth

This is the burial depth of the pipes, or the trenches

containing the pipes

Units: m

IP-Units: ft

Default value: 1.5

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

design_flow_rate

field Design Flow Rate

Units: m3/s

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

evapotranspiration_ground_cover_parameter

field Evapotranspiration Ground Cover Parameter

This specifies the ground cover effects during evapotranspiration

calculations. The value roughly represents the following cases:

= 0 : concrete or other solid, non-permeable ground surface material

= 0.5 : short grass, much like a manicured lawn

= 1 : standard reference state (12 cm grass)

= 1.5 : wild growth

Default value: 0.4

value <= 1.5

Parameters:value (float) – value for IDD Field Evapotranspiration Ground Cover Parameter Raises:ValueError – if value is not a valid value Returns:the value of evapotranspiration_ground_cover_parameter or None if not set Return type:float

horizontal_spacing_between_pipes

field Horizontal Spacing Between Pipes

This represents the average horizontal spacing between any two

trenches for heat exchangers that have multiple trenches

Units: m

Default value: 1.0

Parameters:value (float) – value for IDD Field Horizontal Spacing Between Pipes Raises:ValueError – if value is not a valid value Returns:the value of horizontal_spacing_between_pipes or None if not set Return type:float

inlet_node_name

field Inlet Node Name

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

name

field Name

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

number_of_trenches

field Number of Trenches

This is the number of horizontal legs that will be used

in the entire heat exchanger, one pipe per trench

Default value: 1

value >= 1

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

outlet_node_name

field Outlet Node Name

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

pipe_density

field Pipe Density

Units: kg/m3

Default value: 641.0

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

pipe_inner_diameter

field Pipe Inner Diameter

Units: m

IP-Units: in

Default value: 0.016

Parameters:value (float) – value for IDD Field Pipe Inner Diameter Raises:ValueError – if value is not a valid value Returns:the value of pipe_inner_diameter or None if not set Return type:float

pipe_outer_diameter

field Pipe Outer Diameter

Units: m

IP-Units: in

Default value: 0.026

Parameters:value (float) – value for IDD Field Pipe Outer Diameter Raises:ValueError – if value is not a valid value Returns:the value of pipe_outer_diameter or None if not set Return type:float

pipe_specific_heat

field Pipe Specific Heat

Units: J/kg-K

Default value: 2405.0

Parameters:value (float) – value for IDD Field Pipe Specific Heat Raises:ValueError – if value is not a valid value Returns:the value of pipe_specific_heat or None if not set Return type:float

pipe_thermal_conductivity

field Pipe Thermal Conductivity

Units: W/m-K

Default value: 0.3895

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

soil_density

field Soil Density

Units: kg/m3

Default value: 962.0

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

soil_moisture_content_percent

field Soil Moisture Content Percent

Units: percent

Default value: 30.0

value <= 100.0

Parameters:value (float) – value for IDD Field Soil Moisture Content Percent Raises:ValueError – if value is not a valid value Returns:the value of soil_moisture_content_percent or None if not set Return type:float

soil_moisture_content_percent_at_saturation

field Soil Moisture Content Percent at Saturation

Units: percent

Default value: 50.0

value <= 100.0

Parameters:value (float) – value for IDD Field Soil Moisture Content Percent at Saturation Raises:ValueError – if value is not a valid value Returns:the value of soil_moisture_content_percent_at_saturation or None if not set Return type:float

soil_specific_heat

field Soil Specific Heat

Units: J/kg-K

Default value: 2576.0

Parameters:value (float) – value for IDD Field Soil Specific Heat Raises:ValueError – if value is not a valid value Returns:the value of soil_specific_heat or None if not set Return type:float

soil_thermal_conductivity

field Soil Thermal Conductivity

Units: W/m-K

Default value: 1.08

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

trench_length_in_pipe_axial_direction

field Trench Length in Pipe Axial Direction

This is the total pipe axial length of the heat exchanger

If all pipe trenches are parallel, this is the length of a

single trench. If a single, long run of pipe is used with one

trench, this is the full length of the pipe run.

Units: m

IP-Units: ft

Default value: 50.0

Parameters:value (float) – value for IDD Field Trench Length in Pipe Axial Direction Raises:ValueError – if value is not a valid value Returns:the value of trench_length_in_pipe_axial_direction or None if not set Return type:float

undisturbed_ground_temperature_model_name

field Undisturbed Ground Temperature Model Name

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

undisturbed_ground_temperature_model_type

field Undisturbed Ground Temperature Model Type

Parameters:value (str) – value for IDD Field Undisturbed Ground Temperature Model Type Raises:ValueError – if value is not a valid value Returns:the value of undisturbed_ground_temperature_model_type or None if not set Return type:str

class pyidf.condenser_equipment_and_heat_exchangers.GroundHeatExchangerPond

Bases: pyidf.helper.DataObject

Corresponds to IDD object GroundHeatExchanger:Pond A model of a shallow pond with immersed pipe loops. Typically used in hybrid geothermal systems and included in the condenser loop. This component may also be used as a simple solar collector.

fluid_inlet_node_name

field Fluid Inlet Node Name

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

fluid_outlet_node_name

field Fluid Outlet Node Name

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

ground_thermal_conductivity

field Ground Thermal Conductivity

Units: W/m2-K

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

hydronic_tubing_inside_diameter

field Hydronic Tubing Inside Diameter

Units: m

IP-Units: in

Parameters:value (float) – value for IDD Field Hydronic Tubing Inside Diameter Raises:ValueError – if value is not a valid value Returns:the value of hydronic_tubing_inside_diameter or None if not set Return type:float

hydronic_tubing_outside_diameter

field Hydronic Tubing Outside Diameter

Units: m

IP-Units: in

Parameters:value (float) – value for IDD Field Hydronic Tubing Outside Diameter Raises:ValueError – if value is not a valid value Returns:the value of hydronic_tubing_outside_diameter or None if not set Return type:float

hydronic_tubing_thermal_conductivity

field Hydronic Tubing Thermal Conductivity

Units: W/m-K

Parameters:value (float) – value for IDD Field Hydronic Tubing Thermal Conductivity Raises:ValueError – if value is not a valid value Returns:the value of hydronic_tubing_thermal_conductivity or None if not set Return type:float

length_of_each_tubing_circuit

field Length of Each Tubing Circuit

Units: m

Parameters:value (float) – value for IDD Field Length of Each Tubing Circuit Raises:ValueError – if value is not a valid value Returns:the value of length_of_each_tubing_circuit 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_tubing_circuits

field Number of Tubing Circuits

value >= 1

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

pond_area

field Pond Area

Units: m2

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

pond_depth

field Pond Depth

Units: m

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

class pyidf.condenser_equipment_and_heat_exchangers.GroundHeatExchangerSlinky

Bases: pyidf.helper.DataObject

Corresponds to IDD object GroundHeatExchanger:Slinky This models a slinky horizontal heat exchanger placed in a series of trenches The model uses the model developed by: Xiong, Z., D.E. Fisher, and J.D. Spitler. 2015. Development and Validation of a Slinky Ground Heat Exchanger Model. Applied Energy 141: 57-69.

coil_diameter

field Coil Diameter

This is the diameter of the heat exchanger coil

Units: m

IP-Units: ft

Default value: 1.0

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

coil_pitch

field Coil Pitch

This is the center-to-center distance between coils

Units: m

IP-Units: ft

Default value: 0.2

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

design_flow_rate

field Design Flow Rate

Units: m3/s

Default value: 0.002

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

heat_exchanger_configuration

field Heat Exchanger Configuration

This is the orientation of the heat exchanger

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

horizontal_spacing_between_pipes

field Horizontal Spacing Between Pipes

This represents the average horizontal spacing

between any two

trenches for heat exchangers that have multiple trenches

Units: m

IP-Units: ft

Default value: 2.0

Parameters:value (float) – value for IDD Field Horizontal Spacing Between Pipes Raises:ValueError – if value is not a valid value Returns:the value of horizontal_spacing_between_pipes or None if not set Return type:float

inlet_node_name

field Inlet Node Name

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

maximum_length_of_simulation

field Maximum Length of Simulation

Units: years

Parameters:value (float) – value for IDD Field Maximum Length of Simulation Raises:ValueError – if value is not a valid value Returns:the value of maximum_length_of_simulation 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_trenches

field Number of Trenches

This is the number of parallel trenches that

has a heat exchanger, one per trench

Default value: 1

value >= 1

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

outlet_node_name

field Outlet Node Name

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

pipe_density

field Pipe Density

Units: kg/m3

Default value: 641.0

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

pipe_outer_diameter

field Pipe Outer Diameter

Units: m

IP-Units: in

Default value: 0.02667

Parameters:value (float) – value for IDD Field Pipe Outer Diameter Raises:ValueError – if value is not a valid value Returns:the value of pipe_outer_diameter or None if not set Return type:float

pipe_specific_heat

field Pipe Specific Heat

Units: J/kg-K

Default value: 2405.0

Parameters:value (float) – value for IDD Field Pipe Specific Heat Raises:ValueError – if value is not a valid value Returns:the value of pipe_specific_heat or None if not set Return type:float

pipe_thermal_conductivity

field Pipe Thermal Conductivity

Units: W/m-K

Default value: 0.4

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

pipe_thickness

field Pipe Thickness

Units: m

IP-Units: in

Default value: 0.002413

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

soil_density

field Soil Density

Units: kg/m3

Default value: 962.0

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

soil_specific_heat

field Soil Specific Heat

Units: J/kg-K

Default value: 2576.0

Parameters:value (float) – value for IDD Field Soil Specific Heat Raises:ValueError – if value is not a valid value Returns:the value of soil_specific_heat or None if not set Return type:float

soil_thermal_conductivity

field Soil Thermal Conductivity

Units: W/m-K

Default value: 1.08

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

trench_depth

field Trench Depth

This is the distance from the ground surface to the

trench bottom

Units: m

IP-Units: ft

Default value: 1.8

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

trench_length

field Trench Length

This is the total length of a single trench

This assumes the heat exchanger runs the full length

of the trench

Units: m

IP-Units: ft

Default value: 10.0

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

undisturbed_ground_temperature_model_name

field Undisturbed Ground Temperature Model Name

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

undisturbed_ground_temperature_model_type

field Undisturbed Ground Temperature Model Type

Parameters:value (str) – value for IDD Field Undisturbed Ground Temperature Model Type Raises:ValueError – if value is not a valid value Returns:the value of undisturbed_ground_temperature_model_type or None if not set Return type:str

class pyidf.condenser_equipment_and_heat_exchangers.GroundHeatExchangerSurface

Bases: pyidf.helper.DataObject

Corresponds to IDD object GroundHeatExchanger:Surface A hydronic surface/panel consisting of a multi-layer construction with embedded rows of tubes. Typically used in hybrid geothermal systems and included in the condenser loop. This component may also be used as a simple solar collector. The bottom surface may be defined as ground-coupled or exposed to wind (eg. bridge deck).

construction_name

field Construction Name

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

fluid_inlet_node_name

field Fluid Inlet Node Name

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

fluid_outlet_node_name

field Fluid Outlet Node Name

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

hydronic_tube_spacing

field Hydronic Tube Spacing

Units: m

Parameters:value (float) – value for IDD Field Hydronic Tube Spacing Raises:ValueError – if value is not a valid value Returns:the value of hydronic_tube_spacing or None if not set Return type:float

hydronic_tubing_inside_diameter

field Hydronic Tubing Inside Diameter

Units: m

IP-Units: in

Parameters:value (float) – value for IDD Field Hydronic Tubing Inside Diameter Raises:ValueError – if value is not a valid value Returns:the value of hydronic_tubing_inside_diameter or None if not set Return type:float

lower_surface_environment

field Lower Surface Environment

Default value: Ground

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

name

field Name

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

number_of_tubing_circuits

field Number of Tubing Circuits

value >= 1

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

surface_length

field Surface Length

Units: m

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

surface_width

field Surface Width

Units: m

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

class pyidf.condenser_equipment_and_heat_exchangers.GroundHeatExchangerVertical

Bases: pyidf.helper.DataObject

Corresponds to IDD object GroundHeatExchanger:Vertical Variable short time step vertical ground heat exchanger model based on Yavuztruk, C., J.D.Spitler. 1999. A Short Time Step response Factor Model for Vertical Ground Loop Heat Exchangers The Fluid Type in the associated condenser loop must be same for which the g-functions below are calculated.

bore_hole_length

field Bore Hole Length

Units: m

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

bore_hole_radius

field Bore Hole Radius

Units: m

Parameters:value (float) – value for IDD Field Bore Hole Radius Raises:ValueError – if value is not a valid value Returns:the value of bore_hole_radius or None if not set Return type:float

design_flow_rate

field Design Flow Rate

Units: m3/s

IP-Units: gal/min

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

gfunction_g_value_1

field G-Function G Value 1

Parameters:value (float) – value for IDD Field G-Function G Value 1 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_1 or None if not set Return type:float

gfunction_g_value_10

field G-Function G Value 10

Parameters:value (float) – value for IDD Field G-Function G Value 10 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_10 or None if not set Return type:float

gfunction_g_value_100

field G-Function G Value 100

Parameters:value (float) – value for IDD Field G-Function G Value 100 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_100 or None if not set Return type:float

gfunction_g_value_11

field G-Function G Value 11

Parameters:value (float) – value for IDD Field G-Function G Value 11 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_11 or None if not set Return type:float

gfunction_g_value_12

field G-Function G Value 12

Parameters:value (float) – value for IDD Field G-Function G Value 12 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_12 or None if not set Return type:float

gfunction_g_value_13

field G-Function G Value 13

Parameters:value (float) – value for IDD Field G-Function G Value 13 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_13 or None if not set Return type:float

gfunction_g_value_14

field G-Function G Value 14

Parameters:value (float) – value for IDD Field G-Function G Value 14 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_14 or None if not set Return type:float

gfunction_g_value_15

field G-Function G Value 15

Parameters:value (float) – value for IDD Field G-Function G Value 15 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_15 or None if not set Return type:float

gfunction_g_value_16

field G-Function G Value 16

Parameters:value (float) – value for IDD Field G-Function G Value 16 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_16 or None if not set Return type:float

gfunction_g_value_17

field G-Function G Value 17

Parameters:value (float) – value for IDD Field G-Function G Value 17 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_17 or None if not set Return type:float

gfunction_g_value_18

field G-Function G Value 18

Parameters:value (float) – value for IDD Field G-Function G Value 18 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_18 or None if not set Return type:float

gfunction_g_value_19

field G-Function G Value 19

Parameters:value (float) – value for IDD Field G-Function G Value 19 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_19 or None if not set Return type:float

gfunction_g_value_2

field G-Function G Value 2

Parameters:value (float) – value for IDD Field G-Function G Value 2 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_2 or None if not set Return type:float

gfunction_g_value_20

field G-Function G Value 20

Parameters:value (float) – value for IDD Field G-Function G Value 20 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_20 or None if not set Return type:float

gfunction_g_value_21

field G-Function G Value 21

Parameters:value (float) – value for IDD Field G-Function G Value 21 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_21 or None if not set Return type:float

gfunction_g_value_22

field G-Function G Value 22

Parameters:value (float) – value for IDD Field G-Function G Value 22 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_22 or None if not set Return type:float

gfunction_g_value_23

field G-Function G Value 23

Parameters:value (float) – value for IDD Field G-Function G Value 23 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_23 or None if not set Return type:float

gfunction_g_value_24

field G-Function G Value 24

Parameters:value (float) – value for IDD Field G-Function G Value 24 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_24 or None if not set Return type:float

gfunction_g_value_25

field G-Function G Value 25

Parameters:value (float) – value for IDD Field G-Function G Value 25 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_25 or None if not set Return type:float

gfunction_g_value_26

field G-Function G Value 26

Parameters:value (float) – value for IDD Field G-Function G Value 26 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_26 or None if not set Return type:float

gfunction_g_value_27

field G-Function G Value 27

Parameters:value (float) – value for IDD Field G-Function G Value 27 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_27 or None if not set Return type:float

gfunction_g_value_28

field G-Function G Value 28

Parameters:value (float) – value for IDD Field G-Function G Value 28 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_28 or None if not set Return type:float

gfunction_g_value_29

field G-Function G Value 29

Parameters:value (float) – value for IDD Field G-Function G Value 29 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_29 or None if not set Return type:float

gfunction_g_value_3

field G-Function G Value 3

Parameters:value (float) – value for IDD Field G-Function G Value 3 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_3 or None if not set Return type:float

gfunction_g_value_30

field G-Function G Value 30

Parameters:value (float) – value for IDD Field G-Function G Value 30 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_30 or None if not set Return type:float

gfunction_g_value_31

field G-Function G Value 31

Parameters:value (float) – value for IDD Field G-Function G Value 31 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_31 or None if not set Return type:float

gfunction_g_value_32

field G-Function G Value 32

Parameters:value (float) – value for IDD Field G-Function G Value 32 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_32 or None if not set Return type:float

gfunction_g_value_33

field G-Function G Value 33

Parameters:value (float) – value for IDD Field G-Function G Value 33 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_33 or None if not set Return type:float

gfunction_g_value_34

field G-Function G Value 34

Parameters:value (float) – value for IDD Field G-Function G Value 34 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_34 or None if not set Return type:float

gfunction_g_value_35

field G-Function G Value 35

Parameters:value (float) – value for IDD Field G-Function G Value 35 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_35 or None if not set Return type:float

gfunction_g_value_36

field G-Function G Value 36

Parameters:value (float) – value for IDD Field G-Function G Value 36 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_36 or None if not set Return type:float

gfunction_g_value_37

field G-Function G Value 37

Parameters:value (float) – value for IDD Field G-Function G Value 37 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_37 or None if not set Return type:float

gfunction_g_value_38

field G-Function G Value 38

Parameters:value (float) – value for IDD Field G-Function G Value 38 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_38 or None if not set Return type:float

gfunction_g_value_39

field G-Function G Value 39

Parameters:value (float) – value for IDD Field G-Function G Value 39 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_39 or None if not set Return type:float

gfunction_g_value_4

field G-Function G Value 4

Parameters:value (float) – value for IDD Field G-Function G Value 4 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_4 or None if not set Return type:float

gfunction_g_value_40

field G-Function G Value 40

Parameters:value (float) – value for IDD Field G-Function G Value 40 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_40 or None if not set Return type:float

gfunction_g_value_41

field G-Function G Value 41

Parameters:value (float) – value for IDD Field G-Function G Value 41 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_41 or None if not set Return type:float

gfunction_g_value_42

field G-Function G Value 42

Parameters:value (float) – value for IDD Field G-Function G Value 42 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_42 or None if not set Return type:float

gfunction_g_value_43

field G-Function G Value 43

Parameters:value (float) – value for IDD Field G-Function G Value 43 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_43 or None if not set Return type:float

gfunction_g_value_44

field G-Function G Value 44

Parameters:value (float) – value for IDD Field G-Function G Value 44 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_44 or None if not set Return type:float

gfunction_g_value_45

field G-Function G Value 45

Parameters:value (float) – value for IDD Field G-Function G Value 45 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_45 or None if not set Return type:float

gfunction_g_value_46

field G-Function G Value 46

Parameters:value (float) – value for IDD Field G-Function G Value 46 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_46 or None if not set Return type:float

gfunction_g_value_47

field G-Function G Value 47

Parameters:value (float) – value for IDD Field G-Function G Value 47 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_47 or None if not set Return type:float

gfunction_g_value_48

field G-Function G Value 48

Parameters:value (float) – value for IDD Field G-Function G Value 48 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_48 or None if not set Return type:float

gfunction_g_value_49

field G-Function G Value 49

Parameters:value (float) – value for IDD Field G-Function G Value 49 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_49 or None if not set Return type:float

gfunction_g_value_5

field G-Function G Value 5

Parameters:value (float) – value for IDD Field G-Function G Value 5 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_5 or None if not set Return type:float

gfunction_g_value_50

field G-Function G Value 50

Parameters:value (float) – value for IDD Field G-Function G Value 50 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_50 or None if not set Return type:float

gfunction_g_value_51

field G-Function G Value 51

Parameters:value (float) – value for IDD Field G-Function G Value 51 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_51 or None if not set Return type:float

gfunction_g_value_52

field G-Function G Value 52

Parameters:value (float) – value for IDD Field G-Function G Value 52 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_52 or None if not set Return type:float

gfunction_g_value_53

field G-Function G Value 53

Parameters:value (float) – value for IDD Field G-Function G Value 53 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_53 or None if not set Return type:float

gfunction_g_value_54

field G-Function G Value 54

Parameters:value (float) – value for IDD Field G-Function G Value 54 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_54 or None if not set Return type:float

gfunction_g_value_55

field G-Function G Value 55

Parameters:value (float) – value for IDD Field G-Function G Value 55 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_55 or None if not set Return type:float

gfunction_g_value_56

field G-Function G Value 56

Parameters:value (float) – value for IDD Field G-Function G Value 56 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_56 or None if not set Return type:float

gfunction_g_value_57

field G-Function G Value 57

Parameters:value (float) – value for IDD Field G-Function G Value 57 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_57 or None if not set Return type:float

gfunction_g_value_58

field G-Function G Value 58

Parameters:value (float) – value for IDD Field G-Function G Value 58 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_58 or None if not set Return type:float

gfunction_g_value_59

field G-Function G Value 59

Parameters:value (float) – value for IDD Field G-Function G Value 59 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_59 or None if not set Return type:float

gfunction_g_value_6

field G-Function G Value 6

Parameters:value (float) – value for IDD Field G-Function G Value 6 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_6 or None if not set Return type:float

gfunction_g_value_60

field G-Function G Value 60

Parameters:value (float) – value for IDD Field G-Function G Value 60 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_60 or None if not set Return type:float

gfunction_g_value_61

field G-Function G Value 61

Parameters:value (float) – value for IDD Field G-Function G Value 61 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_61 or None if not set Return type:float

gfunction_g_value_62

field G-Function G Value 62

Parameters:value (float) – value for IDD Field G-Function G Value 62 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_62 or None if not set Return type:float

gfunction_g_value_63

field G-Function G Value 63

Parameters:value (float) – value for IDD Field G-Function G Value 63 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_63 or None if not set Return type:float

gfunction_g_value_64

field G-Function G Value 64

Parameters:value (float) – value for IDD Field G-Function G Value 64 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_64 or None if not set Return type:float

gfunction_g_value_65

field G-Function G Value 65

Parameters:value (float) – value for IDD Field G-Function G Value 65 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_65 or None if not set Return type:float

gfunction_g_value_66

field G-Function G Value 66

Parameters:value (float) – value for IDD Field G-Function G Value 66 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_66 or None if not set Return type:float

gfunction_g_value_67

field G-Function G Value 67

Parameters:value (float) – value for IDD Field G-Function G Value 67 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_67 or None if not set Return type:float

gfunction_g_value_68

field G-Function G Value 68

Parameters:value (float) – value for IDD Field G-Function G Value 68 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_68 or None if not set Return type:float

gfunction_g_value_69

field G-Function G Value 69

Parameters:value (float) – value for IDD Field G-Function G Value 69 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_69 or None if not set Return type:float

gfunction_g_value_7

field G-Function G Value 7

Parameters:value (float) – value for IDD Field G-Function G Value 7 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_7 or None if not set Return type:float

gfunction_g_value_70

field G-Function G Value 70

Parameters:value (float) – value for IDD Field G-Function G Value 70 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_70 or None if not set Return type:float

gfunction_g_value_71

field G-Function G Value 71

Parameters:value (float) – value for IDD Field G-Function G Value 71 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_71 or None if not set Return type:float

gfunction_g_value_72

field G-Function G Value 72

Parameters:value (float) – value for IDD Field G-Function G Value 72 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_72 or None if not set Return type:float

gfunction_g_value_73

field G-Function G Value 73

Parameters:value (float) – value for IDD Field G-Function G Value 73 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_73 or None if not set Return type:float

gfunction_g_value_74

field G-Function G Value 74

Parameters:value (float) – value for IDD Field G-Function G Value 74 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_74 or None if not set Return type:float

gfunction_g_value_75

field G-Function G Value 75

Parameters:value (float) – value for IDD Field G-Function G Value 75 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_75 or None if not set Return type:float

gfunction_g_value_76

field G-Function G Value 76

Parameters:value (float) – value for IDD Field G-Function G Value 76 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_76 or None if not set Return type:float

gfunction_g_value_77

field G-Function G Value 77

Parameters:value (float) – value for IDD Field G-Function G Value 77 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_77 or None if not set Return type:float

gfunction_g_value_78

field G-Function G Value 78

Parameters:value (float) – value for IDD Field G-Function G Value 78 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_78 or None if not set Return type:float

gfunction_g_value_79

field G-Function G Value 79

Parameters:value (float) – value for IDD Field G-Function G Value 79 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_79 or None if not set Return type:float

gfunction_g_value_8

field G-Function G Value 8

Parameters:value (float) – value for IDD Field G-Function G Value 8 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_8 or None if not set Return type:float

gfunction_g_value_80

field G-Function G Value 80

Parameters:value (float) – value for IDD Field G-Function G Value 80 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_80 or None if not set Return type:float

gfunction_g_value_81

field G-Function G Value 81

Parameters:value (float) – value for IDD Field G-Function G Value 81 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_81 or None if not set Return type:float

gfunction_g_value_82

field G-Function G Value 82

Parameters:value (float) – value for IDD Field G-Function G Value 82 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_82 or None if not set Return type:float

gfunction_g_value_83

field G-Function G Value 83

Parameters:value (float) – value for IDD Field G-Function G Value 83 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_83 or None if not set Return type:float

gfunction_g_value_84

field G-Function G Value 84

Parameters:value (float) – value for IDD Field G-Function G Value 84 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_84 or None if not set Return type:float

gfunction_g_value_85

field G-Function G Value 85

Parameters:value (float) – value for IDD Field G-Function G Value 85 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_85 or None if not set Return type:float

gfunction_g_value_86

field G-Function G Value 86

Parameters:value (float) – value for IDD Field G-Function G Value 86 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_86 or None if not set Return type:float

gfunction_g_value_87

field G-Function G Value 87

Parameters:value (float) – value for IDD Field G-Function G Value 87 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_87 or None if not set Return type:float

gfunction_g_value_88

field G-Function G Value 88

Parameters:value (float) – value for IDD Field G-Function G Value 88 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_88 or None if not set Return type:float

gfunction_g_value_89

field G-Function G Value 89

Parameters:value (float) – value for IDD Field G-Function G Value 89 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_89 or None if not set Return type:float

gfunction_g_value_9

field G-Function G Value 9

Parameters:value (float) – value for IDD Field G-Function G Value 9 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_9 or None if not set Return type:float

gfunction_g_value_90

field G-Function G Value 90

Parameters:value (float) – value for IDD Field G-Function G Value 90 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_90 or None if not set Return type:float

gfunction_g_value_91

field G-Function G Value 91

Parameters:value (float) – value for IDD Field G-Function G Value 91 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_91 or None if not set Return type:float

gfunction_g_value_92

field G-Function G Value 92

Parameters:value (float) – value for IDD Field G-Function G Value 92 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_92 or None if not set Return type:float

gfunction_g_value_93

field G-Function G Value 93

Parameters:value (float) – value for IDD Field G-Function G Value 93 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_93 or None if not set Return type:float

gfunction_g_value_94

field G-Function G Value 94

Parameters:value (float) – value for IDD Field G-Function G Value 94 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_94 or None if not set Return type:float

gfunction_g_value_95

field G-Function G Value 95

Parameters:value (float) – value for IDD Field G-Function G Value 95 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_95 or None if not set Return type:float

gfunction_g_value_96

field G-Function G Value 96

Parameters:value (float) – value for IDD Field G-Function G Value 96 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_96 or None if not set Return type:float

gfunction_g_value_97

field G-Function G Value 97

Parameters:value (float) – value for IDD Field G-Function G Value 97 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_97 or None if not set Return type:float

gfunction_g_value_98

field G-Function G Value 98

Parameters:value (float) – value for IDD Field G-Function G Value 98 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_98 or None if not set Return type:float

gfunction_g_value_99

field G-Function G Value 99

Parameters:value (float) – value for IDD Field G-Function G Value 99 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_g_value_99 or None if not set Return type:float

gfunction_lnt_or_ts_value_1

field G-Function Ln(T/Ts) Value 1

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 1 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_1 or None if not set Return type:float

gfunction_lnt_or_ts_value_10

field G-Function Ln(T/Ts) Value 10

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 10 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_10 or None if not set Return type:float

gfunction_lnt_or_ts_value_100

field G-Function Ln(T/Ts) Value 100

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 100 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_100 or None if not set Return type:float

gfunction_lnt_or_ts_value_11

field G-Function Ln(T/Ts) Value 11

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 11 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_11 or None if not set Return type:float

gfunction_lnt_or_ts_value_12

field G-Function Ln(T/Ts) Value 12

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 12 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_12 or None if not set Return type:float

gfunction_lnt_or_ts_value_13

field G-Function Ln(T/Ts) Value 13

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 13 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_13 or None if not set Return type:float

gfunction_lnt_or_ts_value_14

field G-Function Ln(T/Ts) Value 14

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 14 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_14 or None if not set Return type:float

gfunction_lnt_or_ts_value_15

field G-Function Ln(T/Ts) Value 15

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 15 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_15 or None if not set Return type:float

gfunction_lnt_or_ts_value_16

field G-Function Ln(T/Ts) Value 16

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 16 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_16 or None if not set Return type:float

gfunction_lnt_or_ts_value_17

field G-Function Ln(T/Ts) Value 17

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 17 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_17 or None if not set Return type:float

gfunction_lnt_or_ts_value_18

field G-Function Ln(T/Ts) Value 18

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 18 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_18 or None if not set Return type:float

gfunction_lnt_or_ts_value_19

field G-Function Ln(T/Ts) Value 19

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 19 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_19 or None if not set Return type:float

gfunction_lnt_or_ts_value_2

field G-Function Ln(T/Ts) Value 2

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 2 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_2 or None if not set Return type:float

gfunction_lnt_or_ts_value_20

field G-Function Ln(T/Ts) Value 20

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 20 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_20 or None if not set Return type:float

gfunction_lnt_or_ts_value_21

field G-Function Ln(T/Ts) Value 21

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 21 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_21 or None if not set Return type:float

gfunction_lnt_or_ts_value_22

field G-Function Ln(T/Ts) Value 22

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 22 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_22 or None if not set Return type:float

gfunction_lnt_or_ts_value_23

field G-Function Ln(T/Ts) Value 23

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 23 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_23 or None if not set Return type:float

gfunction_lnt_or_ts_value_24

field G-Function Ln(T/Ts) Value 24

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 24 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_24 or None if not set Return type:float

gfunction_lnt_or_ts_value_25

field G-Function Ln(T/Ts) Value 25

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 25 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_25 or None if not set Return type:float

gfunction_lnt_or_ts_value_26

field G-Function Ln(T/Ts) Value 26

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 26 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_26 or None if not set Return type:float

gfunction_lnt_or_ts_value_27

field G-Function Ln(T/Ts) Value 27

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 27 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_27 or None if not set Return type:float

gfunction_lnt_or_ts_value_28

field G-Function Ln(T/Ts) Value 28

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 28 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_28 or None if not set Return type:float

gfunction_lnt_or_ts_value_29

field G-Function Ln(T/Ts) Value 29

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 29 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_29 or None if not set Return type:float

gfunction_lnt_or_ts_value_3

field G-Function Ln(T/Ts) Value 3

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 3 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_3 or None if not set Return type:float

gfunction_lnt_or_ts_value_30

field G-Function Ln(T/Ts) Value 30

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 30 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_30 or None if not set Return type:float

gfunction_lnt_or_ts_value_31

field G-Function Ln(T/Ts) Value 31

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 31 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_31 or None if not set Return type:float

gfunction_lnt_or_ts_value_32

field G-Function Ln(T/Ts) Value 32

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 32 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_32 or None if not set Return type:float

gfunction_lnt_or_ts_value_33

field G-Function Ln(T/Ts) Value 33

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 33 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_33 or None if not set Return type:float

gfunction_lnt_or_ts_value_34

field G-Function Ln(T/Ts) Value 34

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 34 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_34 or None if not set Return type:float

gfunction_lnt_or_ts_value_35

field G-Function Ln(T/Ts) Value 35

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 35 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_35 or None if not set Return type:float

gfunction_lnt_or_ts_value_36

field G-Function Ln(T/Ts) Value 36

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 36 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_36 or None if not set Return type:float

gfunction_lnt_or_ts_value_37

field G-Function Ln(T/Ts) Value 37

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 37 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_37 or None if not set Return type:float

gfunction_lnt_or_ts_value_38

field G-Function Ln(T/Ts) Value 38

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 38 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_38 or None if not set Return type:float

gfunction_lnt_or_ts_value_39

field G-Function Ln(T/Ts) Value 39

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 39 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_39 or None if not set Return type:float

gfunction_lnt_or_ts_value_4

field G-Function Ln(T/Ts) Value 4

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 4 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_4 or None if not set Return type:float

gfunction_lnt_or_ts_value_40

field G-Function Ln(T/Ts) Value 40

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 40 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_40 or None if not set Return type:float

gfunction_lnt_or_ts_value_41

field G-Function Ln(T/Ts) Value 41

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 41 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_41 or None if not set Return type:float

gfunction_lnt_or_ts_value_42

field G-Function Ln(T/Ts) Value 42

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 42 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_42 or None if not set Return type:float

gfunction_lnt_or_ts_value_43

field G-Function Ln(T/Ts) Value 43

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 43 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_43 or None if not set Return type:float

gfunction_lnt_or_ts_value_44

field G-Function Ln(T/Ts) Value 44

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 44 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_44 or None if not set Return type:float

gfunction_lnt_or_ts_value_45

field G-Function Ln(T/Ts) Value 45

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 45 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_45 or None if not set Return type:float

gfunction_lnt_or_ts_value_46

field G-Function Ln(T/Ts) Value 46

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 46 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_46 or None if not set Return type:float

gfunction_lnt_or_ts_value_47

field G-Function Ln(T/Ts) Value 47

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 47 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_47 or None if not set Return type:float

gfunction_lnt_or_ts_value_48

field G-Function Ln(T/Ts) Value 48

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 48 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_48 or None if not set Return type:float

gfunction_lnt_or_ts_value_49

field G-Function Ln(T/Ts) Value 49

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 49 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_49 or None if not set Return type:float

gfunction_lnt_or_ts_value_5

field G-Function Ln(T/Ts) Value 5

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 5 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_5 or None if not set Return type:float

gfunction_lnt_or_ts_value_50

field G-Function Ln(T/Ts) Value 50

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 50 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_50 or None if not set Return type:float

gfunction_lnt_or_ts_value_51

field G-Function Ln(T/Ts) Value 51

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 51 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_51 or None if not set Return type:float

gfunction_lnt_or_ts_value_52

field G-Function Ln(T/Ts) Value 52

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 52 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_52 or None if not set Return type:float

gfunction_lnt_or_ts_value_53

field G-Function Ln(T/Ts) Value 53

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 53 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_53 or None if not set Return type:float

gfunction_lnt_or_ts_value_54

field G-Function Ln(T/Ts) Value 54

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 54 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_54 or None if not set Return type:float

gfunction_lnt_or_ts_value_55

field G-Function Ln(T/Ts) Value 55

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 55 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_55 or None if not set Return type:float

gfunction_lnt_or_ts_value_56

field G-Function Ln(T/Ts) Value 56

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 56 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_56 or None if not set Return type:float

gfunction_lnt_or_ts_value_57

field G-Function Ln(T/Ts) Value 57

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 57 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_57 or None if not set Return type:float

gfunction_lnt_or_ts_value_58

field G-Function Ln(T/Ts) Value 58

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 58 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_58 or None if not set Return type:float

gfunction_lnt_or_ts_value_59

field G-Function Ln(T/Ts) Value 59

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 59 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_59 or None if not set Return type:float

gfunction_lnt_or_ts_value_6

field G-Function Ln(T/Ts) Value 6

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 6 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_6 or None if not set Return type:float

gfunction_lnt_or_ts_value_60

field G-Function Ln(T/Ts) Value 60

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 60 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_60 or None if not set Return type:float

gfunction_lnt_or_ts_value_61

field G-Function Ln(T/Ts) Value 61

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 61 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_61 or None if not set Return type:float

gfunction_lnt_or_ts_value_62

field G-Function Ln(T/Ts) Value 62

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 62 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_62 or None if not set Return type:float

gfunction_lnt_or_ts_value_63

field G-Function Ln(T/Ts) Value 63

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 63 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_63 or None if not set Return type:float

gfunction_lnt_or_ts_value_64

field G-Function Ln(T/Ts) Value 64

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 64 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_64 or None if not set Return type:float

gfunction_lnt_or_ts_value_65

field G-Function Ln(T/Ts) Value 65

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 65 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_65 or None if not set Return type:float

gfunction_lnt_or_ts_value_66

field G-Function Ln(T/Ts) Value 66

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 66 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_66 or None if not set Return type:float

gfunction_lnt_or_ts_value_67

field G-Function Ln(T/Ts) Value 67

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 67 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_67 or None if not set Return type:float

gfunction_lnt_or_ts_value_68

field G-Function Ln(T/Ts) Value 68

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 68 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_68 or None if not set Return type:float

gfunction_lnt_or_ts_value_69

field G-Function Ln(T/Ts) Value 69

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 69 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_69 or None if not set Return type:float

gfunction_lnt_or_ts_value_7

field G-Function Ln(T/Ts) Value 7

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 7 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_7 or None if not set Return type:float

gfunction_lnt_or_ts_value_70

field G-Function Ln(T/Ts) Value 70

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 70 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_70 or None if not set Return type:float

gfunction_lnt_or_ts_value_71

field G-Function Ln(T/Ts) Value 71

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 71 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_71 or None if not set Return type:float

gfunction_lnt_or_ts_value_72

field G-Function Ln(T/Ts) Value 72

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 72 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_72 or None if not set Return type:float

gfunction_lnt_or_ts_value_73

field G-Function Ln(T/Ts) Value 73

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 73 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_73 or None if not set Return type:float

gfunction_lnt_or_ts_value_74

field G-Function Ln(T/Ts) Value 74

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 74 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_74 or None if not set Return type:float

gfunction_lnt_or_ts_value_75

field G-Function Ln(T/Ts) Value 75

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 75 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_75 or None if not set Return type:float

gfunction_lnt_or_ts_value_76

field G-Function Ln(T/Ts) Value 76

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 76 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_76 or None if not set Return type:float

gfunction_lnt_or_ts_value_77

field G-Function Ln(T/Ts) Value 77

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 77 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_77 or None if not set Return type:float

gfunction_lnt_or_ts_value_78

field G-Function Ln(T/Ts) Value 78

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 78 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_78 or None if not set Return type:float

gfunction_lnt_or_ts_value_79

field G-Function Ln(T/Ts) Value 79

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 79 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_79 or None if not set Return type:float

gfunction_lnt_or_ts_value_8

field G-Function Ln(T/Ts) Value 8

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 8 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_8 or None if not set Return type:float

gfunction_lnt_or_ts_value_80

field G-Function Ln(T/Ts) Value 80

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 80 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_80 or None if not set Return type:float

gfunction_lnt_or_ts_value_81

field G-Function Ln(T/Ts) Value 81

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 81 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_81 or None if not set Return type:float

gfunction_lnt_or_ts_value_82

field G-Function Ln(T/Ts) Value 82

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 82 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_82 or None if not set Return type:float

gfunction_lnt_or_ts_value_83

field G-Function Ln(T/Ts) Value 83

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 83 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_83 or None if not set Return type:float

gfunction_lnt_or_ts_value_84

field G-Function Ln(T/Ts) Value 84

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 84 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_84 or None if not set Return type:float

gfunction_lnt_or_ts_value_85

field G-Function Ln(T/Ts) Value 85

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 85 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_85 or None if not set Return type:float

gfunction_lnt_or_ts_value_86

field G-Function Ln(T/Ts) Value 86

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 86 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_86 or None if not set Return type:float

gfunction_lnt_or_ts_value_87

field G-Function Ln(T/Ts) Value 87

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 87 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_87 or None if not set Return type:float

gfunction_lnt_or_ts_value_88

field G-Function Ln(T/Ts) Value 88

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 88 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_88 or None if not set Return type:float

gfunction_lnt_or_ts_value_89

field G-Function Ln(T/Ts) Value 89

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 89 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_89 or None if not set Return type:float

gfunction_lnt_or_ts_value_9

field G-Function Ln(T/Ts) Value 9

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 9 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_9 or None if not set Return type:float

gfunction_lnt_or_ts_value_90

field G-Function Ln(T/Ts) Value 90

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 90 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_90 or None if not set Return type:float

gfunction_lnt_or_ts_value_91

field G-Function Ln(T/Ts) Value 91

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 91 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_91 or None if not set Return type:float

gfunction_lnt_or_ts_value_92

field G-Function Ln(T/Ts) Value 92

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 92 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_92 or None if not set Return type:float

gfunction_lnt_or_ts_value_93

field G-Function Ln(T/Ts) Value 93

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 93 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_93 or None if not set Return type:float

gfunction_lnt_or_ts_value_94

field G-Function Ln(T/Ts) Value 94

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 94 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_94 or None if not set Return type:float

gfunction_lnt_or_ts_value_95

field G-Function Ln(T/Ts) Value 95

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 95 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_95 or None if not set Return type:float

gfunction_lnt_or_ts_value_96

field G-Function Ln(T/Ts) Value 96

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 96 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_96 or None if not set Return type:float

gfunction_lnt_or_ts_value_97

field G-Function Ln(T/Ts) Value 97

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 97 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_97 or None if not set Return type:float

gfunction_lnt_or_ts_value_98

field G-Function Ln(T/Ts) Value 98

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 98 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_98 or None if not set Return type:float

gfunction_lnt_or_ts_value_99

field G-Function Ln(T/Ts) Value 99

Parameters:value (float) – value for IDD Field G-Function Ln(T/Ts) Value 99 Raises:ValueError – if value is not a valid value Returns:the value of gfunction_lnt_or_ts_value_99 or None if not set Return type:float

gfunction_reference_ratio

field G-Function Reference Ratio

Units: dimensionless

Default value: 0.0005

Parameters:value (float) – value for IDD Field G-Function Reference Ratio Raises:ValueError – if value is not a valid value Returns:the value of gfunction_reference_ratio or None if not set Return type:float

ground_temperature

field Ground Temperature

Units: C

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

ground_thermal_conductivity

field Ground Thermal Conductivity

Units: W/m-K

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

ground_thermal_heat_capacity

field Ground Thermal Heat Capacity

Units: J/m3-K

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

grout_thermal_conductivity

field Grout Thermal Conductivity

Units: W/m-K

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

inlet_node_name

field Inlet Node Name

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

maximum_length_of_simulation

field Maximum Length of Simulation

Units: years

Parameters:value (float) – value for IDD Field Maximum Length of Simulation Raises:ValueError – if value is not a valid value Returns:the value of maximum_length_of_simulation 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_bore_holes

field Number of Bore Holes

Parameters:value (float) – value for IDD Field Number of Bore Holes Raises:ValueError – if value is not a valid value Returns:the value of number_of_bore_holes or None if not set Return type:float

number_of_data_pairs_of_the_g_function

field Number of Data Pairs of the G Function

value <= 100.0

Parameters:value (float) – value for IDD Field Number of Data Pairs of the G Function Raises:ValueError – if value is not a valid value Returns:the value of number_of_data_pairs_of_the_g_function or None if not set Return type:float

outlet_node_name

field Outlet Node Name

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

pipe_out_diameter

field Pipe Out Diameter

Units: m

IP-Units: in

Parameters:value (float) – value for IDD Field Pipe Out Diameter Raises:ValueError – if value is not a valid value Returns:the value of pipe_out_diameter or None if not set Return type:float

pipe_thermal_conductivity

field Pipe Thermal Conductivity

Units: W/m-K

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

pipe_thickness

field Pipe Thickness

Units: m

IP-Units: in

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

utube_distance

field U-Tube Distance

Units: m

Parameters:value (float) – value for IDD Field U-Tube Distance Raises:ValueError – if value is not a valid value Returns:the value of utube_distance or None if not set Return type:float

class pyidf.condenser_equipment_and_heat_exchangers.HeatExchangerFluidToFluid

Bases: pyidf.helper.DataObject

Corresponds to IDD object HeatExchanger:FluidToFluid A fluid/fluid heat exchanger designed to couple the supply side of one loop to the demand side of another loop Loops can be either plant or condenser loops but no air side connections are allowed

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.

default is that heat exchanger is on

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

component_override_cooling_control_temperature_mode

field Component Override Cooling Control Temperature Mode

This field is only used if Control Type is set to CoolingSetpointOnOffWithComponentOverride

Default value: Loop

Parameters:value (str) – value for IDD Field Component Override Cooling Control Temperature Mode Raises:ValueError – if value is not a valid value Returns:the value of component_override_cooling_control_temperature_mode or None if not set Return type:str

component_override_loop_demand_side_inlet_node_name

field Component Override Loop Demand Side Inlet Node Name

This field is only used if Control Type is set to CoolingSetpointOnOffWithComponentOverride

Parameters:value (str) – value for IDD Field Component Override Loop Demand Side Inlet Node Name Raises:ValueError – if value is not a valid value Returns:the value of component_override_loop_demand_side_inlet_node_name or None if not set Return type:str

component_override_loop_supply_side_inlet_node_name

field Component Override Loop Supply Side Inlet Node Name

This field is only used if Control Type is set to CoolingSetpointOnOffWithComponentOverride

Parameters:value (str) – value for IDD Field Component Override Loop Supply Side Inlet Node Name Raises:ValueError – if value is not a valid value Returns:the value of component_override_loop_supply_side_inlet_node_name or None if not set Return type:str

control_type

field Control Type

Default value: UncontrolledOn

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

heat_exchange_model_type

field Heat Exchange Model Type

Default value: Ideal

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

heat_exchanger_setpoint_node_name

field Heat Exchanger Setpoint Node Name

Setpoint node is needed with any Control Type that is “Setpoint“

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

heat_exchanger_ufactor_times_area_value

field Heat Exchanger U-Factor Times Area Value

Units: W/k

Parameters:value (float or “Autosize”) – value for IDD Field Heat Exchanger U-Factor Times Area Value Raises:ValueError – if value is not a valid value Returns:the value of heat_exchanger_ufactor_times_area_value or None if not set Return type:float or “Autosize”

heat_transfer_metering_end_use_type

field Heat Transfer Metering End Use Type

This field controls end use reporting for heat transfer meters

Default value: LoopToLoop

Parameters:value (str) – value for IDD Field Heat Transfer Metering End Use Type Raises:ValueError – if value is not a valid value Returns:the value of heat_transfer_metering_end_use_type or None if not set Return type:str

loop_demand_side_design_flow_rate

field Loop Demand Side Design Flow Rate

Units: m3/s

IP-Units: gal/min

Parameters:value (float or “Autosize”) – value for IDD Field Loop Demand Side Design Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of loop_demand_side_design_flow_rate or None if not set Return type:float or “Autosize”

loop_demand_side_inlet_node_name

field Loop Demand Side Inlet Node Name

This connection is to the demand side of a loop and is the inlet to the heat exchanger

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

loop_demand_side_outlet_node_name

field Loop Demand Side Outlet Node Name

This connection is to the demand side of a loop

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

loop_supply_side_design_flow_rate

field Loop Supply Side Design Flow Rate

Units: m3/s

IP-Units: gal/min

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

loop_supply_side_inlet_node_name

field Loop Supply Side Inlet Node Name

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

loop_supply_side_outlet_node_name

field Loop Supply Side Outlet Node Name

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

minimum_temperature_difference_to_activate_heat_exchanger

field Minimum Temperature Difference to Activate Heat Exchanger

Tolerance between control temperatures used to determine if heat exchanger should run.

Units: deltaC

Default value: 0.01

value <= 50.0

Parameters:value (float) – value for IDD Field Minimum Temperature Difference to Activate Heat Exchanger Raises:ValueError – if value is not a valid value Returns:the value of minimum_temperature_difference_to_activate_heat_exchanger 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

operation_maximum_temperature_limit

field Operation Maximum Temperature Limit

Upper limit on inlet temperatures, heat exchanger will not operate if either inlet is above this limit

Units: C

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

operation_minimum_temperature_limit

field Operation Minimum Temperature Limit

Lower limit on inlet temperatures, heat exchanger will not operate if either inlet is below this limit

Units: C

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

sizing_factor

field Sizing Factor

Multiplies the autosized flow rates for this device

Default value: 1.0

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