pyidf.advanced_construction module

Data objects in group “Advanced Construction”

class pyidf.advanced_construction.ComplexFenestrationPropertySolarAbsorbedLayers

Bases: pyidf.helper.DataObject

Corresponds to IDD object ComplexFenestrationProperty:SolarAbsorbedLayers Used to provide solar radiation absorbed in fenestration layers. References surface-construction pair and if that pair is used in a simulation, then program will use value provided in schedules instead of calculating it.

construction_name

field Construction Name

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

fenestration_surface

field Fenestration Surface

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

layer_1_solar_radiation_absorbed_schedule_name

field Layer 1 Solar Radiation Absorbed Schedule Name

Parameters:value (str) – value for IDD Field Layer 1 Solar Radiation Absorbed Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of layer_1_solar_radiation_absorbed_schedule_name or None if not set Return type:str

layer_2_solar_radiation_absorbed_schedule_name

field Layer 2 Solar Radiation Absorbed Schedule Name

Parameters:value (str) – value for IDD Field Layer 2 Solar Radiation Absorbed Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of layer_2_solar_radiation_absorbed_schedule_name or None if not set Return type:str

layer_3_solar_radiation_absorbed_schedule_name

field Layer 3 Solar Radiation Absorbed Schedule Name

Parameters:value (str) – value for IDD Field Layer 3 Solar Radiation Absorbed Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of layer_3_solar_radiation_absorbed_schedule_name or None if not set Return type:str

layer_4_solar_radiation_absorbed_schedule_name

field Layer 4 Solar Radiation Absorbed Schedule Name

Parameters:value (str) – value for IDD Field Layer 4 Solar Radiation Absorbed Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of layer_4_solar_radiation_absorbed_schedule_name or None if not set Return type:str

layer_5_solar_radiation_absorbed_schedule_name

field Layer 5 Solar Radiation Absorbed Schedule Name

Parameters:value (str) – value for IDD Field Layer 5 Solar Radiation Absorbed Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of layer_5_solar_radiation_absorbed_schedule_name or None if not set Return type:str

name

field Name

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

class pyidf.advanced_construction.SurfaceControlMovableInsulation

Bases: pyidf.helper.DataObject

Corresponds to IDD object SurfaceControl:MovableInsulation Exterior or Interior Insulation on opaque surfaces

insulation_type

field Insulation Type

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

material_name

field Material Name

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

schedule_name

field Schedule Name

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

surface_name

field Surface Name

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

class pyidf.advanced_construction.SurfaceConvectionAlgorithmInsideAdaptiveModelSelections

Bases: pyidf.helper.DataObject

Corresponds to IDD object SurfaceConvectionAlgorithm:Inside:AdaptiveModelSelections Options to change the individual convection model equations for dynamic selection when using AdaptiveConvectiongAlgorithm This object is only needed to make changes to the default model selections for any or all of the surface categories. This object is for the inside face, the side of the surface facing a thermal zone.

central_air_diffuser_ceiling_equation_source

field Central Air Diffuser Ceiling Equation Source

Applies to zone with mechanical forced central air with diffusers

This is for all ceiling surfaces

Default value: FisherPedersenCeilingDiffuserCeiling

Parameters:value (str) – value for IDD Field Central Air Diffuser Ceiling Equation Source Raises:ValueError – if value is not a valid value Returns:the value of central_air_diffuser_ceiling_equation_source or None if not set Return type:str

central_air_diffuser_ceiling_equation_user_curve_name

field Central Air Diffuser Ceiling Equation User Curve Name

The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve

Parameters:value (str) – value for IDD Field Central Air Diffuser Ceiling Equation User Curve Name Raises:ValueError – if value is not a valid value Returns:the value of central_air_diffuser_ceiling_equation_user_curve_name or None if not set Return type:str

central_air_diffuser_floor_equation_source

field Central Air Diffuser Floor Equation Source

Applies to zone with mechanical forced central air with diffusers

This is for all floor surfaces

Default value: GoldsteinNovoselacCeilingDiffuserFloor

Parameters:value (str) – value for IDD Field Central Air Diffuser Floor Equation Source Raises:ValueError – if value is not a valid value Returns:the value of central_air_diffuser_floor_equation_source or None if not set Return type:str

central_air_diffuser_floor_equation_user_curve_name

field Central Air Diffuser Floor Equation User Curve Name

The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve

Parameters:value (str) – value for IDD Field Central Air Diffuser Floor Equation User Curve Name Raises:ValueError – if value is not a valid value Returns:the value of central_air_diffuser_floor_equation_user_curve_name or None if not set Return type:str

central_air_diffuser_wall_equation_source

field Central Air Diffuser Wall Equation Source

Applies to zone with mechanical forced central air with diffusers

This is for all wall surfaces

Default value: GoldsteinNovoselacCeilingDiffuserWalls

Parameters:value (str) – value for IDD Field Central Air Diffuser Wall Equation Source Raises:ValueError – if value is not a valid value Returns:the value of central_air_diffuser_wall_equation_source or None if not set Return type:str

central_air_diffuser_wall_equation_user_curve_name

field Central Air Diffuser Wall Equation User Curve Name

The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve

Parameters:value (str) – value for IDD Field Central Air Diffuser Wall Equation User Curve Name Raises:ValueError – if value is not a valid value Returns:the value of central_air_diffuser_wall_equation_user_curve_name or None if not set Return type:str

central_air_diffuser_window_equation_source

field Central Air Diffuser Window Equation Source

Applies to zone with mechanical forced central air with diffusers

This is for all window surfaces

Default value: GoldsteinNovoselacCeilingDiffuserWindow

Parameters:value (str) – value for IDD Field Central Air Diffuser Window Equation Source Raises:ValueError – if value is not a valid value Returns:the value of central_air_diffuser_window_equation_source or None if not set Return type:str

central_air_diffuser_window_equation_user_curve_name

field Central Air Diffuser Window Equation User Curve Name

The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve

Parameters:value (str) – value for IDD Field Central Air Diffuser Window Equation User Curve Name Raises:ValueError – if value is not a valid value Returns:the value of central_air_diffuser_window_equation_user_curve_name or None if not set Return type:str

convective_zone_heater_stable_horizontal_equation_source

field Convective Zone Heater Stable Horizontal Equation Source

Applies to zone with convective heater

This is for horizontal surfaces with heat flow directed for stable thermal stratification

Default value: AlamdariHammondStableHorizontal

Parameters:value (str) – value for IDD Field Convective Zone Heater Stable Horizontal Equation Source Raises:ValueError – if value is not a valid value Returns:the value of convective_zone_heater_stable_horizontal_equation_source or None if not set Return type:str

convective_zone_heater_stable_horizontal_equation_user_curve_name

field Convective Zone Heater Stable Horizontal Equation User Curve Name

The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve

Parameters:value (str) – value for IDD Field Convective Zone Heater Stable Horizontal Equation User Curve Name Raises:ValueError – if value is not a valid value Returns:the value of convective_zone_heater_stable_horizontal_equation_user_curve_name or None if not set Return type:str

convective_zone_heater_stable_tilted_equation_source

field Convective Zone Heater Stable Tilted Equation Source

Applies to zone with convective heater

This is for tilted surfaces with heat flow for stable thermal stratification

Default value: WaltonStableHorizontalOrTilt

Parameters:value (str) – value for IDD Field Convective Zone Heater Stable Tilted Equation Source Raises:ValueError – if value is not a valid value Returns:the value of convective_zone_heater_stable_tilted_equation_source or None if not set Return type:str

convective_zone_heater_stable_tilted_equation_user_curve_name

field Convective Zone Heater Stable Tilted Equation User Curve Name

The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve

Parameters:value (str) – value for IDD Field Convective Zone Heater Stable Tilted Equation User Curve Name Raises:ValueError – if value is not a valid value Returns:the value of convective_zone_heater_stable_tilted_equation_user_curve_name or None if not set Return type:str

convective_zone_heater_unstable_horizontal_equation_source

field Convective Zone Heater Unstable Horizontal Equation Source

Applies to zone with convective heater

This is for horizontal surfaces with heat flow directed for unstable thermal stratification

Default value: KhalifaEq7Ceiling

Parameters:value (str) – value for IDD Field Convective Zone Heater Unstable Horizontal Equation Source Raises:ValueError – if value is not a valid value Returns:the value of convective_zone_heater_unstable_horizontal_equation_source or None if not set Return type:str

convective_zone_heater_unstable_horizontal_equation_user_curve_name

field Convective Zone Heater Unstable Horizontal Equation User Curve Name

The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve

Parameters:value (str) – value for IDD Field Convective Zone Heater Unstable Horizontal Equation User Curve Name Raises:ValueError – if value is not a valid value Returns:the value of convective_zone_heater_unstable_horizontal_equation_user_curve_name or None if not set Return type:str

convective_zone_heater_unstable_tilted_equation_source

field Convective Zone Heater Unstable Tilted Equation Source

Applies to zone with convective heater

This is for tilted surfaces with heat flow for unstable thermal stratification

Default value: WaltonUnstableHorizontalOrTilt

