pyidf.pumps module

Data objects in group “Pumps”

class pyidf.pumps.HeaderedPumpsConstantSpeed

Bases: pyidf.helper.DataObject

Corresponds to IDD object HeaderedPumps:ConstantSpeed This Headered pump object describes a pump bank with more than 1 pump in parallel

flow_sequencing_control_scheme

field Flow Sequencing Control Scheme

Default value: Sequential

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

fraction_of_motor_inefficiencies_to_fluid_stream

field Fraction of Motor Inefficiencies to Fluid Stream

value <= 1.0

Parameters:value (float) – value for IDD Field Fraction of Motor Inefficiencies to Fluid Stream Raises:ValueError – if value is not a valid value Returns:the value of fraction_of_motor_inefficiencies_to_fluid_stream 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

motor_efficiency

field Motor Efficiency

This is the motor efficiency only. When the Rated Power Consumption if autosized,

an impeller efficiency of 0.78 is assumed in addition to the motor efficiency.

Default value: 0.9

value <= 1.0

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

name

field Name

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

number_of_pumps_in_bank

field Number of Pumps in Bank

Parameters:value (int) – value for IDD Field Number of Pumps in Bank Raises:ValueError – if value is not a valid value Returns:the value of number_of_pumps_in_bank 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

pump_control_type

field Pump Control Type

Default value: Continuous

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

pump_flow_rate_schedule_name

field Pump Flow Rate Schedule Name

Modifies the rated flow rate of the pump on a time basis. Default is

that the pump is on and runs according to its other operational requirements

specified above. The schedule is for special pump operations.

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

rated_power_consumption

field Rated Power Consumption

If the field is not autosized set to the power consumed by the pump bank

when all the pumps are running at nominal flow

If this field is autosized, an impeller efficiency of 0.78 is assumed.

autosized Rated Power Consumption = Total Rated Flow Rate * Rated Pump Head / (0.78 * Motor Efficiency)

Units: W

IP-Units: W

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

rated_pump_head

field Rated Pump Head

default head is 60 feet

Units: Pa

IP-Units: ftH2O

Default value: 179352.0

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

skin_loss_radiative_fraction

field Skin Loss Radiative Fraction

optional. If zone identified in previous field then this determines

the split between convection and radiation for the skin losses

value <= 1.0

Parameters:value (float) – value for IDD Field Skin Loss Radiative Fraction Raises:ValueError – if value is not a valid value Returns:the value of skin_loss_radiative_fraction or None if not set Return type:float

total_rated_flow_rate

field Total Rated Flow Rate

If the field is not autosized set to the flow rate to

the total flow when all pumps are running at full load

Units: m3/s

IP-Units: gal/min

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

zone_name

field Zone Name

optional, if used pump losses transfered to zone as internal gains

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

class pyidf.pumps.HeaderedPumpsVariableSpeed

Bases: pyidf.helper.DataObject

Corresponds to IDD object HeaderedPumps:VariableSpeed This Headered pump object describes a pump bank with more than 1 pump in parallel

coefficient_1_of_the_part_load_performance_curve

field Coefficient 1 of the Part Load Performance Curve

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

coefficient_2_of_the_part_load_performance_curve

field Coefficient 2 of the Part Load Performance Curve

Default value: 1.0

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

coefficient_3_of_the_part_load_performance_curve

field Coefficient 3 of the Part Load Performance Curve

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

coefficient_4_of_the_part_load_performance_curve

field Coefficient 4 of the Part Load Performance Curve

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

flow_sequencing_control_scheme

field Flow Sequencing Control Scheme

Default value: Sequential

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

fraction_of_motor_inefficiencies_to_fluid_stream

field Fraction of Motor Inefficiencies to Fluid Stream

value <= 1.0

Parameters:value (float) – value for IDD Field Fraction of Motor Inefficiencies to Fluid Stream Raises:ValueError – if value is not a valid value Returns:the value of fraction_of_motor_inefficiencies_to_fluid_stream 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

minimum_flow_rate_fraction

field Minimum Flow Rate Fraction

This value can be zero and will be defaulted to that if not specified.

value <= 1.0

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

motor_efficiency

field Motor Efficiency

This is the motor efficiency only. When the Rated Power Consumption if autosized,

an impeller efficiency of 0.78 is assumed in addition to the motor efficiency.

Default value: 0.9

value <= 1.0

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

name

field Name

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

number_of_pumps_in_bank

field Number of Pumps in Bank

Parameters:value (int) – value for IDD Field Number of Pumps in Bank Raises:ValueError – if value is not a valid value Returns:the value of number_of_pumps_in_bank 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

pump_control_type

field Pump Control Type

Default value: Continuous

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

pump_flow_rate_schedule_name

field Pump Flow Rate Schedule Name

Modifies the rated flow rate of the pump on a time basis. Default is

that the pump is on and runs according to its other operational requirements

specified above. The schedule is for special pump operations.

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

rated_power_consumption

field Rated Power Consumption

If the field is not autosized set to the power consumed by the pump bank

when all the pumps are running at nominal flow

If this field is autosized, an impeller efficiency of 0.78 is assumed.

