pyidf.zone_airflow module¶

Data objects in group “Zone Airflow”

class pyidf.zone_airflow.ZoneAirBalanceOutdoorAir¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object ZoneAirBalance:OutdoorAir Provide a combined zone outdoor air flow by including interactions between mechanical ventilation, infiltration and duct leakage. This object will combine outdoor flows from all ZoneInfiltration and ZoneVentilation objects in the same zone. Balanced flows will be summed, while unbalanced flows will be added in quadrature.

air_balance_method¶

field Air Balance Method

None: Only perform simple calculations without using a combined zone outdoor air.
Quadrature: A combined outdoor air is used in the quadrature sum.
Default value: Quadrature

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

induced_outdoor_air_due_to_unbalanced_duct_leakage¶

field Induced Outdoor Air Due to Unbalanced Duct Leakage

Units: m3/s

Parameters:	value (float) – value for IDD Field Induced Outdoor Air Due to Unbalanced Duct Leakage
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of induced_outdoor_air_due_to_unbalanced_duct_leakage or None if not set
Return type:	float

induced_outdoor_air_schedule_name¶

field Induced Outdoor Air Schedule Name

This schedule contains the fraction values applied to the Induced Outdoor Air given in the

previous input field (0.0 - 1.0).

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

zone_name¶

field Zone Name

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.zone_airflow.ZoneCoolTowerShower¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object ZoneCoolTower:Shower A cooltower (sometimes referred to as a wind tower or a shower cooling tower) models passive downdraught evaporative cooling (PDEC) that is designed to capture the wind at the top of a tower and cool the outdoor air using water evaporation before delivering it to a space.

airflow_outlet_area¶

field Airflow Outlet Area

User have to specify effective area when outlet area is relatively bigger than the cross sectional area
of cooltower. If the number of outlet is more than one, assume the air passes through only one.
Units: m2

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

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

effective_tower_height¶

field Effective Tower Height

This field is from either the spray or the wet pad to the top of the outlet.

Units: m

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

flow_control_type¶

field Flow Control Type

Water flow schedule should be selected when the water flow rate is known.
Wind-driven flow should be selected when the water flow rate is unknown.
Default value: WindDrivenFlow

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

fraction_of_flow_schedule¶

field Fraction of Flow Schedule

value <= 1.0

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

fraction_of_water_loss¶

field Fraction of Water Loss

value <= 1.0

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

maximum_air_flow_rate¶

field Maximum Air Flow Rate

Units: m3/s

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

maximum_water_flow_rate¶

field Maximum Water Flow Rate

Units: m3/s

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

minimum_indoor_temperature¶

field Minimum Indoor Temperature

This field is to specify the indoor temperature below which cooltower is shutoff.
Units: C
value >= -100.0
value <= 100.0

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

name¶

field Name

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

pump_flow_rate_schedule_name¶

field Pump Flow Rate Schedule Name

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

Units: W

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

water_supply_storage_tank_name¶

field Water Supply Storage Tank Name

In case of stand alone tank or underground water, leave this input blank

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

zone_name¶

field Zone Name

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.zone_airflow.ZoneCrossMixing¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object ZoneCrossMixing ZoneCrossMixing exchanges an equal amount of air between two zones. Note that this statement affects the energy balance of both zones.

air_changes_per_hour¶

field Air Changes per Hour

Units: 1/hr

Parameters:	value (float) – value for IDD Field Air Changes per Hour
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of air_changes_per_hour or None if not set
Return type:	float

delta_temperature¶

field Delta Temperature

This field contains the constant temperature differential between source and
receiving zones below which cross mixing is shutoff. This value must be greater
than or equal to zero.
Units: deltaC

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

delta_temperature_schedule_name¶

field Delta Temperature Schedule Name

This schedule contains the temperature differential between source and receiving

zones versus time below which cross mixing is shutoff.

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

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

design_flow_rate_calculation_method¶

field Design Flow Rate Calculation Method

The entered calculation method is used to create the maximum amount of ventilation
for this set of attributes
Choices: Flow/Zone => Design Flow Rate – simply enter Design Flow Rate
Flow/Area => Flow Rate per Zone Floor Area - Value * Floor Area (zone) = Design Flow Rate
Flow/Person => Flow Rate per Person - Value * #people = Design Flow Rate
AirChanges/Hour => Air Changes per Hour - Value * Floor Volume (zone) adjusted for m3/s = Design Volume Flow Rate
“Vdesign” in Equation is the result.
Default value: Flow/Zone

Parameters:	value (str) – value for IDD Field Design Flow Rate Calculation Method
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of design_flow_rate_calculation_method or None if not set
Return type:	str

flow_rate_per_person¶

field Flow Rate per Person

Units: m3/s-person

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

flow_rate_per_zone_floor_area¶

field Flow Rate per Zone Floor Area

Units: m3/s-m2

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

maximum_outdoor_temperature_schedule_name¶

field Maximum Outdoor Temperature Schedule Name

This schedule contains the outdoor temperature versus time above which

cross mixing is shutoff.

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

maximum_source_zone_temperature_schedule_name¶

field Maximum Source Zone Temperature Schedule Name

This schedule contains the source zone dry-bulb temperature versus time above

which cross mixing is shutoff.

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

maximum_zone_temperature_schedule_name¶

field Maximum Zone Temperature Schedule Name

This schedule contains the indoor temperature versus time above which

cross mixing is shutoff.

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

minimum_outdoor_temperature_schedule_name¶

field Minimum Outdoor Temperature Schedule Name

This schedule contains the outdoor temperature versus time below which

cross mixing is shutoff.

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

minimum_source_zone_temperature_schedule_name¶

field Minimum Source Zone Temperature Schedule Name

This schedule contains the source zone dry-bulb temperature versus time below

which cross mixing is shutoff.

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

minimum_zone_temperature_schedule_name¶

field Minimum Zone Temperature Schedule Name

This schedule contains the indoor temperature versus time below which

cross mixing is shutoff.

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

schedule_name¶

field Schedule Name

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

source_zone_name¶

field Source Zone Name

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

zone_name¶

field Zone Name

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.zone_airflow.ZoneEarthtube¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object ZoneEarthtube Earth Tube is specified as a design level which is modified by a Schedule fraction, temperature difference and wind speed: Earthtube=Edesign * Fschedule * (A + B*|(Tzone-Todb)| + C*WindSpd + D * WindSpd**2)

amplitude_of_soil_surface_temperature¶

field Amplitude of Soil Surface Temperature