Parameters:value (str) – value for IDD Field Convective Zone Heater Unstable Tilted Equation Source Raises:ValueError – if value is not a valid value Returns:the value of convective_zone_heater_unstable_tilted_equation_source or None if not set Return type:str

convective_zone_heater_unstable_tilted_equation_user_curve_name

field Convective Zone Heater Unstable Tilted Equation User Curve Name

The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve

Parameters:value (str) – value for IDD Field Convective Zone Heater Unstable Tilted Equation User Curve Name Raises:ValueError – if value is not a valid value Returns:the value of convective_zone_heater_unstable_tilted_equation_user_curve_name or None if not set Return type:str

convective_zone_heater_vertical_wall_equation_source

field Convective Zone Heater Vertical Wall Equation Source

Applies to zone with convective heater

This is for vertical walls not directly affected by heater

Default value: FohannoPolidoriVerticalWall

Parameters:value (str) – value for IDD Field Convective Zone Heater Vertical Wall Equation Source Raises:ValueError – if value is not a valid value Returns:the value of convective_zone_heater_vertical_wall_equation_source or None if not set Return type:str

convective_zone_heater_vertical_wall_equation_user_curve_name

field Convective Zone Heater Vertical Wall Equation User Curve Name

The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve

Parameters:value (str) – value for IDD Field Convective Zone Heater Vertical Wall Equation User Curve Name Raises:ValueError – if value is not a valid value Returns:the value of convective_zone_heater_vertical_wall_equation_user_curve_name or None if not set Return type:str

convective_zone_heater_vertical_walls_near_heater_equation_source

field Convective Zone Heater Vertical Walls Near Heater Equation Source

Applies to zone with convective heater

This is for vertical walls that are directly affected by heater

Walls are considered “near” when listed in field set for Fraction of Radiant Energy to Surface

Default value: KhalifaEq5WallNearHeat

Parameters:value (str) – value for IDD Field Convective Zone Heater Vertical Walls Near Heater Equation Source Raises:ValueError – if value is not a valid value Returns:the value of convective_zone_heater_vertical_walls_near_heater_equation_source or None if not set Return type:str

convective_zone_heater_vertical_walls_near_heater_equation_user_curve_name

field Convective Zone Heater Vertical Walls Near Heater Equation User Curve Name

The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve

Parameters:value (str) – value for IDD Field Convective Zone Heater Vertical Walls Near Heater Equation User Curve Name Raises:ValueError – if value is not a valid value Returns:the value of convective_zone_heater_vertical_walls_near_heater_equation_user_curve_name or None if not set Return type:str

convective_zone_heater_windows_equation_source

field Convective Zone Heater Windows Equation Source

Applies to zone with convective heater

This is for all window surfaces

Default value: ISO15099Windows

Parameters:value (str) – value for IDD Field Convective Zone Heater Windows Equation Source Raises:ValueError – if value is not a valid value Returns:the value of convective_zone_heater_windows_equation_source or None if not set Return type:str

convective_zone_heater_windows_equation_user_curve_name

field Convective Zone Heater Windows Equation User Curve Name

The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve

Parameters:value (str) – value for IDD Field Convective Zone Heater Windows Equation User Curve Name Raises:ValueError – if value is not a valid value Returns:the value of convective_zone_heater_windows_equation_user_curve_name or None if not set Return type:str

floor_heat_ceiling_cool_chilled_ceiling_equation_source

field Floor Heat Ceiling Cool Chilled Ceiling Equation Source

Applies to zone with in-floor heating and/or in-ceiling cooling

This is for a ceiling with active cooling elements

Default value: KaradagChilledCeiling

Parameters:value (str) – value for IDD Field Floor Heat Ceiling Cool Chilled Ceiling Equation Source Raises:ValueError – if value is not a valid value Returns:the value of floor_heat_ceiling_cool_chilled_ceiling_equation_source or None if not set Return type:str

floor_heat_ceiling_cool_chilled_ceiling_equation_user_curve_name

field Floor Heat Ceiling Cool Chilled Ceiling Equation User Curve Name

The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve

Parameters:value (str) – value for IDD Field Floor Heat Ceiling Cool Chilled Ceiling Equation User Curve Name Raises:ValueError – if value is not a valid value Returns:the value of floor_heat_ceiling_cool_chilled_ceiling_equation_user_curve_name or None if not set Return type:str

floor_heat_ceiling_cool_heated_floor_equation_source

field Floor Heat Ceiling Cool Heated Floor Equation Source

Applies to zone with in-floor heating and/or in-ceiling cooling

This is for a floor with active heating elements

Default value: AwbiHattonHeatedFloor

Parameters:value (str) – value for IDD Field Floor Heat Ceiling Cool Heated Floor Equation Source Raises:ValueError – if value is not a valid value Returns:the value of floor_heat_ceiling_cool_heated_floor_equation_source or None if not set Return type:str

floor_heat_ceiling_cool_heated_floor_equation_user_curve_name

field Floor Heat Ceiling Cool Heated Floor Equation User Curve Name

The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve

Parameters:value (str) – value for IDD Field Floor Heat Ceiling Cool Heated Floor Equation User Curve Name Raises:ValueError – if value is not a valid value Returns:the value of floor_heat_ceiling_cool_heated_floor_equation_user_curve_name or None if not set Return type:str

floor_heat_ceiling_cool_stable_horizontal_equation_source

field Floor Heat Ceiling Cool Stable Horizontal Equation Source

Applies to zone with in-floor heating and/or in-ceiling cooling

This is for passive horizontal surfaces with heat flow for stable thermal stratification

Default value: AlamdariHammondStableHorizontal

Parameters:value (str) – value for IDD Field Floor Heat Ceiling Cool Stable Horizontal Equation Source Raises:ValueError – if value is not a valid value Returns:the value of floor_heat_ceiling_cool_stable_horizontal_equation_source or None if not set Return type:str

floor_heat_ceiling_cool_stable_horizontal_equation_user_curve_name

field Floor Heat Ceiling Cool Stable Horizontal Equation User Curve Name

The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve

Parameters:value (str) – value for IDD Field Floor Heat Ceiling Cool Stable Horizontal Equation User Curve Name Raises:ValueError – if value is not a valid value Returns:the value of floor_heat_ceiling_cool_stable_horizontal_equation_user_curve_name or None if not set Return type:str

floor_heat_ceiling_cool_stable_tilted_equation_source

field Floor Heat Ceiling Cool Stable Tilted Equation Source

Applies to zone with in-floor heating and/or in-ceiling cooling

This is for tilted surfaces with heat flow for stable thermal stratification

Default value: WaltonStableHorizontalOrTilt

Parameters:value (str) – value for IDD Field Floor Heat Ceiling Cool Stable Tilted Equation Source Raises:ValueError – if value is not a valid value Returns:the value of floor_heat_ceiling_cool_stable_tilted_equation_source or None if not set Return type:str

floor_heat_ceiling_cool_stable_tilted_equation_user_curve_name

field Floor Heat Ceiling Cool Stable Tilted Equation User Curve Name

The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve

Parameters:value (str) – value for IDD Field Floor Heat Ceiling Cool Stable Tilted Equation User Curve Name Raises:ValueError – if value is not a valid value Returns:the value of floor_heat_ceiling_cool_stable_tilted_equation_user_curve_name or None if not set Return type:str

floor_heat_ceiling_cool_unstable_horizontal_equation_source

field Floor Heat Ceiling Cool Unstable Horizontal Equation Source

Applies to zone with in-floor heating and/or in-ceiling cooling

This is for passive horizontal surfaces with heat flow for unstable thermal stratification

Default value: KhalifaEq4CeilingAwayFromHeat

Parameters:value (str) – value for IDD Field Floor Heat Ceiling Cool Unstable Horizontal Equation Source Raises:ValueError – if value is not a valid value Returns:the value of floor_heat_ceiling_cool_unstable_horizontal_equation_source or None if not set Return type:str

floor_heat_ceiling_cool_unstable_horizontal_equation_user_curve_name

field Floor Heat Ceiling Cool Unstable Horizontal Equation User Curve Name

The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve

Parameters:value (str) – value for IDD Field Floor Heat Ceiling Cool Unstable Horizontal Equation User Curve Name Raises:ValueError – if value is not a valid value Returns:the value of floor_heat_ceiling_cool_unstable_horizontal_equation_user_curve_name or None if not set Return type:str

floor_heat_ceiling_cool_unstable_tilted_equation_source

field Floor Heat Ceiling Cool Unstable Tilted Equation Source

Applies to zone with in-floor heating and/or in-ceiling cooling

This is for tilted surfaces with heat flow for unstable thermal stratification

Default value: WaltonUnstableHorizontalOrTilt

Parameters:value (str) – value for IDD Field Floor Heat Ceiling Cool Unstable Tilted Equation Source Raises:ValueError – if value is not a valid value Returns:the value of floor_heat_ceiling_cool_unstable_tilted_equation_source or None if not set Return type:str

floor_heat_ceiling_cool_unstable_tilted_equation_user_curve_name

field Floor Heat Ceiling Cool Unstable Tilted Equation User Curve Name

