pyidf.natural_ventilation_and_duct_leakage module

Data objects in group “Natural Ventilation and Duct Leakage”

class pyidf.natural_ventilation_and_duct_leakage.AirflowNetworkDistributionComponentCoil

Bases: pyidf.helper.DataObject

Corresponds to IDD object AirflowNetwork:Distribution:Component:Coil This object defines the name of a coil used in an air loop.

air_path_hydraulic_diameter

field Air Path Hydraulic Diameter

Enter the hydraulic diameter of this coil. The hydraulic diameter is

defined as 4 multiplied by the cross section area divided by perimeter.

Units: m

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

air_path_length

field Air Path Length

Enter the air path length (depth) for the coil.

Units: m

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

coil_name

field Coil Name

Enter the name of a cooling or heating coil in the primary Air loop.

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

coil_object_type

field Coil Object Type

Select the type of coil corresponding to the name entered in the field above.

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

class pyidf.natural_ventilation_and_duct_leakage.AirflowNetworkDistributionComponentConstantPressureDrop

Bases: pyidf.helper.DataObject

Corresponds to IDD object AirflowNetwork:Distribution:Component:ConstantPressureDrop This object defines the characteristics of a constant pressure drop component (e.g. filter). Each node connected to this object can not be a node of mixer, splitter, a node of air primary loop, or zone equipment loop. It is recommended to connect to a duct component at both ends.

name

field Name

Enter a unique name for this object.

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_difference_across_the_component

field Pressure Difference Across the Component

Enter the pressure drop across this component.

Units: Pa

Parameters:value (float) – value for IDD Field Pressure Difference Across the Component Raises:ValueError – if value is not a valid value Returns:the value of pressure_difference_across_the_component or None if not set Return type:float

class pyidf.natural_ventilation_and_duct_leakage.AirflowNetworkDistributionComponentDuct

Bases: pyidf.helper.DataObject

Corresponds to IDD object AirflowNetwork:Distribution:Component:Duct This object defines the relationship between pressure and air flow through the duct.

coefficient_for_local_dynamic_loss_due_to_fitting

field Coefficient for Local Dynamic Loss Due to Fitting

Enter the coefficient used to calculate dynamic losses of fittings (e.g. elbows).

Units: dimensionless

Parameters:value (float) – value for IDD Field Coefficient for Local Dynamic Loss Due to Fitting Raises:ValueError – if value is not a valid value Returns:the value of coefficient_for_local_dynamic_loss_due_to_fitting or None if not set Return type:float

cross_section_area

field Cross Section Area

Enter the cross section area of the duct.

Units: m2

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

duct_length

field Duct Length

Enter the length of the duct.

Units: m

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

hydraulic_diameter

field Hydraulic Diameter

Enter the hydraulic diameter of the duct.

Hydraulic diameter is defined as 4 multiplied by cross section area divided by perimeter

Units: m

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

name

field Name

Enter a unique name for this object.

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

overall_heat_transmittance_coefficient_ufactor_from_air_to_air

field Overall Heat Transmittance Coefficient (U-Factor) from Air to Air

including film coefficients at both surfaces

Enter the overall U-value for this duct.

Default value of 0.772 is equivalent to 1.06 m2-K/W (R6) duct insulation with

film coefficients for outside and inside equal to 5 and 25 W/m2-K, respectively.

Units: W/m2-K

Default value: 0.772

Parameters:value (float) – value for IDD Field Overall Heat Transmittance Coefficient (U-Factor) from Air to Air Raises:ValueError – if value is not a valid value Returns:the value of overall_heat_transmittance_coefficient_ufactor_from_air_to_air or None if not set Return type:float

overall_moisture_transmittance_coefficient_from_air_to_air

field Overall Moisture Transmittance Coefficient from Air to Air

Enter the overall moisture transmittance coefficient

including moisture film coefficients at both surfaces.

Units: kg/m2

Default value: 0.001

Parameters:value (float) – value for IDD Field Overall Moisture Transmittance Coefficient from Air to Air Raises:ValueError – if value is not a valid value Returns:the value of overall_moisture_transmittance_coefficient_from_air_to_air or None if not set Return type:float

surface_roughness

field Surface Roughness

Enter the inside surface roughness of the duct.

Units: m

Default value: 0.0009

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

class pyidf.natural_ventilation_and_duct_leakage.AirflowNetworkDistributionComponentFan

Bases: pyidf.helper.DataObject

Corresponds to IDD object AirflowNetwork:Distribution:Component:Fan This object defines the name of the constant volume supply Air Fan used in an Air loop.

fan_name

field Fan Name

Enter the name of the constant volume fan in the primary air loop.

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

supply_fan_object_type

field Supply Fan Object Type

Default value: Fan:ConstantVolume

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

class pyidf.natural_ventilation_and_duct_leakage.AirflowNetworkDistributionComponentHeatExchanger

Bases: pyidf.helper.DataObject

Corresponds to IDD object AirflowNetwork:Distribution:Component:HeatExchanger This object defines the name of an air-to-air heat exchanger used in an air loop.

air_path_hydraulic_diameter

field Air Path Hydraulic Diameter

Enter the hydraulic diameter of this heat exchanger. The hydraulic diameter is

defined as 4 multiplied by the cross section area divided by perimeter.

Units: m

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

air_path_length

field Air Path Length

Enter the air path length (depth) for the heat exchanger.

Units: m

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

heatexchanger_name

field HeatExchanger Name

Enter the name of an air-to-air heat exchanger in the primary Air loop.

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

heatexchanger_object_type

field HeatExchanger Object Type

Select the type of heat exchanger corresponding to the name entered in the field above.

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

class pyidf.natural_ventilation_and_duct_leakage.AirflowNetworkDistributionComponentLeak

Bases: pyidf.helper.DataObject

Corresponds to IDD object AirflowNetwork:Distribution:Component:Leak This object defines the characteristics of a supply or return air leak.

air_mass_flow_coefficient

field Air Mass Flow Coefficient

Defined at 1 Pa pressure difference across this component.

Enter the coefficient used in the following equation:

Mass Flow Rate = Air Mass Flow Coefficient * (dP)^Air Mass Flow Exponent

Units: kg/s

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

air_mass_flow_exponent

field Air Mass Flow Exponent

Enter the exponent used in the following equation:

Mass Flow Rate = Air Mass Flow Coefficient * (dP)^Air Mass Flow Exponent

Units: dimensionless

Default value: 0.65

value >= 0.5

value <= 1.0

Parameters:value (float) – value for IDD Field Air Mass Flow Exponent Raises:ValueError – if value is not a valid value Returns:the value of air_mass_flow_exponent or None if not set Return type:float

name

field Name

Enter a unique name for this object.

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

class pyidf.natural_ventilation_and_duct_leakage.AirflowNetworkDistributionComponentLeakageRatio

Bases: pyidf.helper.DataObject

Corresponds to IDD object AirflowNetwork:Distribution:Component:LeakageRatio This object is used to define supply and return air leaks with respect to the fan’s maximum air flow rate.

air_mass_flow_exponent

field Air Mass Flow Exponent

Enter the exponent used in the air mass flow equation.

Units: dimensionless

Default value: 0.65

value >= 0.5

value <= 1.0

Parameters:value (float) – value for IDD Field Air Mass Flow Exponent Raises:ValueError – if value is not a valid value Returns:the value of air_mass_flow_exponent or None if not set Return type:float

effective_leakage_ratio

field Effective Leakage Ratio

Defined as a ratio of leak flow rate to the maximum flow rate.

Units: dimensionless

value <= 1.0

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

maximum_flow_rate

field Maximum Flow Rate

Enter the maximum air flow rate in this air loop.

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

name

field Name

Enter a unique name for this object.

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

reference_pressure_difference

field Reference Pressure Difference

Enter the pressure corresponding to the Effective leakage ratio entered above.

Units: Pa

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

class pyidf.natural_ventilation_and_duct_leakage.AirflowNetworkDistributionComponentTerminalUnit

Bases: pyidf.helper.DataObject

Corresponds to IDD object AirflowNetwork:Distribution:Component:TerminalUnit This object defines the name of a terminal unit in an air loop.

air_path_hydraulic_diameter

field Air Path Hydraulic Diameter

Enter the hydraulic diameter of this terminal unit. The hydraulic diameter is