Units: deltaC

Parameters:	value (float) – value for IDD Field Amplitude of Soil Surface Temperature
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of amplitude_of_soil_surface_temperature or None if not set
Return type:	float

average_soil_surface_temperature¶

field Average Soil Surface Temperature

Units: C

Parameters:	value (float) – value for IDD Field Average Soil Surface Temperature
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of average_soil_surface_temperature or None if not set
Return type:	float

constant_term_flow_coefficient¶

field Constant Term Flow Coefficient

“A” in Equation

Default value: 1.0

Parameters:	value (float) – value for IDD Field Constant Term Flow Coefficient
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of constant_term_flow_coefficient or None if not set
Return type:	float

delta_temperature¶

field Delta Temperature

This is the temperature difference between indoor and outdoor below which the earth tube is shut off

Units: deltaC

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

design_flow_rate¶

field Design Flow Rate

“Edesign” in Equation

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

earthtube_type¶

field Earthtube Type

Default value: Natural

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

fan_pressure_rise¶

field Fan Pressure Rise

pressure rise across the fan

Units: Pa

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

fan_total_efficiency¶

field Fan Total Efficiency

Default 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_zone_temperature_when_heating¶

field Maximum Zone Temperature when Heating

this is the indoor temperature above which the earth tube is shut off
Units: C
value >= -100.0
value <= 100.0

Parameters:	value (float) – value for IDD Field Maximum Zone Temperature when Heating
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of maximum_zone_temperature_when_heating or None if not set
Return type:	float

minimum_zone_temperature_when_cooling¶

field Minimum Zone Temperature when Cooling

this is the indoor temperature below which the earth tube is shut off
Units: C
value >= -100.0
value <= 100.0

Parameters:	value (float) – value for IDD Field Minimum Zone Temperature when Cooling
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of minimum_zone_temperature_when_cooling or None if not set
Return type:	float

phase_constant_of_soil_surface_temperature¶

field Phase Constant of Soil Surface Temperature

Units: days

Parameters:	value (float) – value for IDD Field Phase Constant of Soil Surface Temperature
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of phase_constant_of_soil_surface_temperature or None if not set
Return type:	float

pipe_depth_under_ground_surface¶

field Pipe Depth Under Ground Surface

Units: m

Default value: 3.0

Parameters:	value (float) – value for IDD Field Pipe Depth Under Ground Surface
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of pipe_depth_under_ground_surface or None if not set
Return type:	float

pipe_length¶

field Pipe Length

Units: m

Default value: 15.0

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

pipe_radius¶

field Pipe Radius

Units: m

Default value: 1.0

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

pipe_thermal_conductivity¶

field Pipe Thermal Conductivity

Units: W/m-K

Default value: 200.0

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

Default value: 0.2

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

schedule_name¶

field Schedule Name

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

soil_condition¶

field Soil Condition

Default value: HeavyAndDamp

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

temperature_term_flow_coefficient¶

field Temperature Term Flow Coefficient

“B” in Equation

Parameters:	value (float) – value for IDD Field Temperature Term Flow Coefficient
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of temperature_term_flow_coefficient or None if not set
Return type:	float

velocity_squared_term_flow_coefficient¶

field Velocity Squared Term Flow Coefficient

“D” in Equation

Parameters:	value (float) – value for IDD Field Velocity Squared Term Flow Coefficient
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of velocity_squared_term_flow_coefficient or None if not set
Return type:	float

velocity_term_flow_coefficient¶

field Velocity Term Flow Coefficient

“C” in Equation

Parameters:	value (float) – value for IDD Field Velocity Term Flow Coefficient
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of velocity_term_flow_coefficient or None if not set
Return type:	float

zone_name¶

field Zone Name

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.zone_airflow.ZoneInfiltrationDesignFlowRate¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object ZoneInfiltration:DesignFlowRate Infiltration is specified as a design level which is modified by a Schedule fraction, temperature difference and wind speed: Infiltration=Idesign * FSchedule * (A + B*|(Tzone-Todb)| + C*WindSpd + D * WindSpd**2) If you use a ZoneList in the Zone or ZoneList name field then this definition applies to all the zones in the ZoneList.

air_changes_per_hour¶

field Air Changes per Hour

Units: 1/hr

Parameters:	value (float) – value for IDD Field Air Changes per Hour
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of air_changes_per_hour or None if not set
Return type:	float

constant_term_coefficient¶

field Constant Term Coefficient

“A” in Equation

Default value: 1.0

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

design_flow_rate¶

field Design Flow Rate

Units: m3/s

IP-Units: ft3/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

design_flow_rate_calculation_method¶

field Design Flow Rate Calculation Method

The entered calculation method is used to create the maximum amount of infiltration
for this set of attributes
Choices: Flow/Zone => Design Flow Rate – simply enter Design Flow Rate
Flow/Area => Flow per Zone Floor Area - Value * Floor Area (zone) = Design Flow Rate
Flow/ExteriorArea => Flow per Exterior Surface Area - Value * Exterior Surface Area (zone) = Design Flow Rate
Flow/ExteriorWallArea => Flow per Exterior Surface Area - Value * Exterior Wall Surface Area (zone) = Design Flow Rate
AirChanges/Hour => Air Changes per Hour - Value * Floor Volume (zone) adjusted for m3/s = Design Volume Flow Rate
“Idesign” in Equation is the result.
Default value: Flow/Zone

Parameters:	value (str) – value for IDD Field Design Flow Rate Calculation Method
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of design_flow_rate_calculation_method or None if not set
Return type:	str

flow_per_exterior_surface_area¶

field Flow per Exterior Surface Area

use key Flow/ExteriorArea for all exterior surface area
use key Flow/ExteriorWallArea to include only exterior wall area
Units: m3/s-m2

Parameters:	value (float) – value for IDD Field Flow per Exterior Surface Area
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of flow_per_exterior_surface_area or None if not set
Return type:	float

flow_per_zone_floor_area¶

field Flow per Zone Floor Area

Units: m3/s-m2

Parameters:	value (float) – value for IDD Field Flow per Zone Floor Area
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of flow_per_zone_floor_area 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

schedule_name¶

field Schedule Name

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

temperature_term_coefficient¶

field Temperature Term Coefficient

“B” in Equation

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

velocity_squared_term_coefficient¶

field Velocity Squared Term Coefficient

“D” in Equation

Parameters:	value (float) – value for IDD Field Velocity Squared Term Coefficient
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of velocity_squared_term_coefficient or None if not set
Return type:	float