The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve

Parameters:value (str) – value for IDD Field Floor Heat Ceiling Cool Unstable Tilted Equation User Curve Name Raises:ValueError – if value is not a valid value Returns:the value of floor_heat_ceiling_cool_unstable_tilted_equation_user_curve_name or None if not set Return type:str

floor_heat_ceiling_cool_vertical_wall_equation_source

field Floor Heat Ceiling Cool Vertical Wall Equation Source

Applies to zone with in-floor heating and/or in-ceiling cooling

This is for vertical walls

Default value: KhalifaEq3WallAwayFromHeat

Parameters:value (str) – value for IDD Field Floor Heat Ceiling Cool Vertical Wall Equation Source Raises:ValueError – if value is not a valid value Returns:the value of floor_heat_ceiling_cool_vertical_wall_equation_source or None if not set Return type:str

floor_heat_ceiling_cool_vertical_wall_equation_user_curve_name

field Floor Heat Ceiling Cool Vertical Wall Equation User Curve Name

The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve

Parameters:value (str) – value for IDD Field Floor Heat Ceiling Cool Vertical Wall Equation User Curve Name Raises:ValueError – if value is not a valid value Returns:the value of floor_heat_ceiling_cool_vertical_wall_equation_user_curve_name or None if not set Return type:str

floor_heat_ceiling_cool_window_equation_source

field Floor Heat Ceiling Cool Window Equation Source

Applies to zone with in-floor heating and/or in-ceiling cooling

This is for all window surfaces

Default value: ISO15099Windows

Parameters:value (str) – value for IDD Field Floor Heat Ceiling Cool Window Equation Source Raises:ValueError – if value is not a valid value Returns:the value of floor_heat_ceiling_cool_window_equation_source or None if not set Return type:str

floor_heat_ceiling_cool_window_equation_user_curve_name

field Floor Heat Ceiling Cool Window Equation User Curve Name

The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve

Parameters:value (str) – value for IDD Field Floor Heat Ceiling Cool Window Equation User Curve Name Raises:ValueError – if value is not a valid value Returns:the value of floor_heat_ceiling_cool_window_equation_user_curve_name or None if not set Return type:str

mechanical_zone_fan_circulation_stable_horizontal_equation_source

field Mechanical Zone Fan Circulation Stable Horizontal Equation Source

reference choice fields

Default value: AlamdariHammondStableHorizontal

Parameters:value (str) – value for IDD Field Mechanical Zone Fan Circulation Stable Horizontal Equation Source Raises:ValueError – if value is not a valid value Returns:the value of mechanical_zone_fan_circulation_stable_horizontal_equation_source or None if not set Return type:str

mechanical_zone_fan_circulation_stable_horizontal_equation_user_curve_name

field Mechanical Zone Fan Circulation Stable Horizontal Equation User Curve Name

The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve

Parameters:value (str) – value for IDD Field Mechanical Zone Fan Circulation Stable Horizontal Equation User Curve Name Raises:ValueError – if value is not a valid value Returns:the value of mechanical_zone_fan_circulation_stable_horizontal_equation_user_curve_name or None if not set Return type:str

mechanical_zone_fan_circulation_stable_tilted_equation_source

field Mechanical Zone Fan Circulation Stable Tilted Equation Source

reference choice fields

Default value: WaltonStableHorizontalOrTilt

Parameters:value (str) – value for IDD Field Mechanical Zone Fan Circulation Stable Tilted Equation Source Raises:ValueError – if value is not a valid value Returns:the value of mechanical_zone_fan_circulation_stable_tilted_equation_source or None if not set Return type:str

mechanical_zone_fan_circulation_stable_tilted_equation_user_curve_name

field Mechanical Zone Fan Circulation Stable Tilted Equation User Curve Name

The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve

Parameters:value (str) – value for IDD Field Mechanical Zone Fan Circulation Stable Tilted Equation User Curve Name Raises:ValueError – if value is not a valid value Returns:the value of mechanical_zone_fan_circulation_stable_tilted_equation_user_curve_name or None if not set Return type:str

mechanical_zone_fan_circulation_unstable_horizontal_equation_source

field Mechanical Zone Fan Circulation Unstable Horizontal Equation Source

reference choice fields

Default value: KhalifaEq4CeilingAwayFromHeat

Parameters:value (str) – value for IDD Field Mechanical Zone Fan Circulation Unstable Horizontal Equation Source Raises:ValueError – if value is not a valid value Returns:the value of mechanical_zone_fan_circulation_unstable_horizontal_equation_source or None if not set Return type:str

mechanical_zone_fan_circulation_unstable_horizontal_equation_user_curve_name

field Mechanical Zone Fan Circulation Unstable Horizontal Equation User Curve Name

The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve

Parameters:value (str) – value for IDD Field Mechanical Zone Fan Circulation Unstable Horizontal Equation User Curve Name Raises:ValueError – if value is not a valid value Returns:the value of mechanical_zone_fan_circulation_unstable_horizontal_equation_user_curve_name or None if not set Return type:str

mechanical_zone_fan_circulation_unstable_tilted_equation_source

field Mechanical Zone Fan Circulation Unstable Tilted Equation Source

reference choice fields

Default value: WaltonUnstableHorizontalOrTilt

Parameters:value (str) – value for IDD Field Mechanical Zone Fan Circulation Unstable Tilted Equation Source Raises:ValueError – if value is not a valid value Returns:the value of mechanical_zone_fan_circulation_unstable_tilted_equation_source or None if not set Return type:str

mechanical_zone_fan_circulation_unstable_tilted_equation_user_curve_name

field Mechanical Zone Fan Circulation Unstable Tilted Equation User Curve Name

The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve

Parameters:value (str) – value for IDD Field Mechanical Zone Fan Circulation Unstable Tilted Equation User Curve Name Raises:ValueError – if value is not a valid value Returns:the value of mechanical_zone_fan_circulation_unstable_tilted_equation_user_curve_name or None if not set Return type:str

mechanical_zone_fan_circulation_vertical_wall_equation_source

field Mechanical Zone Fan Circulation Vertical Wall Equation Source

reference choice fields

Default value: KhalifaEq3WallAwayFromHeat

Parameters:value (str) – value for IDD Field Mechanical Zone Fan Circulation Vertical Wall Equation Source Raises:ValueError – if value is not a valid value Returns:the value of mechanical_zone_fan_circulation_vertical_wall_equation_source or None if not set Return type:str

mechanical_zone_fan_circulation_vertical_wall_equation_user_curve_name

field Mechanical Zone Fan Circulation Vertical Wall Equation User Curve Name

The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve

Parameters:value (str) – value for IDD Field Mechanical Zone Fan Circulation Vertical Wall Equation User Curve Name Raises:ValueError – if value is not a valid value Returns:the value of mechanical_zone_fan_circulation_vertical_wall_equation_user_curve_name or None if not set Return type:str

mechanical_zone_fan_circulation_window_equation_source

field Mechanical Zone Fan Circulation Window Equation Source

reference choice fields

Default value: ISO15099Windows

Parameters:value (str) – value for IDD Field Mechanical Zone Fan Circulation Window Equation Source Raises:ValueError – if value is not a valid value Returns:the value of mechanical_zone_fan_circulation_window_equation_source or None if not set Return type:str

mechanical_zone_fan_circulation_window_equation_user_curve_name

field Mechanical Zone Fan Circulation Window Equation User Curve Name

The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve

Parameters:value (str) – value for IDD Field Mechanical Zone Fan Circulation Window Equation User Curve Name Raises:ValueError – if value is not a valid value Returns:the value of mechanical_zone_fan_circulation_window_equation_user_curve_name or None if not set Return type:str

mixed_regime_buoyancy_assisting_flow_on_walls_equation_source

field Mixed Regime Buoyancy Assisting Flow on Walls Equation Source

reference choice fields

Default value: BeausoleilMorrisonMixedAssistedWall

Parameters:value (str) – value for IDD Field Mixed Regime Buoyancy Assisting Flow on Walls Equation Source Raises:ValueError – if value is not a valid value Returns:the value of mixed_regime_buoyancy_assisting_flow_on_walls_equation_source or None if not set Return type:str

mixed_regime_buoyancy_assisting_flow_on_walls_equation_user_curve_name

field Mixed Regime Buoyancy Assisting Flow on Walls Equation User Curve Name

The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve

Parameters:value (str) – value for IDD Field Mixed Regime Buoyancy Assisting Flow on Walls Equation User Curve Name Raises:ValueError – if value is not a valid value Returns:the value of mixed_regime_buoyancy_assisting_flow_on_walls_equation_user_curve_name or None if not set Return type:str

mixed_regime_buoyancy_opposing_flow_on_walls_equation_source

field Mixed Regime Buoyancy Opposing Flow on Walls Equation Source

reference choice fields

Default value: BeausoleilMorrisonMixedOpposingWall

Parameters:value (str) – value for IDD Field Mixed Regime Buoyancy Opposing Flow on Walls Equation Source Raises:ValueError – if value is not a valid value Returns:the value of mixed_regime_buoyancy_opposing_flow_on_walls_equation_source or None if not set Return type:str