defined as 4 multiplied by the cross section area divided by perimeter.

Units: m

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

air_path_length

field Air Path Length

Enter the air path length (depth) for the terminal unit.

Units: m

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

terminal_unit_name

field Terminal Unit Name

Enter the name of a terminal unit in the AirLoopHVAC.

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

terminal_unit_object_type

field Terminal Unit Object Type

Select the type of terminal unit corresponding to the name entered in the field above.

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

class pyidf.natural_ventilation_and_duct_leakage.AirflowNetworkDistributionLinkage

Bases: pyidf.helper.DataObject

Corresponds to IDD object AirflowNetwork:Distribution:Linkage This object defines the connection between two nodes and a component.

component_name

field Component Name

Enter the name of an AirflowNetwork component. A component is one of the

following AirflowNetwork:Distribution:Component objects: Leak, LeakageRatio,

Duct, ConstantVolumeFan, Coil, TerminalUnit, ConstantPressureDrop, or HeatExchanger.

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

name

field Name

Enter a unique name for this object.

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

node_1_name

field Node 1 Name

Enter the name of zone or AirflowNetwork Node.

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

node_2_name

field Node 2 Name

Enter the name of zone or AirflowNetwork Node.

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

thermal_zone_name

field Thermal Zone Name

Only used if component = AirflowNetwork:Distribution:Component:Duct

The zone name is where AirflowNetwork:Distribution:Component:Duct is exposed. Leave this field blank if the duct

conduction loss is ignored.

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

class pyidf.natural_ventilation_and_duct_leakage.AirflowNetworkDistributionNode

Bases: pyidf.helper.DataObject

Corresponds to IDD object AirflowNetwork:Distribution:Node This object represents an air distribution node in the AirflowNetwork model.

component_name_or_node_name

field Component Name or Node Name

Designates node names defined in another object. The node name may occur in air branches.

Enter a node name to represent a node already defined in an air loop.

Leave this field blank if the Node or Object Type field below is entered as

AirLoopHVAC:ZoneMixer, AirLoopHVAC:ZoneSplitter, AirLoopHVAC:OutdoorAirSystem, or Other.

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

component_object_type_or_node_type

field Component Object Type or Node Type

Designates Node type for the Node or Component Name defined in the field above.

AirLoopHVAC:ZoneMixer – Represents a AirLoopHVAC:ZoneMixer object.

AirLoopHVAC:ZoneSplitter – Represents a AirLoopHVAC:ZoneSplitter object.

AirLoopHVAC:OutdoorAirSystem – Represents an AirLoopHVAC:OutdoorAirSystem object.

OAMixerOutdoorAirStreamNode – Represents an external node used in the OutdoorAir:Mixer

OutdoorAir:NodeList – Represents an external node when a heat exchanger is used before

the OutdoorAir:Mixer

OutdoorAir:Node – Represents an external node when a heat exchanger is used before

the OutdoorAir:Mixer

Other – none of the above, the Node name already defined in the previous field is part

of an air loop.

Default value: Other

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

name

field Name

Enter a unique name for this object.

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

node_height

field Node Height

Enter the reference height used to calculate the relative pressure.

Units: m

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

class pyidf.natural_ventilation_and_duct_leakage.AirflowNetworkIntraZoneLinkage

Bases: pyidf.helper.DataObject

Corresponds to IDD object AirflowNetwork:IntraZone:Linkage This object defines the connection between two nodes and a component used in the combination of RoomAir and AirflowNetwork model.

airflownetworkmultizonesurface_name

field AirflowNetwork:MultiZone:Surface Name

Only used when one of two nodes defined above are not located in the same zone, and

the input of the Component Name field in this object is ignored

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

component_name

field Component Name

Enter the name of an AirflowNetwork component. A component is one of the

following AirflowNetwork:Multizone:Component objects:

AirflowNetwork:MultiZone:Surface:Crack,

AirflowNetwork:MultiZone:Surface:EffectiveLeakageArea,

If the next field is specified, this field can be either blank or ignored.

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

name

field Name

Enter a unique name for this object.

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

node_1_name

field Node 1 Name

Enter the name of zone or AirflowNetwork Node.

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

node_2_name

field Node 2 Name

Enter the name of zone or AirflowNetwork Node.

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

class pyidf.natural_ventilation_and_duct_leakage.AirflowNetworkIntraZoneNode

Bases: pyidf.helper.DataObject

Corresponds to IDD object AirflowNetwork:IntraZone:Node This object represents a node in a zone in the combination of RoomAir and AirflowNetwork model.

name

field Name

Enter a unique name for this object.

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

node_height

field Node Height

Enter the reference height used to calculate the relative pressure

Units: m

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

roomairnodeairflownetwork_name

field RoomAir:Node:AirflowNetwork Name

Enter the name of a RoomAir:Node object defined in a RoomAirSettings:AirflowNetwork

object.

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

zone_name

field Zone Name

Enter the name of a zone object defined in a AirflowNetwork:MultiZone:Zone

object.

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.natural_ventilation_and_duct_leakage.AirflowNetworkMultiZoneComponentDetailedOpening

Bases: pyidf.helper.DataObject

Corresponds to IDD object AirflowNetwork:MultiZone:Component:DetailedOpening This object specifies the properties of airflow through windows and doors (window, door and glass door heat transfer subsurfaces) when they are closed or open.

air_mass_flow_coefficient_when_opening_is_closed

field Air Mass Flow Coefficient When Opening is Closed

Defined at 1 Pa per meter of crack length. Enter the coefficient used in the following

equation:

Mass Flow Rate = Air Mass Flow Coefficient * (dP)^Air Mass Flow Exponent.

Used only when opening (window or door) is closed.

Units: kg/s-m

Parameters:value (float) – value for IDD Field Air Mass Flow Coefficient When Opening is Closed Raises:ValueError – if value is not a valid value Returns:the value of air_mass_flow_coefficient_when_opening_is_closed or None if not set Return type:float

air_mass_flow_exponent_when_opening_is_closed

field Air Mass Flow Exponent When Opening is Closed

Enter the exponent used in the following equation:

Mass Flow Rate = Air Mass Flow Coefficient * (dP)^Air Mass Flow Exponent.

Used only when opening (window or door) is closed.

Units: dimensionless

Default value: 0.65

value >= 0.5

value <= 1.0

Parameters:value (float) – value for IDD Field Air Mass Flow Exponent When Opening is Closed Raises:ValueError – if value is not a valid value Returns:the value of air_mass_flow_exponent_when_opening_is_closed or None if not set Return type:float

discharge_coefficient_for_opening_factor_1

field Discharge Coefficient for Opening Factor 1

The Discharge Coefficient indicates the fractional effectiveness

for air flow through a window or door at that Opening Factor.

Units: dimensionless

Default value: 0.001

value <= 1.0

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

discharge_coefficient_for_opening_factor_2

field Discharge Coefficient for Opening Factor 2

The Discharge Coefficient indicates the fractional effectiveness

for air flow through a window or door at that Opening Factor.

Units: dimensionless

Default value: 1.0

value <= 1.0

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

discharge_coefficient_for_opening_factor_3

field Discharge Coefficient for Opening Factor 3

The Discharge Coefficient indicates the fractional effectiveness

for air flow through a window or door at that Opening Factor.

Units: dimensionless

value <= 1.0

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

discharge_coefficient_for_opening_factor_4

field Discharge Coefficient for Opening Factor 4

The Discharge Coefficient indicates the fractional effectiveness

for air flow through a window or door at that Opening Factor.

Units: dimensionless

value <= 1.0

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

extra_crack_length_or_height_of_pivoting_axis

field Extra Crack Length or Height of Pivoting Axis

Extra crack length is used for LVO Non-pivoted type with multiple openable parts.

Height of pivoting axis is used for LVO Horizontally pivoted type.

Specifies window or door characteristics that depend on the LVO type.

For Non-pivoted Type (rectangular windows and doors), this field is the extra crack length

in meters due to multiple openable parts, if present. Extra here means in addition

to the length of the cracks on the top, bottom and sides of the window/door.

For Horizontally pivoted Type, this field gives the height of the

pivoting axis measured from the bottom of the glazed part of the window (m).

Units: m