velocity_term_coefficient¶

field Velocity Term Coefficient

“C” in Equation

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

zone_or_zonelist_name¶

field Zone or ZoneList Name

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

class pyidf.zone_airflow.ZoneInfiltrationEffectiveLeakageArea¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object ZoneInfiltration:EffectiveLeakageArea Infiltration is specified as effective leakage area at 4 Pa, schedule fraction, stack and wind coefficients, and is a function of temperature difference and wind speed: Infiltration=FSchedule * (AL /1000) SQRT(Cs*|(Tzone-Todb)| + Cw*WindSpd**2 )

effective_air_leakage_area¶

field Effective Air Leakage Area

“AL” in Equation
units are cm2 (square centimeters)
Units: cm2

Parameters:	value (float) – value for IDD Field Effective Air Leakage Area
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of effective_air_leakage_area 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

schedule_name¶

field Schedule Name

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

stack_coefficient¶

field Stack Coefficient

“Cs” in Equation

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

wind_coefficient¶

field Wind Coefficient

“Cw” in Equation

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

zone_name¶

field Zone Name

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.zone_airflow.ZoneInfiltrationFlowCoefficient¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object ZoneInfiltration:FlowCoefficient Infiltration is specified as flow coefficient, schedule fraction, stack and wind coefficients, and is a function of temperature difference and wind speed: Infiltration=FSchedule * SQRT( (c * Cs*|(Tzone-Todb)|**n)**2 + (c* Cw*(s * WindSpd)**2n)**2 )

flow_coefficient¶

field Flow Coefficient

“c” in Equation

Parameters:	value (float) – value for IDD Field Flow Coefficient
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of flow_coefficient 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_exponent¶

field Pressure Exponent

“n” in Equation

Default value: 0.67

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

schedule_name¶

field Schedule Name

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

shelter_factor¶

field Shelter Factor

“s” in Equation

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

stack_coefficient¶

field Stack Coefficient

“Cs” in Equation

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

wind_coefficient¶

field Wind Coefficient

“Cw” in Equation

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

zone_name¶

field Zone Name

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.zone_airflow.ZoneMixing¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object ZoneMixing ZoneMixing is a simple air exchange from one zone to another. Note that this statement only affects the energy balance of the “receiving” zone and will not produce any effect on the “source” zone. Mixing statements can be complementary and include multiple zones, but the balancing of flows between zones is left to the user’s discretion.

air_changes_per_hour¶

field Air Changes per Hour

Units: 1/hr

Parameters:	value (float) – value for IDD Field Air Changes per Hour
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of air_changes_per_hour or None if not set
Return type:	float

delta_temperature¶

field Delta Temperature

This field contains the constant temperature differential between source and
receiving zones below which mixing is shutoff.
Units: deltaC

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

delta_temperature_schedule_name¶

field Delta Temperature Schedule Name

This schedule contains the temperature differential between source and receiving

zones versus time below which mixing is shutoff.

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

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

design_flow_rate_calculation_method¶

field Design Flow Rate Calculation Method

The entered calculation method is used to create the maximum amount of ventilation
for this set of attributes
Choices: Flow/Zone => Design Flow Rate – simply enter Design Flow Rate
Flow/Area => Flow Rate per Zone Floor Area - Value * Floor Area (zone) = Design Flow Rate
Flow/Person => Flow Rate per Person - Value * #people = Design Flow Rate
AirChanges/Hour => Air Changes per Hour - Value * Floor Volume (zone) adjusted for m3/s = Design Volume Flow Rate
“Vdesign” in Equation is the result.
Default value: Flow/Zone

Parameters:	value (str) – value for IDD Field Design Flow Rate Calculation Method
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of design_flow_rate_calculation_method or None if not set
Return type:	str

flow_rate_per_person¶

field Flow Rate per Person

Units: m3/s-person

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

flow_rate_per_zone_floor_area¶

field Flow Rate per Zone Floor Area

Units: m3/s-m2

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

maximum_outdoor_temperature_schedule_name¶

field Maximum Outdoor Temperature Schedule Name

This schedule contains the outdoor temperature versus time above which

mixing is shutoff.

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

maximum_source_zone_temperature_schedule_name¶

field Maximum Source Zone Temperature Schedule Name

This schedule contains the source zone dry-bulb temperature versus time above

which mixing is shutoff.

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

maximum_zone_temperature_schedule_name¶

field Maximum Zone Temperature Schedule Name

This schedule contains the zone dry-bulb temperature versus time above which

mixing is shutoff.

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

minimum_outdoor_temperature_schedule_name¶

field Minimum Outdoor Temperature Schedule Name

This schedule contains the outdoor temperature versus time below which

mixing is shutoff.

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

minimum_source_zone_temperature_schedule_name¶

field Minimum Source Zone Temperature Schedule Name

This schedule contains the source zone dry-bulb temperature versus time below

which mixing is shutoff.

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

minimum_zone_temperature_schedule_name¶

field Minimum Zone Temperature Schedule Name

This schedule contains the zone dry-bulb temperature versus time below which

mixing is shutoff.

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

schedule_name¶

field Schedule Name

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

source_zone_name¶

field Source Zone Name

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

zone_name¶

field Zone Name

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.zone_airflow.ZoneRefrigerationDoorMixing¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object ZoneRefrigerationDoorMixing Refrigeration Door Mixing is used for an opening between two zones that are at the same elevation but have different air temperatures. In this case, the mixing air flow between the two zones is determined by the density difference between the two zones. This would typically be used between two zones in a refrigerated warehouse that are controlled at different temperatures. It could also be used to model a door to a walk-in refrigerated space if that space were modeled as a zone instead of using the object Refrigeration:WalkIn.

door_area¶

field Door Area

Units: m2
Default value: 9.0
value <= 400.0

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

door_height¶

field Door Height

Units: m
Default value: 3.0
value <= 50.0

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

door_protection_type¶

field Door Protection Type

Door protection can reduce the air flow through a refrigeration door
The default value is “None”
Choices: “None”, “AirCurtain”, and “StripCurtain”
A strip curtain reduces the air flow more than an air curtain
Default value: None

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

name¶

field Name

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

schedule_name¶

field Schedule Name

This schedule defines the fraction of the time the refrigeration door is open
For example, if the warehouse is closed at night and there are no door openings
between two zones, the value for that time period would be 0.
If doors were propped open, the value  over that time period would be 1.0
If the doors were open about 20% of the time, the value over that period would be 0.2
Schedule values must lie between 0 and 1.0

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