mixed_regime_buoyancy_opposing_flow_on_walls_equation_user_curve_name

field Mixed Regime Buoyancy Opposing Flow on Walls Equation User Curve Name

The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve

Parameters:value (str) – value for IDD Field Mixed Regime Buoyancy Opposing Flow on Walls Equation User Curve Name Raises:ValueError – if value is not a valid value Returns:the value of mixed_regime_buoyancy_opposing_flow_on_walls_equation_user_curve_name or None if not set Return type:str

mixed_regime_stable_ceiling_equation_source

field Mixed Regime Stable Ceiling Equation Source

reference choice fields

Default value: BeausoleilMorrisonMixedStableCeiling

Parameters:value (str) – value for IDD Field Mixed Regime Stable Ceiling Equation Source Raises:ValueError – if value is not a valid value Returns:the value of mixed_regime_stable_ceiling_equation_source or None if not set Return type:str

mixed_regime_stable_ceiling_equation_user_curve_name

field Mixed Regime Stable Ceiling Equation User Curve Name

The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve

Parameters:value (str) – value for IDD Field Mixed Regime Stable Ceiling Equation User Curve Name Raises:ValueError – if value is not a valid value Returns:the value of mixed_regime_stable_ceiling_equation_user_curve_name or None if not set Return type:str

mixed_regime_stable_floor_equation_source

field Mixed Regime Stable Floor Equation Source

reference choice fields

Default value: BeausoleilMorrisonMixedStableFloor

Parameters:value (str) – value for IDD Field Mixed Regime Stable Floor Equation Source Raises:ValueError – if value is not a valid value Returns:the value of mixed_regime_stable_floor_equation_source or None if not set Return type:str

mixed_regime_stable_floor_equation_user_curve_name

field Mixed Regime Stable Floor Equation User Curve Name

The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve

Parameters:value (str) – value for IDD Field Mixed Regime Stable Floor Equation User Curve Name Raises:ValueError – if value is not a valid value Returns:the value of mixed_regime_stable_floor_equation_user_curve_name or None if not set Return type:str

mixed_regime_unstable_ceiling_equation_source

field Mixed Regime Unstable Ceiling Equation Source

reference choice fields

Default value: BeausoleilMorrisonMixedUnstableCeiling

Parameters:value (str) – value for IDD Field Mixed Regime Unstable Ceiling Equation Source Raises:ValueError – if value is not a valid value Returns:the value of mixed_regime_unstable_ceiling_equation_source or None if not set Return type:str

mixed_regime_unstable_ceiling_equation_user_curve_name

field Mixed Regime Unstable Ceiling Equation User Curve Name

The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve

Parameters:value (str) – value for IDD Field Mixed Regime Unstable Ceiling Equation User Curve Name Raises:ValueError – if value is not a valid value Returns:the value of mixed_regime_unstable_ceiling_equation_user_curve_name or None if not set Return type:str

mixed_regime_unstable_floor_equation_source

field Mixed Regime Unstable Floor Equation Source

reference choice fields

Default value: BeausoleilMorrisonMixedUnstableFloor

Parameters:value (str) – value for IDD Field Mixed Regime Unstable Floor Equation Source Raises:ValueError – if value is not a valid value Returns:the value of mixed_regime_unstable_floor_equation_source or None if not set Return type:str

mixed_regime_unstable_floor_equation_user_curve_name

field Mixed Regime Unstable Floor Equation User Curve Name

The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve

Parameters:value (str) – value for IDD Field Mixed Regime Unstable Floor Equation User Curve Name Raises:ValueError – if value is not a valid value Returns:the value of mixed_regime_unstable_floor_equation_user_curve_name or None if not set Return type:str

mixed_regime_window_equation_source

field Mixed Regime Window Equation Source

reference choice fields

Default value: GoldsteinNovoselacCeilingDiffuserWindow

Parameters:value (str) – value for IDD Field Mixed Regime Window Equation Source Raises:ValueError – if value is not a valid value Returns:the value of mixed_regime_window_equation_source or None if not set Return type:str

mixed_regime_window_equation_user_curve_name

field Mixed Regime Window Equation User Curve Name

The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve

Parameters:value (str) – value for IDD Field Mixed Regime Window Equation User Curve Name Raises:ValueError – if value is not a valid value Returns:the value of mixed_regime_window_equation_user_curve_name or None if not set Return type:str

name

field Name

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

simple_buoyancy_stable_horizontal_equation_source

field Simple Buoyancy Stable Horizontal Equation Source

Applies to zone with no HVAC or when HVAC is off

This is for horizontal surfaces with heat flow directed for stable thermal stratification

Default value: AlamdariHammondStableHorizontal

Parameters:value (str) – value for IDD Field Simple Buoyancy Stable Horizontal Equation Source Raises:ValueError – if value is not a valid value Returns:the value of simple_buoyancy_stable_horizontal_equation_source or None if not set Return type:str

simple_buoyancy_stable_horizontal_equation_user_curve_name

field Simple Buoyancy Stable Horizontal Equation User Curve Name

The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve

Parameters:value (str) – value for IDD Field Simple Buoyancy Stable Horizontal Equation User Curve Name Raises:ValueError – if value is not a valid value Returns:the value of simple_buoyancy_stable_horizontal_equation_user_curve_name or None if not set Return type:str

simple_buoyancy_stable_tilted_equation_source

field Simple Buoyancy Stable Tilted Equation Source

Applies to zone with no HVAC or when HVAC is off

This is for tilted surfaces with heat flow for stable thermal stratification

Default value: WaltonStableHorizontalOrTilt

Parameters:value (str) – value for IDD Field Simple Buoyancy Stable Tilted Equation Source Raises:ValueError – if value is not a valid value Returns:the value of simple_buoyancy_stable_tilted_equation_source or None if not set Return type:str

simple_buoyancy_stable_tilted_equation_user_curve_name

field Simple Buoyancy Stable Tilted Equation User Curve Name

The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve

Parameters:value (str) – value for IDD Field Simple Buoyancy Stable Tilted Equation User Curve Name Raises:ValueError – if value is not a valid value Returns:the value of simple_buoyancy_stable_tilted_equation_user_curve_name or None if not set Return type:str

simple_buoyancy_unstable_horizontal_equation_source

field Simple Buoyancy Unstable Horizontal Equation Source

Applies to zone with no HVAC or when HVAC is off

This is for passive horizontal surfaces with heat flow for unstable thermal stratification

Default value: AlamdariHammondUnstableHorizontal

Parameters:value (str) – value for IDD Field Simple Buoyancy Unstable Horizontal Equation Source Raises:ValueError – if value is not a valid value Returns:the value of simple_buoyancy_unstable_horizontal_equation_source or None if not set Return type:str

simple_buoyancy_unstable_horizontal_equation_user_curve_name

field Simple Buoyancy Unstable Horizontal Equation User Curve Name

The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve

Parameters:value (str) – value for IDD Field Simple Buoyancy Unstable Horizontal Equation User Curve Name Raises:ValueError – if value is not a valid value Returns:the value of simple_buoyancy_unstable_horizontal_equation_user_curve_name or None if not set Return type:str

simple_buoyancy_unstable_tilted_equation_source

field Simple Buoyancy Unstable Tilted Equation Source

Applies to zone with no HVAC or when HVAC is off

This is for tilted surfaces with heat flow for unstable thermal stratification

Default value: WaltonUnstableHorizontalOrTilt

Parameters:value (str) – value for IDD Field Simple Buoyancy Unstable Tilted Equation Source Raises:ValueError – if value is not a valid value Returns:the value of simple_buoyancy_unstable_tilted_equation_source or None if not set Return type:str

simple_buoyancy_unstable_tilted_equation_user_curve_name

field Simple Buoyancy Unstable Tilted Equation User Curve Name

The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve

Parameters:value (str) – value for IDD Field Simple Buoyancy Unstable Tilted Equation User Curve Name Raises:ValueError – if value is not a valid value Returns:the value of simple_buoyancy_unstable_tilted_equation_user_curve_name or None if not set Return type:str

simple_buoyancy_vertical_wall_equation_source

field Simple Buoyancy Vertical Wall Equation Source

Applies to zone with no HVAC or when HVAC is off

This is for vertical walls

Default value: FohannoPolidoriVerticalWall

Parameters:value (str) – value for IDD Field Simple Buoyancy Vertical Wall Equation Source Raises:ValueError – if value is not a valid value Returns:the value of simple_buoyancy_vertical_wall_equation_source or None if not set Return type:str

simple_buoyancy_vertical_wall_user_curve_name

field Simple Buoyancy Vertical Wall User Curve Name

The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve

Parameters:value (str) – value for IDD Field Simple Buoyancy Vertical Wall User Curve Name Raises:ValueError – if value is not a valid value Returns:the value of simple_buoyancy_vertical_wall_user_curve_name or None if not set Return type:str

simple_buoyancy_windows_equation_source

field Simple Buoyancy Windows Equation Source

Applies to zone with no HVAC or when HVAC is off

This is for all window surfaces

Default value: ISO15099Windows