Parameters:value (float) – value for IDD Field Extra Crack Length or Height of Pivoting Axis Raises:ValueError – if value is not a valid value Returns:the value of extra_crack_length_or_height_of_pivoting_axis or None if not set Return type:float

height_factor_for_opening_factor_1

field Height Factor for Opening Factor 1

The Height Factor is the opening height divided by the window or door height.

Units: dimensionless

value <= 1.0

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

height_factor_for_opening_factor_2

field Height Factor for Opening Factor 2

The Height Factor is the opening height divided by the window or door height.

Units: dimensionless

Default value: 1.0

value <= 1.0

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

height_factor_for_opening_factor_3

field Height Factor for Opening Factor 3

The Height Factor is the opening height divided by the window or door height.

Units: dimensionless

value <= 1.0

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

height_factor_for_opening_factor_4

field Height Factor for Opening Factor 4

The Height Factor is the opening height divided by the window or door height.

Units: dimensionless

value <= 1.0

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

name

field Name

Enter a unique name for this object.

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

number_of_sets_of_opening_factor_data

field Number of Sets of Opening Factor Data

Enter the number of the following sets of data for opening factor,

discharge coefficient, width factor, height factor, and start height factor.

value >= 2

value <= 4

Parameters:value (int) – value for IDD Field Number of Sets of Opening Factor Data Raises:ValueError – if value is not a valid value Returns:the value of number_of_sets_of_opening_factor_data or None if not set Return type:int

opening_factor_1

field Opening Factor 1

This value must be specified as 0.

Units: dimensionless

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

opening_factor_2

field Opening Factor 2

If Number of Sets of Opening Factor Data = 2, this value must be 1.0.

If Number of Sets of Opening Factor Data = 3, this value must be less than 1.0.

If Number of Sets of Opening Factor Data = 4, this value must be less than the

value entered for Opening factor 3 and greater than the value entered

for Opening factor 1.

Units: dimensionless

value <= 1.0

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

opening_factor_3

field Opening Factor 3

If Number of Sets of Opening Factor Data = 3, this value must be 1.0.

If Number of Sets of Opening Factor Data = 4, this value must be less than 1.0,

and greater than value entered for Opening factor 2.

Units: dimensionless

value <= 1.0

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

opening_factor_4

field Opening Factor 4

If Number of Sets of Opening Factor Data = 4, this value must be 1.0

Units: dimensionless

value <= 1.0

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

start_height_factor_for_opening_factor_1

field Start Height Factor for Opening Factor 1

The Start Height Factor is the Start Height divided by the window or door height.

Start Height is the distance between the bottom of the window or door and the

bottom of the window or door opening. The sum of the Height Factor and the Start Height

Factor must be less than 1.0 in order to have the opening within the window or door

dimensions.

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Start Height Factor for Opening Factor 1 Raises:ValueError – if value is not a valid value Returns:the value of start_height_factor_for_opening_factor_1 or None if not set Return type:float

start_height_factor_for_opening_factor_2

field Start Height Factor for Opening Factor 2

The Start Height Factor is the Start Height divided by the window or door height.

Start Height is the distance between the bottom of the window or door and the

bottom of the window or door opening. The sum of the Height Factor and the Start Height

Factor must be less than 1.0 in order to have the opening within the window or door

dimensions.

Units: dimensionless

value < 1.0

Parameters:value (float) – value for IDD Field Start Height Factor for Opening Factor 2 Raises:ValueError – if value is not a valid value Returns:the value of start_height_factor_for_opening_factor_2 or None if not set Return type:float

start_height_factor_for_opening_factor_3

field Start Height Factor for Opening Factor 3

The Start Height Factor is the Start Height divided by the window or door height.

Start Height is the distance between the bottom of the window or door and the

bottom of the window or door opening. The sum of the Height Factor and the Start Height

Factor must be less than 1.0 in order to have the opening within the window or door

dimensions.

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Start Height Factor for Opening Factor 3 Raises:ValueError – if value is not a valid value Returns:the value of start_height_factor_for_opening_factor_3 or None if not set Return type:float

start_height_factor_for_opening_factor_4

field Start Height Factor for Opening Factor 4

The Start Height Factor is the Start Height divided by the window or door height.

Start Height is the distance between the bottom of the window or door and the

bottom of the window or door opening. The sum of the Height Factor and the Start Height

Factor must be less than 1.0 in order to have the opening within the window or door

dimensions.

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Start Height Factor for Opening Factor 4 Raises:ValueError – if value is not a valid value Returns:the value of start_height_factor_for_opening_factor_4 or None if not set Return type:float

type_of_rectangular_large_vertical_opening_lvo

field Type of Rectangular Large Vertical Opening (LVO)

Select the type of vertical opening: Non-pivoted opening or Horizontally pivoted opening.

Default value: NonPivoted

Parameters:value (str) – value for IDD Field Type of Rectangular Large Vertical Opening (LVO) Raises:ValueError – if value is not a valid value Returns:the value of type_of_rectangular_large_vertical_opening_lvo or None if not set Return type:str

width_factor_for_opening_factor_1

field Width Factor for Opening Factor 1

The Width Factor is the opening width divided by the window or door width.

Units: dimensionless

value <= 1.0

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

width_factor_for_opening_factor_2

field Width Factor for Opening Factor 2

The Width Factor is the opening width divided by the window or door width.

Units: dimensionless

Default value: 1.0

value <= 1.0

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

width_factor_for_opening_factor_3

field Width Factor for Opening Factor 3

The Width Factor is the opening width divided by the window or door width.

Units: dimensionless

value <= 1.0

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

width_factor_for_opening_factor_4

field Width Factor for Opening Factor 4

The Width Factor is the opening width divided by the window or door width.

Units: dimensionless

value <= 1.0

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

class pyidf.natural_ventilation_and_duct_leakage.AirflowNetworkMultiZoneComponentHorizontalOpening

Bases: pyidf.helper.DataObject

Corresponds to IDD object AirflowNetwork:MultiZone:Component:HorizontalOpening This object specifies the properties of air flow through a horizontal opening

air_mass_flow_coefficient_when_opening_is_closed

field Air Mass Flow Coefficient When Opening is Closed

Defined at 1 Pa pressure difference. Enter the coefficient used in the following equation:

Mass flow rate = Air Mass Flow Coefficient * (dP)^Air Mass Flow Exponent.

Used only when opening is closed.

Units: kg/s-m

Parameters:value (float) – value for IDD Field Air Mass Flow Coefficient When Opening is Closed Raises:ValueError – if value is not a valid value Returns:the value of air_mass_flow_coefficient_when_opening_is_closed or None if not set Return type:float

air_mass_flow_exponent_when_opening_is_closed

field Air Mass Flow Exponent When Opening is Closed

Enter the exponent used in the following equation:

Mass flow rate = Air Mass Flow Coefficient * (dP)^Air Mass Flow Exponent.

Used only when opening is closed.

Units: dimensionless

Default value: 0.65

value >= 0.5

value <= 1.0

Parameters:value (float) – value for IDD Field Air Mass Flow Exponent When Opening is Closed Raises:ValueError – if value is not a valid value Returns:the value of air_mass_flow_exponent_when_opening_is_closed or None if not set Return type:float

discharge_coefficient

field Discharge Coefficient

The Discharge Coefficient indicates the fractional effectiveness

for air flow through the opening at that Opening Factor.

Units: dimensionless

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

name

field Name

Enter a unique name for this object.

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

sloping_plane_angle

field Sloping Plane Angle

Sloping plane angle = 90 is equivalent to fully open.

Units: deg

Default value: 90.0

value <= 90.0

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

class pyidf.natural_ventilation_and_duct_leakage.AirflowNetworkMultiZoneComponentSimpleOpening

Bases: pyidf.helper.DataObject

Corresponds to IDD object AirflowNetwork:MultiZone:Component:SimpleOpening This object specifies the properties of air flow through windows and doors (window, door and glass door heat transfer subsurfaces) when they are closed or open.

air_mass_flow_coefficient_when_opening_is_closed

field Air Mass Flow Coefficient When Opening is Closed

Defined at 1 Pa pressure difference. Enter the coefficient used in the following equation:

Mass Flow Rate = Air Mass Flow Coefficient * (dP)^Air Mass Flow Exponent.

Used only when opening (window or door) is closed.

Units: kg/s-m