zone_1_name¶

field Zone 1 Name

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

zone_2_name¶

field Zone 2 Name

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

class pyidf.zone_airflow.ZoneThermalChimney¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object ZoneThermalChimney A thermal chimney is a vertical shaft utilizing solar radiation to enhance natural ventilation. It consists of an absorber wall, air gap and glass cover with high solar transmissivity.

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

cross_sectional_area_of_air_channel_outlet¶

field Cross Sectional Area of Air Channel Outlet

Units: m2

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

cross_sectional_areas_of_air_channel_inlet_1¶

field Cross Sectional Areas of Air Channel Inlet 1

Units: m2

Parameters:	value (float) – value for IDD Field Cross Sectional Areas of Air Channel Inlet 1
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of cross_sectional_areas_of_air_channel_inlet_1 or None if not set
Return type:	float

cross_sectional_areas_of_air_channel_inlet_10¶

field Cross Sectional Areas of Air Channel Inlet 10

Units: m2

Parameters:	value (float) – value for IDD Field Cross Sectional Areas of Air Channel Inlet 10
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of cross_sectional_areas_of_air_channel_inlet_10 or None if not set
Return type:	float

cross_sectional_areas_of_air_channel_inlet_11¶

field Cross Sectional Areas of Air Channel Inlet 11

Units: m2

Parameters:	value (float) – value for IDD Field Cross Sectional Areas of Air Channel Inlet 11
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of cross_sectional_areas_of_air_channel_inlet_11 or None if not set
Return type:	float

cross_sectional_areas_of_air_channel_inlet_12¶

field Cross Sectional Areas of Air Channel Inlet 12

Units: m2

Parameters:	value (float) – value for IDD Field Cross Sectional Areas of Air Channel Inlet 12
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of cross_sectional_areas_of_air_channel_inlet_12 or None if not set
Return type:	float

cross_sectional_areas_of_air_channel_inlet_13¶

field Cross Sectional Areas of Air Channel Inlet 13

Units: m2

Parameters:	value (float) – value for IDD Field Cross Sectional Areas of Air Channel Inlet 13
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of cross_sectional_areas_of_air_channel_inlet_13 or None if not set
Return type:	float

cross_sectional_areas_of_air_channel_inlet_14¶

field Cross Sectional Areas of Air Channel Inlet 14

Units: m2

Parameters:	value (float) – value for IDD Field Cross Sectional Areas of Air Channel Inlet 14
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of cross_sectional_areas_of_air_channel_inlet_14 or None if not set
Return type:	float

cross_sectional_areas_of_air_channel_inlet_15¶

field Cross Sectional Areas of Air Channel Inlet 15

Units: m2

Parameters:	value (float) – value for IDD Field Cross Sectional Areas of Air Channel Inlet 15
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of cross_sectional_areas_of_air_channel_inlet_15 or None if not set
Return type:	float

cross_sectional_areas_of_air_channel_inlet_16¶

field Cross Sectional Areas of Air Channel Inlet 16

Units: m2

Parameters:	value (float) – value for IDD Field Cross Sectional Areas of Air Channel Inlet 16
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of cross_sectional_areas_of_air_channel_inlet_16 or None if not set
Return type:	float

cross_sectional_areas_of_air_channel_inlet_17¶

field Cross Sectional Areas of Air Channel Inlet 17

Units: m2

Parameters:	value (float) – value for IDD Field Cross Sectional Areas of Air Channel Inlet 17
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of cross_sectional_areas_of_air_channel_inlet_17 or None if not set
Return type:	float

cross_sectional_areas_of_air_channel_inlet_18¶

field Cross Sectional Areas of Air Channel Inlet 18

Units: m2

Parameters:	value (float) – value for IDD Field Cross Sectional Areas of Air Channel Inlet 18
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of cross_sectional_areas_of_air_channel_inlet_18 or None if not set
Return type:	float

cross_sectional_areas_of_air_channel_inlet_19¶

field Cross Sectional Areas of Air Channel Inlet 19

Units: m2

Parameters:	value (float) – value for IDD Field Cross Sectional Areas of Air Channel Inlet 19
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of cross_sectional_areas_of_air_channel_inlet_19 or None if not set
Return type:	float

cross_sectional_areas_of_air_channel_inlet_2¶

field Cross Sectional Areas of Air Channel Inlet 2

Units: m2

Parameters:	value (float) – value for IDD Field Cross Sectional Areas of Air Channel Inlet 2
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of cross_sectional_areas_of_air_channel_inlet_2 or None if not set
Return type:	float

cross_sectional_areas_of_air_channel_inlet_20¶

field Cross Sectional Areas of Air Channel Inlet 20

Units: m2

Parameters:	value (float) – value for IDD Field Cross Sectional Areas of Air Channel Inlet 20
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of cross_sectional_areas_of_air_channel_inlet_20 or None if not set
Return type:	float

cross_sectional_areas_of_air_channel_inlet_3¶

field Cross Sectional Areas of Air Channel Inlet 3

Units: m2

Parameters:	value (float) – value for IDD Field Cross Sectional Areas of Air Channel Inlet 3
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of cross_sectional_areas_of_air_channel_inlet_3 or None if not set
Return type:	float

cross_sectional_areas_of_air_channel_inlet_4¶

field Cross Sectional Areas of Air Channel Inlet 4

Units: m2

Parameters:	value (float) – value for IDD Field Cross Sectional Areas of Air Channel Inlet 4
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of cross_sectional_areas_of_air_channel_inlet_4 or None if not set
Return type:	float

cross_sectional_areas_of_air_channel_inlet_5¶

field Cross Sectional Areas of Air Channel Inlet 5

Units: m2

Parameters:	value (float) – value for IDD Field Cross Sectional Areas of Air Channel Inlet 5
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of cross_sectional_areas_of_air_channel_inlet_5 or None if not set
Return type:	float

cross_sectional_areas_of_air_channel_inlet_6¶

field Cross Sectional Areas of Air Channel Inlet 6

Units: m2

Parameters:	value (float) – value for IDD Field Cross Sectional Areas of Air Channel Inlet 6
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of cross_sectional_areas_of_air_channel_inlet_6 or None if not set
Return type:	float

cross_sectional_areas_of_air_channel_inlet_7¶

field Cross Sectional Areas of Air Channel Inlet 7

Units: m2

Parameters:	value (float) – value for IDD Field Cross Sectional Areas of Air Channel Inlet 7
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of cross_sectional_areas_of_air_channel_inlet_7 or None if not set
Return type:	float