Parameters:value (str) – value for IDD Field Simple Buoyancy Windows Equation Source Raises:ValueError – if value is not a valid value Returns:the value of simple_buoyancy_windows_equation_source or None if not set Return type:str

simple_buoyancy_windows_equation_user_curve_name

field Simple Buoyancy Windows Equation User Curve Name

The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve

Parameters:value (str) – value for IDD Field Simple Buoyancy Windows Equation User Curve Name Raises:ValueError – if value is not a valid value Returns:the value of simple_buoyancy_windows_equation_user_curve_name or None if not set Return type:str

wall_panel_heating_heated_wall_equation_source

field Wall Panel Heating Heated Wall Equation Source

Applies to zone with in-wall panel heating

This is for vertical walls that are being actively heated

Default value: AwbiHattonHeatedWall

Parameters:value (str) – value for IDD Field Wall Panel Heating Heated Wall Equation Source Raises:ValueError – if value is not a valid value Returns:the value of wall_panel_heating_heated_wall_equation_source or None if not set Return type:str

wall_panel_heating_heated_wall_equation_user_curve_name

field Wall Panel Heating Heated Wall Equation User Curve Name

The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve

Parameters:value (str) – value for IDD Field Wall Panel Heating Heated Wall Equation User Curve Name Raises:ValueError – if value is not a valid value Returns:the value of wall_panel_heating_heated_wall_equation_user_curve_name or None if not set Return type:str

wall_panel_heating_stable_horizontal_equation_source

field Wall Panel Heating Stable Horizontal Equation Source

Applies to zone with in-wall panel heating

This is for horizontal surfaces with heat flow directed for stable thermal stratification

Default value: AlamdariHammondStableHorizontal

Parameters:value (str) – value for IDD Field Wall Panel Heating Stable Horizontal Equation Source Raises:ValueError – if value is not a valid value Returns:the value of wall_panel_heating_stable_horizontal_equation_source or None if not set Return type:str

wall_panel_heating_stable_horizontal_equation_user_curve_name

field Wall Panel Heating Stable Horizontal Equation User Curve Name

The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve

Parameters:value (str) – value for IDD Field Wall Panel Heating Stable Horizontal Equation User Curve Name Raises:ValueError – if value is not a valid value Returns:the value of wall_panel_heating_stable_horizontal_equation_user_curve_name or None if not set Return type:str

wall_panel_heating_stable_tilted_equation_source

field Wall Panel Heating Stable Tilted Equation Source

Applies to zone with in-wall panel heating

This is for tilted surfaces with heat flow for stable thermal stratification

Default value: WaltonStableHorizontalOrTilt

Parameters:value (str) – value for IDD Field Wall Panel Heating Stable Tilted Equation Source Raises:ValueError – if value is not a valid value Returns:the value of wall_panel_heating_stable_tilted_equation_source or None if not set Return type:str

wall_panel_heating_stable_tilted_equation_user_curve_name

field Wall Panel Heating Stable Tilted Equation User Curve Name

The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve

Parameters:value (str) – value for IDD Field Wall Panel Heating Stable Tilted Equation User Curve Name Raises:ValueError – if value is not a valid value Returns:the value of wall_panel_heating_stable_tilted_equation_user_curve_name or None if not set Return type:str

wall_panel_heating_unstable_horizontal_equation_source

field Wall Panel Heating Unstable Horizontal Equation Source

Applies to zone with in-wall panel heating

This is for horizontal surfaces with heat flow directed for unstable thermal stratification

Default value: KhalifaEq7Ceiling

Parameters:value (str) – value for IDD Field Wall Panel Heating Unstable Horizontal Equation Source Raises:ValueError – if value is not a valid value Returns:the value of wall_panel_heating_unstable_horizontal_equation_source or None if not set Return type:str

wall_panel_heating_unstable_horizontal_equation_user_curve_name

field Wall Panel Heating Unstable Horizontal Equation User Curve Name

The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve

Parameters:value (str) – value for IDD Field Wall Panel Heating Unstable Horizontal Equation User Curve Name Raises:ValueError – if value is not a valid value Returns:the value of wall_panel_heating_unstable_horizontal_equation_user_curve_name or None if not set Return type:str

wall_panel_heating_unstable_tilted_equation_source

field Wall Panel Heating Unstable Tilted Equation Source

Applies to zone with in-wall panel heating

This is for tilted surfaces with heat flow for unstable thermal stratification

Default value: WaltonUnstableHorizontalOrTilt

Parameters:value (str) – value for IDD Field Wall Panel Heating Unstable Tilted Equation Source Raises:ValueError – if value is not a valid value Returns:the value of wall_panel_heating_unstable_tilted_equation_source or None if not set Return type:str

wall_panel_heating_unstable_tilted_equation_user_curve_name

field Wall Panel Heating Unstable Tilted Equation User Curve Name

The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve

Parameters:value (str) – value for IDD Field Wall Panel Heating Unstable Tilted Equation User Curve Name Raises:ValueError – if value is not a valid value Returns:the value of wall_panel_heating_unstable_tilted_equation_user_curve_name or None if not set Return type:str

wall_panel_heating_vertical_wall_equation_source

field Wall Panel Heating Vertical Wall Equation Source

Applies to zone with in-wall panel heating

This is for vertical walls that are not actively heated

Default value: KhalifaEq6NonHeatedWalls

Parameters:value (str) – value for IDD Field Wall Panel Heating Vertical Wall Equation Source Raises:ValueError – if value is not a valid value Returns:the value of wall_panel_heating_vertical_wall_equation_source or None if not set Return type:str

wall_panel_heating_vertical_wall_equation_user_curve_name

field Wall Panel Heating Vertical Wall Equation User Curve Name

The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve

Parameters:value (str) – value for IDD Field Wall Panel Heating Vertical Wall Equation User Curve Name Raises:ValueError – if value is not a valid value Returns:the value of wall_panel_heating_vertical_wall_equation_user_curve_name or None if not set Return type:str

wall_panel_heating_window_equation_source

field Wall Panel Heating Window Equation Source

Applies to zone with in-wall panel heating

This is for all window surfaces

Default value: ISO15099Windows

Parameters:value (str) – value for IDD Field Wall Panel Heating Window Equation Source Raises:ValueError – if value is not a valid value Returns:the value of wall_panel_heating_window_equation_source or None if not set Return type:str

wall_panel_heating_window_equation_user_curve_name

field Wall Panel Heating Window Equation User Curve Name

The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve

Parameters:value (str) – value for IDD Field Wall Panel Heating Window Equation User Curve Name Raises:ValueError – if value is not a valid value Returns:the value of wall_panel_heating_window_equation_user_curve_name or None if not set Return type:str

class pyidf.advanced_construction.SurfaceConvectionAlgorithmInsideUserCurve

Bases: pyidf.helper.DataObject

Corresponds to IDD object SurfaceConvectionAlgorithm:Inside:UserCurve Used to describe a custom model equation for surface convection heat transfer coefficient If more than one curve is referenced they are all used and added together.

hc_function_of_air_change_rate_curve_name

field Hc Function of Air Change Rate Curve Name

Curve’s “x” is mechanical ACH (Air Changes per hour from mechanical air system), (1/hr)

Parameters:value (str) – value for IDD Field Hc Function of Air Change Rate Curve Name Raises:ValueError – if value is not a valid value Returns:the value of hc_function_of_air_change_rate_curve_name or None if not set Return type:str

hc_function_of_air_system_volume_flow_rate_divided_by_zone_perimeter_length_curve_name

field Hc Function of Air System Volume Flow Rate Divided by Zone Perimeter Length Curve Name

Curve’s “x” is mechanical system air flow rate (m3/s) divided by zone’s length along

exterior walls (m).

Parameters:value (str) – value for IDD Field Hc Function of Air System Volume Flow Rate Divided by Zone Perimeter Length Curve Name Raises:ValueError – if value is not a valid value Returns:the value of hc_function_of_air_system_volume_flow_rate_divided_by_zone_perimeter_length_curve_name or None if not set Return type:str

hc_function_of_temperature_difference_curve_name

field Hc Function of Temperature Difference Curve Name

Curve’s “x” is absolute value of delta-T (Surface temperature minus reference temperature, (C))

Parameters:value (str) – value for IDD Field Hc Function of Temperature Difference Curve Name Raises:ValueError – if value is not a valid value Returns:the value of hc_function_of_temperature_difference_curve_name or None if not set Return type:str

hc_function_of_temperature_difference_divided_by_height_curve_name

field Hc Function of Temperature Difference Divided by Height Curve Name

Curve’s “x” is absolute value of delta-T/Height (Surface temp minus Air temp)/(vertical length scale), (C/m)

when used for an inside face the vertical length scale is the zone’s interior height

Parameters:value (str) – value for IDD Field Hc Function of Temperature Difference Divided by Height Curve Name Raises:ValueError – if value is not a valid value Returns:the value of hc_function_of_temperature_difference_divided_by_height_curve_name or None if not set Return type:str

name

field Name

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

reference_temperature_for_convection_heat_transfer

field Reference Temperature for Convection Heat Transfer

