pyidf.fans module¶

Data objects in group “Fans”

class pyidf.fans.FanComponentModel¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object Fan:ComponentModel A detailed fan type for constant-air-volume (CAV) and variable-air-volume (VAV) systems. It includes inputs that describe the air-distribution system as well as the fan, drive belt (if used), motor, and variable-frequency-drive (if used).

air_inlet_node_name¶

field Air Inlet Node Name

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

air_outlet_node_name¶

field Air Outlet Node Name

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

availability_schedule_name¶

field Availability Schedule Name

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

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

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

belt_fractional_torque_transition¶

field Belt Fractional Torque Transition

Region 1 to 2 curve transition for belt normalized efficiency
Default value: 0.167
value <= 1.0

Parameters:	value (float) – value for IDD Field Belt Fractional Torque Transition
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of belt_fractional_torque_transition or None if not set
Return type:	float

belt_maximum_torque¶

field Belt Maximum Torque

Maximum torque transmitted by belt

Units: N-m

Parameters:	value (float or “Autosize”) – value for IDD Field Belt Maximum Torque
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of belt_maximum_torque or None if not set
Return type:	float or “Autosize”

belt_sizing_factor¶

field Belt Sizing Factor

Applied to specified or autosized max torque transmitted by belt
Default value: 1.0
value >= 1.0

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

duct_static_pressure_reset_curve_name¶

field Duct Static Pressure Reset Curve Name

Function of fan volumetric flow
Minimum and maximum fan airflows correspond respectively to
minimum and maximum duct static pressure set points

Parameters:	value (str) – value for IDD Field Duct Static Pressure Reset Curve Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of duct_static_pressure_reset_curve_name or None if not set
Return type:	str

enduse_subcategory¶

field End-Use Subcategory

Default value: General

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

euler_number_at_maximum_fan_static_efficiency¶

field Euler Number at Maximum Fan Static Efficiency

Euler number (Eu) determined from fan performance data

Parameters:	value (float) – value for IDD Field Euler Number at Maximum Fan Static Efficiency
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of euler_number_at_maximum_fan_static_efficiency or None if not set
Return type:	float

fan_outlet_area¶

field Fan Outlet Area

Area at fan outlet plane for determining discharge velocity pressure

Units: m2

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

fan_pressure_rise_curve_name¶

field Fan Pressure Rise Curve Name

Pressure rise depends on volumetric flow, system resistances,

system leakage, and duct static pressure set point

Parameters:	value (str) – value for IDD Field Fan Pressure Rise Curve Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of fan_pressure_rise_curve_name or None if not set
Return type:	str

fan_sizing_factor¶

field Fan Sizing Factor

Applied to specified or autosized max fan airflow
Default value: 1.0
value >= 1.0

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

fan_wheel_diameter¶

field Fan Wheel Diameter

Diameter of wheel outer circumference

Units: m

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

maximum_belt_efficiency_curve_name¶

field Maximum Belt Efficiency Curve Name

Determines maximum fan drive belt efficiency in log space
as function of xbelt,max
Curve should have minimum of -4.6 and maximum of 0.0
If field blank, assumes output of curve is always 1.0

Parameters:	value (str) – value for IDD Field Maximum Belt Efficiency Curve Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of maximum_belt_efficiency_curve_name or None if not set
Return type:	str

maximum_dimensionless_fan_airflow¶

field Maximum Dimensionless Fan Airflow

Corresponds to maximum ratio between fan airflow and
fan shaft rotational speed for specified fan wheel diameter
Determined from fan performance data

Parameters:	value (float) – value for IDD Field Maximum Dimensionless Fan Airflow
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of maximum_dimensionless_fan_airflow or None if not set
Return type:	float

maximum_fan_static_efficiency¶

field Maximum Fan Static Efficiency

Maximum ratio between power delivered to air and fan shaft input power
Determined from fan performance data
value <= 1.0

Parameters:	value (float) – value for IDD Field Maximum Fan Static Efficiency
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of maximum_fan_static_efficiency or None if not set
Return type:	float

maximum_flow_rate¶

field Maximum Flow Rate

Units: m3/s

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

maximum_motor_efficiency_curve_name¶

field Maximum Motor Efficiency Curve Name

Curve should have minimum > 0.0 and maximum of 1.0

If field blank, assumes output of curve is always 1.0

Parameters:	value (str) – value for IDD Field Maximum Motor Efficiency Curve Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of maximum_motor_efficiency_curve_name or None if not set
Return type:	str

maximum_motor_output_power¶

field Maximum Motor Output Power

Maximum power input to drive belt by motor

Units: W