cross_sectional_areas_of_air_channel_inlet_8¶

field Cross Sectional Areas of Air Channel Inlet 8

Units: m2

Parameters:	value (float) – value for IDD Field Cross Sectional Areas of Air Channel Inlet 8
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of cross_sectional_areas_of_air_channel_inlet_8 or None if not set
Return type:	float

cross_sectional_areas_of_air_channel_inlet_9¶

field Cross Sectional Areas of Air Channel Inlet 9

Units: m2

Parameters:	value (float) – value for IDD Field Cross Sectional Areas of Air Channel Inlet 9
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of cross_sectional_areas_of_air_channel_inlet_9 or None if not set
Return type:	float

discharge_coefficient¶

field Discharge Coefficient

Default value: 0.8

value <= 1.0

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

distance_from_top_of_thermal_chimney_to_inlet_1¶

field Distance from Top of Thermal Chimney to Inlet 1

Units: m

Parameters:	value (float) – value for IDD Field Distance from Top of Thermal Chimney to Inlet 1
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of distance_from_top_of_thermal_chimney_to_inlet_1 or None if not set
Return type:	float

distance_from_top_of_thermal_chimney_to_inlet_10¶

field Distance from Top of Thermal Chimney to Inlet 10

Units: m

Parameters:	value (float) – value for IDD Field Distance from Top of Thermal Chimney to Inlet 10
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of distance_from_top_of_thermal_chimney_to_inlet_10 or None if not set
Return type:	float

distance_from_top_of_thermal_chimney_to_inlet_11¶

field Distance from Top of Thermal Chimney to Inlet 11

Units: m

Parameters:	value (float) – value for IDD Field Distance from Top of Thermal Chimney to Inlet 11
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of distance_from_top_of_thermal_chimney_to_inlet_11 or None if not set
Return type:	float

distance_from_top_of_thermal_chimney_to_inlet_12¶

field Distance from Top of Thermal Chimney to Inlet 12

Units: m

Parameters:	value (float) – value for IDD Field Distance from Top of Thermal Chimney to Inlet 12
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of distance_from_top_of_thermal_chimney_to_inlet_12 or None if not set
Return type:	float

distance_from_top_of_thermal_chimney_to_inlet_13¶

field Distance from Top of Thermal Chimney to Inlet 13

Units: m

Parameters:	value (float) – value for IDD Field Distance from Top of Thermal Chimney to Inlet 13
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of distance_from_top_of_thermal_chimney_to_inlet_13 or None if not set
Return type:	float

distance_from_top_of_thermal_chimney_to_inlet_14¶

field Distance from Top of Thermal Chimney to Inlet 14

Units: m

Parameters:	value (float) – value for IDD Field Distance from Top of Thermal Chimney to Inlet 14
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of distance_from_top_of_thermal_chimney_to_inlet_14 or None if not set
Return type:	float

distance_from_top_of_thermal_chimney_to_inlet_15¶

field Distance from Top of Thermal Chimney to Inlet 15

Units: m

Parameters:	value (float) – value for IDD Field Distance from Top of Thermal Chimney to Inlet 15
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of distance_from_top_of_thermal_chimney_to_inlet_15 or None if not set
Return type:	float

distance_from_top_of_thermal_chimney_to_inlet_16¶

field Distance from Top of Thermal Chimney to Inlet 16

Units: m

Parameters:	value (float) – value for IDD Field Distance from Top of Thermal Chimney to Inlet 16
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of distance_from_top_of_thermal_chimney_to_inlet_16 or None if not set
Return type:	float

distance_from_top_of_thermal_chimney_to_inlet_17¶

field Distance from Top of Thermal Chimney to Inlet 17

Units: m

Parameters:	value (float) – value for IDD Field Distance from Top of Thermal Chimney to Inlet 17
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of distance_from_top_of_thermal_chimney_to_inlet_17 or None if not set
Return type:	float

distance_from_top_of_thermal_chimney_to_inlet_18¶

field Distance from Top of Thermal Chimney to Inlet 18

Units: m

Parameters:	value (float) – value for IDD Field Distance from Top of Thermal Chimney to Inlet 18
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of distance_from_top_of_thermal_chimney_to_inlet_18 or None if not set
Return type:	float

distance_from_top_of_thermal_chimney_to_inlet_19¶

field Distance from Top of Thermal Chimney to Inlet 19

Units: m

Parameters:	value (float) – value for IDD Field Distance from Top of Thermal Chimney to Inlet 19
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of distance_from_top_of_thermal_chimney_to_inlet_19 or None if not set
Return type:	float

distance_from_top_of_thermal_chimney_to_inlet_2¶

field Distance from Top of Thermal Chimney to Inlet 2

Units: m

Parameters:	value (float) – value for IDD Field Distance from Top of Thermal Chimney to Inlet 2
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of distance_from_top_of_thermal_chimney_to_inlet_2 or None if not set
Return type:	float

distance_from_top_of_thermal_chimney_to_inlet_20¶

field Distance from Top of Thermal Chimney to Inlet 20

Units: m

Parameters:	value (float) – value for IDD Field Distance from Top of Thermal Chimney to Inlet 20
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of distance_from_top_of_thermal_chimney_to_inlet_20 or None if not set
Return type:	float

distance_from_top_of_thermal_chimney_to_inlet_3¶

field Distance from Top of Thermal Chimney to Inlet 3

Units: m

Parameters:	value (float) – value for IDD Field Distance from Top of Thermal Chimney to Inlet 3
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of distance_from_top_of_thermal_chimney_to_inlet_3 or None if not set
Return type:	float

distance_from_top_of_thermal_chimney_to_inlet_4¶

field Distance from Top of Thermal Chimney to Inlet 4

Units: m

Parameters:	value (float) – value for IDD Field Distance from Top of Thermal Chimney to Inlet 4
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of distance_from_top_of_thermal_chimney_to_inlet_4 or None if not set
Return type:	float

distance_from_top_of_thermal_chimney_to_inlet_5¶

field Distance from Top of Thermal Chimney to Inlet 5

Units: m

Parameters:	value (float) – value for IDD Field Distance from Top of Thermal Chimney to Inlet 5
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of distance_from_top_of_thermal_chimney_to_inlet_5 or None if not set
Return type:	float

distance_from_top_of_thermal_chimney_to_inlet_6¶

field Distance from Top of Thermal Chimney to Inlet 6

Units: m