autosized Rated Power Consumption = Total Rated Flow Rate * Rated Pump Head / (0.78 * Motor Efficiency)

Units: W

IP-Units: W

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

rated_pump_head

field Rated Pump Head

default head is 60 feet

Units: Pa

IP-Units: ftH2O

Default value: 179352.0

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

skin_loss_radiative_fraction

field Skin Loss Radiative Fraction

optional. If zone identified in previous field then this determines

the split between convection and radiation for the skin losses

value <= 1.0

Parameters:value (float) – value for IDD Field Skin Loss Radiative Fraction Raises:ValueError – if value is not a valid value Returns:the value of skin_loss_radiative_fraction or None if not set Return type:float

total_rated_flow_rate

field Total Rated Flow Rate

If the field is not autosized set to the flow rate to

the total flow when all pumps are running at full load

Units: m3/s

IP-Units: gal/min

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

zone_name

field Zone Name

optional, if used pump losses transfered to zone as internal gains

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

class pyidf.pumps.PumpConstantSpeed

Bases: pyidf.helper.DataObject

Corresponds to IDD object Pump:ConstantSpeed This pump model is described in the ASHRAE secondary HVAC toolkit.

fraction_of_motor_inefficiencies_to_fluid_stream

field Fraction of Motor Inefficiencies to Fluid Stream

value <= 1.0

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

impeller_diameter

field Impeller Diameter

“D” in above expression in field A6

Units: m

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

motor_efficiency

field Motor Efficiency

This is the motor efficiency only. When the Rated Power Consumption if autosized,

an impeller efficiency of 0.78 is assumed in addition to the motor efficiency.

Default value: 0.9

value <= 1.0

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

name

field Name

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

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

pump_control_type

field Pump Control Type

Default value: Continuous

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

pump_curve_name

field Pump Curve Name

This references any single independent variable polynomial curve in order to

do pressure vs. flow calculations for this pump. The available types are then:

Linear, Quadratic, Cubic, and Quartic

The non-dimensional pump pressure relationship is of the following form:

(psi = C4*phi^4 + C3*phi^3 + C2*phi^2 + C1*phi + C0)

Where the non-dimensional variables are defined as:

delP = rho * ((N/60)^2) * (D^2) * psi

mdot = rho * (N/60) * (D^3) * phi

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

pump_flow_rate_schedule_name

field Pump Flow Rate Schedule Name

Modifies the rated flow rate of the pump on a time basis. Default is

that the pump is on and runs according to its other operational requirements

specified above. The schedule is for special pump operations.

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

rated_flow_rate

field Rated Flow Rate

Units: m3/s

IP-Units: gal/min

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

rated_power_consumption

field Rated Power Consumption

If this field is autosized, an impeller efficiency of 0.78 is assumed.

autosized Rated Power Consumption = Rated Flow Rate * Rated Pump Head / (0.78 * Motor Efficiency)

Units: W

IP-Units: W

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

rated_pump_head

field Rated Pump Head

default head is 60 feet

Units: Pa

IP-Units: ftH2O

Default value: 179352.0

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

rotational_speed

field Rotational Speed

“N” in above expression in field A6

Units: rev/min

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

skin_loss_radiative_fraction

field Skin Loss Radiative Fraction

optional. If zone identified in previous field then this determines

the split between convection and radiation for the skin losses

value <= 1.0

Parameters:value (float) – value for IDD Field Skin Loss Radiative Fraction Raises:ValueError – if value is not a valid value Returns:the value of skin_loss_radiative_fraction or None if not set Return type:float

zone_name

field Zone Name

optional, if used pump losses transfered to zone as internal gains

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

class pyidf.pumps.PumpVariableSpeed

Bases: pyidf.helper.DataObject

Corresponds to IDD object Pump:VariableSpeed This pump model is described in the ASHRAE secondary HVAC toolkit.

coefficient_1_of_the_part_load_performance_curve

field Coefficient 1 of the Part Load Performance Curve

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

coefficient_2_of_the_part_load_performance_curve

field Coefficient 2 of the Part Load Performance Curve

Default value: 1.0

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

coefficient_3_of_the_part_load_performance_curve

field Coefficient 3 of the Part Load Performance Curve

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

coefficient_4_of_the_part_load_performance_curve

field Coefficient 4 of the Part Load Performance Curve

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

fraction_of_motor_inefficiencies_to_fluid_stream

field Fraction of Motor Inefficiencies to Fluid Stream

value <= 1.0

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

impeller_diameter

field Impeller Diameter

“D” in above expression in field A6

Units: m

Parameters:value (float) – value for IDD Field Impeller Diameter Raises:ValueError – if value is not a valid value Returns:the value of impeller_diameter 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_pressure_schedule

field Maximum Pressure Schedule

Units: Pa

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

maximum_rpm_schedule

field Maximum RPM Schedule

Units: Rotations Per Minute

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

minimum_flow_rate

field Minimum Flow Rate

This value can be zero and will be defaulted to that if not specified.

Units: m3/s

IP-Units: gal/min

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

minimum_pressure_schedule

field Minimum Pressure Schedule