Parameters:	value (float or “Autosize”) – value for IDD Field Maximum Motor Output Power
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of maximum_motor_output_power or None if not set
Return type:	float or “Autosize”

maximum_vfd_output_power¶

field Maximum VFD Output Power

Maximum power input to motor by VFD

Units: W

Parameters:	value (float or “Autosize”) – value for IDD Field Maximum VFD Output Power
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of maximum_vfd_output_power or None if not set
Return type:	float or “Autosize”

minimum_flow_rate¶

field Minimum Flow Rate

Units: m3/s

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

motor_fan_pulley_ratio¶

field Motor Fan Pulley Ratio

Ratio of motor pulley diameter to fan pulley diameter

Default value: 1.0

Parameters:	value (float or “Autosize”) – value for IDD Field Motor Fan Pulley Ratio
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of motor_fan_pulley_ratio or None if not set
Return type:	float or “Autosize”

motor_in_airstream_fraction¶

field Motor In Airstream Fraction

0.0 means motor outside air stream
1.0 means motor inside air stream
Default value: 1.0
value <= 1.0

Parameters:	value (float) – value for IDD Field Motor In Airstream Fraction
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of motor_in_airstream_fraction or None if not set
Return type:	float

motor_maximum_speed¶

field Motor Maximum Speed

Maximum rotational speed of fan motor shaft

Units: rev/min

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

motor_sizing_factor¶

field Motor Sizing Factor

Applied to specified or autosized motor output power
Default value: 1.0
value >= 1.0

Parameters:	value (float) – value for IDD Field Motor Sizing Factor
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of motor_sizing_factor 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

normalized_belt_efficiency_curve_name_region_1¶

field Normalized Belt Efficiency Curve Name - Region 1

Region 1 (0 <= xbelt < xbelt,trans)
Curve should have minimum > 0.0 and maximum of 1.0
If field blank, assumes output of curve is always 1.0 in Region 1

Parameters:	value (str) – value for IDD Field Normalized Belt Efficiency Curve Name - Region 1
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of normalized_belt_efficiency_curve_name_region_1 or None if not set
Return type:	str

normalized_belt_efficiency_curve_name_region_2¶

field Normalized Belt Efficiency Curve Name - Region 2

Region 2 (xbelt,trans <= xbelt <= 1)
Curve should have minimum > 0.0 and maximum of 1.0
If field blank, assumes output of curve is always 1.0 in Region 2

Parameters:	value (str) – value for IDD Field Normalized Belt Efficiency Curve Name - Region 2
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of normalized_belt_efficiency_curve_name_region_2 or None if not set
Return type:	str

normalized_belt_efficiency_curve_name_region_3¶

field Normalized Belt Efficiency Curve Name - Region 3

Determines normalized drive belt efficiency Region 3 (xbelt > 1)
Curve should have minimum > 0.0 and maximum of 1.0
If field blank, assumes output of curve is always 1.0 in Region 3

Parameters:	value (str) – value for IDD Field Normalized Belt Efficiency Curve Name - Region 3
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of normalized_belt_efficiency_curve_name_region_3 or None if not set
Return type:	str

normalized_dimensionless_airflow_curve_namenonstall_region¶

field Normalized Dimensionless Airflow Curve Name-Non-Stall Region

xspd <= 0

Curve should have maximum of 1.0

Parameters:	value (str) – value for IDD Field Normalized Dimensionless Airflow Curve Name-Non-Stall Region
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of normalized_dimensionless_airflow_curve_namenonstall_region or None if not set
Return type:	str

normalized_dimensionless_airflow_curve_namestall_region¶

field Normalized Dimensionless Airflow Curve Name-Stall Region

xspd > 0

Curve should have maximum of 1.0

Parameters:	value (str) – value for IDD Field Normalized Dimensionless Airflow Curve Name-Stall Region
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of normalized_dimensionless_airflow_curve_namestall_region or None if not set
Return type:	str

normalized_fan_static_efficiency_curve_namenonstall_region¶

field Normalized Fan Static Efficiency Curve Name-Non-Stall Region

xfan <= 0

Curve should have maximum of 1.0

Parameters:	value (str) – value for IDD Field Normalized Fan Static Efficiency Curve Name-Non-Stall Region
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of normalized_fan_static_efficiency_curve_namenonstall_region or None if not set
Return type:	str

normalized_fan_static_efficiency_curve_namestall_region¶

field Normalized Fan Static Efficiency Curve Name-Stall Region

xfan > 0

Curve should have maximum of 1.0