Parameters:	value (float) – value for IDD Field Distance from Top of Thermal Chimney to Inlet 6
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of distance_from_top_of_thermal_chimney_to_inlet_6 or None if not set
Return type:	float

distance_from_top_of_thermal_chimney_to_inlet_7¶

field Distance from Top of Thermal Chimney to Inlet 7

Units: m

Parameters:	value (float) – value for IDD Field Distance from Top of Thermal Chimney to Inlet 7
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of distance_from_top_of_thermal_chimney_to_inlet_7 or None if not set
Return type:	float

distance_from_top_of_thermal_chimney_to_inlet_8¶

field Distance from Top of Thermal Chimney to Inlet 8

Units: m

Parameters:	value (float) – value for IDD Field Distance from Top of Thermal Chimney to Inlet 8
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of distance_from_top_of_thermal_chimney_to_inlet_8 or None if not set
Return type:	float

distance_from_top_of_thermal_chimney_to_inlet_9¶

field Distance from Top of Thermal Chimney to Inlet 9

Units: m

Parameters:	value (float) – value for IDD Field Distance from Top of Thermal Chimney to Inlet 9
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of distance_from_top_of_thermal_chimney_to_inlet_9 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

relative_ratios_of_air_flow_rates_passing_through_zone_1¶

field Relative Ratios of Air Flow Rates Passing through Zone 1

Default value: 1.0

value <= 1.0

Parameters:	value (float) – value for IDD Field Relative Ratios of Air Flow Rates Passing through Zone 1
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of relative_ratios_of_air_flow_rates_passing_through_zone_1 or None if not set
Return type:	float

relative_ratios_of_air_flow_rates_passing_through_zone_10¶

field Relative Ratios of Air Flow Rates Passing through Zone 10

value <= 1.0

Parameters:	value (float) – value for IDD Field Relative Ratios of Air Flow Rates Passing through Zone 10
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of relative_ratios_of_air_flow_rates_passing_through_zone_10 or None if not set
Return type:	float

relative_ratios_of_air_flow_rates_passing_through_zone_11¶

field Relative Ratios of Air Flow Rates Passing through Zone 11

value <= 1.0

Parameters:	value (float) – value for IDD Field Relative Ratios of Air Flow Rates Passing through Zone 11
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of relative_ratios_of_air_flow_rates_passing_through_zone_11 or None if not set
Return type:	float

relative_ratios_of_air_flow_rates_passing_through_zone_12¶

field Relative Ratios of Air Flow Rates Passing through Zone 12

value <= 1.0

Parameters:	value (float) – value for IDD Field Relative Ratios of Air Flow Rates Passing through Zone 12
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of relative_ratios_of_air_flow_rates_passing_through_zone_12 or None if not set
Return type:	float

relative_ratios_of_air_flow_rates_passing_through_zone_13¶

field Relative Ratios of Air Flow Rates Passing through Zone 13

value <= 1.0

Parameters:	value (float) – value for IDD Field Relative Ratios of Air Flow Rates Passing through Zone 13
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of relative_ratios_of_air_flow_rates_passing_through_zone_13 or None if not set
Return type:	float

relative_ratios_of_air_flow_rates_passing_through_zone_14¶

field Relative Ratios of Air Flow Rates Passing through Zone 14

value <= 1.0

Parameters:	value (float) – value for IDD Field Relative Ratios of Air Flow Rates Passing through Zone 14
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of relative_ratios_of_air_flow_rates_passing_through_zone_14 or None if not set
Return type:	float

relative_ratios_of_air_flow_rates_passing_through_zone_15¶

field Relative Ratios of Air Flow Rates Passing through Zone 15

value <= 1.0

Parameters:	value (float) – value for IDD Field Relative Ratios of Air Flow Rates Passing through Zone 15
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of relative_ratios_of_air_flow_rates_passing_through_zone_15 or None if not set
Return type:	float

relative_ratios_of_air_flow_rates_passing_through_zone_16¶

field Relative Ratios of Air Flow Rates Passing through Zone 16

value <= 1.0

Parameters:	value (float) – value for IDD Field Relative Ratios of Air Flow Rates Passing through Zone 16
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of relative_ratios_of_air_flow_rates_passing_through_zone_16 or None if not set
Return type:	float

relative_ratios_of_air_flow_rates_passing_through_zone_17¶

field Relative Ratios of Air Flow Rates Passing through Zone 17

value <= 1.0

Parameters:	value (float) – value for IDD Field Relative Ratios of Air Flow Rates Passing through Zone 17
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of relative_ratios_of_air_flow_rates_passing_through_zone_17 or None if not set
Return type:	float

relative_ratios_of_air_flow_rates_passing_through_zone_18¶

field Relative Ratios of Air Flow Rates Passing through Zone 18

value <= 1.0

Parameters:	value (float) – value for IDD Field Relative Ratios of Air Flow Rates Passing through Zone 18
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of relative_ratios_of_air_flow_rates_passing_through_zone_18 or None if not set
Return type:	float

relative_ratios_of_air_flow_rates_passing_through_zone_19¶

field Relative Ratios of Air Flow Rates Passing through Zone 19

value <= 1.0

Parameters:	value (float) – value for IDD Field Relative Ratios of Air Flow Rates Passing through Zone 19
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of relative_ratios_of_air_flow_rates_passing_through_zone_19 or None if not set
Return type:	float

relative_ratios_of_air_flow_rates_passing_through_zone_2¶

field Relative Ratios of Air Flow Rates Passing through Zone 2

value <= 1.0

Parameters:	value (float) – value for IDD Field Relative Ratios of Air Flow Rates Passing through Zone 2
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of relative_ratios_of_air_flow_rates_passing_through_zone_2 or None if not set
Return type:	float

relative_ratios_of_air_flow_rates_passing_through_zone_20¶

field Relative Ratios of Air Flow Rates Passing through Zone 20

value <= 1.0

Parameters:	value (float) – value for IDD Field Relative Ratios of Air Flow Rates Passing through Zone 20
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of relative_ratios_of_air_flow_rates_passing_through_zone_20 or None if not set
Return type:	float

relative_ratios_of_air_flow_rates_passing_through_zone_3¶

field Relative Ratios of Air Flow Rates Passing through Zone 3

value <= 1.0

Parameters:	value (float) – value for IDD Field Relative Ratios of Air Flow Rates Passing through Zone 3
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of relative_ratios_of_air_flow_rates_passing_through_zone_3 or None if not set
Return type:	float

relative_ratios_of_air_flow_rates_passing_through_zone_4¶