Controls which temperature is differenced from surface temperature when using the Hc value

Parameters:value (str) – value for IDD Field Reference Temperature for Convection Heat Transfer Raises:ValueError – if value is not a valid value Returns:the value of reference_temperature_for_convection_heat_transfer or None if not set Return type:str

class pyidf.advanced_construction.SurfaceConvectionAlgorithmOutsideAdaptiveModelSelections

Bases: pyidf.helper.DataObject

Corresponds to IDD object SurfaceConvectionAlgorithm:Outside:AdaptiveModelSelections Options to change the individual convection model equations for dynamic selection when using AdaptiveConvectiongAlgorithm This object is only needed to make changes to the default model selections for any or all of the surface categories. This object is for the outside face, the side of the surface facing away from the thermal zone.

name

field Name

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

natural_convection_stable_horizontal_equation_source

field Natural Convection Stable Horizontal Equation Source

This is for horizontal surfaces with heat flow directed for stable thermal stratification

Default value: WaltonStableHorizontalOrTilt

Parameters:value (str) – value for IDD Field Natural Convection Stable Horizontal Equation Source Raises:ValueError – if value is not a valid value Returns:the value of natural_convection_stable_horizontal_equation_source or None if not set Return type:str

natural_convection_stable_horizontal_equation_user_curve_name

field Natural Convection Stable Horizontal Equation User Curve Name

The SurfaceConvectionAlgorithm:Outside:UserCurve named in this field is used when the previous field is set to UserCurve

Parameters:value (str) – value for IDD Field Natural Convection Stable Horizontal Equation User Curve Name Raises:ValueError – if value is not a valid value Returns:the value of natural_convection_stable_horizontal_equation_user_curve_name or None if not set Return type:str

natural_convection_unstable_horizontal_equation_source

field Natural Convection Unstable Horizontal Equation Source

Default value: WaltonUnstableHorizontalOrTilt

Parameters:value (str) – value for IDD Field Natural Convection Unstable Horizontal Equation Source Raises:ValueError – if value is not a valid value Returns:the value of natural_convection_unstable_horizontal_equation_source or None if not set Return type:str

natural_convection_unstable_horizontal_equation_user_curve_name

field Natural Convection Unstable Horizontal Equation User Curve Name

The SurfaceConvectionAlgorithm:Outside:UserCurve named in this field is used when the previous field is set to UserCurve

Parameters:value (str) – value for IDD Field Natural Convection Unstable Horizontal Equation User Curve Name Raises:ValueError – if value is not a valid value Returns:the value of natural_convection_unstable_horizontal_equation_user_curve_name or None if not set Return type:str

natural_convection_vertical_wall_equation_source

field Natural Convection Vertical Wall Equation Source

This is for vertical walls

Default value: ASHRAEVerticalWall

Parameters:value (str) – value for IDD Field Natural Convection Vertical Wall Equation Source Raises:ValueError – if value is not a valid value Returns:the value of natural_convection_vertical_wall_equation_source or None if not set Return type:str

natural_convection_vertical_wall_equation_user_curve_name

field Natural Convection Vertical Wall Equation User Curve Name

The SurfaceConvectionAlgorithm:Outside:UserCurve named in this field is used when the previous field is set to UserCurve

Parameters:value (str) – value for IDD Field Natural Convection Vertical Wall Equation User Curve Name Raises:ValueError – if value is not a valid value Returns:the value of natural_convection_vertical_wall_equation_user_curve_name or None if not set Return type:str

wind_convection_horizontal_roof_equation_source

field Wind Convection Horizontal Roof Equation Source

Default value: ClearRoof

Parameters:value (str) – value for IDD Field Wind Convection Horizontal Roof Equation Source Raises:ValueError – if value is not a valid value Returns:the value of wind_convection_horizontal_roof_equation_source or None if not set Return type:str

wind_convection_horizontal_roof_user_curve_name

field Wind Convection Horizontal Roof User Curve Name

The SurfaceConvectionAlgorithm:Outside:UserCurve named in this field is used when the previous field is set to UserCurve

Parameters:value (str) – value for IDD Field Wind Convection Horizontal Roof User Curve Name Raises:ValueError – if value is not a valid value Returns:the value of wind_convection_horizontal_roof_user_curve_name or None if not set Return type:str

wind_convection_leeward_vertical_wall_equation_source

field Wind Convection Leeward Vertical Wall Equation Source

Default value: TARPLeeward

Parameters:value (str) – value for IDD Field Wind Convection Leeward Vertical Wall Equation Source Raises:ValueError – if value is not a valid value Returns:the value of wind_convection_leeward_vertical_wall_equation_source or None if not set Return type:str

wind_convection_leeward_vertical_wall_equation_user_curve_name

field Wind Convection Leeward Vertical Wall Equation User Curve Name

The SurfaceConvectionAlgorithm:Outside:UserCurve named in this field is used when the previous field is set to UserCurve

Parameters:value (str) – value for IDD Field Wind Convection Leeward Vertical Wall Equation User Curve Name Raises:ValueError – if value is not a valid value Returns:the value of wind_convection_leeward_vertical_wall_equation_user_curve_name or None if not set Return type:str

wind_convection_windward_equation_vertical_wall_user_curve_name

field Wind Convection Windward Equation Vertical Wall User Curve Name

The SurfaceConvectionAlgorithm:Outside:UserCurve named in this field is used when the previous field is set to UserCurve

Parameters:value (str) – value for IDD Field Wind Convection Windward Equation Vertical Wall User Curve Name Raises:ValueError – if value is not a valid value Returns:the value of wind_convection_windward_equation_vertical_wall_user_curve_name or None if not set Return type:str

wind_convection_windward_vertical_wall_equation_source

field Wind Convection Windward Vertical Wall Equation Source

Default value: TARPWindward

Parameters:value (str) – value for IDD Field Wind Convection Windward Vertical Wall Equation Source Raises:ValueError – if value is not a valid value Returns:the value of wind_convection_windward_vertical_wall_equation_source or None if not set Return type:str

class pyidf.advanced_construction.SurfaceConvectionAlgorithmOutsideUserCurve

Bases: pyidf.helper.DataObject

Corresponds to IDD object SurfaceConvectionAlgorithm:Outside:UserCurve Used to describe a custom model equation for surface convection heat transfer coefficient If more than one curve is referenced they are all used and added together.

hf_function_of_wind_speed_curve_name

field Hf Function of Wind Speed Curve Name

Curve’s “x” is wind speed of the type determined in the previous field (m/s)

Parameters:value (str) – value for IDD Field Hf Function of Wind Speed Curve Name Raises:ValueError – if value is not a valid value Returns:the value of hf_function_of_wind_speed_curve_name or None if not set Return type:str

hn_function_of_temperature_difference_curve_name

field Hn Function of Temperature Difference Curve Name

Curve’s “x” is absolute value of delta-T (Surface temperature minus air temperature, (C))

Parameters:value (str) – value for IDD Field Hn Function of Temperature Difference Curve Name Raises:ValueError – if value is not a valid value Returns:the value of hn_function_of_temperature_difference_curve_name or None if not set Return type:str

hn_function_of_temperature_difference_divided_by_height_curve_name

field Hn Function of Temperature Difference Divided by Height Curve Name

Curve’s “x” is absolute value of delta-T/Height (Surface temp minus Air temp)/(vertical length scale), (C/m)

when used for an outside face the vertical length scale is the exterior facade’s overall height

Parameters:value (str) – value for IDD Field Hn Function of Temperature Difference Divided by Height Curve Name Raises:ValueError – if value is not a valid value Returns:the value of hn_function_of_temperature_difference_divided_by_height_curve_name or None if not set Return type:str

name

field Name

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

wind_speed_type_for_curve

field Wind Speed Type for Curve

Default value: HeightAdjust

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

class pyidf.advanced_construction.SurfacePropertiesVaporCoefficients

Bases: pyidf.helper.DataObject

Corresponds to IDD object SurfaceProperties:VaporCoefficients The interior and external vapor transfer coefficients. Normally these value are calculated using the heat convection coefficient values. Use this object to used fixed constant values. Units are kg/Pa.s.m2 This will only work with the CombinedHeatAndMoistureFiniteElement algorithm for surfaces. Other algorithms will ignore these coefficients

constant_external_vapor_transfer_coefficient

field Constant External Vapor Transfer Coefficient

Default value: No

Parameters:value (str) – value for IDD Field Constant External Vapor Transfer Coefficient Raises:ValueError – if value is not a valid value Returns:the value of constant_external_vapor_transfer_coefficient or None if not set Return type:str

constant_internal_vapor_transfer_coefficient

field Constant Internal vapor Transfer Coefficient

Default value: No

Parameters:value (str) – value for IDD Field Constant Internal vapor Transfer Coefficient Raises:ValueError – if value is not a valid value Returns:the value of constant_internal_vapor_transfer_coefficient or None if not set Return type:str

external_vapor_coefficient_value

field External Vapor Coefficient Value

Units: kg/Pa-s-m2

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

internal_vapor_coefficient_value

field Internal Vapor Coefficient Value