Parameters:value (float) – value for IDD Field Air Mass Flow Coefficient When Opening is Closed Raises:ValueError – if value is not a valid value Returns:the value of air_mass_flow_coefficient_when_opening_is_closed or None if not set Return type:float

air_mass_flow_exponent_when_opening_is_closed

field Air Mass Flow Exponent When Opening is Closed

Enter the exponent used in the following equation:

Mass Flow Rate = Air Mass Flow Coefficient * (dP)^Air Mass Flow Exponent.

Used only when opening (window or door) is closed.

Units: dimensionless

Default value: 0.65

value >= 0.5

value <= 1.0

Parameters:value (float) – value for IDD Field Air Mass Flow Exponent When Opening is Closed Raises:ValueError – if value is not a valid value Returns:the value of air_mass_flow_exponent_when_opening_is_closed or None if not set Return type:float

discharge_coefficient

field Discharge Coefficient

The Discharge Coefficient indicates the fractional effectiveness

for air flow through a window or door at that Opening Factor.

Units: dimensionless

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

minimum_density_difference_for_twoway_flow

field Minimum Density Difference for Two-Way Flow

Enter the minimum density difference above which two-way flow may occur due to stack effect.

Units: kg/m3

Parameters:value (float) – value for IDD Field Minimum Density Difference for Two-Way Flow Raises:ValueError – if value is not a valid value Returns:the value of minimum_density_difference_for_twoway_flow or None if not set Return type:float

name

field Name

Enter a unique name for this object.

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

class pyidf.natural_ventilation_and_duct_leakage.AirflowNetworkMultiZoneComponentZoneExhaustFan

Bases: pyidf.helper.DataObject

Corresponds to IDD object AirflowNetwork:MultiZone:Component:ZoneExhaustFan This object specifies the additional properties for a zone exhaust fan to perform multizone airflow calculations.

air_mass_flow_coefficient_when_the_zone_exhaust_fan_is_off_at_reference_conditions

field Air Mass Flow Coefficient When the Zone Exhaust Fan is Off at Reference Conditions

Enter the air mass flow coefficient at the conditions defined

in the Reference Crack Conditions object.

Defined at 1 Pa pressure difference. Enter the coefficient used in the following

equation:

Mass Flow Rate = Air Mass Flow Coefficient * (dP)^Air Mass Flow Exponent.

Used only when the fan is off.

Units: kg/s

Parameters:value (float) – value for IDD Field Air Mass Flow Coefficient When the Zone Exhaust Fan is Off at Reference Conditions Raises:ValueError – if value is not a valid value Returns:the value of air_mass_flow_coefficient_when_the_zone_exhaust_fan_is_off_at_reference_conditions or None if not set Return type:float

air_mass_flow_exponent_when_the_zone_exhaust_fan_is_off

field Air Mass Flow Exponent When the Zone Exhaust Fan is Off

Enter the exponent used in the following equation:

Mass Flow Rate = Air Mass Flow Coefficient * (dP)^Air Mass Flow Exponent.

Used only when the fan is off.

Units: dimensionless

Default value: 0.65

value >= 0.5

value <= 1.0

Parameters:value (float) – value for IDD Field Air Mass Flow Exponent When the Zone Exhaust Fan is Off Raises:ValueError – if value is not a valid value Returns:the value of air_mass_flow_exponent_when_the_zone_exhaust_fan_is_off or None if not set Return type:float

name

field Name

Enter the name of a Fan:ZoneExhaust object.

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

reference_crack_conditions

field Reference Crack Conditions

Select a AirflowNetwork:MultiZone:ReferenceCrackConditions name associated with

the air mass flow coefficient entered above.

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

class pyidf.natural_ventilation_and_duct_leakage.AirflowNetworkMultiZoneExternalNode

Bases: pyidf.helper.DataObject

Corresponds to IDD object AirflowNetwork:MultiZone:ExternalNode This object defines outdoor environmental conditions outside of the building.

external_node_height

field External Node Height

Designates the reference height used to calculate relative pressure.

Units: m

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

name

field Name

Enter a unique name for this object.

This node name will be referenced by a particular building facade.

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

wind_pressure_coefficient_values_object_name

field Wind Pressure Coefficient Values Object Name

Enter the name of the AirflowNetwork:MultiZone:WindPressureCoefficientValues object.

Parameters:value (str) – value for IDD Field Wind Pressure Coefficient Values Object Name Raises:ValueError – if value is not a valid value Returns:the value of wind_pressure_coefficient_values_object_name or None if not set Return type:str

class pyidf.natural_ventilation_and_duct_leakage.AirflowNetworkMultiZoneReferenceCrackConditions

Bases: pyidf.helper.DataObject

Corresponds to IDD object AirflowNetwork:MultiZone:ReferenceCrackConditions This object specifies the conditions under which the air mass flow coefficient was measured.

name

field Name

Enter a unique name for this object.

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

reference_barometric_pressure

field Reference Barometric Pressure

Enter the reference barometric pressure under which the surface crack data were obtained.

Units: Pa

IP-Units: inHg

Default value: 101325.0

value >= 31000.0

value <= 120000.0

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

reference_humidity_ratio

field Reference Humidity Ratio

Enter the reference humidity ratio under which the surface crack data were obtained.

Units: kgWater/kgDryAir

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

reference_temperature

field Reference Temperature

Enter the reference temperature under which the surface crack data were obtained.

Units: C

Default value: 20.0

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

class pyidf.natural_ventilation_and_duct_leakage.AirflowNetworkMultiZoneSurface

Bases: pyidf.helper.DataObject

Corresponds to IDD object AirflowNetwork:MultiZone:Surface This object specifies the properties of a surface linkage through which air flows. Airflow Report: Node 1 as an inside face zone; Node 2 as an outside face zone or external node.

external_node_name

field External Node Name

Used if Wind Pressure Coefficient Type = Input in the AirflowNetwork:SimulationControl object,

otherwise this field may be left blank.

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

indoor_and_outdoor_enthalpy_difference_lower_limit_for_maximum_venting_open_factor

field Indoor and Outdoor Enthalpy Difference Lower Limit For Maximum Venting Open Factor

Applicable only if Ventilation Control Mode = Enthalpy.

This value must be less than the corresponding upper value (next field).

Units: deltaJ/kg

value < 300000.0

Parameters:value (float) – value for IDD Field Indoor and Outdoor Enthalpy Difference Lower Limit For Maximum Venting Open Factor Raises:ValueError – if value is not a valid value Returns:the value of indoor_and_outdoor_enthalpy_difference_lower_limit_for_maximum_venting_open_factor or None if not set Return type:float

indoor_and_outdoor_enthalpy_difference_upper_limit_for_minimum_venting_open_factor

field Indoor and Outdoor Enthalpy Difference Upper Limit for Minimum Venting Open Factor

Applicable only if Ventilation Control Mode = Enthalpy.

This value must be greater than the corresponding lower value (previous field).

Units: deltaJ/kg

Default value: 300000.0

Parameters:value (float) – value for IDD Field Indoor and Outdoor Enthalpy Difference Upper Limit for Minimum Venting Open Factor Raises:ValueError – if value is not a valid value Returns:the value of indoor_and_outdoor_enthalpy_difference_upper_limit_for_minimum_venting_open_factor or None if not set Return type:float

indoor_and_outdoor_temperature_difference_lower_limit_for_maximum_venting_open_factor

field Indoor and Outdoor Temperature Difference Lower Limit For Maximum Venting Open Factor

Applicable only if Ventilation Control Mode = Temperature

Units: deltaC

value < 100.0

Parameters:value (float) – value for IDD Field Indoor and Outdoor Temperature Difference Lower Limit For Maximum Venting Open Factor Raises:ValueError – if value is not a valid value Returns:the value of indoor_and_outdoor_temperature_difference_lower_limit_for_maximum_venting_open_factor or None if not set Return type:float

indoor_and_outdoor_temperature_difference_upper_limit_for_minimum_venting_open_factor

field Indoor and Outdoor Temperature Difference Upper Limit for Minimum Venting Open Factor

Applicable only if Ventilation Control Mode = Temperature.

This value must be greater than the corresponding lower value (previous field).

Units: deltaC

Default value: 100.0