field Relative Ratios of Air Flow Rates Passing through Zone 4

value <= 1.0

Parameters:	value (float) – value for IDD Field Relative Ratios of Air Flow Rates Passing through Zone 4
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of relative_ratios_of_air_flow_rates_passing_through_zone_4 or None if not set
Return type:	float

relative_ratios_of_air_flow_rates_passing_through_zone_5¶

field Relative Ratios of Air Flow Rates Passing through Zone 5

value <= 1.0

Parameters:	value (float) – value for IDD Field Relative Ratios of Air Flow Rates Passing through Zone 5
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of relative_ratios_of_air_flow_rates_passing_through_zone_5 or None if not set
Return type:	float

relative_ratios_of_air_flow_rates_passing_through_zone_6¶

field Relative Ratios of Air Flow Rates Passing through Zone 6

value <= 1.0

Parameters:	value (float) – value for IDD Field Relative Ratios of Air Flow Rates Passing through Zone 6
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of relative_ratios_of_air_flow_rates_passing_through_zone_6 or None if not set
Return type:	float

relative_ratios_of_air_flow_rates_passing_through_zone_7¶

field Relative Ratios of Air Flow Rates Passing through Zone 7

value <= 1.0

Parameters:	value (float) – value for IDD Field Relative Ratios of Air Flow Rates Passing through Zone 7
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of relative_ratios_of_air_flow_rates_passing_through_zone_7 or None if not set
Return type:	float

relative_ratios_of_air_flow_rates_passing_through_zone_8¶

field Relative Ratios of Air Flow Rates Passing through Zone 8

value <= 1.0

Parameters:	value (float) – value for IDD Field Relative Ratios of Air Flow Rates Passing through Zone 8
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of relative_ratios_of_air_flow_rates_passing_through_zone_8 or None if not set
Return type:	float

relative_ratios_of_air_flow_rates_passing_through_zone_9¶

field Relative Ratios of Air Flow Rates Passing through Zone 9

value <= 1.0

Parameters:	value (float) – value for IDD Field Relative Ratios of Air Flow Rates Passing through Zone 9
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of relative_ratios_of_air_flow_rates_passing_through_zone_9 or None if not set
Return type:	float

width_of_the_absorber_wall¶

field Width of the Absorber Wall

Units: m

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

zone_10_name¶

field Zone 10 Name

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

zone_11_name¶

field Zone 11 Name

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

zone_12_name¶

field Zone 12 Name

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

zone_13_name¶

field Zone 13 Name

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

zone_14_name¶

field Zone 14 Name

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

zone_15_name¶

field Zone 15 Name

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

zone_16_name¶

field Zone 16 Name

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

zone_17_name¶

field Zone 17 Name

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

zone_18_name¶

field Zone 18 Name

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

zone_19_name¶

field Zone 19 Name

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

zone_1_name¶

field Zone 1 Name

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

zone_20_name¶

field Zone 20 Name

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

zone_2_name¶

field Zone 2 Name

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

zone_3_name¶

field Zone 3 Name

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

zone_4_name¶

field Zone 4 Name

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

zone_5_name¶

field Zone 5 Name

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

zone_6_name¶

field Zone 6 Name

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

zone_7_name¶

field Zone 7 Name

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

zone_8_name¶

field Zone 8 Name

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

zone_9_name¶

field Zone 9 Name

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

zone_name¶

field Zone Name

Name of zone that is the thermal chimney

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.zone_airflow.ZoneVentilationDesignFlowRate¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object ZoneVentilation:DesignFlowRate Ventilation is specified as a design level which is modified by a schedule fraction, temperature difference and wind speed: Ventilation=Vdesign * Fschedule * (A + B*|(Tzone-Todb)| + C*WindSpd + D * WindSpd**2) If you use a ZoneList in the Zone or ZoneList name field then this definition applies to all the zones in the ZoneList.

air_changes_per_hour¶

field Air Changes per Hour

Units: 1/hr

Parameters:	value (float) – value for IDD Field Air Changes per Hour
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of air_changes_per_hour or None if not set
Return type:	float

constant_term_coefficient¶

field Constant Term Coefficient

“A” in Equation

Default value: 1.0

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

delta_temperature¶

field Delta Temperature

This is the temperature differential between indoor and outdoor below which ventilation is shutoff.
If ((IndoorTemp - OutdoorTemp) < DeltaTemperature) then ventilation is not allowed.
For example, if delta temperature is 2C, ventilation is assumed to be available if the outside air temperature
is at least 2C cooler than the zone air temperature. The values for this field can include negative numbers.
This allows ventilation to occur even if the outdoor temperature is above the indoor temperature.
Units: deltaC
Default value: -100.0
value >= -100.0

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

delta_temperature_schedule_name¶

field Delta Temperature Schedule Name

This schedule contains the temperature differential between indoor and outdoor

versus time below which ventilation is shutoff.

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

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

design_flow_rate_calculation_method¶

field Design Flow Rate Calculation Method

The entered calculation method is used to create the maximum amount of ventilation
for this set of attributes
Choices: Flow/Zone => Design Flow Rate – simply enter Design Flow Rate
Flow/Area => Flow Rate per Zone Floor Area - Value * Floor Area (zone) = Design Flow Rate
Flow/Person => Flow Rate per Person - Value * #people = Design Flow Rate
AirChanges/Hour => Air Changes per Hour - Value * Floor Volume (zone) adjusted for m3/s = Design Volume Flow Rate
“Vdesign” in Equation is the result.
Default value: Flow/Zone

Parameters:	value (str) – value for IDD Field Design Flow Rate Calculation Method
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of design_flow_rate_calculation_method or None if not set
Return type:	str

fan_pressure_rise¶

field Fan Pressure Rise

pressure rise across the fan

Units: Pa

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

fan_total_efficiency¶

field Fan Total Efficiency

Default 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_rate_per_person¶

field Flow Rate per Person

Units: m3/s-person

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

flow_rate_per_zone_floor_area¶

field Flow Rate per Zone Floor Area

Units: m3/s-m2

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

maximum_indoor_temperature¶

field Maximum Indoor Temperature

this is the indoor temperature above which ventilation is shutoff
Units: C
Default value: 100.0
value >= -100.0
value <= 100.0

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

maximum_indoor_temperature_schedule_name¶

field Maximum Indoor Temperature Schedule Name

This schedule contains the indoor temperature versus time above which

ventilation is shutoff.

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

maximum_outdoor_temperature¶

field Maximum Outdoor Temperature