Units: kg/Pa-s-m2

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

surface_name

field Surface Name

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

class pyidf.advanced_construction.SurfacePropertyConvectionCoefficients

Bases: pyidf.helper.DataObject

Corresponds to IDD object SurfaceProperty:ConvectionCoefficients Allow user settable interior and/or exterior convection coefficients. Note that some other factors may limit the lower bounds for these values, such as for windows, the interior convection coefficient must be >.28, for trombe wall algorithm selection (zone), the interior convection coefficient must be >.1 for TARP interior convection, the lower limit is also .1 Minimum and maximum limits are set in HeatBalanceAlgorithm object. Defaults in HeatBalanceAlgorithm object are [.1,1000].

convection_coefficient_1

field Convection Coefficient 1

used if Convection Type=Value, min and max limits are set in HeatBalanceAlgorithm object.

Default limits are Minimum >= 0.1 and Maximum <= 1000

Units: W/m2-K

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

convection_coefficient_1_location

field Convection Coefficient 1 Location

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

convection_coefficient_1_schedule_name

field Convection Coefficient 1 Schedule Name

used if Convection Type=Schedule, min and max limits are set in HeatBalanceAlgorithm object.

Default limits are Minimum >= 0.1 and Maximum <= 1000

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

convection_coefficient_1_type

field Convection Coefficient 1 Type

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

convection_coefficient_1_user_curve_name

field Convection Coefficient 1 User Curve Name

used if Convection Type = UserCurve

Parameters:value (str) – value for IDD Field Convection Coefficient 1 User Curve Name Raises:ValueError – if value is not a valid value Returns:the value of convection_coefficient_1_user_curve_name or None if not set Return type:str

convection_coefficient_2

field Convection Coefficient 2

used if Convection Type=Value, min and max limits are set in HeatBalanceAlgorithm object.

Default limits are Minimum >= 0.1 and Maximum <= 1000

Units: W/m2-K

Default value: 0.1

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

convection_coefficient_2_location

field Convection Coefficient 2 Location

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

convection_coefficient_2_schedule_name

field Convection Coefficient 2 Schedule Name

used if Convection Type=Schedule, min and max limits are set in HeatBalanceAlgorithm object.

Default limits are Minimum >= 0.1 and Maximum <= 1000

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

convection_coefficient_2_type

field Convection Coefficient 2 Type

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

convection_coefficient_2_user_curve_name

field Convection Coefficient 2 User Curve Name

used if Convection Type = UserCurve

Parameters:value (str) – value for IDD Field Convection Coefficient 2 User Curve Name Raises:ValueError – if value is not a valid value Returns:the value of convection_coefficient_2_user_curve_name or None if not set Return type:str

surface_name

field Surface Name

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

class pyidf.advanced_construction.SurfacePropertyConvectionCoefficientsMultipleSurface

Bases: pyidf.helper.DataObject

Corresponds to IDD object SurfaceProperty:ConvectionCoefficients:MultipleSurface Allow user settable interior and/or exterior convection coefficients. Note that some other factors may limit the lower bounds for these values, such as for windows, the interior convection coefficient must be >.28, for trombe wall algorithm selection (zone), the interior convection coefficient must be >.1 for TARP interior convection, the lower limit is also .1 Minimum and maximum limits are set in HeatBalanceAlgorithm object. Defaults in HeatBalanceAlgorithm object are [.1,1000].

convection_coefficient_1

field Convection Coefficient 1

used if Convection Type=Value, min and max limits are set in HeatBalanceAlgorithm object.

Default limits are Minimum >= 0.1 and Maximum <= 1000

Units: W/m2-K

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

convection_coefficient_1_location

field Convection Coefficient 1 Location

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

convection_coefficient_1_schedule_name

field Convection Coefficient 1 Schedule Name

used if Convection Type=Schedule, min and max limits are set in HeatBalanceAlgorithm object.

Default limits are Minimum >= 0.1 and Maximum <= 1000

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

convection_coefficient_1_type

field Convection Coefficient 1 Type

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

convection_coefficient_1_user_curve_name

field Convection Coefficient 1 User Curve Name

used if Convection Type = UserCurve

Parameters:value (str) – value for IDD Field Convection Coefficient 1 User Curve Name Raises:ValueError – if value is not a valid value Returns:the value of convection_coefficient_1_user_curve_name or None if not set Return type:str

convection_coefficient_2

field Convection Coefficient 2

used if Convection Type=Value, min and max limits are set in HeatBalanceAlgorithm object.

Default limits are Minimum >= 0.1 and Maximum <= 1000

Units: W/m2-K

Default value: 0.1

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

convection_coefficient_2_location

field Convection Coefficient 2 Location

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

convection_coefficient_2_schedule_name

field Convection Coefficient 2 Schedule Name

used if Convection Type=Schedule, min and max limits are set in HeatBalanceAlgorithm object.

Default limits are Minimum >= 0.1 and Maximum <= 1000

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

convection_coefficient_2_type

field Convection Coefficient 2 Type

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

convection_coefficient_2_user_curve_name

field Convection Coefficient 2 User Curve Name

used if Convection Type = UserCurve

Parameters:value (str) – value for IDD Field Convection Coefficient 2 User Curve Name Raises:ValueError – if value is not a valid value Returns:the value of convection_coefficient_2_user_curve_name or None if not set Return type:str

surface_type

field Surface Type

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

class pyidf.advanced_construction.SurfacePropertyExteriorNaturalVentedCavity

Bases: pyidf.helper.DataObject

Corresponds to IDD object SurfaceProperty:ExteriorNaturalVentedCavity Used to describe the decoupled layer, or baffle, and the characteristics of the cavity and openings for naturally ventilated exterior surfaces. This object is also used in conjunction with the OtherSideConditionsModel.

add_extensible(surface_1_name=None)

Add values for extensible fields

Parameters:surface_1_name (str) – value for IDD Field Surface 1 Name if value is None it will not be checked against the specification and is assumed to be a missing value

area_fraction_of_openings

field Area Fraction of Openings

Units: dimensionless

value <= 1.0

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

boundary_conditions_model_name

field Boundary Conditions Model Name

Enter the name of a SurfaceProperty:OtherSideConditionsModel object

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

discharge_coefficient_for_openings_with_respect_to_buoyancy_driven_flow

field Discharge Coefficient for Openings with Respect to Buoyancy Driven Flow

Units: dimensionless

Default value: 0.65

value <= 1.5

Parameters:value (float) – value for IDD Field Discharge Coefficient for Openings with Respect to Buoyancy Driven Flow Raises:ValueError – if value is not a valid value Returns:the value of discharge_coefficient_for_openings_with_respect_to_buoyancy_driven_flow or None if not set Return type:float

effective_thickness_of_cavity_behind_exterior_baffle

field Effective Thickness of Cavity Behind Exterior Baffle

if corrugated, use average depth

Units: m

Parameters:value (float) – value for IDD Field Effective Thickness of Cavity Behind Exterior Baffle Raises:ValueError – if value is not a valid value Returns:the value of effective_thickness_of_cavity_behind_exterior_baffle or None if not set Return type:float

effectiveness_for_perforations_with_respect_to_wind

field Effectiveness for Perforations with Respect to Wind

Units: dimensionless

Default value: 0.25

value <= 1.5

Parameters:value (float) – value for IDD Field Effectiveness for Perforations with Respect to Wind Raises:ValueError – if value is not a valid value Returns:the value of effectiveness_for_perforations_with_respect_to_wind or None if not set Return type:float

extensibles

Get list of all extensibles

height_scale_for_buoyancydriven_ventilation

field Height Scale for Buoyancy-Driven Ventilation

Units: m

Parameters:value (float) – value for IDD Field Height Scale for Buoyancy-Driven Ventilation Raises:ValueError – if value is not a valid value Returns:the value of height_scale_for_buoyancydriven_ventilation or None if not set Return type:float

name

field Name

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

ratio_of_actual_surface_area_to_projected_surface_area

field Ratio of Actual Surface Area to Projected Surface Area

this parameter is used to help account for corrugations in the collector

Units: dimensionless

Default value: 1.0

value >= 0.8

value <= 2.0

Parameters:value (float) – value for IDD Field Ratio of Actual Surface Area to Projected Surface Area Raises:ValueError – if value is not a valid value Returns:the value of ratio_of_actual_surface_area_to_projected_surface_area or None if not set Return type:float

roughness_of_exterior_surface

field Roughness of Exterior Surface

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

solar_absorbtivity_of_exterior_baffle

field Solar Absorbtivity of Exterior Baffle

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Solar Absorbtivity of Exterior Baffle Raises:ValueError – if value is not a valid value Returns:the value of solar_absorbtivity_of_exterior_baffle or None if not set Return type:float

thermal_emissivity_of_exterior_baffle_material

field Thermal Emissivity of Exterior Baffle Material

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Thermal Emissivity of Exterior Baffle Material Raises:ValueError – if value is not a valid value Returns:the value of thermal_emissivity_of_exterior_baffle_material or None if not set Return type:float

class pyidf.advanced_construction.SurfacePropertyHeatTransferAlgorithm