Parameters:value (float) – value for IDD Field Indoor and Outdoor Temperature Difference Upper Limit for Minimum Venting Open Factor Raises:ValueError – if value is not a valid value Returns:the value of indoor_and_outdoor_temperature_difference_upper_limit_for_minimum_venting_open_factor or None if not set Return type:float

leakage_component_name

field Leakage Component Name

Enter the name of an Airflow Network leakage component. A leakage component is

one of the following AirflowNetwork:Multizone objects:

AirflowNetwork:MultiZone:Component:DetailedOpening,

AirflowNetwork:MultiZone:Component:SimpleOpening,

AirflowNetwork:MultiZone:Surface:Crack,

AirflowNetwork:MultiZone:Surface:EffectiveLeakageArea,

AirflowNetwork:MultiZone:Component:HorizontalOpening, or

AirflowNetwork:MultiZone:Component:ZoneExhaustFan.

When the zone exhaust fan name is entered, any surface control fields below A3 are

ignored when the zone exhaust fan turns on.

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

minimum_venting_open_factor

field Minimum Venting Open Factor

Used only if Ventilation Control Mode = Temperature or Enthalpy.

Units: dimensionless

value <= 1.0

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

occupant_ventilation_control_name

field Occupant Ventilation Control Name

Enter the name where Occupancy Ventilation Control is required.

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

surface_name

field Surface Name

Enter the name of a heat transfer surface.

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

ventilation_control_mode

field Ventilation Control Mode

When Ventilation Control Mode = Temperature or Enthalpy, the following

fields are used to modulate the Ventilation Open Factor for a

window or door opening according to the parent zone’s

indoor-outdoor temperature or enthalpy difference.

When Ventilation Control Mode = AdjacentTemperature or AdjacentEnthalpy, the following

fields are used to modulate the Ventilation Open Factor for an interior

window or door opening according to temperature or enthalpy difference

between the parent zone and the adjacent zone.

Constant: controlled by field Venting Schedule Name.

NoVent: control will not open window or door during simulation (Ventilation Open Factor = 0).

ZoneLevel: control will be controlled by AirflowNetwork:MultiZone:Zone

Mode.

Default value: ZoneLevel

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

ventilation_control_zone_temperature_setpoint_schedule_name

field Ventilation Control Zone Temperature Setpoint Schedule Name

Used only if Ventilation Control Mode = Temperature or Enthalpy.

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

venting_availability_schedule_name

field Venting Availability Schedule Name

Non-zero schedule value means venting is allowed if other venting control conditions are

satisfied. A zero (or negative) schedule value means venting is not allowed under any

circumstances. The schedule values should be greater than or equal to 0 and less than or

equal to 1. If this schedule is not specified then venting is allowed if

other venting control conditions are satisfied.

Not used if Ventilation Control Mode = NoVent or ZoneLevel.

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

window_or_door_opening_factor_or_crack_factor

field Window/Door Opening Factor, or Crack Factor

This field specifies a multiplier for a crack, window, or door.

Units: dimensionless

Default value: 1.0

value <= 1.0

Parameters:value (float) – value for IDD Field Window/Door Opening Factor, or Crack Factor Raises:ValueError – if value is not a valid value Returns:the value of window_or_door_opening_factor_or_crack_factor or None if not set Return type:float

class pyidf.natural_ventilation_and_duct_leakage.AirflowNetworkMultiZoneSurfaceCrack

Bases: pyidf.helper.DataObject

Corresponds to IDD object AirflowNetwork:MultiZone:Surface:Crack This object specifies the properties of airflow through a crack.

air_mass_flow_coefficient_at_reference_conditions

field Air Mass Flow Coefficient at Reference Conditions

Enter the air mass flow coefficient at the conditions defined

in the Reference Crack Conditions object.

Defined at 1 Pa pressure difference across this crack.

Units: kg/s

Parameters:value (float) – value for IDD Field Air Mass Flow Coefficient at Reference Conditions Raises:ValueError – if value is not a valid value Returns:the value of air_mass_flow_coefficient_at_reference_conditions or None if not set Return type:float

air_mass_flow_exponent

field Air Mass Flow Exponent

Enter the air mass flow exponent for the surface crack.

Units: dimensionless

Default value: 0.65

value >= 0.5

value <= 1.0

Parameters:value (float) – value for IDD Field Air Mass Flow Exponent Raises:ValueError – if value is not a valid value Returns:the value of air_mass_flow_exponent or None if not set Return type:float

name

field Name

Enter a unique name for this object.

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

reference_crack_conditions

field Reference Crack Conditions

Select a AirflowNetwork:MultiZone:ReferenceCrackConditions name associated with

the air mass flow coefficient entered above.

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

class pyidf.natural_ventilation_and_duct_leakage.AirflowNetworkMultiZoneSurfaceEffectiveLeakageArea

Bases: pyidf.helper.DataObject

Corresponds to IDD object AirflowNetwork:MultiZone:Surface:EffectiveLeakageArea This object is used to define surface air leakage.

air_mass_flow_exponent

field Air Mass Flow Exponent

Enter the exponent used in the air mass flow equation.

Units: dimensionless

Default value: 0.65

value >= 0.5

value <= 1.0

Parameters:value (float) – value for IDD Field Air Mass Flow Exponent Raises:ValueError – if value is not a valid value Returns:the value of air_mass_flow_exponent or None if not set Return type:float

discharge_coefficient

field Discharge Coefficient

Enter the coefficient used in the air mass flow equation.

Units: dimensionless

Default 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

effective_leakage_area

field Effective Leakage Area

Enter the effective leakage area.

Units: m2

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

name

field Name

Enter a unique name for this object.

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

reference_pressure_difference

field Reference Pressure Difference

Enter the pressure difference used to define the air mass flow coefficient and exponent.

Units: Pa

Default value: 4.0

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

class pyidf.natural_ventilation_and_duct_leakage.AirflowNetworkMultiZoneWindPressureCoefficientArray

Bases: pyidf.helper.DataObject

Corresponds to IDD object AirflowNetwork:MultiZone:WindPressureCoefficientArray Used only if Wind Pressure Coefficient (WPC) Type = Input in the AirflowNetwork:SimulationControl object. Number of WPC Values in the corresponding AirflowNetwork:MultiZone:WindPressureCoefficientValues object must be the same as the number of wind directions specified for this AirflowNetwork:MultiZone:WindPressureCoefficientArray object.

name

field Name

Enter a unique name for the object.

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

wind_direction_1

field Wind Direction 1

Enter the wind direction corresponding to the 1st WPC Array value.

Units: deg

value <= 360.0

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

wind_direction_10

field Wind Direction 10

Enter the wind direction corresponding to the 10th WPC Array value.

Units: deg

value <= 360.0

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

wind_direction_11

field Wind Direction 11

Enter the wind direction corresponding to the 11th WPC Array value.

Units: deg

value <= 360.0

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

wind_direction_12

field Wind Direction 12

Enter the wind direction corresponding to the 12th WPC Array value.

Units: deg

value <= 360.0

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

wind_direction_13

field Wind Direction 13

Enter the wind direction corresponding to the 13th WPC Array value.

Units: deg

value <= 360.0

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

wind_direction_14

field Wind Direction 14

Enter the wind direction corresponding to the 14th WPC Array value.

Units: deg

value <= 360.0

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

wind_direction_15

field Wind Direction 15

Enter the wind direction corresponding to the 15th WPC Array value.

Units: deg

value <= 360.0

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

wind_direction_16

field Wind Direction 16

Enter the wind direction corresponding to the 16th WPC Array value.

Units: deg

value <= 360.0

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

wind_direction_17

field Wind Direction 17

Enter the wind direction corresponding to the 17th WPC Array value.

Units: deg

value <= 360.0

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

wind_direction_18

field Wind Direction 18

Enter the wind direction corresponding to the 18th WPC Array value.

Units: deg

value <= 360.0

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

wind_direction_19

field Wind Direction 19

Enter the wind direction corresponding to the 19th WPC Array value.

Units: deg

value <= 360.0

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

wind_direction_2

field Wind Direction 2

Enter the wind direction corresponding to the 2nd WPC Array value.

Units: deg

value <= 360.0

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

wind_direction_20

field Wind Direction 20

Enter the wind direction corresponding to the 20th WPC Array value.

Units: deg

value <= 360.0

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

wind_direction_21

field Wind Direction 21