this is the outdoor temperature above which ventilation is shutoff
Units: C
Default value: 100.0
value >= -100.0
value <= 100.0

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

maximum_outdoor_temperature_schedule_name¶

field Maximum Outdoor Temperature Schedule Name

This schedule contains the outdoor temperature versus time above which

ventilation is shutoff.

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

maximum_wind_speed¶

field Maximum Wind Speed

this is the outdoor wind speed above which ventilation is shutoff
Units: m/s
Default value: 40.0
value <= 40.0

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

minimum_indoor_temperature¶

field Minimum Indoor Temperature

this is the indoor temperature below which ventilation is shutoff
Units: C
Default value: -100.0
value >= -100.0
value <= 100.0

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

minimum_indoor_temperature_schedule_name¶

field Minimum Indoor Temperature Schedule Name

This schedule contains the indoor temperature versus time below which

ventilation is shutoff.

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

minimum_outdoor_temperature¶

field Minimum Outdoor Temperature

this is the outdoor temperature below which ventilation is shutoff
Units: C
Default value: -100.0
value >= -100.0
value <= 100.0

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

minimum_outdoor_temperature_schedule_name¶

field Minimum Outdoor Temperature Schedule Name

This schedule contains the outdoor temperature versus time below which

ventilation is shutoff.

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

schedule_name¶

field Schedule Name

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

temperature_term_coefficient¶

field Temperature Term Coefficient

“B” in Equation

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

velocity_squared_term_coefficient¶

field Velocity Squared Term Coefficient

“D” in Equation

Parameters:	value (float) – value for IDD Field Velocity Squared Term Coefficient
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of velocity_squared_term_coefficient or None if not set
Return type:	float

velocity_term_coefficient¶

field Velocity Term Coefficient

“C” in Equation

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

ventilation_type¶

field Ventilation Type

Default value: Natural

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

zone_or_zonelist_name¶

field Zone or ZoneList Name

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

class pyidf.zone_airflow.ZoneVentilationWindandStackOpenArea¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object ZoneVentilation:WindandStackOpenArea This object is specified as natural ventilation driven by wind and stack effect only: Ventilation Wind = Cw * Opening Area * Schedule * WindSpd Ventilation Stack = Cd * Opening Area * Schedule * SQRT(2*g*DH*(|(Tzone-Todb)|/Tzone)) Total Ventilation = SQRT((Ventilation Wind)^2 + (Ventilation Stack)^2)

delta_temperature¶

field Delta Temperature

This is the temperature differential between indoor and outdoor below
which ventilation is shutoff.
Units: deltaC
Default value: -100.0
value >= -100.0

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

delta_temperature_schedule_name¶

field Delta Temperature Schedule Name

This schedule contains the temperature differential between indoor and outdoor

versus time below which ventilation is shutoff.

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

discharge_coefficient_for_opening¶

field Discharge Coefficient for Opening

This is the discharge coefficient used to calculate stack effect.
“Cd” in the stack equation and the maximum value is 1.0.
When the input is Autocalculate, the following equation is used to calculate the
coefficient:
Cd = 0.4 + 0.0045*|(Tzone-Todb)|
Default value: “Autocalculate”
value <= 1.0

Parameters:	value (float or “Autocalculate”) – value for IDD Field Discharge Coefficient for Opening
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of discharge_coefficient_for_opening or None if not set
Return type:	float or “Autocalculate”

effective_angle¶

field Effective Angle

This field is defined as normal angle of the opening area and is used when input
field Opening Effectiveness = Autocalculate.
Units: deg
value < 360.0

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

height_difference¶

field Height Difference

This is the height difference between the midpoint of an opening and
the neutral pressure level.
“DH” in the stack equation.
Units: m

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

maximum_indoor_temperature¶

field Maximum Indoor Temperature

This is the indoor temperature above which ventilation is shutoff.
Units: C
Default value: 100.0
value >= -100.0
value <= 100.0

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

maximum_indoor_temperature_schedule_name¶

field Maximum Indoor Temperature Schedule Name

This schedule contains the indoor temperature versus time above which

ventilation is shutoff.

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

maximum_outdoor_temperature¶

field Maximum Outdoor Temperature

This is the outdoor temperature above which ventilation is shutoff.
Units: C
Default value: 100.0
value >= -100.0
value <= 100.0

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

maximum_outdoor_temperature_schedule_name¶

field Maximum Outdoor Temperature Schedule Name

This schedule contains the outdoor temperature versus time above which

ventilation is shutoff.

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

maximum_wind_speed¶

field Maximum Wind Speed

This is the outdoor wind speed above which ventilation is shutoff.
Units: m/s
Default value: 40.0
value <= 40.0

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

minimum_indoor_temperature¶

field Minimum Indoor Temperature

This is the indoor temperature below which ventilation is shutoff.
Units: C
Default value: -100.0
value >= -100.0
value <= 100.0

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

minimum_indoor_temperature_schedule_name¶

field Minimum Indoor Temperature Schedule Name

This schedule contains the indoor temperature versus time below which

ventilation is shutoff.

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

minimum_outdoor_temperature¶

field Minimum Outdoor Temperature

This is the outdoor temperature below which ventilation is shutoff.
Units: C
Default value: -100.0
value >= -100.0
value <= 100.0

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

minimum_outdoor_temperature_schedule_name¶

field Minimum Outdoor Temperature Schedule Name

This schedule contains the outdoor temperature versus time below which

ventilation is shutoff.

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

opening_area¶

field Opening Area

This is the opening area used to calculate stack effect and wind driven ventilation.

Units: m2

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

opening_area_fraction_schedule_name¶

field Opening Area Fraction Schedule Name

This schedule contains the fraction values applied to the opening area given in the previous

input field (0.0 - 1.0).

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

opening_effectiveness¶

field Opening Effectiveness

This field is used to calculate wind driven ventilation.
“Cw” in the wind-driven equation and the maximum value is 1.0.
When the input is Autocalculate, the program calculates Cw based on an angle between
wind direction and effective angle
Cw = 0.55 at angle = 0, and Cw = 0.3 at angle=180
Linear interpolation is used to calculate Cw based on the above two values.
Units: dimensionless
Default value: “Autocalculate”
value <= 1.0

Parameters:	value (float or “Autocalculate”) – value for IDD Field Opening Effectiveness
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of opening_effectiveness or None if not set
Return type:	float or “Autocalculate”

zone_name¶

field Zone Name

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

pyidf.zone_airflow module¶

Related Topics

This Page