Parameters:	value (str) – value for IDD Field Normalized Fan Static Efficiency Curve Name-Stall Region
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of normalized_fan_static_efficiency_curve_namestall_region or None if not set
Return type:	str

normalized_motor_efficiency_curve_name¶

field Normalized Motor Efficiency Curve Name

Curve should have minimum > 0.0 and maximum of 1.0

If field blank, assumes output of curve is always 1.0

Parameters:	value (str) – value for IDD Field Normalized Motor Efficiency Curve Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of normalized_motor_efficiency_curve_name or None if not set
Return type:	str

vfd_efficiency_curve_name¶

field VFD Efficiency Curve Name

Determines VFD efficiency as function of motor load or speed fraction
Curve should have minimum > 0.0 and maximum of 1.0
If field blank, assumes constant VFD efficiency (0.97)

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

vfd_efficiency_type¶

field VFD Efficiency Type

Efficiency depends on fraction of full-load motor speed
Efficiency depends on  fraction of full-load motor input power
If field blank, then assumes constant VFD efficiency (0.97)

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

vfd_sizing_factor¶

field VFD Sizing Factor

Applied to specified or autosized VFD output power
Default value: 1.0
value >= 1.0

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

class pyidf.fans.FanConstantVolume¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object Fan:ConstantVolume Constant volume fan that is intended to operate continuously based on a time schedule. This fan will not cycle on and off based on cooling/heating load or other control signals.

air_inlet_node_name¶

field Air Inlet Node Name

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

air_outlet_node_name¶

field Air Outlet Node Name

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

availability_schedule_name¶

field Availability Schedule Name

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

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

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

enduse_subcategory¶

field End-Use Subcategory

Default value: General

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

fan_total_efficiency¶

field Fan Total Efficiency

Default value: 0.7

value <= 1.0

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

maximum_flow_rate¶

field Maximum Flow Rate

Units: m3/s

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

motor_efficiency¶

field 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

motor_in_airstream_fraction¶

field Motor In Airstream Fraction

0.0 means fan motor outside of air stream, 1.0 means motor inside of air stream
Default value: 1.0
value <= 1.0

Parameters:	value (float) – value for IDD Field Motor In Airstream Fraction
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of motor_in_airstream_fraction 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

pressure_rise¶

field Pressure Rise

Units: Pa

IP-Units: inH2O

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

class pyidf.fans.FanOnOff¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object Fan:OnOff Constant volume fan that is intended to cycle on and off based on cooling/heating load or other control signals. This fan can also operate continuously like Fan:ConstantVolume.

air_inlet_node_name¶

field Air Inlet Node Name

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

air_outlet_node_name¶

field Air Outlet Node Name

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

availability_schedule_name¶

field Availability Schedule Name

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

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

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

enduse_subcategory¶

field End-Use Subcategory

Default value: General

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

fan_efficiency_ratio_function_of_speed_ratio_curve_name¶

field Fan Efficiency Ratio Function of Speed Ratio Curve Name

Parameters:	value (str) – value for IDD Field Fan Efficiency Ratio Function of Speed Ratio Curve Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of fan_efficiency_ratio_function_of_speed_ratio_curve_name or None if not set
Return type:	str

fan_power_ratio_function_of_speed_ratio_curve_name¶

field Fan Power Ratio Function of Speed Ratio Curve Name

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

fan_total_efficiency¶

field Fan Total Efficiency

Default value: 0.6

value <= 1.0

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

maximum_flow_rate¶

field Maximum Flow Rate

Units: m3/s

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

motor_efficiency¶

field Motor Efficiency

Default value: 0.8

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

motor_in_airstream_fraction¶

field Motor In Airstream Fraction

0.0 means fan motor outside of air stream, 1.0 means motor inside of air stream
Default value: 1.0
value <= 1.0

Parameters:	value (float) – value for IDD Field Motor In Airstream Fraction
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of motor_in_airstream_fraction 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

pressure_rise¶

field Pressure Rise

Units: Pa

IP-Units: inH2O

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

class pyidf.fans.FanPerformanceNightVentilation¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object FanPerformance:NightVentilation Specifies an alternate set of performance parameters for a fan. These alternate parameters are used when a system manager (such as AvailabilityManager:NightVentilation) sets a specified flow rate. May be used with any type of fan except not with Fan:ComponentModel. If the fan model senses that a fixed flow rate has been set, it will use these alternate performance parameters. It is assumed that the fan will run at a fixed speed in the alternate mode.

fan_name¶

field Fan Name

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

fan_total_efficiency¶

field Fan Total Efficiency

value <= 1.0

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

maximum_flow_rate¶

field Maximum Flow Rate