Units: Pa

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

minimum_rpm_schedule

field Minimum RPM Schedule

Units: Rotations Per Minute

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

motor_efficiency

field Motor Efficiency

This is the motor efficiency only. When the Rated Power Consumption if autosized,

an impeller efficiency of 0.78 is assumed in addition to the motor efficiency.

Default value: 0.9

value <= 1.0

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

name

field Name

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

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

pump_control_type

field Pump Control Type

Default value: Continuous

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

pump_curve_name

field Pump Curve Name

This references any single independent variable polynomial curve in order to

do pressure vs. flow calculations for this pump. The available types are then:

Linear, Quadratic, Cubic, and Quartic

The non-dimensional pump pressure relationship is of the following form:

(psi = C4*phi^4 + C3*phi^3 + C2*phi^2 + C1*phi + C0)

Where the non-dimensional variables are defined as:

delP = rho * ((N/60)^2) * (D^2) * psi

mdot = rho * (N/60) * (D^3) * phi

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

pump_flow_rate_schedule_name

field Pump Flow Rate Schedule Name

Modifies the rated flow rate of the pump on a time basis. Default is

that the pump is on and runs according to its other operational requirements

specified above. The schedule is for special pump operations.

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

pump_rpm_schedule_name

field Pump rpm Schedule Name

Modifies the rpm of the pump on a time basis. Default is

that the pump is on and runs according to its other operational requirements

specified above. The schedule is for special pump operations.

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

rated_flow_rate

field Rated Flow Rate

Units: m3/s

IP-Units: gal/min

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

rated_power_consumption

field Rated Power Consumption

If this field is autosized, an impeller efficiency of 0.78 is assumed.

autosized Rated Power Consumption = Rated Flow Rate * Rated Pump Head / (0.78 * Motor Efficiency)

Units: W

IP-Units: W

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

rated_pump_head

field Rated Pump Head

default head is 60 feet

Units: Pa

IP-Units: ftH2O

Default value: 179352.0

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

skin_loss_radiative_fraction

field Skin Loss Radiative Fraction

optional. If zone identified in previous field then this determines

the split between convection and radiation for the skin losses

value <= 1.0

Parameters:value (float) – value for IDD Field Skin Loss Radiative Fraction Raises:ValueError – if value is not a valid value Returns:the value of skin_loss_radiative_fraction or None if not set Return type:float

vfd_control_type

field VFD Control Type

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

zone_name

field Zone Name

optional, if used pump losses transfered to zone as internal gains

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

class pyidf.pumps.PumpVariableSpeedCondensate

Bases: pyidf.helper.DataObject

Corresponds to IDD object Pump:VariableSpeed:Condensate This pump model is described in the ASHRAE secondary HVAC toolkit. Variable Speed Condensate pump for Steam Systems

coefficient_1_of_the_part_load_performance_curve

field Coefficient 1 of the Part Load Performance Curve

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

coefficient_2_of_the_part_load_performance_curve

field Coefficient 2 of the Part Load Performance Curve

Default value: 1.0

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

coefficient_3_of_the_part_load_performance_curve

field Coefficient 3 of the Part Load Performance Curve

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

coefficient_4_of_the_part_load_performance_curve

field Coefficient 4 of the Part Load Performance Curve

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

fraction_of_motor_inefficiencies_to_fluid_stream

field Fraction of Motor Inefficiencies to Fluid Stream

value <= 1.0

Parameters:value (float) – value for IDD Field Fraction of Motor Inefficiencies to Fluid Stream Raises:ValueError – if value is not a valid value Returns:the value of fraction_of_motor_inefficiencies_to_fluid_stream 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

motor_efficiency

field Motor Efficiency

This is the motor efficiency only. When the Rated Power Consumption if autosized,

an impeller efficiency of 0.78 is assumed in addition to the motor efficiency.

Default value: 0.9

value <= 1.0

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

name

field Name

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

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

pump_flow_rate_schedule_name

field Pump Flow Rate Schedule Name

Modifies the rated flow rate of the pump on a time basis. Default is

that the pump is on and runs according to its other operational requirements

specified above. The schedule is for special pump operations.

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

rated_flow_rate

field Rated Flow Rate

Units: m3/s

IP-Units: gal/min

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

rated_power_consumption

field Rated Power Consumption

If this field is autosized, an impeller efficiency of 0.78 is assumed.

autosized Rated Power Consumption = Rated Flow Rate * Rated Pump Head / (0.78 * Motor Efficiency)

Units: W

IP-Units: W

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

rated_pump_head

field Rated Pump Head

default head is 60 feet

Units: Pa

IP-Units: ftH2O

Default value: 179352.0

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

skin_loss_radiative_fraction

field Skin Loss Radiative Fraction

optional. If zone identified in previous field then this determines

the split between convection and radiation for the skin losses

value <= 1.0

Parameters:value (float) – value for IDD Field Skin Loss Radiative Fraction Raises:ValueError – if value is not a valid value Returns:the value of skin_loss_radiative_fraction or None if not set Return type:float

zone_name

field Zone Name

optional, if used pump losses transfered to zone as internal gains

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