Enter the wind direction corresponding to the 21st WPC Array value.

Units: deg

value <= 360.0

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

wind_direction_22

field Wind Direction 22

Enter the wind direction corresponding to the 22nd WPC Array value.

Units: deg

value <= 360.0

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

wind_direction_23

field Wind Direction 23

Enter the wind direction corresponding to the 23rd WPC Array value.

Units: deg

value <= 360.0

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

wind_direction_24

field Wind Direction 24

Enter the wind direction corresponding to the 24th WPC Array value.

Units: deg

value <= 360.0

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

wind_direction_25

field Wind Direction 25

Enter the wind direction corresponding to the 25th WPC Array value.

Units: deg

value <= 360.0

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

wind_direction_26

field Wind Direction 26

Enter the wind direction corresponding to the 26th WPC Array value.

Units: deg

value <= 360.0

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

wind_direction_27

field Wind Direction 27

Enter the wind direction corresponding to the 27th WPC Array value.

Units: deg

value <= 360.0

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

wind_direction_28

field Wind Direction 28

Enter the wind direction corresponding to the 28th WPC Array value.

Units: deg

value <= 360.0

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

wind_direction_29

field Wind Direction 29

Enter the wind direction corresponding to the 29th WPC Array value.

Units: deg

value <= 360.0

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

wind_direction_3

field Wind Direction 3

Enter the wind direction corresponding to the 3rd WPC Array value.

Units: deg

value <= 360.0

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

wind_direction_30

field Wind Direction 30

Enter the wind direction corresponding to the 30th WPC Array value.

Units: deg

value <= 360.0

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

wind_direction_31

field Wind Direction 31

Enter the wind direction corresponding to the 31st WPC Array value.

Units: deg

value <= 360.0

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

wind_direction_32

field Wind Direction 32

Enter the wind direction corresponding to the 32nd WPC Array value.

Units: deg

value <= 360.0

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

wind_direction_33

field Wind Direction 33

Enter the wind direction corresponding to the 33rd WPC Array value.

Units: deg

value <= 360.0

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

wind_direction_34

field Wind Direction 34

Enter the wind direction corresponding to the 34th WPC Array value.

Units: deg

value <= 360.0

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

wind_direction_35

field Wind Direction 35

Enter the wind direction corresponding to the 35th WPC Array value.

Units: deg

value <= 360.0

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

wind_direction_36

field Wind Direction 36

Enter the wind direction corresponding to the 36th WPC Array value.

Units: deg

value <= 360.0

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

wind_direction_4

field Wind Direction 4

Enter the wind direction corresponding to the 4th WPC Array value.

Units: deg

value <= 360.0

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

wind_direction_5

field Wind Direction 5

Enter the wind direction corresponding to the 5th WPC Array value.

Units: deg

value <= 360.0

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

wind_direction_6

field Wind Direction 6

Enter the wind direction corresponding to the 6th WPC Array value.

Units: deg

value <= 360.0

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

wind_direction_7

field Wind Direction 7

Enter the wind direction corresponding to the 7th WPC Array value.

Units: deg

value <= 360.0

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

wind_direction_8

field Wind Direction 8

Enter the wind direction corresponding to the 8th WPC Array value.

Units: deg

value <= 360.0

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

wind_direction_9

field Wind Direction 9

Enter the wind direction corresponding to the 9th WPC Array value.

Units: deg

value <= 360.0

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

class pyidf.natural_ventilation_and_duct_leakage.AirflowNetworkMultiZoneWindPressureCoefficientValues

Bases: pyidf.helper.DataObject

Corresponds to IDD object AirflowNetwork:MultiZone:WindPressureCoefficientValues Used only if Wind Pressure Coefficient (WPC) Type = INPUT in the AirflowNetwork:SimulationControl object. The number of WPC numeric inputs must correspond to the number of wind direction inputs in the AirflowNetwork:Multizone:WindPressureCoefficientArray object.

airflownetworkmultizonewindpressurecoefficientarray_name

field AirflowNetwork:MultiZone:WindPressureCoefficientArray Name

Enter the name of the AirflowNetwork:Multizone:WindPressureCoefficientArray object.

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

name

field Name

Enter a unique name for this object.

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

wind_pressure_coefficient_value_1

field Wind Pressure Coefficient Value 1

Enter the WPC Value corresponding to the 1st wind direction.

Units: dimensionless

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

wind_pressure_coefficient_value_10

field Wind Pressure Coefficient Value 10

Enter the WPC Value corresponding to the 10th wind direction.

Units: dimensionless

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

wind_pressure_coefficient_value_11

field Wind Pressure Coefficient Value 11

Enter the WPC Value corresponding to the 11th wind direction.

Units: dimensionless

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

wind_pressure_coefficient_value_12

field Wind Pressure Coefficient Value 12

Enter the WPC Value corresponding to the 12th wind direction.

Units: dimensionless

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

wind_pressure_coefficient_value_13

field Wind Pressure Coefficient Value 13

Enter the WPC Value corresponding to the 13th wind direction.

Units: dimensionless

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

wind_pressure_coefficient_value_14

field Wind Pressure Coefficient Value 14

Enter the WPC Value corresponding to the 14th wind direction.

Units: dimensionless

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

wind_pressure_coefficient_value_15

field Wind Pressure Coefficient Value 15

Enter the WPC Value corresponding to the 15th wind direction.

Units: dimensionless

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

wind_pressure_coefficient_value_16

field Wind Pressure Coefficient Value 16

Enter the WPC Value corresponding to the 16th wind direction.

Units: dimensionless

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

wind_pressure_coefficient_value_17

field Wind Pressure Coefficient Value 17

Enter the WPC Value corresponding to the 17th wind direction.

Units: dimensionless

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

wind_pressure_coefficient_value_18

field Wind Pressure Coefficient Value 18

Enter the WPC Value corresponding to the 18th wind direction.

Units: dimensionless

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

wind_pressure_coefficient_value_19

field Wind Pressure Coefficient Value 19

Enter the WPC Value corresponding to the 19th wind direction.

Units: dimensionless

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

wind_pressure_coefficient_value_2

field Wind Pressure Coefficient Value 2

Enter the WPC Value corresponding to the 2nd wind direction.

Units: dimensionless

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

wind_pressure_coefficient_value_20

field Wind Pressure Coefficient Value 20

Enter the WPC Value corresponding to the 20th wind direction.

Units: dimensionless

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

wind_pressure_coefficient_value_21

field Wind Pressure Coefficient Value 21

Enter the WPC Value corresponding to the 21st wind direction.

Units: dimensionless

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

wind_pressure_coefficient_value_22

field Wind Pressure Coefficient Value 22

Enter the WPC Value corresponding to the 22nd wind direction.

Units: dimensionless

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

wind_pressure_coefficient_value_23

field Wind Pressure Coefficient Value 23

Enter the WPC Value corresponding to the 23rd wind direction.

Units: dimensionless

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

wind_pressure_coefficient_value_24

field Wind Pressure Coefficient Value 24

Enter the WPC Value corresponding to the 24th wind direction.

Units: dimensionless

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

wind_pressure_coefficient_value_25

field Wind Pressure Coefficient Value 25

Enter the WPC Value corresponding to the 25th wind direction.

Units: dimensionless

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

wind_pressure_coefficient_value_26

field Wind Pressure Coefficient Value 26

Enter the WPC Value corresponding to the 26th wind direction.

Units: dimensionless

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

wind_pressure_coefficient_value_27

field Wind Pressure Coefficient Value 27

Enter the WPC Value corresponding to the 27th wind direction.

Units: dimensionless

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

wind_pressure_coefficient_value_28

field Wind Pressure Coefficient Value 28

Enter the WPC Value corresponding to the 28th wind direction.

Units: dimensionless

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

wind_pressure_coefficient_value_29

field Wind Pressure Coefficient Value 29

Enter the WPC Value corresponding to the 29th wind direction.

Units: dimensionless

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

wind_pressure_coefficient_value_3

field Wind Pressure Coefficient Value 3

Enter the WPC Value corresponding to the 3rd wind direction.

Units: dimensionless

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

wind_pressure_coefficient_value_30

field Wind Pressure Coefficient Value 30

Enter the WPC Value corresponding to the 30th wind direction.

Units: dimensionless

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

wind_pressure_coefficient_value_31