Units: m3/s

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

motor_efficiency¶

field Motor Efficiency

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

motor_in_airstream_fraction¶

field Motor in Airstream Fraction

0.0 means fan motor outside of airstream
1.0 means fan motor inside of airstream
Default value: 1.0
value <= 1.0

Parameters:	value (float) – value for IDD Field Motor in Airstream Fraction
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of motor_in_airstream_fraction or None if not set
Return type:	float

pressure_rise¶

field Pressure Rise

Units: Pa

IP-Units: inH2O

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

class pyidf.fans.FanVariableVolume¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object Fan:VariableVolume Variable air volume fan where the electric power input varies according to a performance curve as a function of flow fraction.

air_inlet_node_name¶

field Air Inlet Node Name

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

air_outlet_node_name¶

field Air Outlet Node Name

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

availability_schedule_name¶

field Availability Schedule Name

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

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

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

enduse_subcategory¶

field End-Use Subcategory

Default value: General

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

fan_power_coefficient_1¶

field Fan Power Coefficient 1

all Fan Power Coefficients should not be 0.0 or no fan power will be consumed.
Fan Power Coefficents are specified as function of full flow rate/power
Equation:

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

fan_power_coefficient_2¶

field Fan Power Coefficient 2

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

fan_power_coefficient_3¶

field Fan Power Coefficient 3

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

fan_power_coefficient_4¶

field Fan Power Coefficient 4

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

fan_power_coefficient_5¶

field Fan Power Coefficient 5

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

fan_power_minimum_air_flow_rate¶

field Fan Power Minimum Air Flow Rate

Units: m3/s

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

fan_power_minimum_flow_fraction¶

field Fan Power Minimum Flow Fraction

Default value: 0.25

value <= 1.0

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

fan_power_minimum_flow_rate_input_method¶

field Fan Power Minimum Flow Rate Input Method

Default value: Fraction

Parameters:	value (str) – value for IDD Field Fan Power Minimum Flow Rate Input Method
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of fan_power_minimum_flow_rate_input_method or None if not set
Return type:	str

fan_total_efficiency¶

field Fan Total Efficiency

Default value: 0.7

value <= 1.0

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

maximum_flow_rate¶

field Maximum Flow Rate

Units: m3/s

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

motor_efficiency¶

field 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

motor_in_airstream_fraction¶

field Motor In Airstream Fraction

0.0 means fan motor outside of air stream, 1.0 means motor inside of air stream
Default value: 1.0
value <= 1.0

Parameters:	value (float) – value for IDD Field Motor In Airstream Fraction
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of motor_in_airstream_fraction 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

pressure_rise¶

field Pressure Rise

Units: Pa

IP-Units: inH2O

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

class pyidf.fans.FanZoneExhaust¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object Fan:ZoneExhaust Models a fan that exhausts air from a zone.

air_inlet_node_name¶

field Air Inlet Node Name

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

air_outlet_node_name¶

field Air Outlet Node Name

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

availability_schedule_name¶

field Availability Schedule Name

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

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

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

balanced_exhaust_fraction_schedule_name¶

field Balanced Exhaust Fraction Schedule Name

Used to control fan’s impact on flow at the return air node. Enter the portion of the exhaust that is balanced by simple airflows.

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

enduse_subcategory¶

field End-Use Subcategory

Default value: General

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

fan_total_efficiency¶

field Fan Total Efficiency

Default value: 0.6

value <= 1.0

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

flow_fraction_schedule_name¶

field Flow Fraction Schedule Name

If field is used, then when fan runs the exhausted air flow rate is controlled to be the scheduled fraction times the Maximum Flow Rate

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

maximum_flow_rate¶

field Maximum Flow Rate

Units: m3/s

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

minimum_zone_temperature_limit_schedule_name¶

field Minimum Zone Temperature Limit Schedule Name

If field is used, the exhaust fan will not run if the zone temperature is lower than this limit

Parameters:	value (str) – value for IDD Field Minimum Zone Temperature Limit Schedule Name
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of minimum_zone_temperature_limit_schedule_name or None if not set
Return type:	str

name¶

field Name

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

pressure_rise¶

field Pressure Rise

Units: Pa

IP-Units: inH2O

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

system_availability_manager_coupling_mode¶

field System Availability Manager Coupling Mode

Control if fan is to be interlocked with HVAC system Availability Managers or not.

Default value: Coupled

Parameters:	value (str) – value for IDD Field System Availability Manager Coupling Mode
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of system_availability_manager_coupling_mode or None if not set
Return type:	str

pyidf.fans module¶

Related Topics

This Page