Bases: pyidf.helper.DataObject

Corresponds to IDD object SurfaceProperty:HeatTransferAlgorithm Determines which Heat Balance Algorithm will be used for a specific surface Allows selectively overriding the global setting in HeatBalanceAlgorithm CTF (Conduction Transfer Functions), EMPD (Effective Moisture Penetration Depth with Conduction Transfer Functions). Advanced/Research Usage: CondFD (Conduction Finite Difference) Advanced/Research Usage: HAMT (Combined Heat And Moisture Finite Element)

algorithm

field Algorithm

Default value: ConductionTransferFunction

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

surface_name

field Surface Name

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

class pyidf.advanced_construction.SurfacePropertyHeatTransferAlgorithmConstruction

Bases: pyidf.helper.DataObject

Corresponds to IDD object SurfaceProperty:HeatTransferAlgorithm:Construction Determines which Heat Balance Algorithm will be used for surfaces that have a specific type of construction Allows selectively overriding the global setting in HeatBalanceAlgorithm CTF (Conduction Transfer Functions), EMPD (Effective Moisture Penetration Depth with Conduction Transfer Functions). Advanced/Research Usage: CondFD (Conduction Finite Difference) Advanced/Research Usage: HAMT (Combined Heat And Moisture Finite Element)

algorithm

field Algorithm

Default value: ConductionTransferFunction

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

construction_name

field Construction Name

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

name

field Name

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

class pyidf.advanced_construction.SurfacePropertyHeatTransferAlgorithmMultipleSurface

Bases: pyidf.helper.DataObject

Corresponds to IDD object SurfaceProperty:HeatTransferAlgorithm:MultipleSurface Determines which Heat Balance Algorithm will be used for a group of surface types Allows selectively overriding the global setting in HeatBalanceAlgorithm CTF (Conduction Transfer Functions), EMPD (Effective Moisture Penetration Depth with Conduction Transfer Functions). Advanced/Research Usage: CondFD (Conduction Finite Difference) Advanced/Research Usage: HAMT (Combined Heat And Moisture Finite Element)

algorithm

field Algorithm

Default value: ConductionTransferFunction

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

name

field Name

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

surface_type

field Surface Type

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

class pyidf.advanced_construction.SurfacePropertyHeatTransferAlgorithmSurfaceList

Bases: pyidf.helper.DataObject

Corresponds to IDD object SurfaceProperty:HeatTransferAlgorithm:SurfaceList Determines which Heat Balance Algorithm will be used for a list of surfaces Allows selectively overriding the global setting in HeatBalanceAlgorithm CTF (Conduction Transfer Functions), EMPD (Effective Moisture Penetration Depth with Conduction Transfer Functions). Advanced/Research Usage: CondFD (Conduction Finite Difference) Advanced/Research Usage: HAMT (Combined Heat And Moisture Finite Element)

add_extensible(surface_name_1=None)

Add values for extensible fields

Parameters:surface_name_1 (str) – value for IDD Field Surface Name 1 if value is None it will not be checked against the specification and is assumed to be a missing value

algorithm

field Algorithm

Default value: ConductionTransferFunction

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

extensibles

Get list of all extensibles

name

field Name

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

class pyidf.advanced_construction.SurfacePropertyOtherSideCoefficients

Bases: pyidf.helper.DataObject

Corresponds to IDD object SurfaceProperty:OtherSideCoefficients This object sets the other side conditions for a surface in a variety of ways.

combined_convective_or_radiative_film_coefficient

field Combined Convective/Radiative Film Coefficient

if>0, this field becomes the exterior convective/radiative film coefficient

and the other fields are used to calculate the outdoor air temperature

then exterior surface temperature based on outdoor air and specified coefficient

if<=0, then remaining fields calculate the outside surface temperature

The following fields are used in the equation:

OtherSideTemp=N2*N3 + N4*OutdoorDry-bulb + N5*GroundTemp + N6*WindSpeed*OutdoorDry-bulb + N7*TempZone + N9*TempPrev

Units: W/m2-K

Parameters:value (float) – value for IDD Field Combined Convective/Radiative Film Coefficient Raises:ValueError – if value is not a valid value Returns:the value of combined_convective_or_radiative_film_coefficient or None if not set Return type:float

constant_temperature

field Constant Temperature

This parameter will be overwritten by the values from the Constant Temperature Schedule Name (below) if one is present

Units: C

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

constant_temperature_coefficient

field Constant Temperature Coefficient

This coefficient is used even with a Schedule. It should normally be 1.0 in that case.

This field is ignored if Sinusoidal Variation of Constant Temperature Coefficient = Yes.

Default value: 1.0

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

constant_temperature_schedule_name

field Constant Temperature Schedule Name

Name of schedule for values of constant temperature.

Schedule values replace any value specified in the field Constant Temperature.

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

external_drybulb_temperature_coefficient

field External Dry-Bulb Temperature Coefficient

Parameters:value (float) – value for IDD Field External Dry-Bulb Temperature Coefficient Raises:ValueError – if value is not a valid value Returns:the value of external_drybulb_temperature_coefficient or None if not set Return type:float

ground_temperature_coefficient

field Ground Temperature Coefficient

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

maximum_other_side_temperature_limit

field Maximum Other Side Temperature Limit

This field specifies an upper limit for the other side temperature result.

Blank indicates no limit

Units: C

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

minimum_other_side_temperature_limit

field Minimum Other Side Temperature Limit

This field specifies a lower limit for the other side temperature result.

Blank indicates no limit

Units: C

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

name

field Name

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

period_of_sinusoidal_variation

field Period of Sinusoidal Variation

Use with sinusoidal variation to define the time period

Units: hr

Default value: 24.0

Parameters:value (float) – value for IDD Field Period of Sinusoidal Variation Raises:ValueError – if value is not a valid value Returns:the value of period_of_sinusoidal_variation or None if not set Return type:float

previous_other_side_temperature_coefficient

field Previous Other Side Temperature Coefficient

This coefficient multiplies the other side temperature result from the

previous zone timestep

Parameters:value (float) – value for IDD Field Previous Other Side Temperature Coefficient Raises:ValueError – if value is not a valid value Returns:the value of previous_other_side_temperature_coefficient or None if not set Return type:float

sinusoidal_variation_of_constant_temperature_coefficient

field Sinusoidal Variation of Constant Temperature Coefficient

Optionally used to vary Constant Temperature Coefficient with unitary sine wave

Default value: No

Parameters:value (str) – value for IDD Field Sinusoidal Variation of Constant Temperature Coefficient Raises:ValueError – if value is not a valid value Returns:the value of sinusoidal_variation_of_constant_temperature_coefficient or None if not set Return type:str

wind_speed_coefficient

field Wind Speed Coefficient

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

zone_air_temperature_coefficient

field Zone Air Temperature Coefficient

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

class pyidf.advanced_construction.SurfacePropertyOtherSideConditionsModel

Bases: pyidf.helper.DataObject

Corresponds to IDD object SurfaceProperty:OtherSideConditionsModel This object sets up modifying the other side conditions for a surface from other model results.

name

field Name

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

type_of_modeling

field Type of Modeling

GapConvectionRadiation provides boundary conditions for convection

and linearized thermal radiation across a gap or cavity

on the other side of the surface that are modeled separately.

UndergroundPipingSystemSurface provides boundary conditions for

surfaces in contact with PipingSystem:Underground domains

GroundCoupledSurface provides boundary conditions for surfaces

in contact with GroundDomain objects

Default value: GapConvectionRadiation

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

class pyidf.advanced_construction.SurfacePropertySolarIncidentInside

Bases: pyidf.helper.DataObject

Corresponds to IDD object SurfaceProperty:SolarIncidentInside Used to provide incident solar radiation on the inside of the surface. Reference surface-construction pair and if that pair is used in a simulation, then program will use value provided in schedule instead of calculating it.

construction_name

field Construction Name

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

inside_surface_incident_sun_solar_radiation_schedule_name

field Inside Surface Incident Sun Solar Radiation Schedule Name

Parameters:value (str) – value for IDD Field Inside Surface Incident Sun Solar Radiation Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of inside_surface_incident_sun_solar_radiation_schedule_name or None if not set Return type:str

name

field Name

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

surface_name

field Surface Name

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

class pyidf.advanced_construction.ZonePropertyUserViewFactorsBySurfaceName

Bases: pyidf.helper.DataObject

Corresponds to IDD object ZoneProperty:UserViewFactors:bySurfaceName View factors for Surface to Surface in a zone. (Number of Surfaces)**2 must be entered.

add_extensible(from_surface_1=None, to_surface_1=None, view_factor_1=None)

Add values for extensible fields

Parameters:

• from_surface_1 (str) – value for IDD Field From Surface 1 if value is None it will not be checked against the specification and is assumed to be a missing value
• to_surface_1 (str) – value for IDD Field To Surface 1 if value is None it will not be checked against the specification and is assumed to be a missing value
• view_factor_1 (float) – value for IDD Field View Factor 1 value <= 1.0 if value is None it will not be checked against the specification and is assumed to be a missing value

extensibles

Get list of all extensibles

zone_name

field Zone Name

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