field Wind Pressure Coefficient Value 31

Enter the WPC Value corresponding to the 31st wind direction.

Units: dimensionless

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

wind_pressure_coefficient_value_32

field Wind Pressure Coefficient Value 32

Enter the WPC Value corresponding to the 32nd wind direction.

Units: dimensionless

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

wind_pressure_coefficient_value_33

field Wind Pressure Coefficient Value 33

Enter the WPC Value corresponding to the 33rd wind direction.

Units: dimensionless

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

wind_pressure_coefficient_value_34

field Wind Pressure Coefficient Value 34

Enter the WPC Value corresponding to the 34th wind direction.

Units: dimensionless

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

wind_pressure_coefficient_value_35

field Wind Pressure Coefficient Value 35

Enter the WPC Value corresponding to the 35th wind direction.

Units: dimensionless

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

wind_pressure_coefficient_value_36

field Wind Pressure Coefficient Value 36

Enter the WPC Value corresponding to the 36th wind direction.

Units: dimensionless

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

wind_pressure_coefficient_value_4

field Wind Pressure Coefficient Value 4

Enter the WPC Value corresponding to the 4th wind direction.

Units: dimensionless

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

wind_pressure_coefficient_value_5

field Wind Pressure Coefficient Value 5

Enter the WPC Value corresponding to the 5th wind direction.

Units: dimensionless

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

wind_pressure_coefficient_value_6

field Wind Pressure Coefficient Value 6

Enter the WPC Value corresponding to the 6th wind direction.

Units: dimensionless

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

wind_pressure_coefficient_value_7

field Wind Pressure Coefficient Value 7

Enter the WPC Value corresponding to the 7th wind direction.

Units: dimensionless

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

wind_pressure_coefficient_value_8

field Wind Pressure Coefficient Value 8

Enter the WPC Value corresponding to the 8th wind direction.

Units: dimensionless

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

wind_pressure_coefficient_value_9

field Wind Pressure Coefficient Value 9

Enter the WPC Value corresponding to the 9th wind direction.

Units: dimensionless

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

class pyidf.natural_ventilation_and_duct_leakage.AirflowNetworkMultiZoneZone

Bases: pyidf.helper.DataObject

Corresponds to IDD object AirflowNetwork:MultiZone:Zone This object is used to simultaneously control a thermal zone’s window and door openings, both exterior and interior.

facade_width

field Facade Width

This is the whole building width along the direction of the facade of this zone.

Units: m

Default value: 10.0

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

indoor_and_outdoor_enthalpy_difference_lower_limit_for_maximum_venting_open_factor

field Indoor and Outdoor Enthalpy Difference Lower Limit For Maximum Venting Open Factor

Applicable only if Ventilation Control Mode = Enthalpy.

This value must be less than the corresponding upper value (next field).

Units: deltaJ/kg

value < 300000.0

Parameters:value (float) – value for IDD Field Indoor and Outdoor Enthalpy Difference Lower Limit For Maximum Venting Open Factor Raises:ValueError – if value is not a valid value Returns:the value of indoor_and_outdoor_enthalpy_difference_lower_limit_for_maximum_venting_open_factor or None if not set Return type:float

indoor_and_outdoor_enthalpy_difference_upper_limit_for_minimum_venting_open_factor

field Indoor and Outdoor Enthalpy Difference Upper Limit for Minimum Venting Open Factor

Applicable only if Ventilation Control Mode = Enthalpy.

This value must be greater than the corresponding lower value (previous field).

Units: deltaJ/kg

Default value: 300000.0

Parameters:value (float) – value for IDD Field Indoor and Outdoor Enthalpy Difference Upper Limit for Minimum Venting Open Factor Raises:ValueError – if value is not a valid value Returns:the value of indoor_and_outdoor_enthalpy_difference_upper_limit_for_minimum_venting_open_factor or None if not set Return type:float

indoor_and_outdoor_temperature_difference_lower_limit_for_maximum_venting_open_factor

field Indoor and Outdoor Temperature Difference Lower Limit For Maximum Venting Open Factor

Applicable only if Ventilation Control Mode = Temperature.

This value must be less than the corresponding upper value (next field).

Units: deltaC

value < 100.0

Parameters:value (float) – value for IDD Field Indoor and Outdoor Temperature Difference Lower Limit For Maximum Venting Open Factor Raises:ValueError – if value is not a valid value Returns:the value of indoor_and_outdoor_temperature_difference_lower_limit_for_maximum_venting_open_factor or None if not set Return type:float

indoor_and_outdoor_temperature_difference_upper_limit_for_minimum_venting_open_factor

field Indoor and Outdoor Temperature Difference Upper Limit for Minimum Venting Open Factor

Applicable only if Ventilation Control Mode = Temperature.

This value must be greater than the corresponding lower value (previous field).

Units: deltaC

Default value: 100.0

Parameters:value (float) – value for IDD Field Indoor and Outdoor Temperature Difference Upper Limit for Minimum Venting Open Factor Raises:ValueError – if value is not a valid value Returns:the value of indoor_and_outdoor_temperature_difference_upper_limit_for_minimum_venting_open_factor or None if not set Return type:float

minimum_venting_open_factor

field Minimum Venting Open Factor

Used only if Ventilation Control Mode = Temperature or Enthalpy.

Units: dimensionless

value <= 1.0

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

occupant_ventilation_control_name

field Occupant Ventilation Control Name

Enter the name where Occupancy Ventilation Control is required.

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

single_sided_wind_pressure_coefficient_algorithm

field Single Sided Wind Pressure Coefficient Algorithm

Selecting Advanced results in EnergyPlus calculating modified Wind Pressure Coefficients

to account for wind direction and turbulence effects on single sided ventilation rates.

Model is only valid for zones with 2 openings, both of which are on a single facade.

Default value: Standard

Parameters:value (str) – value for IDD Field Single Sided Wind Pressure Coefficient Algorithm Raises:ValueError – if value is not a valid value Returns:the value of single_sided_wind_pressure_coefficient_algorithm or None if not set Return type:str

ventilation_control_mode

field Ventilation Control Mode

When Ventilation Control Mode = Temperature or Enthalpy, the following

fields are used to modulate the Ventilation Open Factor for all

window and door openings in the zone according to the zone’s

indoor-outdoor temperature or enthalpy difference.

Constant: controlled by field Venting Schedule Name.

NoVent: control will not open window or door during simulation (Ventilation Open Factor = 0).

Default value: NoVent

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

ventilation_control_zone_temperature_setpoint_schedule_name

field Ventilation Control Zone Temperature Setpoint Schedule Name

Used only if Ventilation Control Mode = Temperature or Enthalpy.

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

venting_availability_schedule_name

field Venting Availability Schedule Name

Non-zero Schedule value means venting is allowed if other venting control conditions are

satisfied. A zero (or negative) Schedule value means venting is not allowed under any

The Schedule values should be greater than or equal to 0 and less than or equal to 1.

circumstances. If this Schedule is not specified then venting is allowed if

other venting control conditions are satisfied.

Not used if Ventilation Control Mode = NoVent.

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

zone_name

field Zone Name

Enter the zone name where ventilation control is required.

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.natural_ventilation_and_duct_leakage.AirflowNetworkOccupantVentilationControl

Bases: pyidf.helper.DataObject

Corresponds to IDD object AirflowNetwork:OccupantVentilationControl This object is used to provide advanced thermal comfort control of window opening and closing for both exterior and interior windows.

closing_probability_schedule_name

field Closing Probability Schedule Name

If this field is blank, the closing probability check is bypassed and closing is true.

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

maximum_threshold_for_persons_dissatisfied_ppd

field Maximum Threshold for Persons Dissatisfied PPD

Units: percent

Default value: 10.0

value <= 100.0

Parameters:value (float) – value for IDD Field Maximum Threshold for Persons Dissatisfied PPD Raises:ValueError – if value is not a valid value Returns:the value of maximum_threshold_for_persons_dissatisfied_ppd or None if not set Return type:float

minimum_closing_time

field Minimum Closing Time

Units: minutes

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

minimum_opening_time

field Minimum Opening Time

Units: minutes

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

name

field Name

Enter the name where the advanced thermal comfort control is required.

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

occupancy_check

field Occupancy Check

If Yes, occupancy check will be performed as part of the opening probability check.

Default value: No

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

opening_probability_schedule_name

field Opening Probability Schedule Name

If this field is blank, the opening probability check is bypassed and opening is true.

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

thermal_comfort_high_temperature_curve_name

field Thermal Comfort High Temperature Curve Name

Enter a curve name that represents thermal comfort temperature as a

function of outdoor dry-bulb temperature. Up to two curves are allowed if the

performance cannot be represented by a single curve.

If a single performance curve is used, leave this field blank.

Parameters:value (str) – value for IDD Field Thermal Comfort High Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of thermal_comfort_high_temperature_curve_name or None if not set Return type:str

thermal_comfort_low_temperature_curve_name

field Thermal Comfort Low Temperature Curve Name

Enter a curve name that represents thermal comfort temperature as a

function of outdoor dry-bulb temperature. Up to two curves are allowed if the

performance cannot be represented by a single curve.

The following two fields are used if two curves are required.

Parameters:value (str) – value for IDD Field Thermal Comfort Low Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of thermal_comfort_low_temperature_curve_name or None if not set Return type:str

thermal_comfort_temperature_boundary_point

field Thermal Comfort Temperature Boundary Point

This point is used to allow separate low and high thermal comfort temperature

curves. If a single performance curve is used, leave this field blank.

Units: C

Default value: 10.0

Parameters:value (float) – value for IDD Field Thermal Comfort Temperature Boundary Point Raises:ValueError – if value is not a valid value Returns:the value of thermal_comfort_temperature_boundary_point or None if not set Return type:float

class pyidf.natural_ventilation_and_duct_leakage.AirflowNetworkSimulationControl

Bases: pyidf.helper.DataObject

Corresponds to IDD object AirflowNetwork:SimulationControl This object defines the global parameters used in an Airflow Network simulation.

absolute_airflow_convergence_tolerance

field Absolute Airflow Convergence Tolerance

This tolerance is defined as the absolute value of the sum of the mass flow rates. The mass

flow rates described here refer to the mass flow rates at all nodes in the AirflowNetwork

model. The solution converges when both this tolerance and the tolerance in the previous

field (Relative Airflow Convergence Tolerance) are satisfied.

Units: kg/s

Default value: 1e-06

Parameters:value (float) – value for IDD Field Absolute Airflow Convergence Tolerance Raises:ValueError – if value is not a valid value Returns:the value of absolute_airflow_convergence_tolerance or None if not set Return type:float

airflownetwork_control

field AirflowNetwork Control

NoMultizoneOrDistribution: Only perform Simple calculations (objects ZoneInfiltration:*,

ZoneVentilation:*, ZoneMixing, ZoneCrossMixing, ZoneRefrigerationDoorMixing,

ZoneAirBalance:OutdoorAir, ZoneEarthtube, ZoneThermalChimney, and ZoneCoolTower:Shower);

MultizoneWithoutDistribution: Use AirflowNetwork objects to simulate multizone

Airflows driven by wind during simulation time,

and objects of ZoneInfiltration:, ZoneVentilation:, ZoneMixing, ZoneCrossMixing

ZoneRefrigerationDoorMixing, ZoneAirBalance:OutdoorAir, ZoneEarthtube,

ZoneThermalChimney, and ZoneCoolTower:Shower are ignored;

MultizoneWithDistributionOnlyDuringFanOperation: Perform distribution system

calculations during system fan on time

and Simple calculations during system Fan off time;

MultizoneWithDistribution: Perform distribution system calculations during system

fan on time and multizone Airflow driven by wind during system fan off time.

Default value: NoMultizoneOrDistribution

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

airflownetwork_wind_pressure_coefficient_array_name

field AirflowNetwork Wind Pressure Coefficient Array Name

Used only if Wind Pressure Coefficient Type = Input, otherwise this field may be left blank.

Parameters:value (str) – value for IDD Field AirflowNetwork Wind Pressure Coefficient Array Name Raises:ValueError – if value is not a valid value Returns:the value of airflownetwork_wind_pressure_coefficient_array_name or None if not set Return type:str

azimuth_angle_of_long_axis_of_building

field Azimuth Angle of Long Axis of Building

Degrees clockwise from true North.

Used only if Wind Pressure Coefficient Type = SurfaceAverageCalculation.

Units: deg

value <= 180.0

Parameters:value (float) – value for IDD Field Azimuth Angle of Long Axis of Building Raises:ValueError – if value is not a valid value Returns:the value of azimuth_angle_of_long_axis_of_building or None if not set Return type:float

building_type

field Building Type

Used only if Wind Pressure Coefficient Type = SurfaceAverageCalculation,

otherwise this field may be left blank.

Default value: LowRise

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

convergence_acceleration_limit

field Convergence Acceleration Limit

Used only for AirflowNetwork:SimulationControl

Units: dimensionless

Default value: -0.5

value >= -1.0

value <= 1.0

Parameters:value (float) – value for IDD Field Convergence Acceleration Limit Raises:ValueError – if value is not a valid value Returns:the value of convergence_acceleration_limit or None if not set Return type:float

height_dependence_of_external_node_temperature

field Height Dependence of External Node Temperature

If Yes, external node temperature is height dependent.

If No, external node temperature is based on zero height.

Default value: No

Parameters:value (str) – value for IDD Field Height Dependence of External Node Temperature Raises:ValueError – if value is not a valid value Returns:the value of height_dependence_of_external_node_temperature or None if not set Return type:str

height_selection_for_local_wind_pressure_calculation

field Height Selection for Local Wind Pressure Calculation

If ExternalNode is selected, the height given in the

AirflowNetwork:MultiZone:ExternalNode object will be used.

If OpeningHeight is selected, the surface opening height (centroid) will be used to

calculate local wind pressure

This field is ignored when the choice of the Wind Pressure Coefficient Type field is

SurfaceAverageCalculation.

Default value: OpeningHeight

Parameters:value (str) – value for IDD Field Height Selection for Local Wind Pressure Calculation Raises:ValueError – if value is not a valid value Returns:the value of height_selection_for_local_wind_pressure_calculation or None if not set Return type:str

initialization_type

field Initialization Type

Default value: ZeroNodePressures

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

maximum_number_of_iterations

field Maximum Number of Iterations

Determines the maximum number of iterations used to converge on a solution. If this limit

is exceeded, the program terminates.

Units: dimensionless

Default value: 500

value > 10

value <= 30000

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

name

field Name

Enter a unique name for this object.

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

ratio_of_building_width_along_short_axis_to_width_along_long_axis

field Ratio of Building Width Along Short Axis to Width Along Long Axis

Used only if Wind Pressure Coefficient Type = SurfaceAverageCalculation.

Default value: 1.0

value <= 1.0

Parameters:value (float) – value for IDD Field Ratio of Building Width Along Short Axis to Width Along Long Axis Raises:ValueError – if value is not a valid value Returns:the value of ratio_of_building_width_along_short_axis_to_width_along_long_axis or None if not set Return type:float

relative_airflow_convergence_tolerance

field Relative Airflow Convergence Tolerance

This tolerance is defined as the absolute value of the sum of the mass Flow Rates

divided by the sum of the absolute value of the mass Flow Rates. The mass Flow Rates

described here refer to the mass Flow Rates at all Nodes in the AirflowNetwork model.

The solution converges when both this tolerance and the tolerance in the next field

(Absolute Airflow Convergence Tolerance) are satisfied.

Units: dimensionless

Default value: 0.0001

Parameters:value (float) – value for IDD Field Relative Airflow Convergence Tolerance Raises:ValueError – if value is not a valid value Returns:the value of relative_airflow_convergence_tolerance or None if not set Return type:float

wind_pressure_coefficient_type

field Wind Pressure Coefficient Type

Input: User must enter AirflowNetwork:MultiZone:WindPressureCoefficientArray,

AirflowNetwork:MultiZone:ExternalNode, and

AirflowNetwork:MultiZone:WindPressureCoefficientValues objects.

SurfaceAverageCalculation: used only for rectangular buildings.

If SurfaceAverageCalculation is selected,

AirflowNetwork:MultiZone:WindPressureCoefficientArray, AirflowNetwork:MultiZone:ExternalNode,

and AirflowNetwork:MultiZone:WindPressureCoefficientValues objects are not used.

Default value: SurfaceAverageCalculation

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