pyidf.surface_construction_elements module

Data objects in group “Surface Construction Elements”

class pyidf.surface_construction_elements.Construction

Bases: pyidf.helper.DataObject

Corresponds to IDD object Construction Start with outside layer and work your way to the inside layer Up to 10 layers total, 8 for windows Enter the material name for each layer

layer_10

field Layer 10

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

layer_2

field Layer 2

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

layer_3

field Layer 3

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

layer_4

field Layer 4

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

layer_5

field Layer 5

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

layer_6

field Layer 6

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

layer_7

field Layer 7

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

layer_8

field Layer 8

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

layer_9

field Layer 9

Parameters:value (str) – value for IDD Field Layer 9 Raises:ValueError – if value is not a valid value Returns:the value of layer_9 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

outside_layer

field Outside Layer

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

class pyidf.surface_construction_elements.ConstructionCfactorUndergroundWall

Bases: pyidf.helper.DataObject

Corresponds to IDD object Construction:CfactorUndergroundWall Alternate method of describing underground wall constructions

cfactor

field C-Factor

Enter C-Factor without film coefficients or soil

Units: W/m2-K

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

height

field Height

Enter height of the underground wall

Units: m

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

class pyidf.surface_construction_elements.ConstructionComplexFenestrationState

Bases: pyidf.helper.DataObject

Corresponds to IDD object Construction:ComplexFenestrationState Describes one state for a complex glazing system These input objects are typically generated by using WINDOW software and export to IDF syntax

basis_matrix_name

field Basis Matrix Name

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

basis_symmetry_type

field Basis Symmetry Type

Default value: None

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

basis_type

field Basis Type

Default value: LBNLWINDOW

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

cfs_gap_1_directional_back_absoptance_matrix_name

field CFS Gap 1 Directional Back Absoptance Matrix Name

Reserved for future use. Leave it blank for this version

Parameters:value (str) – value for IDD Field CFS Gap 1 Directional Back Absoptance Matrix Name Raises:ValueError – if value is not a valid value Returns:the value of cfs_gap_1_directional_back_absoptance_matrix_name or None if not set Return type:str

cfs_gap_1_directional_front_absoptance_matrix_name

field CFS Gap 1 Directional Front Absoptance Matrix Name

Reserved for future use. Leave it blank for this version

Parameters:value (str) – value for IDD Field CFS Gap 1 Directional Front Absoptance Matrix Name Raises:ValueError – if value is not a valid value Returns:the value of cfs_gap_1_directional_front_absoptance_matrix_name or None if not set Return type:str

gap_1_name

field Gap 1 Name

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

gap_2_directional_back_absoptance_matrix_name

field Gap 2 Directional Back Absoptance Matrix Name

Reserved for future use. Leave it blank for this version

Parameters:value (str) – value for IDD Field Gap 2 Directional Back Absoptance Matrix Name Raises:ValueError – if value is not a valid value Returns:the value of gap_2_directional_back_absoptance_matrix_name or None if not set Return type:str

gap_2_directional_front_absoptance_matrix_name

field Gap 2 Directional Front Absoptance Matrix Name

Reserved for future use. Leave it blank for this version

Parameters:value (str) – value for IDD Field Gap 2 Directional Front Absoptance Matrix Name Raises:ValueError – if value is not a valid value Returns:the value of gap_2_directional_front_absoptance_matrix_name or None if not set Return type:str

gap_2_name

field Gap 2 Name

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

gap_3_directional_back_absoptance_matrix_name

field Gap 3 Directional Back Absoptance Matrix Name

Reserved for future use. Leave it blank for this version

Parameters:value (str) – value for IDD Field Gap 3 Directional Back Absoptance Matrix Name Raises:ValueError – if value is not a valid value Returns:the value of gap_3_directional_back_absoptance_matrix_name or None if not set Return type:str

gap_3_directional_front_absoptance_matrix_name

field Gap 3 Directional Front Absoptance Matrix Name

Reserved for future use. Leave it blank for this version

Parameters:value (str) – value for IDD Field Gap 3 Directional Front Absoptance Matrix Name Raises:ValueError – if value is not a valid value Returns:the value of gap_3_directional_front_absoptance_matrix_name or None if not set Return type:str

gap_3_name

field Gap 3 Name

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

gap_4_directional_back_absoptance_matrix_name

field Gap 4 Directional Back Absoptance Matrix Name

Reserved for future use. Leave it blank for this version

Parameters:value (str) – value for IDD Field Gap 4 Directional Back Absoptance Matrix Name Raises:ValueError – if value is not a valid value Returns:the value of gap_4_directional_back_absoptance_matrix_name or None if not set Return type:str

gap_4_directional_front_absoptance_matrix_name

field Gap 4 Directional Front Absoptance Matrix Name

Reserved for future use. Leave it blank for this version

Parameters:value (str) – value for IDD Field Gap 4 Directional Front Absoptance Matrix Name Raises:ValueError – if value is not a valid value Returns:the value of gap_4_directional_front_absoptance_matrix_name or None if not set Return type:str

gap_4_name

field Gap 4 Name

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

layer_2_directional_back_absoptance_matrix_name

field Layer 2 Directional Back Absoptance Matrix Name

Parameters:value (str) – value for IDD Field Layer 2 Directional Back Absoptance Matrix Name Raises:ValueError – if value is not a valid value Returns:the value of layer_2_directional_back_absoptance_matrix_name or None if not set Return type:str

layer_2_directional_front_absoptance_matrix_name

field Layer 2 Directional Front Absoptance Matrix Name

Parameters:value (str) – value for IDD Field Layer 2 Directional Front Absoptance Matrix Name Raises:ValueError – if value is not a valid value Returns:the value of layer_2_directional_front_absoptance_matrix_name or None if not set Return type:str

layer_2_name

field Layer 2 Name

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

layer_3_directional_back_absoptance_matrix_name

field Layer 3 Directional Back Absoptance Matrix Name

Parameters:value (str) – value for IDD Field Layer 3 Directional Back Absoptance Matrix Name Raises:ValueError – if value is not a valid value Returns:the value of layer_3_directional_back_absoptance_matrix_name or None if not set Return type:str

layer_3_directional_front_absoptance_matrix_name

field Layer 3 Directional Front Absoptance Matrix Name

Parameters:value (str) – value for IDD Field Layer 3 Directional Front Absoptance Matrix Name Raises:ValueError – if value is not a valid value Returns:the value of layer_3_directional_front_absoptance_matrix_name or None if not set Return type:str

layer_3_material

field Layer 3 Material

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

layer_4_directional_back_absoptance_matrix_name

field Layer 4 Directional Back Absoptance Matrix Name

Parameters:value (str) – value for IDD Field Layer 4 Directional Back Absoptance Matrix Name Raises:ValueError – if value is not a valid value Returns:the value of layer_4_directional_back_absoptance_matrix_name or None if not set Return type:str

layer_4_directional_front_absoptance_matrix_name

field Layer 4 Directional Front Absoptance Matrix Name

Parameters:value (str) – value for IDD Field Layer 4 Directional Front Absoptance Matrix Name Raises:ValueError – if value is not a valid value Returns:the value of layer_4_directional_front_absoptance_matrix_name or None if not set Return type:str

layer_4_name

field Layer 4 Name

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

layer_5_directional_back_absoptance_matrix_name

field Layer 5 Directional Back Absoptance Matrix Name

Parameters:value (str) – value for IDD Field Layer 5 Directional Back Absoptance Matrix Name Raises:ValueError – if value is not a valid value Returns:the value of layer_5_directional_back_absoptance_matrix_name or None if not set Return type:str

layer_5_directional_front_absoptance_matrix_name

field Layer 5 Directional Front Absoptance Matrix Name

Parameters:value (str) – value for IDD Field Layer 5 Directional Front Absoptance Matrix Name Raises:ValueError – if value is not a valid value Returns:the value of layer_5_directional_front_absoptance_matrix_name or None if not set Return type:str

layer_5_name

field Layer 5 Name

Parameters:value (str) – value for IDD Field Layer 5 Name Raises:ValueError – if value is not a valid value Returns:the value of layer_5_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

outside_layer_directional_back_absoptance_matrix_name

field Outside Layer Directional Back Absoptance Matrix Name

Parameters:value (str) – value for IDD Field Outside Layer Directional Back Absoptance Matrix Name Raises:ValueError – if value is not a valid value Returns:the value of outside_layer_directional_back_absoptance_matrix_name or None if not set Return type:str

outside_layer_directional_front_absoptance_matrix_name

field Outside Layer Directional Front Absoptance Matrix Name

Parameters:value (str) – value for IDD Field Outside Layer Directional Front Absoptance Matrix Name Raises:ValueError – if value is not a valid value Returns:the value of outside_layer_directional_front_absoptance_matrix_name or None if not set Return type:str

outside_layer_name

field Outside Layer Name

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

solar_optical_complex_back_reflectance_matrix_name

field Solar Optical Complex Back Reflectance Matrix Name

Parameters:value (str) – value for IDD Field Solar Optical Complex Back Reflectance Matrix Name Raises:ValueError – if value is not a valid value Returns:the value of solar_optical_complex_back_reflectance_matrix_name or None if not set Return type:str

solar_optical_complex_front_transmittance_matrix_name

field Solar Optical Complex Front Transmittance Matrix Name

Parameters:value (str) – value for IDD Field Solar Optical Complex Front Transmittance Matrix Name Raises:ValueError – if value is not a valid value Returns:the value of solar_optical_complex_front_transmittance_matrix_name or None if not set Return type:str

visible_optical_complex_back_transmittance_matrix_name

field Visible Optical Complex Back Transmittance Matrix Name

Parameters:value (str) – value for IDD Field Visible Optical Complex Back Transmittance Matrix Name Raises:ValueError – if value is not a valid value Returns:the value of visible_optical_complex_back_transmittance_matrix_name or None if not set Return type:str

visible_optical_complex_front_transmittance_matrix_name

field Visible Optical Complex Front Transmittance Matrix Name

Parameters:value (str) – value for IDD Field Visible Optical Complex Front Transmittance Matrix Name Raises:ValueError – if value is not a valid value Returns:the value of visible_optical_complex_front_transmittance_matrix_name or None if not set Return type:str

window_thermal_model

field Window Thermal Model

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

class pyidf.surface_construction_elements.ConstructionFfactorGroundFloor

Bases: pyidf.helper.DataObject

Corresponds to IDD object Construction:FfactorGroundFloor Alternate method of describing slab-on-grade or underground floor constructions

area

field Area

Enter area of the floor

Units: m2

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

ffactor

field F-Factor

Units: W/m-K

IP-Units: Btu/h-ft-F

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

perimeterexposed

field PerimeterExposed

Enter exposed perimeter of the floor

Units: m

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

class pyidf.surface_construction_elements.ConstructionInternalSource

Bases: pyidf.helper.DataObject

Corresponds to IDD object Construction:InternalSource Start with outside layer and work your way to the inside Layer Up to 10 layers total, 8 for windows Enter the material name for each layer

dimensions_for_the_ctf_calculation

field Dimensions for the CTF Calculation

1 = 1-dimensional calculation, 2 = 2-dimensional calculation

value >= 1

value <= 2

Parameters:value (int) – value for IDD Field Dimensions for the CTF Calculation Raises:ValueError – if value is not a valid value Returns:the value of dimensions_for_the_ctf_calculation or None if not set Return type:int

layer_10

field Layer 10

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

layer_2

field Layer 2

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

layer_3

field Layer 3

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

layer_4

field Layer 4

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

layer_5

field Layer 5

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

layer_6

field Layer 6

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

layer_7

field Layer 7

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

layer_8

field Layer 8

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

layer_9

field Layer 9

Parameters:value (str) – value for IDD Field Layer 9 Raises:ValueError – if value is not a valid value Returns:the value of layer_9 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

outside_layer

field Outside Layer

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

source_present_after_layer_number

field Source Present After Layer Number

refers to the list of materials which follows

value >= 1

Parameters:value (int) – value for IDD Field Source Present After Layer Number Raises:ValueError – if value is not a valid value Returns:the value of source_present_after_layer_number or None if not set Return type:int

temperature_calculation_requested_after_layer_number

field Temperature Calculation Requested After Layer Number

refers to the list of materials which follows

Parameters:value (int) – value for IDD Field Temperature Calculation Requested After Layer Number Raises:ValueError – if value is not a valid value Returns:the value of temperature_calculation_requested_after_layer_number or None if not set Return type:int

tube_spacing

field Tube Spacing

uniform spacing between tubes or resistance wires in direction

perpendicular to main intended direction of heat transfer

Units: m

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

class pyidf.surface_construction_elements.ConstructionWindowDataFile

Bases: pyidf.helper.DataObject

Corresponds to IDD object Construction:WindowDataFile Initiates search of the Window data file for a window called Name.

file_name

field File Name

default file name is “Window5DataFile.dat”

limit on this field is 100 characters.

Parameters:value (str) – value for IDD Field File Name Raises:ValueError – if value is not a valid value Returns:the value of file_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.surface_construction_elements.ConstructionWindowEquivalentLayer

Bases: pyidf.helper.DataObject

Corresponds to IDD object Construction:WindowEquivalentLayer Start with outside layer and work your way to the inside Layer Up to 11 layers total. Up to six solid layers and up to five gaps. Enter the material name for each layer

layer_10

field Layer 10

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

layer_11

field Layer 11

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

layer_2

field Layer 2

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

layer_3

field Layer 3

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

layer_4

field Layer 4

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

layer_5

field Layer 5

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

layer_6

field Layer 6

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

layer_7

field Layer 7

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

layer_8

field Layer 8

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

layer_9

field Layer 9

Parameters:value (str) – value for IDD Field Layer 9 Raises:ValueError – if value is not a valid value Returns:the value of layer_9 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

outside_layer

field Outside Layer

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

class pyidf.surface_construction_elements.Material

Bases: pyidf.helper.DataObject

Corresponds to IDD object Material Regular materials described with full set of thermal properties

conductivity

field Conductivity

Units: W/m-K

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

density

field Density

Units: kg/m3

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

roughness

field Roughness

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

solar_absorptance

field Solar Absorptance

Default value: 0.7

value <= 1.0

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

specific_heat

field Specific Heat

Units: J/kg-K

value >= 100.0

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

thermal_absorptance

field Thermal Absorptance

Default value: 0.9

value <= 0.99999

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

thickness

field Thickness

Units: m

IP-Units: in

value <= 3.0

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

visible_absorptance

field Visible Absorptance

Default value: 0.7

value <= 1.0

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

class pyidf.surface_construction_elements.MaterialAirGap

Bases: pyidf.helper.DataObject

Corresponds to IDD object Material:AirGap Air Space in Opaque Construction

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

thermal_resistance

field Thermal Resistance

Units: m2-K/W

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

class pyidf.surface_construction_elements.MaterialInfraredTransparent

Bases: pyidf.helper.DataObject

Corresponds to IDD object Material:InfraredTransparent Special infrared transparent material. Similar to a Material:Nomass with low thermal resistance. High absorptance in both wavelengths. Area will be doubled internally to make internal radiant exchange accurate. Should be only material in single layer surface construction. All thermal properties are set internally. User needs only to supply name. Cannot be used with ConductionFiniteDifference solution algorithms

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.surface_construction_elements.MaterialNoMass

Bases: pyidf.helper.DataObject

Corresponds to IDD object Material:NoMass Regular materials properties described whose principal description is R (Thermal Resistance)

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

roughness

field Roughness

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

solar_absorptance

field Solar Absorptance

Default value: 0.7

value <= 1.0

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

thermal_absorptance

field Thermal Absorptance

Default value: 0.9

value <= 0.99999

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

thermal_resistance

field Thermal Resistance

Units: m2-K/W

value >= 0.001

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

visible_absorptance

field Visible Absorptance

Default value: 0.7

value <= 1.0

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

class pyidf.surface_construction_elements.MaterialPropertyGlazingSpectralData

Bases: pyidf.helper.DataObject

Corresponds to IDD object MaterialProperty:GlazingSpectralData Name is followed by up to 800 sets of normal-incidence measured values of [wavelength, transmittance, front reflectance, back reflectance] for wavelengths covering the solar spectrum (from about 0.25 to 2.5 microns)

back_reflectance_1

field Back Reflectance 1

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

back_reflectance_2

field Back Reflectance 2

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

back_reflectance_3

field Back Reflectance 3

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

back_reflectance_4

field Back Reflectance 4

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

back_reflectance_5_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3

field Back Reflectance 5 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3

Parameters:value (float) – value for IDD Field Back Reflectance 5 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 Raises:ValueError – if value is not a valid value Returns:the value of back_reflectance_5_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3 or None if not set Return type:float

front_reflectance_1

field Front Reflectance 1

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

front_reflectance_2

field Front Reflectance 2

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

front_reflectance_3

field Front Reflectance 3

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

front_reflectance_4

field Front Reflectance 4

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

front_reflectance_5

field Front Reflectance 5

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

transmittance_1

field Transmittance 1

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

transmittance_2

field Transmittance 2

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

transmittance_3

field Transmittance 3

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

transmittance_4

field Transmittance 4

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

transmittance_5

field Transmittance 5

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

wavelength_1

field Wavelength 1

Units: micron

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

wavelength_2

field Wavelength 2

Units: micron

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

wavelength_3

field Wavelength 3

Units: micron

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

wavelength_4

field Wavelength 4

Units: micron

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

wavelength_5

field Wavelength 5

Units: micron

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

class pyidf.surface_construction_elements.MaterialPropertyHeatAndMoistureTransferDiffusion

Bases: pyidf.helper.DataObject

Corresponds to IDD object MaterialProperty:HeatAndMoistureTransfer:Diffusion HeatBalanceAlgorithm = CombinedHeatAndMoistureFiniteElement solution algorithm only. Relationship between water vapor diffusion and relative humidity fraction Has no effect with other HeatBalanceAlgorithm solution algorithms

material_name

field Material Name

Moisture Material Name that the moisture properties will be added to.

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

number_of_data_pairs

field Number of Data Pairs

Water Vapor Diffusion Resistance Factor

value >= 1

value <= 25

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

relative_humidity_fraction_1

field Relative Humidity Fraction 1

The relative humidity is entered as a fraction.

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Relative Humidity Fraction 1 Raises:ValueError – if value is not a valid value Returns:the value of relative_humidity_fraction_1 or None if not set Return type:float

relative_humidity_fraction_10

field Relative Humidity Fraction 10

The relative humidity is entered as a fraction.

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Relative Humidity Fraction 10 Raises:ValueError – if value is not a valid value Returns:the value of relative_humidity_fraction_10 or None if not set Return type:float

relative_humidity_fraction_11

field Relative Humidity Fraction 11

The relative humidity is entered as a fraction.

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Relative Humidity Fraction 11 Raises:ValueError – if value is not a valid value Returns:the value of relative_humidity_fraction_11 or None if not set Return type:float

relative_humidity_fraction_12

field Relative Humidity Fraction 12

The relative humidity is entered as a fraction.

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Relative Humidity Fraction 12 Raises:ValueError – if value is not a valid value Returns:the value of relative_humidity_fraction_12 or None if not set Return type:float

relative_humidity_fraction_13

field Relative Humidity Fraction 13

The relative humidity is entered as a fraction.

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Relative Humidity Fraction 13 Raises:ValueError – if value is not a valid value Returns:the value of relative_humidity_fraction_13 or None if not set Return type:float

relative_humidity_fraction_14

field Relative Humidity Fraction 14

The relative humidity is entered as a fraction.

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Relative Humidity Fraction 14 Raises:ValueError – if value is not a valid value Returns:the value of relative_humidity_fraction_14 or None if not set Return type:float

relative_humidity_fraction_15

field Relative Humidity Fraction 15

The relative humidity is entered as a fraction.

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Relative Humidity Fraction 15 Raises:ValueError – if value is not a valid value Returns:the value of relative_humidity_fraction_15 or None if not set Return type:float

relative_humidity_fraction_16

field Relative Humidity Fraction 16

The relative humidity is entered as a fraction.

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Relative Humidity Fraction 16 Raises:ValueError – if value is not a valid value Returns:the value of relative_humidity_fraction_16 or None if not set Return type:float

relative_humidity_fraction_17

field Relative Humidity Fraction 17

The relative humidity is entered as a fraction.

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Relative Humidity Fraction 17 Raises:ValueError – if value is not a valid value Returns:the value of relative_humidity_fraction_17 or None if not set Return type:float

relative_humidity_fraction_18

field Relative Humidity Fraction 18

The relative humidity is entered as a fraction.

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Relative Humidity Fraction 18 Raises:ValueError – if value is not a valid value Returns:the value of relative_humidity_fraction_18 or None if not set Return type:float

relative_humidity_fraction_19

field Relative Humidity Fraction 19

The relative humidity is entered as a fraction.

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Relative Humidity Fraction 19 Raises:ValueError – if value is not a valid value Returns:the value of relative_humidity_fraction_19 or None if not set Return type:float

relative_humidity_fraction_2

field Relative Humidity Fraction 2

The relative humidity is entered as a fraction.

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Relative Humidity Fraction 2 Raises:ValueError – if value is not a valid value Returns:the value of relative_humidity_fraction_2 or None if not set Return type:float

relative_humidity_fraction_20

field Relative Humidity Fraction 20

The relative humidity is entered as a fraction.

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Relative Humidity Fraction 20 Raises:ValueError – if value is not a valid value Returns:the value of relative_humidity_fraction_20 or None if not set Return type:float

relative_humidity_fraction_21

field Relative Humidity Fraction 21

The relative humidity is entered as a fraction.

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Relative Humidity Fraction 21 Raises:ValueError – if value is not a valid value Returns:the value of relative_humidity_fraction_21 or None if not set Return type:float

relative_humidity_fraction_22

field Relative Humidity Fraction 22

The relative humidity is entered as a fraction.

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Relative Humidity Fraction 22 Raises:ValueError – if value is not a valid value Returns:the value of relative_humidity_fraction_22 or None if not set Return type:float

relative_humidity_fraction_23

field Relative Humidity Fraction 23

The relative humidity is entered as a fraction.

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Relative Humidity Fraction 23 Raises:ValueError – if value is not a valid value Returns:the value of relative_humidity_fraction_23 or None if not set Return type:float

relative_humidity_fraction_24

field Relative Humidity Fraction 24

The relative humidity is entered as a fraction.

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Relative Humidity Fraction 24 Raises:ValueError – if value is not a valid value Returns:the value of relative_humidity_fraction_24 or None if not set Return type:float

relative_humidity_fraction_25

field Relative Humidity Fraction 25

The relative humidity is entered as a fraction.

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Relative Humidity Fraction 25 Raises:ValueError – if value is not a valid value Returns:the value of relative_humidity_fraction_25 or None if not set Return type:float

relative_humidity_fraction_3

field Relative Humidity Fraction 3

The relative humidity is entered as a fraction.

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Relative Humidity Fraction 3 Raises:ValueError – if value is not a valid value Returns:the value of relative_humidity_fraction_3 or None if not set Return type:float

relative_humidity_fraction_4

field Relative Humidity Fraction 4

The relative humidity is entered as a fraction.

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Relative Humidity Fraction 4 Raises:ValueError – if value is not a valid value Returns:the value of relative_humidity_fraction_4 or None if not set Return type:float

relative_humidity_fraction_5

field Relative Humidity Fraction 5

The relative humidity is entered as a fraction.

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Relative Humidity Fraction 5 Raises:ValueError – if value is not a valid value Returns:the value of relative_humidity_fraction_5 or None if not set Return type:float

relative_humidity_fraction_6

field Relative Humidity Fraction 6

The relative humidity is entered as a fraction.

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Relative Humidity Fraction 6 Raises:ValueError – if value is not a valid value Returns:the value of relative_humidity_fraction_6 or None if not set Return type:float

relative_humidity_fraction_7

field Relative Humidity Fraction 7

The relative humidity is entered as a fraction.

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Relative Humidity Fraction 7 Raises:ValueError – if value is not a valid value Returns:the value of relative_humidity_fraction_7 or None if not set Return type:float

relative_humidity_fraction_8

field Relative Humidity Fraction 8

The relative humidity is entered as a fraction.

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Relative Humidity Fraction 8 Raises:ValueError – if value is not a valid value Returns:the value of relative_humidity_fraction_8 or None if not set Return type:float

relative_humidity_fraction_9

field Relative Humidity Fraction 9

The relative humidity is entered as a fraction.

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Relative Humidity Fraction 9 Raises:ValueError – if value is not a valid value Returns:the value of relative_humidity_fraction_9 or None if not set Return type:float

water_vapor_diffusion_resistance_factor_1

field Water Vapor Diffusion Resistance Factor 1

Units: dimensionless

Parameters:value (float) – value for IDD Field Water Vapor Diffusion Resistance Factor 1 Raises:ValueError – if value is not a valid value Returns:the value of water_vapor_diffusion_resistance_factor_1 or None if not set Return type:float

water_vapor_diffusion_resistance_factor_10

field Water Vapor Diffusion Resistance Factor 10

Units: dimensionless

Parameters:value (float) – value for IDD Field Water Vapor Diffusion Resistance Factor 10 Raises:ValueError – if value is not a valid value Returns:the value of water_vapor_diffusion_resistance_factor_10 or None if not set Return type:float

water_vapor_diffusion_resistance_factor_11

field Water Vapor Diffusion Resistance Factor 11

Units: dimensionless

Parameters:value (float) – value for IDD Field Water Vapor Diffusion Resistance Factor 11 Raises:ValueError – if value is not a valid value Returns:the value of water_vapor_diffusion_resistance_factor_11 or None if not set Return type:float

water_vapor_diffusion_resistance_factor_12

field Water Vapor Diffusion Resistance Factor 12

Units: dimensionless

Parameters:value (float) – value for IDD Field Water Vapor Diffusion Resistance Factor 12 Raises:ValueError – if value is not a valid value Returns:the value of water_vapor_diffusion_resistance_factor_12 or None if not set Return type:float

water_vapor_diffusion_resistance_factor_13

field Water Vapor Diffusion Resistance Factor 13

Units: dimensionless

Parameters:value (float) – value for IDD Field Water Vapor Diffusion Resistance Factor 13 Raises:ValueError – if value is not a valid value Returns:the value of water_vapor_diffusion_resistance_factor_13 or None if not set Return type:float

water_vapor_diffusion_resistance_factor_14

field Water Vapor Diffusion Resistance Factor 14

Units: dimensionless

Parameters:value (float) – value for IDD Field Water Vapor Diffusion Resistance Factor 14 Raises:ValueError – if value is not a valid value Returns:the value of water_vapor_diffusion_resistance_factor_14 or None if not set Return type:float

water_vapor_diffusion_resistance_factor_15

field Water Vapor Diffusion Resistance Factor 15

Units: dimensionless

Parameters:value (float) – value for IDD Field Water Vapor Diffusion Resistance Factor 15 Raises:ValueError – if value is not a valid value Returns:the value of water_vapor_diffusion_resistance_factor_15 or None if not set Return type:float

water_vapor_diffusion_resistance_factor_16

field Water Vapor Diffusion Resistance Factor 16

Units: dimensionless

Parameters:value (float) – value for IDD Field Water Vapor Diffusion Resistance Factor 16 Raises:ValueError – if value is not a valid value Returns:the value of water_vapor_diffusion_resistance_factor_16 or None if not set Return type:float

water_vapor_diffusion_resistance_factor_17

field Water Vapor Diffusion Resistance Factor 17

Units: dimensionless

Parameters:value (float) – value for IDD Field Water Vapor Diffusion Resistance Factor 17 Raises:ValueError – if value is not a valid value Returns:the value of water_vapor_diffusion_resistance_factor_17 or None if not set Return type:float

water_vapor_diffusion_resistance_factor_18

field Water Vapor Diffusion Resistance Factor 18

Units: dimensionless

Parameters:value (float) – value for IDD Field Water Vapor Diffusion Resistance Factor 18 Raises:ValueError – if value is not a valid value Returns:the value of water_vapor_diffusion_resistance_factor_18 or None if not set Return type:float

water_vapor_diffusion_resistance_factor_19

field Water Vapor Diffusion Resistance Factor 19

Units: dimensionless

Parameters:value (float) – value for IDD Field Water Vapor Diffusion Resistance Factor 19 Raises:ValueError – if value is not a valid value Returns:the value of water_vapor_diffusion_resistance_factor_19 or None if not set Return type:float

water_vapor_diffusion_resistance_factor_2

field Water Vapor Diffusion Resistance Factor 2

Units: dimensionless

Parameters:value (float) – value for IDD Field Water Vapor Diffusion Resistance Factor 2 Raises:ValueError – if value is not a valid value Returns:the value of water_vapor_diffusion_resistance_factor_2 or None if not set Return type:float

water_vapor_diffusion_resistance_factor_20

field Water Vapor Diffusion Resistance Factor 20

Units: dimensionless

Parameters:value (float) – value for IDD Field Water Vapor Diffusion Resistance Factor 20 Raises:ValueError – if value is not a valid value Returns:the value of water_vapor_diffusion_resistance_factor_20 or None if not set Return type:float

water_vapor_diffusion_resistance_factor_21

field Water Vapor Diffusion Resistance Factor 21

Units: dimensionless

Parameters:value (float) – value for IDD Field Water Vapor Diffusion Resistance Factor 21 Raises:ValueError – if value is not a valid value Returns:the value of water_vapor_diffusion_resistance_factor_21 or None if not set Return type:float

water_vapor_diffusion_resistance_factor_22

field Water Vapor Diffusion Resistance Factor 22

Units: dimensionless

Parameters:value (float) – value for IDD Field Water Vapor Diffusion Resistance Factor 22 Raises:ValueError – if value is not a valid value Returns:the value of water_vapor_diffusion_resistance_factor_22 or None if not set Return type:float

water_vapor_diffusion_resistance_factor_23

field Water Vapor Diffusion Resistance Factor 23

Units: dimensionless

Parameters:value (float) – value for IDD Field Water Vapor Diffusion Resistance Factor 23 Raises:ValueError – if value is not a valid value Returns:the value of water_vapor_diffusion_resistance_factor_23 or None if not set Return type:float

water_vapor_diffusion_resistance_factor_24

field Water Vapor Diffusion Resistance Factor 24

Units: dimensionless

Parameters:value (float) – value for IDD Field Water Vapor Diffusion Resistance Factor 24 Raises:ValueError – if value is not a valid value Returns:the value of water_vapor_diffusion_resistance_factor_24 or None if not set Return type:float

water_vapor_diffusion_resistance_factor_25

field Water Vapor Diffusion Resistance Factor 25

Units: dimensionless

Parameters:value (float) – value for IDD Field Water Vapor Diffusion Resistance Factor 25 Raises:ValueError – if value is not a valid value Returns:the value of water_vapor_diffusion_resistance_factor_25 or None if not set Return type:float

water_vapor_diffusion_resistance_factor_3

field Water Vapor Diffusion Resistance Factor 3

Units: dimensionless

Parameters:value (float) – value for IDD Field Water Vapor Diffusion Resistance Factor 3 Raises:ValueError – if value is not a valid value Returns:the value of water_vapor_diffusion_resistance_factor_3 or None if not set Return type:float

water_vapor_diffusion_resistance_factor_4

field Water Vapor Diffusion Resistance Factor 4

Units: dimensionless

Parameters:value (float) – value for IDD Field Water Vapor Diffusion Resistance Factor 4 Raises:ValueError – if value is not a valid value Returns:the value of water_vapor_diffusion_resistance_factor_4 or None if not set Return type:float

water_vapor_diffusion_resistance_factor_5

field Water Vapor Diffusion Resistance Factor 5

Units: dimensionless

Parameters:value (float) – value for IDD Field Water Vapor Diffusion Resistance Factor 5 Raises:ValueError – if value is not a valid value Returns:the value of water_vapor_diffusion_resistance_factor_5 or None if not set Return type:float

water_vapor_diffusion_resistance_factor_6

field Water Vapor Diffusion Resistance Factor 6

Units: dimensionless

Parameters:value (float) – value for IDD Field Water Vapor Diffusion Resistance Factor 6 Raises:ValueError – if value is not a valid value Returns:the value of water_vapor_diffusion_resistance_factor_6 or None if not set Return type:float

water_vapor_diffusion_resistance_factor_7

field Water Vapor Diffusion Resistance Factor 7

Units: dimensionless

Parameters:value (float) – value for IDD Field Water Vapor Diffusion Resistance Factor 7 Raises:ValueError – if value is not a valid value Returns:the value of water_vapor_diffusion_resistance_factor_7 or None if not set Return type:float

water_vapor_diffusion_resistance_factor_8

field Water Vapor Diffusion Resistance Factor 8

Units: dimensionless

Parameters:value (float) – value for IDD Field Water Vapor Diffusion Resistance Factor 8 Raises:ValueError – if value is not a valid value Returns:the value of water_vapor_diffusion_resistance_factor_8 or None if not set Return type:float

water_vapor_diffusion_resistance_factor_9

field Water Vapor Diffusion Resistance Factor 9

Units: dimensionless

Parameters:value (float) – value for IDD Field Water Vapor Diffusion Resistance Factor 9 Raises:ValueError – if value is not a valid value Returns:the value of water_vapor_diffusion_resistance_factor_9 or None if not set Return type:float

class pyidf.surface_construction_elements.MaterialPropertyHeatAndMoistureTransferRedistribution

Bases: pyidf.helper.DataObject

Corresponds to IDD object MaterialProperty:HeatAndMoistureTransfer:Redistribution HeatBalanceAlgorithm = CombinedHeatAndMoistureFiniteElement solution algorithm only. Relationship between liquid transport coefficient and moisture content Has no effect with other HeatBalanceAlgorithm solution algorithms

liquid_transport_coefficient_1

field Liquid Transport Coefficient 1

Units: m2/s

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

liquid_transport_coefficient_10

field Liquid Transport Coefficient 10

Units: m2/s

Parameters:value (float) – value for IDD Field Liquid Transport Coefficient 10 Raises:ValueError – if value is not a valid value Returns:the value of liquid_transport_coefficient_10 or None if not set Return type:float

liquid_transport_coefficient_11

field Liquid Transport Coefficient 11

Units: m2/s

Parameters:value (float) – value for IDD Field Liquid Transport Coefficient 11 Raises:ValueError – if value is not a valid value Returns:the value of liquid_transport_coefficient_11 or None if not set Return type:float

liquid_transport_coefficient_12

field Liquid Transport Coefficient 12

Units: m2/s

Parameters:value (float) – value for IDD Field Liquid Transport Coefficient 12 Raises:ValueError – if value is not a valid value Returns:the value of liquid_transport_coefficient_12 or None if not set Return type:float

liquid_transport_coefficient_13

field Liquid Transport Coefficient 13

Units: m2/s

Parameters:value (float) – value for IDD Field Liquid Transport Coefficient 13 Raises:ValueError – if value is not a valid value Returns:the value of liquid_transport_coefficient_13 or None if not set Return type:float

liquid_transport_coefficient_14

field Liquid Transport Coefficient 14

Units: m2/s

Parameters:value (float) – value for IDD Field Liquid Transport Coefficient 14 Raises:ValueError – if value is not a valid value Returns:the value of liquid_transport_coefficient_14 or None if not set Return type:float

liquid_transport_coefficient_15

field Liquid Transport Coefficient 15

Units: m2/s

Parameters:value (float) – value for IDD Field Liquid Transport Coefficient 15 Raises:ValueError – if value is not a valid value Returns:the value of liquid_transport_coefficient_15 or None if not set Return type:float

liquid_transport_coefficient_16

field Liquid Transport Coefficient 16

Units: m2/s

Parameters:value (float) – value for IDD Field Liquid Transport Coefficient 16 Raises:ValueError – if value is not a valid value Returns:the value of liquid_transport_coefficient_16 or None if not set Return type:float

liquid_transport_coefficient_17

field Liquid Transport Coefficient 17

Units: m2/s

Parameters:value (float) – value for IDD Field Liquid Transport Coefficient 17 Raises:ValueError – if value is not a valid value Returns:the value of liquid_transport_coefficient_17 or None if not set Return type:float

liquid_transport_coefficient_18

field Liquid Transport Coefficient 18

Units: m2/s

Parameters:value (float) – value for IDD Field Liquid Transport Coefficient 18 Raises:ValueError – if value is not a valid value Returns:the value of liquid_transport_coefficient_18 or None if not set Return type:float

liquid_transport_coefficient_19

field Liquid Transport Coefficient 19

Units: m2/s

Parameters:value (float) – value for IDD Field Liquid Transport Coefficient 19 Raises:ValueError – if value is not a valid value Returns:the value of liquid_transport_coefficient_19 or None if not set Return type:float

liquid_transport_coefficient_2

field Liquid Transport Coefficient 2

Units: m2/s

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

liquid_transport_coefficient_20

field Liquid Transport Coefficient 20

Units: m2/s

Parameters:value (float) – value for IDD Field Liquid Transport Coefficient 20 Raises:ValueError – if value is not a valid value Returns:the value of liquid_transport_coefficient_20 or None if not set Return type:float

liquid_transport_coefficient_21

field Liquid Transport Coefficient 21

Units: m2/s

Parameters:value (float) – value for IDD Field Liquid Transport Coefficient 21 Raises:ValueError – if value is not a valid value Returns:the value of liquid_transport_coefficient_21 or None if not set Return type:float

liquid_transport_coefficient_22

field Liquid Transport Coefficient 22

Units: m2/s

Parameters:value (float) – value for IDD Field Liquid Transport Coefficient 22 Raises:ValueError – if value is not a valid value Returns:the value of liquid_transport_coefficient_22 or None if not set Return type:float

liquid_transport_coefficient_23

field Liquid Transport Coefficient 23

Units: m2/s

Parameters:value (float) – value for IDD Field Liquid Transport Coefficient 23 Raises:ValueError – if value is not a valid value Returns:the value of liquid_transport_coefficient_23 or None if not set Return type:float

liquid_transport_coefficient_24

field Liquid Transport Coefficient 24

Units: m2/s

Parameters:value (float) – value for IDD Field Liquid Transport Coefficient 24 Raises:ValueError – if value is not a valid value Returns:the value of liquid_transport_coefficient_24 or None if not set Return type:float

liquid_transport_coefficient_25

field Liquid Transport Coefficient 25

Units: m2/s

Parameters:value (float) – value for IDD Field Liquid Transport Coefficient 25 Raises:ValueError – if value is not a valid value Returns:the value of liquid_transport_coefficient_25 or None if not set Return type:float

liquid_transport_coefficient_3

field Liquid Transport Coefficient 3

Units: m2/s

Parameters:value (float) – value for IDD Field Liquid Transport Coefficient 3 Raises:ValueError – if value is not a valid value Returns:the value of liquid_transport_coefficient_3 or None if not set Return type:float

liquid_transport_coefficient_4

field Liquid Transport Coefficient 4

Units: m2/s

Parameters:value (float) – value for IDD Field Liquid Transport Coefficient 4 Raises:ValueError – if value is not a valid value Returns:the value of liquid_transport_coefficient_4 or None if not set Return type:float

liquid_transport_coefficient_5

field Liquid Transport Coefficient 5

Units: m2/s

Parameters:value (float) – value for IDD Field Liquid Transport Coefficient 5 Raises:ValueError – if value is not a valid value Returns:the value of liquid_transport_coefficient_5 or None if not set Return type:float

liquid_transport_coefficient_6

field Liquid Transport Coefficient 6

Units: m2/s

Parameters:value (float) – value for IDD Field Liquid Transport Coefficient 6 Raises:ValueError – if value is not a valid value Returns:the value of liquid_transport_coefficient_6 or None if not set Return type:float

liquid_transport_coefficient_7

field Liquid Transport Coefficient 7

Units: m2/s

Parameters:value (float) – value for IDD Field Liquid Transport Coefficient 7 Raises:ValueError – if value is not a valid value Returns:the value of liquid_transport_coefficient_7 or None if not set Return type:float

liquid_transport_coefficient_8

field Liquid Transport Coefficient 8

Units: m2/s

Parameters:value (float) – value for IDD Field Liquid Transport Coefficient 8 Raises:ValueError – if value is not a valid value Returns:the value of liquid_transport_coefficient_8 or None if not set Return type:float

liquid_transport_coefficient_9

field Liquid Transport Coefficient 9

Units: m2/s

Parameters:value (float) – value for IDD Field Liquid Transport Coefficient 9 Raises:ValueError – if value is not a valid value Returns:the value of liquid_transport_coefficient_9 or None if not set Return type:float

material_name

field Material Name

Moisture Material Name that the moisture properties will be added to.

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

moisture_content_1

field Moisture Content 1

Units: kg/m3

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

moisture_content_10

field Moisture Content 10

Units: kg/m3

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

moisture_content_11

field Moisture Content 11

Units: kg/m3

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

moisture_content_12

field Moisture Content 12

Units: kg/m3

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

moisture_content_13

field Moisture Content 13

Units: kg/m3

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

moisture_content_14

field Moisture Content 14

Units: kg/m3

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

moisture_content_15

field Moisture Content 15

Units: kg/m3

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

moisture_content_16

field Moisture Content 16

Units: kg/m3

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

moisture_content_17

field Moisture Content 17

Units: kg/m3

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

moisture_content_18

field Moisture Content 18

Units: kg/m3

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

moisture_content_19

field Moisture Content 19

Units: kg/m3

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

moisture_content_2

field Moisture Content 2

Units: kg/m3

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

moisture_content_20

field Moisture Content 20

Units: kg/m3

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

moisture_content_21

field Moisture Content 21

Units: kg/m3

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

moisture_content_22

field Moisture Content 22

Units: kg/m3

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

moisture_content_23

field Moisture Content 23

Units: kg/m3

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

moisture_content_24

field Moisture Content 24

Units: kg/m3

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

moisture_content_25

field Moisture Content 25

Units: kg/m3

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

moisture_content_3

field Moisture Content 3

Units: kg/m3

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

moisture_content_4

field Moisture Content 4

Units: kg/m3

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

moisture_content_5

field Moisture Content 5

Units: kg/m3

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

moisture_content_6

field Moisture Content 6

Units: kg/m3

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

moisture_content_7

field Moisture Content 7

Units: kg/m3

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

moisture_content_8

field Moisture Content 8

Units: kg/m3

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

moisture_content_9

field Moisture Content 9

Units: kg/m3

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

number_of_redistribution_points

field Number of Redistribution points

number of data points

value >= 1

value <= 25

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

class pyidf.surface_construction_elements.MaterialPropertyHeatAndMoistureTransferSettings

Bases: pyidf.helper.DataObject

Corresponds to IDD object MaterialProperty:HeatAndMoistureTransfer:Settings HeatBalanceAlgorithm = CombinedHeatAndMoistureFiniteElement solution algorithm only. Additional material properties for surfaces. Has no effect with other HeatBalanceAlgorithm solution algorithms

initial_water_content_ratio

field Initial Water Content Ratio

units are the water/material density ratio at the beginning of each run period.

Units: kg/kg

Default value: 0.2

Parameters:value (float) – value for IDD Field Initial Water Content Ratio Raises:ValueError – if value is not a valid value Returns:the value of initial_water_content_ratio or None if not set Return type:float

material_name

field Material Name

Material Name that the moisture properties will be added to.

This augments material properties needed for combined heat and moisture transfer for surfaces.

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

porosity

field Porosity

Units: m3/m3

value <= 1.0

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

class pyidf.surface_construction_elements.MaterialPropertyHeatAndMoistureTransferSorptionIsotherm

Bases: pyidf.helper.DataObject

Corresponds to IDD object MaterialProperty:HeatAndMoistureTransfer:SorptionIsotherm HeatBalanceAlgorithm = CombinedHeatAndMoistureFiniteElement solution algorithm only. Relationship between moisture content and relative humidity fraction. Has no effect with other HeatBalanceAlgorithm solution algorithms

material_name

field Material Name

The Material Name that the moisture sorption isotherm will be added to.

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

moisture_content_1

field Moisture Content 1

Units: kg/m3

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

moisture_content_10

field Moisture Content 10

Units: kg/m3

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

moisture_content_11

field Moisture Content 11

Units: kg/m3

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

moisture_content_12

field Moisture Content 12

Units: kg/m3

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

moisture_content_13

field Moisture Content 13

Units: kg/m3

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

moisture_content_14

field Moisture Content 14

Units: kg/m3

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

moisture_content_15

field Moisture Content 15

Units: kg/m3

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

moisture_content_16

field Moisture Content 16

Units: kg/m3

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

moisture_content_17

field Moisture Content 17

Units: kg/m3

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

moisture_content_18

field Moisture Content 18

Units: kg/m3

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

moisture_content_19

field Moisture Content 19

Units: kg/m3

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

moisture_content_2

field Moisture Content 2

Units: kg/m3

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

moisture_content_20

field Moisture Content 20

Units: kg/m3

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

moisture_content_21

field Moisture Content 21

Units: kg/m3

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

moisture_content_22

field Moisture Content 22

Units: kg/m3

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

moisture_content_23

field Moisture Content 23

Units: kg/m3

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

moisture_content_24

field Moisture Content 24

Units: kg/m3

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

moisture_content_25

field Moisture Content 25

Units: kg/m3

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

moisture_content_3

field Moisture Content 3

Units: kg/m3

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

moisture_content_4

field Moisture Content 4

Units: kg/m3

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

moisture_content_5

field Moisture Content 5

Units: kg/m3

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

moisture_content_6

field Moisture Content 6

Units: kg/m3

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

moisture_content_7

field Moisture Content 7

Units: kg/m3

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

moisture_content_8

field Moisture Content 8

Units: kg/m3

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

moisture_content_9

field Moisture Content 9

Units: kg/m3

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

number_of_isotherm_coordinates

field Number of Isotherm Coordinates

Number of data Coordinates

value >= 1

value <= 25

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

relative_humidity_fraction_1

field Relative Humidity Fraction 1

The relative humidity is entered as a fraction.

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Relative Humidity Fraction 1 Raises:ValueError – if value is not a valid value Returns:the value of relative_humidity_fraction_1 or None if not set Return type:float

relative_humidity_fraction_10

field Relative Humidity Fraction 10

The relative humidity is entered as a fraction.

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Relative Humidity Fraction 10 Raises:ValueError – if value is not a valid value Returns:the value of relative_humidity_fraction_10 or None if not set Return type:float

relative_humidity_fraction_11

field Relative Humidity Fraction 11

The relative humidity is entered as a fraction.

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Relative Humidity Fraction 11 Raises:ValueError – if value is not a valid value Returns:the value of relative_humidity_fraction_11 or None if not set Return type:float

relative_humidity_fraction_12

field Relative Humidity Fraction 12

The relative humidity is entered as a fraction.

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Relative Humidity Fraction 12 Raises:ValueError – if value is not a valid value Returns:the value of relative_humidity_fraction_12 or None if not set Return type:float

relative_humidity_fraction_13

field Relative Humidity Fraction 13

The relative humidity is entered as a fraction.

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Relative Humidity Fraction 13 Raises:ValueError – if value is not a valid value Returns:the value of relative_humidity_fraction_13 or None if not set Return type:float

relative_humidity_fraction_14

field Relative Humidity Fraction 14

The relative humidity is entered as a fraction.

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Relative Humidity Fraction 14 Raises:ValueError – if value is not a valid value Returns:the value of relative_humidity_fraction_14 or None if not set Return type:float

relative_humidity_fraction_15

field Relative Humidity Fraction 15

The relative humidity is entered as a fraction.

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Relative Humidity Fraction 15 Raises:ValueError – if value is not a valid value Returns:the value of relative_humidity_fraction_15 or None if not set Return type:float

relative_humidity_fraction_16

field Relative Humidity Fraction 16

The relative humidity is entered as a fraction.

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Relative Humidity Fraction 16 Raises:ValueError – if value is not a valid value Returns:the value of relative_humidity_fraction_16 or None if not set Return type:float

relative_humidity_fraction_17

field Relative Humidity Fraction 17

The relative humidity is entered as a fraction.

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Relative Humidity Fraction 17 Raises:ValueError – if value is not a valid value Returns:the value of relative_humidity_fraction_17 or None if not set Return type:float

relative_humidity_fraction_18

field Relative Humidity Fraction 18

The relative humidity is entered as a fraction.

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Relative Humidity Fraction 18 Raises:ValueError – if value is not a valid value Returns:the value of relative_humidity_fraction_18 or None if not set Return type:float

relative_humidity_fraction_19

field Relative Humidity Fraction 19

The relative humidity is entered as a fraction.

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Relative Humidity Fraction 19 Raises:ValueError – if value is not a valid value Returns:the value of relative_humidity_fraction_19 or None if not set Return type:float

relative_humidity_fraction_2

field Relative Humidity Fraction 2

The relative humidity is entered as a fraction.

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Relative Humidity Fraction 2 Raises:ValueError – if value is not a valid value Returns:the value of relative_humidity_fraction_2 or None if not set Return type:float

relative_humidity_fraction_20

field Relative Humidity Fraction 20

The relative humidity is entered as a fraction.

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Relative Humidity Fraction 20 Raises:ValueError – if value is not a valid value Returns:the value of relative_humidity_fraction_20 or None if not set Return type:float

relative_humidity_fraction_21

field Relative Humidity Fraction 21

The relative humidity is entered as a fraction.

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Relative Humidity Fraction 21 Raises:ValueError – if value is not a valid value Returns:the value of relative_humidity_fraction_21 or None if not set Return type:float

relative_humidity_fraction_22

field Relative Humidity Fraction 22

The relative humidity is entered as a fraction.

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Relative Humidity Fraction 22 Raises:ValueError – if value is not a valid value Returns:the value of relative_humidity_fraction_22 or None if not set Return type:float

relative_humidity_fraction_23

field Relative Humidity Fraction 23

The relative humidity is entered as a fraction.

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Relative Humidity Fraction 23 Raises:ValueError – if value is not a valid value Returns:the value of relative_humidity_fraction_23 or None if not set Return type:float

relative_humidity_fraction_24

field Relative Humidity Fraction 24

The relative humidity is entered as a fraction.

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Relative Humidity Fraction 24 Raises:ValueError – if value is not a valid value Returns:the value of relative_humidity_fraction_24 or None if not set Return type:float

relative_humidity_fraction_25

field Relative Humidity Fraction 25

The relative humidity is entered as a fraction.

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Relative Humidity Fraction 25 Raises:ValueError – if value is not a valid value Returns:the value of relative_humidity_fraction_25 or None if not set Return type:float

relative_humidity_fraction_3

field Relative Humidity Fraction 3

The relative humidity is entered as a fraction.

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Relative Humidity Fraction 3 Raises:ValueError – if value is not a valid value Returns:the value of relative_humidity_fraction_3 or None if not set Return type:float

relative_humidity_fraction_4

field Relative Humidity Fraction 4

The relative humidity is entered as a fraction.

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Relative Humidity Fraction 4 Raises:ValueError – if value is not a valid value Returns:the value of relative_humidity_fraction_4 or None if not set Return type:float

relative_humidity_fraction_5

field Relative Humidity Fraction 5

The relative humidity is entered as a fraction.

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Relative Humidity Fraction 5 Raises:ValueError – if value is not a valid value Returns:the value of relative_humidity_fraction_5 or None if not set Return type:float

relative_humidity_fraction_6

field Relative Humidity Fraction 6

The relative humidity is entered as a fraction.

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Relative Humidity Fraction 6 Raises:ValueError – if value is not a valid value Returns:the value of relative_humidity_fraction_6 or None if not set Return type:float

relative_humidity_fraction_7

field Relative Humidity Fraction 7

The relative humidity is entered as a fraction.

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Relative Humidity Fraction 7 Raises:ValueError – if value is not a valid value Returns:the value of relative_humidity_fraction_7 or None if not set Return type:float

relative_humidity_fraction_8

field Relative Humidity Fraction 8

The relative humidity is entered as a fraction.

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Relative Humidity Fraction 8 Raises:ValueError – if value is not a valid value Returns:the value of relative_humidity_fraction_8 or None if not set Return type:float

relative_humidity_fraction_9

field Relative Humidity Fraction 9

The relative humidity is entered as a fraction.

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Relative Humidity Fraction 9 Raises:ValueError – if value is not a valid value Returns:the value of relative_humidity_fraction_9 or None if not set Return type:float

class pyidf.surface_construction_elements.MaterialPropertyHeatAndMoistureTransferSuction

Bases: pyidf.helper.DataObject

Corresponds to IDD object MaterialProperty:HeatAndMoistureTransfer:Suction HeatBalanceAlgorithm = CombinedHeatAndMoistureFiniteElement solution algorithm only. Relationship between liquid suction transport coefficient and moisture content Has no effect with other HeatBalanceAlgorithm solution algorithms

liquid_transport_coefficient_1

field Liquid Transport Coefficient 1

Units: m2/s

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

liquid_transport_coefficient_10

field Liquid Transport Coefficient 10

Units: m2/s

Parameters:value (float) – value for IDD Field Liquid Transport Coefficient 10 Raises:ValueError – if value is not a valid value Returns:the value of liquid_transport_coefficient_10 or None if not set Return type:float

liquid_transport_coefficient_11

field Liquid Transport Coefficient 11

Units: m2/s

Parameters:value (float) – value for IDD Field Liquid Transport Coefficient 11 Raises:ValueError – if value is not a valid value Returns:the value of liquid_transport_coefficient_11 or None if not set Return type:float

liquid_transport_coefficient_12

field Liquid Transport Coefficient 12

Units: m2/s

Parameters:value (float) – value for IDD Field Liquid Transport Coefficient 12 Raises:ValueError – if value is not a valid value Returns:the value of liquid_transport_coefficient_12 or None if not set Return type:float

liquid_transport_coefficient_13

field Liquid Transport Coefficient 13

Units: m2/s

Parameters:value (float) – value for IDD Field Liquid Transport Coefficient 13 Raises:ValueError – if value is not a valid value Returns:the value of liquid_transport_coefficient_13 or None if not set Return type:float

liquid_transport_coefficient_14

field Liquid Transport Coefficient 14

Units: m2/s

Parameters:value (float) – value for IDD Field Liquid Transport Coefficient 14 Raises:ValueError – if value is not a valid value Returns:the value of liquid_transport_coefficient_14 or None if not set Return type:float

liquid_transport_coefficient_15

field Liquid Transport Coefficient 15

Units: m2/s

Parameters:value (float) – value for IDD Field Liquid Transport Coefficient 15 Raises:ValueError – if value is not a valid value Returns:the value of liquid_transport_coefficient_15 or None if not set Return type:float

liquid_transport_coefficient_16

field Liquid Transport Coefficient 16

Units: m2/s

Parameters:value (float) – value for IDD Field Liquid Transport Coefficient 16 Raises:ValueError – if value is not a valid value Returns:the value of liquid_transport_coefficient_16 or None if not set Return type:float

liquid_transport_coefficient_17

field Liquid Transport Coefficient 17

Units: m2/s

Parameters:value (float) – value for IDD Field Liquid Transport Coefficient 17 Raises:ValueError – if value is not a valid value Returns:the value of liquid_transport_coefficient_17 or None if not set Return type:float

liquid_transport_coefficient_18

field Liquid Transport Coefficient 18

Units: m2/s

Parameters:value (float) – value for IDD Field Liquid Transport Coefficient 18 Raises:ValueError – if value is not a valid value Returns:the value of liquid_transport_coefficient_18 or None if not set Return type:float

liquid_transport_coefficient_19

field Liquid Transport Coefficient 19

Units: m2/s

Parameters:value (float) – value for IDD Field Liquid Transport Coefficient 19 Raises:ValueError – if value is not a valid value Returns:the value of liquid_transport_coefficient_19 or None if not set Return type:float

liquid_transport_coefficient_2

field Liquid Transport Coefficient 2

Units: m2/s

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

liquid_transport_coefficient_20

field Liquid Transport Coefficient 20

Units: m2/s

Parameters:value (float) – value for IDD Field Liquid Transport Coefficient 20 Raises:ValueError – if value is not a valid value Returns:the value of liquid_transport_coefficient_20 or None if not set Return type:float

liquid_transport_coefficient_21

field Liquid Transport Coefficient 21

Units: m2/s

Parameters:value (float) – value for IDD Field Liquid Transport Coefficient 21 Raises:ValueError – if value is not a valid value Returns:the value of liquid_transport_coefficient_21 or None if not set Return type:float

liquid_transport_coefficient_22

field Liquid Transport Coefficient 22

Units: m2/s

Parameters:value (float) – value for IDD Field Liquid Transport Coefficient 22 Raises:ValueError – if value is not a valid value Returns:the value of liquid_transport_coefficient_22 or None if not set Return type:float

liquid_transport_coefficient_23

field Liquid Transport Coefficient 23

Units: m2/s

Parameters:value (float) – value for IDD Field Liquid Transport Coefficient 23 Raises:ValueError – if value is not a valid value Returns:the value of liquid_transport_coefficient_23 or None if not set Return type:float

liquid_transport_coefficient_24

field Liquid Transport Coefficient 24

Units: m2/s

Parameters:value (float) – value for IDD Field Liquid Transport Coefficient 24 Raises:ValueError – if value is not a valid value Returns:the value of liquid_transport_coefficient_24 or None if not set Return type:float

liquid_transport_coefficient_25

field Liquid Transport Coefficient 25

Units: m2/s

Parameters:value (float) – value for IDD Field Liquid Transport Coefficient 25 Raises:ValueError – if value is not a valid value Returns:the value of liquid_transport_coefficient_25 or None if not set Return type:float

liquid_transport_coefficient_3

field Liquid Transport Coefficient 3

Units: m2/s

Parameters:value (float) – value for IDD Field Liquid Transport Coefficient 3 Raises:ValueError – if value is not a valid value Returns:the value of liquid_transport_coefficient_3 or None if not set Return type:float

liquid_transport_coefficient_4

field Liquid Transport Coefficient 4

Units: m2/s

Parameters:value (float) – value for IDD Field Liquid Transport Coefficient 4 Raises:ValueError – if value is not a valid value Returns:the value of liquid_transport_coefficient_4 or None if not set Return type:float

liquid_transport_coefficient_5

field Liquid Transport Coefficient 5

Units: m2/s

Parameters:value (float) – value for IDD Field Liquid Transport Coefficient 5 Raises:ValueError – if value is not a valid value Returns:the value of liquid_transport_coefficient_5 or None if not set Return type:float

liquid_transport_coefficient_6

field Liquid Transport Coefficient 6

Units: m2/s

Parameters:value (float) – value for IDD Field Liquid Transport Coefficient 6 Raises:ValueError – if value is not a valid value Returns:the value of liquid_transport_coefficient_6 or None if not set Return type:float

liquid_transport_coefficient_7

field Liquid Transport Coefficient 7

Units: m2/s

Parameters:value (float) – value for IDD Field Liquid Transport Coefficient 7 Raises:ValueError – if value is not a valid value Returns:the value of liquid_transport_coefficient_7 or None if not set Return type:float

liquid_transport_coefficient_8

field Liquid Transport Coefficient 8

Units: m2/s

Parameters:value (float) – value for IDD Field Liquid Transport Coefficient 8 Raises:ValueError – if value is not a valid value Returns:the value of liquid_transport_coefficient_8 or None if not set Return type:float

liquid_transport_coefficient_9

field Liquid Transport Coefficient 9

Units: m2/s

Parameters:value (float) – value for IDD Field Liquid Transport Coefficient 9 Raises:ValueError – if value is not a valid value Returns:the value of liquid_transport_coefficient_9 or None if not set Return type:float

material_name

field Material Name

Material Name that the moisture properties will be added to.

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

moisture_content_1

field Moisture Content 1

Units: kg/m3

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

moisture_content_10

field Moisture Content 10

Units: kg/m3

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

moisture_content_11

field Moisture Content 11

Units: kg/m3

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

moisture_content_12

field Moisture Content 12

Units: kg/m3

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

moisture_content_13

field Moisture Content 13

Units: kg/m3

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

moisture_content_14

field Moisture Content 14

Units: kg/m3

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

moisture_content_15

field Moisture Content 15

Units: kg/m3

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

moisture_content_16

field Moisture Content 16

Units: kg/m3

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

moisture_content_17

field Moisture Content 17

Units: kg/m3

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

moisture_content_18

field Moisture Content 18

Units: kg/m3

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

moisture_content_19

field Moisture Content 19

Units: kg/m3

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

moisture_content_2

field Moisture Content 2

Units: kg/m3

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

moisture_content_20

field Moisture Content 20

Units: kg/m3

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

moisture_content_21

field Moisture Content 21

Units: kg/m3

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

moisture_content_22

field Moisture Content 22

Units: kg/m3

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

moisture_content_23

field Moisture Content 23

Units: kg/m3

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

moisture_content_24

field Moisture Content 24

Units: kg/m3

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

moisture_content_25

field Moisture Content 25

Units: kg/m3

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

moisture_content_3

field Moisture Content 3

Units: kg/m3

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

moisture_content_4

field Moisture Content 4

Units: kg/m3

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

moisture_content_5

field Moisture Content 5

Units: kg/m3

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

moisture_content_6

field Moisture Content 6

Units: kg/m3

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

moisture_content_7

field Moisture Content 7

Units: kg/m3

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

moisture_content_8

field Moisture Content 8

Units: kg/m3

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

moisture_content_9

field Moisture Content 9

Units: kg/m3

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

number_of_suction_points

field Number of Suction points

Number of Suction Liquid Transport Coefficient coordinates

value >= 1

value <= 25

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

class pyidf.surface_construction_elements.MaterialPropertyHeatAndMoistureTransferThermalConductivity

Bases: pyidf.helper.DataObject

Corresponds to IDD object MaterialProperty:HeatAndMoistureTransfer:ThermalConductivity HeatBalanceAlgorithm = CombinedHeatAndMoistureFiniteElement solution algorithm only. Relationship between thermal conductivity and moisture content Has no effect with other HeatBalanceAlgorithm solution algorithms

material_name

field Material Name

Moisture Material Name that the Thermal Conductivity will be added to.

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

moisture_content_1

field Moisture Content 1

Units: kg/m3

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

moisture_content_10

field Moisture Content 10

Units: kg/m3

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

moisture_content_11

field Moisture Content 11

Units: kg/m3

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

moisture_content_12

field Moisture Content 12

Units: kg/m3

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

moisture_content_13

field Moisture Content 13

Units: kg/m3

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

moisture_content_14

field Moisture Content 14

Units: kg/m3

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

moisture_content_15

field Moisture Content 15

Units: kg/m3

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

moisture_content_16

field Moisture Content 16

Units: kg/m3

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

moisture_content_17

field Moisture Content 17

Units: kg/m3

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

moisture_content_18

field Moisture Content 18

Units: kg/m3

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

moisture_content_19

field Moisture Content 19

Units: kg/m3

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

moisture_content_2

field Moisture Content 2

Units: kg/m3

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

moisture_content_20

field Moisture Content 20

Units: kg/m3

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

moisture_content_21

field Moisture Content 21

Units: kg/m3

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

moisture_content_22

field Moisture Content 22

Units: kg/m3

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

moisture_content_23

field Moisture Content 23

Units: kg/m3

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

moisture_content_24

field Moisture Content 24

Units: kg/m3

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

moisture_content_25

field Moisture Content 25

Units: kg/m3

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

moisture_content_3

field Moisture Content 3

Units: kg/m3

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

moisture_content_4

field Moisture Content 4

Units: kg/m3

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

moisture_content_5

field Moisture Content 5

Units: kg/m3

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

moisture_content_6

field Moisture Content 6

Units: kg/m3

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

moisture_content_7

field Moisture Content 7

Units: kg/m3

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

moisture_content_8

field Moisture Content 8

Units: kg/m3

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

moisture_content_9

field Moisture Content 9

Units: kg/m3

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

number_of_thermal_coordinates

field Number of Thermal Coordinates

number of data coordinates

value >= 1

value <= 25

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

thermal_conductivity_1

field Thermal Conductivity 1

Units: W/m-K

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

thermal_conductivity_10

field Thermal Conductivity 10

Units: W/m-K

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

thermal_conductivity_11

field Thermal Conductivity 11

Units: W/m-K

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

thermal_conductivity_12

field Thermal Conductivity 12

Units: W/m-K

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

thermal_conductivity_13

field Thermal Conductivity 13

Units: W/m-K

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

thermal_conductivity_14

field Thermal Conductivity 14

Units: W/m-K

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

thermal_conductivity_15

field Thermal Conductivity 15

Units: W/m-K

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

thermal_conductivity_16

field Thermal Conductivity 16

Units: W/m-K

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

thermal_conductivity_17

field Thermal Conductivity 17

Units: W/m-K

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

thermal_conductivity_18

field Thermal Conductivity 18

Units: W/m-K

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

thermal_conductivity_19

field Thermal Conductivity 19

Units: W/m-K

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

thermal_conductivity_2

field Thermal Conductivity 2

Units: W/m-K

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

thermal_conductivity_20

field Thermal Conductivity 20

Units: W/m-K

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

thermal_conductivity_21

field Thermal Conductivity 21

Units: W/m-K

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

thermal_conductivity_22

field Thermal Conductivity 22

Units: W/m-K

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

thermal_conductivity_23

field Thermal Conductivity 23

Units: W/m-K

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

thermal_conductivity_24

field Thermal Conductivity 24

Units: W/m-K

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

thermal_conductivity_25

field Thermal Conductivity 25

Units: W/m-K

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

thermal_conductivity_3

field Thermal Conductivity 3

Units: W/m-K

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

thermal_conductivity_4

field Thermal Conductivity 4

Units: W/m-K

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

thermal_conductivity_5

field Thermal Conductivity 5

Units: W/m-K

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

thermal_conductivity_6

field Thermal Conductivity 6

Units: W/m-K

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

thermal_conductivity_7

field Thermal Conductivity 7

Units: W/m-K

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

thermal_conductivity_8

field Thermal Conductivity 8

Units: W/m-K

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

thermal_conductivity_9

field Thermal Conductivity 9

Units: W/m-K

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

class pyidf.surface_construction_elements.MaterialPropertyMoisturePenetrationDepthSettings

Bases: pyidf.helper.DataObject

Corresponds to IDD object MaterialProperty:MoisturePenetrationDepth:Settings Additional properties for moisture using EMPD procedure HeatBalanceAlgorithm choice=MoisturePenetrationDepthConductionTransferFunction only Has no effect with other HeatBalanceAlgorithm solution algorithms

moisture_equation_coefficient_a

field Moisture Equation Coefficient a

Units: dimensionless

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

moisture_equation_coefficient_b

field Moisture Equation Coefficient b

Units: dimensionless

Parameters:value (float) – value for IDD Field Moisture Equation Coefficient b Raises:ValueError – if value is not a valid value Returns:the value of moisture_equation_coefficient_b or None if not set Return type:float

moisture_equation_coefficient_c

field Moisture Equation Coefficient c

Units: dimensionless

Parameters:value (float) – value for IDD Field Moisture Equation Coefficient c Raises:ValueError – if value is not a valid value Returns:the value of moisture_equation_coefficient_c or None if not set Return type:float

moisture_equation_coefficient_d

field Moisture Equation Coefficient d

Units: dimensionless

Parameters:value (float) – value for IDD Field Moisture Equation Coefficient d Raises:ValueError – if value is not a valid value Returns:the value of moisture_equation_coefficient_d or None if not set Return type:float

moisture_penetration_depth

field Moisture Penetration Depth

This is the penetration depth

Units: m

Parameters:value (float) – value for IDD Field Moisture Penetration Depth Raises:ValueError – if value is not a valid value Returns:the value of moisture_penetration_depth or None if not set Return type:float

name

field Name

Material Name that the moisture properties will be added to.

Additional material properties required to perform the EMPD model.

Effective Mean Penetration Depth (EMPD)

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.surface_construction_elements.MaterialPropertyPhaseChange

Bases: pyidf.helper.DataObject

Corresponds to IDD object MaterialProperty:PhaseChange Additional properties for temperature dependent thermal conductivity and enthalpy for Phase Change Materials (PCM) HeatBalanceAlgorithm = CondFD(ConductionFiniteDifference) solution algorithm only. Constructions with this should use the detailed CondFD process. Has no effect with other HeatBalanceAlgorithm solution algorithms

enthalpy_1

field Enthalpy 1

for Temperature-enthalpy function corresponding to temperature 1

Units: J/kg

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

enthalpy_10

field Enthalpy 10

for Temperature-enthalpy function corresponding to temperature 2

Units: J/kg

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

enthalpy_11

field Enthalpy 11

for Temperature-enthalpy function corresponding to temperature 3

Units: J/kg

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

enthalpy_12

field Enthalpy 12

for Temperature-enthalpy function corresponding to temperature 14

Units: J/kg

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

enthalpy_13

field Enthalpy 13

for Temperature-enthalpy function corresponding to temperature 15

Units: J/kg

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

enthalpy_14

field Enthalpy 14

for Temperature-enthalpy function corresponding to temperature 16

Units: J/kg

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

enthalpy_15

field Enthalpy 15

for Temperature-enthalpy function corresponding to temperature 17

Units: J/kg

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

enthalpy_16

field Enthalpy 16

for Temperature-enthalpy function corresponding to temperature 16

Units: J/kg

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

enthalpy_2

field Enthalpy 2

for Temperature-enthalpy function corresponding to temperature 2

Units: J/kg

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

enthalpy_3

field Enthalpy 3

for Temperature-enthalpy function corresponding to temperature 3

Units: J/kg

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

enthalpy_4

field Enthalpy 4

for Temperature-enthalpy function corresponding to temperature 4

Units: J/kg

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

enthalpy_5

field Enthalpy 5

for Temperature-enthalpy function corresponding to temperature 5

Units: J/kg

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

enthalpy_6

field Enthalpy 6

for Temperature-enthalpy function corresponding to temperature 6

Units: J/kg

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

enthalpy_7

field Enthalpy 7

for Temperature-enthalpy function corresponding to temperature 7

Units: J/kg

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

enthalpy_8

field Enthalpy 8

for Temperature-enthalpy function corresponding to temperature 8

Units: J/kg

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

enthalpy_9

field Enthalpy 9

for Temperature-enthalpy function corresponding to temperature 1

Units: J/kg

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

name

field Name

Regular Material Name to which the additional properties will be added.

this the material name for the basic material properties.

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

temperature_1

field Temperature 1

for Temperature-enthalpy function

Units: C

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

temperature_10

field Temperature 10

for Temperature-enthalpy function

Units: C

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

temperature_11

field Temperature 11

for Temperature-enthalpy function

Units: C

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

temperature_12

field Temperature 12

for Temperature-enthalpy function

Units: C

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

temperature_13

field Temperature 13

for Temperature-enthalpy function

Units: C

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

temperature_14

field Temperature 14

for Temperature-enthalpy function

Units: C

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

temperature_15

field Temperature 15

for Temperature-enthalpy function

Units: C

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

temperature_16

field Temperature 16

for Temperature-enthalpy function

Units: C

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

temperature_2

field Temperature 2

for Temperature-enthalpy function

Units: C

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

temperature_3

field Temperature 3

for Temperature-enthalpy function

Units: C

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

temperature_4

field Temperature 4

for Temperature-enthalpy function

Units: C

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

temperature_5

field Temperature 5

for Temperature-enthalpy function

Units: C

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

temperature_6

field Temperature 6

for Temperature-enthalpy function

Units: C

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

temperature_7

field Temperature 7

for Temperature-enthalpy function

Units: C

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

temperature_8

field Temperature 8

for Temperature-enthalpy function

Units: C

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

temperature_9

field Temperature 9

for Temperature-enthalpy function

Units: C

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

temperature_coefficient_for_thermal_conductivity

field Temperature Coefficient for Thermal Conductivity

The base temperature is 20C.

This is the thermal conductivity change per degree excursion from 20C.

This variable conductivity function is overridden by the VariableThermalConductivity object, if present.

Units: W/m-K2

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

class pyidf.surface_construction_elements.MaterialPropertyVariableThermalConductivity

Bases: pyidf.helper.DataObject

Corresponds to IDD object MaterialProperty:VariableThermalConductivity Additional properties for temperature dependent thermal conductivity using piecewise linear temperature-conductivity function. HeatBalanceAlgorithm = CondFD(ConductionFiniteDifference) solution algorithm only. Has no effect with other HeatBalanceAlgorithm solution algorithms

name

field Name

Regular Material Name to which the additional properties will be added.

this the material name for the basic material properties.

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

temperature_1

field Temperature 1

for Temperature-Thermal Conductivity function

Units: C

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

temperature_10

field Temperature 10

for Temperature-Thermal Conductivity function

Units: C

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

temperature_2

field Temperature 2

for Temperature-Thermal Conductivity function

Units: C

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

temperature_3

field Temperature 3

for Temperature-Thermal Conductivity function

Units: C

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

temperature_4

field Temperature 4

for Temperature-Thermal Conductivity function

Units: C

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

temperature_5

field Temperature 5

for Temperature-Thermal Conductivity function

Units: C

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

temperature_6

field Temperature 6

for Temperature-Thermal Conductivity function

Units: C

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

temperature_7

field Temperature 7

for Temperature-Thermal Conductivity function

Units: C

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

temperature_8

field Temperature 8

for Temperature-Thermal Conductivity function

Units: C

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

temperature_9

field Temperature 9

for Temperature-Thermal Conductivity function

Units: C

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

thermal_conductivity_1

field Thermal Conductivity 1

for Temperature-Thermal Conductivity function corresponding to temperature 1

Units: W/m-K

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

thermal_conductivity_10

field Thermal Conductivity 10

for Temperature-Thermal Conductivity function corresponding to temperature 10

Units: W/m-K

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

thermal_conductivity_2

field Thermal Conductivity 2

for Temperature-Thermal Conductivity function corresponding to temperature 2

Units: W/m-K

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

thermal_conductivity_3

field Thermal Conductivity 3

for Temperature-Thermal Conductivity function corresponding to temperature 3

Units: W/m-K

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

thermal_conductivity_4

field Thermal Conductivity 4

for Temperature-Thermal Conductivity function corresponding to temperature 4

Units: W/m-K

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

thermal_conductivity_5

field Thermal Conductivity 5

for Temperature-Thermal Conductivity function corresponding to temperature 5

Units: W/m-K

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

thermal_conductivity_6

field Thermal Conductivity 6

for Temperature-Thermal Conductivity function corresponding to temperature 6

Units: W/m-K

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

thermal_conductivity_7

field Thermal Conductivity 7

for Temperature-Thermal Conductivity function corresponding to temperature 7

Units: W/m-K

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

thermal_conductivity_8

field Thermal Conductivity 8

for Temperature-Thermal Conductivity function corresponding to temperature 8

Units: W/m-K

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

thermal_conductivity_9

field Thermal Conductivity 9

for Temperature-Thermal Conductivity function corresponding to temperature 9

Units: W/m-K

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

class pyidf.surface_construction_elements.MaterialRoofVegetation

Bases: pyidf.helper.DataObject

Corresponds to IDD object Material:RoofVegetation EcoRoof model, plant layer plus soil layer Implemented by Portland State University (Sailor et al., January, 2007) only one material must be referenced per simulation though the same EcoRoof material could be used in multiple constructions. New moisture redistribution scheme (2010) requires higher number of timesteps per hour (minimum 12 recommended).

conductivity_of_dry_soil

field Conductivity of Dry Soil

Thermal conductivity of dry soil.

Typical ecoroof soils range from 0.3 to 0.5

Units: W/m-K

Default value: 0.35

value >= 0.2

value <= 1.5

Parameters:value (float) – value for IDD Field Conductivity of Dry Soil Raises:ValueError – if value is not a valid value Returns:the value of conductivity_of_dry_soil or None if not set Return type:float

density_of_dry_soil

field Density of Dry Soil

Density of dry soil (the code modifies this as the soil becomes moist)

Typical ecoroof soils range from 400 to 1000 (dry to wet)

Units: kg/m3

Default value: 1100.0

value >= 300.0

value <= 2000.0

Parameters:value (float) – value for IDD Field Density of Dry Soil Raises:ValueError – if value is not a valid value Returns:the value of density_of_dry_soil or None if not set Return type:float

height_of_plants

field Height of Plants

The ecoroof module is designed for short plants and shrubs.

Units: m

Default value: 0.2

value > 0.005

value <= 1.0

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

initial_volumetric_moisture_content_of_the_soil_layer

field Initial Volumetric Moisture Content of the Soil Layer

Default value: 0.1

value > 0.05

value <= 0.5

Parameters:value (float) – value for IDD Field Initial Volumetric Moisture Content of the Soil Layer Raises:ValueError – if value is not a valid value Returns:the value of initial_volumetric_moisture_content_of_the_soil_layer or None if not set Return type:float

leaf_area_index

field Leaf Area Index

Entire surface is assumed covered, so decrease LAI accordingly.

Units: dimensionless

Default value: 1.0

value > 0.001

value <= 5.0

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

leaf_emissivity

field Leaf Emissivity

Default value: 0.95

value >= 0.8

value <= 1.0

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

leaf_reflectivity

field Leaf Reflectivity

Leaf reflectivity (albedo) is typically 0.18-0.25

Units: dimensionless

Default value: 0.22

value >= 0.05

value <= 0.5

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

minimum_stomatal_resistance

field Minimum Stomatal Resistance

This depends upon plant type

Units: s/m

Default value: 180.0

value >= 50.0

value <= 300.0

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

moisture_diffusion_calculation_method

field Moisture Diffusion Calculation Method

Advanced calculation requires increased number of timesteps (recommended >20).

Default value: Advanced

Parameters:value (str) – value for IDD Field Moisture Diffusion Calculation Method Raises:ValueError – if value is not a valid value Returns:the value of moisture_diffusion_calculation_method 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

residual_volumetric_moisture_content_of_the_soil_layer

field Residual Volumetric Moisture Content of the Soil Layer

Default value: 0.01

value >= 0.01

value <= 0.1

Parameters:value (float) – value for IDD Field Residual Volumetric Moisture Content of the Soil Layer Raises:ValueError – if value is not a valid value Returns:the value of residual_volumetric_moisture_content_of_the_soil_layer or None if not set Return type:float

roughness

field Roughness

Default value: MediumRough

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

saturation_volumetric_moisture_content_of_the_soil_layer

field Saturation Volumetric Moisture Content of the Soil Layer

Maximum moisture content is typically less than 0.5

Default value: 0.3

value > 0.1

value <= 0.5

Parameters:value (float) – value for IDD Field Saturation Volumetric Moisture Content of the Soil Layer Raises:ValueError – if value is not a valid value Returns:the value of saturation_volumetric_moisture_content_of_the_soil_layer or None if not set Return type:float

soil_layer_name

field Soil Layer Name

Default value: Green Roof Soil

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

solar_absorptance

field Solar Absorptance

Solar absorptance of dry soil (1-albedo) is typically 0.60 to 0.85

corresponding to a dry albedo of 0.15 to 0.40

Default value: 0.7

value >= 0.4

value <= 0.9

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

specific_heat_of_dry_soil

field Specific Heat of Dry Soil

Specific heat of dry soil

Units: J/kg-K

Default value: 1200.0

value > 500.0

value <= 2000.0

Parameters:value (float) – value for IDD Field Specific Heat of Dry Soil Raises:ValueError – if value is not a valid value Returns:the value of specific_heat_of_dry_soil or None if not set Return type:float

thermal_absorptance

field Thermal Absorptance

Soil emissivity is typically in range of 0.90 to 0.98

Default value: 0.9

value > 0.8

value <= 1.0

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

thickness

field Thickness

thickness of the soil layer of the EcoRoof

Soil depths of 0.15m (6in) and 0.30m (12in) are common.

Units: m

IP-Units: in

Default value: 0.1

value > 0.05

value <= 0.7

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

visible_absorptance

field Visible Absorptance

Default value: 0.75

value > 0.5

value <= 1.0

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

class pyidf.surface_construction_elements.WindowGapDeflectionState

Bases: pyidf.helper.DataObject

Corresponds to IDD object WindowGap:DeflectionState Used to enter data describing deflection state of the gap. It is referenced from WindowMaterial:Gap object only and it is used only when deflection model is set to MeasuredDeflection, otherwise it is ignored.

deflected_thickness

field Deflected Thickness

If left blank will be considered that gap has no deflection.

Units: m

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

initial_pressure

field Initial Pressure

Units: Pa

Default value: 101325.0

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

initial_temperature

field Initial Temperature

Units: C

Default value: 25.0

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

name

field Name

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

class pyidf.surface_construction_elements.WindowGapSupportPillar

Bases: pyidf.helper.DataObject

Corresponds to IDD object WindowGap:SupportPillar used to define pillar geometry for support pillars

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

radius

field Radius

Units: m

Default value: 0.0004

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

spacing

field Spacing

Units: m

Default value: 0.04

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

class pyidf.surface_construction_elements.WindowMaterialBlind

Bases: pyidf.helper.DataObject

Corresponds to IDD object WindowMaterial:Blind Window blind thermal properties

back_side_slat_beam_solar_reflectance

field Back Side Slat Beam Solar Reflectance

value < 1.0

Parameters:value (float) – value for IDD Field Back Side Slat Beam Solar Reflectance Raises:ValueError – if value is not a valid value Returns:the value of back_side_slat_beam_solar_reflectance or None if not set Return type:float

back_side_slat_beam_visible_reflectance

field Back Side Slat Beam Visible Reflectance

Required for detailed daylighting calculation

value < 1.0

Parameters:value (float) – value for IDD Field Back Side Slat Beam Visible Reflectance Raises:ValueError – if value is not a valid value Returns:the value of back_side_slat_beam_visible_reflectance or None if not set Return type:float

back_side_slat_diffuse_solar_reflectance

field Back Side Slat Diffuse Solar Reflectance

Must equal “Back Side Slat Beam Solar Reflectance”

value < 1.0

Parameters:value (float) – value for IDD Field Back Side Slat Diffuse Solar Reflectance Raises:ValueError – if value is not a valid value Returns:the value of back_side_slat_diffuse_solar_reflectance or None if not set Return type:float

back_side_slat_diffuse_visible_reflectance

field Back Side Slat Diffuse Visible Reflectance

Required for detailed daylighting calculation

Must equal “Back Side Slat Beam Visible Reflectance”

value < 1.0

Parameters:value (float) – value for IDD Field Back Side Slat Diffuse Visible Reflectance Raises:ValueError – if value is not a valid value Returns:the value of back_side_slat_diffuse_visible_reflectance or None if not set Return type:float

back_side_slat_infrared_hemispherical_emissivity

field Back Side Slat Infrared Hemispherical Emissivity

Default value: 0.9

value < 1.0

Parameters:value (float) – value for IDD Field Back Side Slat Infrared Hemispherical Emissivity Raises:ValueError – if value is not a valid value Returns:the value of back_side_slat_infrared_hemispherical_emissivity or None if not set Return type:float

blind_bottom_opening_multiplier

field Blind Bottom Opening Multiplier

value <= 1.0

Parameters:value (float) – value for IDD Field Blind Bottom Opening Multiplier Raises:ValueError – if value is not a valid value Returns:the value of blind_bottom_opening_multiplier or None if not set Return type:float

blind_left_side_opening_multiplier

field Blind Left Side Opening Multiplier

Default value: 0.5

value <= 1.0

Parameters:value (float) – value for IDD Field Blind Left Side Opening Multiplier Raises:ValueError – if value is not a valid value Returns:the value of blind_left_side_opening_multiplier or None if not set Return type:float

blind_right_side_opening_multiplier

field Blind Right Side Opening Multiplier

Default value: 0.5

value <= 1.0

Parameters:value (float) – value for IDD Field Blind Right Side Opening Multiplier Raises:ValueError – if value is not a valid value Returns:the value of blind_right_side_opening_multiplier or None if not set Return type:float

blind_to_glass_distance

field Blind to Glass Distance

Units: m

IP-Units: in

Default value: 0.05

value >= 0.01

value <= 1.0

Parameters:value (float) – value for IDD Field Blind to Glass Distance Raises:ValueError – if value is not a valid value Returns:the value of blind_to_glass_distance or None if not set Return type:float

blind_top_opening_multiplier

field Blind Top Opening Multiplier

Default value: 0.5

value <= 1.0

Parameters:value (float) – value for IDD Field Blind Top Opening Multiplier Raises:ValueError – if value is not a valid value Returns:the value of blind_top_opening_multiplier or None if not set Return type:float

front_side_slat_beam_solar_reflectance

field Front Side Slat Beam Solar Reflectance

value < 1.0

Parameters:value (float) – value for IDD Field Front Side Slat Beam Solar Reflectance Raises:ValueError – if value is not a valid value Returns:the value of front_side_slat_beam_solar_reflectance or None if not set Return type:float

front_side_slat_beam_visible_reflectance

field Front Side Slat Beam Visible Reflectance

Required for detailed daylighting calculation

value < 1.0

Parameters:value (float) – value for IDD Field Front Side Slat Beam Visible Reflectance Raises:ValueError – if value is not a valid value Returns:the value of front_side_slat_beam_visible_reflectance or None if not set Return type:float

front_side_slat_diffuse_solar_reflectance

field Front Side Slat Diffuse Solar Reflectance

Must equal “Front Side Slat Beam Solar Reflectance”

value < 1.0

Parameters:value (float) – value for IDD Field Front Side Slat Diffuse Solar Reflectance Raises:ValueError – if value is not a valid value Returns:the value of front_side_slat_diffuse_solar_reflectance or None if not set Return type:float

front_side_slat_diffuse_visible_reflectance

field Front Side Slat Diffuse Visible Reflectance

Required for detailed daylighting calculation

Must equal “Front Side Slat Beam Visible Reflectance”

value < 1.0

Parameters:value (float) – value for IDD Field Front Side Slat Diffuse Visible Reflectance Raises:ValueError – if value is not a valid value Returns:the value of front_side_slat_diffuse_visible_reflectance or None if not set Return type:float

front_side_slat_infrared_hemispherical_emissivity

field Front Side Slat Infrared Hemispherical Emissivity

Default value: 0.9

value < 1.0

Parameters:value (float) – value for IDD Field Front Side Slat Infrared Hemispherical Emissivity Raises:ValueError – if value is not a valid value Returns:the value of front_side_slat_infrared_hemispherical_emissivity or None if not set Return type:float

maximum_slat_angle

field Maximum Slat Angle

Used only if WindowProperty:ShadingControl for the window that incorporates

this blind varies the slat angle (i.e., WindowProperty:ShadingControl with

Type of Slat Angle Control for Blinds = ScheduledSlatAngle

or BlockBeamSolar)

Units: deg

Default value: 180.0

value <= 180.0

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

minimum_slat_angle

field Minimum Slat Angle

Used only if WindowProperty:ShadingControl for the window that incorporates

this blind varies the slat angle (i.e., WindowProperty:ShadingControl with

Type of Slat Angle Control for Blinds = ScheduledSlatAngle

or BlockBeamSolar)

Units: deg

value <= 180.0

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

slat_angle

field Slat Angle

If WindowProperty:ShadingControl for the window that incorporates this blind

has Type of Slat Angle Control for Blinds = FixedSlatAngle,

then this is the fixed value of the slat angle;

If WindowProperty:ShadingControl for the window that incorporates this blind

has Type of Slat Angle Control for Blinds = BlockBeamSolar,

then this is the slat angle when slat angle control

is not in effect (e.g., when there is no beam solar on the blind);

Not used if WindowProperty:ShadingControl for the window that incorporates this blind

has Type of Slat Angle Control for Blinds = ScheduledSlatAngle.

Units: deg

Default value: 45.0

value <= 180.0

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

slat_beam_solar_transmittance

field Slat Beam Solar Transmittance

value < 1.0

Parameters:value (float) – value for IDD Field Slat Beam Solar Transmittance Raises:ValueError – if value is not a valid value Returns:the value of slat_beam_solar_transmittance or None if not set Return type:float

slat_beam_visible_transmittance

field Slat Beam Visible Transmittance

Required for detailed daylighting calculation

value < 1.0

Parameters:value (float) – value for IDD Field Slat Beam Visible Transmittance Raises:ValueError – if value is not a valid value Returns:the value of slat_beam_visible_transmittance or None if not set Return type:float

slat_conductivity

field Slat Conductivity

default is for aluminum

Units: W/m-K

Default value: 221.0

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

slat_diffuse_solar_transmittance

field Slat Diffuse Solar Transmittance

Must equal “Slat beam solar transmittance”

value < 1.0

Parameters:value (float) – value for IDD Field Slat Diffuse Solar Transmittance Raises:ValueError – if value is not a valid value Returns:the value of slat_diffuse_solar_transmittance or None if not set Return type:float

slat_diffuse_visible_transmittance

field Slat Diffuse Visible Transmittance

Used only for detailed daylighting calculation

Must equal “Slat Beam Visible Transmittance”

value < 1.0

Parameters:value (float) – value for IDD Field Slat Diffuse Visible Transmittance Raises:ValueError – if value is not a valid value Returns:the value of slat_diffuse_visible_transmittance or None if not set Return type:float

slat_infrared_hemispherical_transmittance

field Slat Infrared Hemispherical Transmittance

value < 1.0

Parameters:value (float) – value for IDD Field Slat Infrared Hemispherical Transmittance Raises:ValueError – if value is not a valid value Returns:the value of slat_infrared_hemispherical_transmittance or None if not set Return type:float

slat_orientation

field Slat Orientation

Default value: Horizontal

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

slat_separation

field Slat Separation

Distance between adjacent slat faces

Units: m

IP-Units: in

value <= 1.0

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

slat_thickness

field Slat Thickness

Distance between top and bottom surfaces of slat

Slat is assumed to be rectangular in cross section and flat

Units: m

IP-Units: in

Default value: 0.00025

value <= 0.1

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

slat_width

field Slat Width

Units: m

IP-Units: in

value <= 1.0

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

class pyidf.surface_construction_elements.WindowMaterialBlindEquivalentLayer

Bases: pyidf.helper.DataObject

Corresponds to IDD object WindowMaterial:Blind:EquivalentLayer Window equivalent layer blind slat optical and thermal properties. The model assumes that slats are thin and flat, applies correction empirical correlation to account for curvature effect. Slats are assumed to transmit and reflect diffusely.

back_side_slat_beamdiffuse_solar_reflectance

field Back Side Slat Beam-Diffuse Solar Reflectance

The back side beam-diffuse solar reflectance of the slat at normal

incidence averaged over the entire spectrum of solar radiation.

Units: dimensionless

value < 1.0

Parameters:value (float) – value for IDD Field Back Side Slat Beam-Diffuse Solar Reflectance Raises:ValueError – if value is not a valid value Returns:the value of back_side_slat_beamdiffuse_solar_reflectance or None if not set Return type:float

back_side_slat_beamdiffuse_solar_transmittance

field Back Side Slat Beam-Diffuse Solar Transmittance

The back side beam-diffuse solar transmittance of the slat at normal

incidence averaged over the entire spectrum of solar radiation.

Units: dimensionless

value < 1.0

Parameters:value (float) – value for IDD Field Back Side Slat Beam-Diffuse Solar Transmittance Raises:ValueError – if value is not a valid value Returns:the value of back_side_slat_beamdiffuse_solar_transmittance or None if not set Return type:float

back_side_slat_beamdiffuse_visible_reflectance

field Back Side Slat Beam-Diffuse Visible Reflectance

The back side beam-diffuse visible reflectance of the slat

at normal incidence averaged over the visible spectrum range

of solar radiation.

Units: dimensionless

value < 1.0

Parameters:value (float) – value for IDD Field Back Side Slat Beam-Diffuse Visible Reflectance Raises:ValueError – if value is not a valid value Returns:the value of back_side_slat_beamdiffuse_visible_reflectance or None if not set Return type:float

back_side_slat_beamdiffuse_visible_transmittance

field Back Side Slat Beam-Diffuse Visible Transmittance

The back side beam-diffuse visible transmittance of the slat

at normal incidence averaged over the visible spectrum range

of solar radiation.

Units: dimensionless

value < 1.0

Parameters:value (float) – value for IDD Field Back Side Slat Beam-Diffuse Visible Transmittance Raises:ValueError – if value is not a valid value Returns:the value of back_side_slat_beamdiffuse_visible_transmittance or None if not set Return type:float

back_side_slat_diffusediffuse_solar_reflectance

field Back Side Slat Diffuse-Diffuse Solar Reflectance

The back side beam-diffuse solar reflectance of the slat

averaged over the entire solar spectrum of solar radiation.

Units: dimensionless

value < 1.0

Parameters:value (float) – value for IDD Field Back Side Slat Diffuse-Diffuse Solar Reflectance Raises:ValueError – if value is not a valid value Returns:the value of back_side_slat_diffusediffuse_solar_reflectance or None if not set Return type:float

back_side_slat_diffusediffuse_visible_reflectance

field Back Side Slat Diffuse-Diffuse Visible Reflectance

The back side beam-diffuse visible reflectance of the slat

averaged over the visible spectrum range of solar radiation.

Units: dimensionless

value < 1.0

Parameters:value (float) – value for IDD Field Back Side Slat Diffuse-Diffuse Visible Reflectance Raises:ValueError – if value is not a valid value Returns:the value of back_side_slat_diffusediffuse_visible_reflectance or None if not set Return type:float

back_side_slat_infrared_emissivity

field Back Side Slat Infrared Emissivity

Back side long-wave hemispherical emissivity of the slat material.

Units: dimensionless

Default value: 0.9

value < 1.0

Parameters:value (float) – value for IDD Field Back Side Slat Infrared Emissivity Raises:ValueError – if value is not a valid value Returns:the value of back_side_slat_infrared_emissivity or None if not set Return type:float

front_side_slat_beamdiffuse_solar_reflectance

field Front Side Slat Beam-Diffuse Solar Reflectance

The front side beam-diffuse solar reflectance of the slat at normal

incidence averaged over the entire spectrum of solar radiation.

Units: dimensionless

value < 1.0

Parameters:value (float) – value for IDD Field Front Side Slat Beam-Diffuse Solar Reflectance Raises:ValueError – if value is not a valid value Returns:the value of front_side_slat_beamdiffuse_solar_reflectance or None if not set Return type:float

front_side_slat_beamdiffuse_solar_transmittance

field Front Side Slat Beam-Diffuse Solar Transmittance

The front side beam-diffuse solar transmittance of the slat at normal

incidence averaged over the entire spectrum of solar radiation.

value < 1.0

Parameters:value (float) – value for IDD Field Front Side Slat Beam-Diffuse Solar Transmittance Raises:ValueError – if value is not a valid value Returns:the value of front_side_slat_beamdiffuse_solar_transmittance or None if not set Return type:float

front_side_slat_beamdiffuse_visible_reflectance

field Front Side Slat Beam-Diffuse Visible Reflectance

The front side beam-diffuse visible reflectance of the slat

at normal incidence averaged over the visible spectrum range

of solar radiation.

Units: dimensionless

value < 1.0

Parameters:value (float) – value for IDD Field Front Side Slat Beam-Diffuse Visible Reflectance Raises:ValueError – if value is not a valid value Returns:the value of front_side_slat_beamdiffuse_visible_reflectance or None if not set Return type:float

front_side_slat_beamdiffuse_visible_transmittance

field Front Side Slat Beam-Diffuse Visible Transmittance

The front side beam-diffuse visible transmittance of the slat

at normal incidence averaged over the visible spectrum range

of solar radiation.

Units: dimensionless

value < 1.0

Parameters:value (float) – value for IDD Field Front Side Slat Beam-Diffuse Visible Transmittance Raises:ValueError – if value is not a valid value Returns:the value of front_side_slat_beamdiffuse_visible_transmittance or None if not set Return type:float

front_side_slat_diffusediffuse_solar_reflectance

field Front Side Slat Diffuse-Diffuse Solar Reflectance

The front side beam-diffuse solar reflectance of the slat

averaged over the entire solar spectrum of solar radiation.

Units: dimensionless

value < 1.0

Parameters:value (float) – value for IDD Field Front Side Slat Diffuse-Diffuse Solar Reflectance Raises:ValueError – if value is not a valid value Returns:the value of front_side_slat_diffusediffuse_solar_reflectance or None if not set Return type:float

front_side_slat_diffusediffuse_visible_reflectance

field Front Side Slat Diffuse-Diffuse Visible Reflectance

The front side beam-diffuse visible reflectance of the slat

averaged over the visible spectrum range of solar radiation.

Units: dimensionless

value < 1.0

Parameters:value (float) – value for IDD Field Front Side Slat Diffuse-Diffuse Visible Reflectance Raises:ValueError – if value is not a valid value Returns:the value of front_side_slat_diffusediffuse_visible_reflectance or None if not set Return type:float

front_side_slat_infrared_emissivity

field Front Side Slat Infrared Emissivity

Front side long-wave hemispherical emissivity of the slat material.

Units: dimensionless

Default value: 0.9

value < 1.0

Parameters:value (float) – value for IDD Field Front Side Slat Infrared Emissivity Raises:ValueError – if value is not a valid value Returns:the value of front_side_slat_infrared_emissivity 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

slat_angle

field Slat Angle

Units: deg

Default value: 45.0

value <= 180.0

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

slat_angle_control

field Slat Angle Control

Used only if slat angle control is desired to either maximize solar

gain (MaximizeSolar), maximize visibility while eliminating beam solar

radiation (BlockBeamSolar), or fixed slate angle (FixedSlatAngle).

If FixedSlatAngle is selected, the slat angle entered above is used.

Default value: FixedSlatAngle

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

slat_crown

field Slat Crown

Perpendicular length between the cord and the curve.

Slat is assumed to be rectangular in cross section

and flat. Crown=0.0625x”Slat width”

Units: m

IP-Units: in

Default value: 0.0015

value <= 0.00156

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

slat_diffusediffuse_solar_transmittance

field Slat Diffuse-Diffuse Solar Transmittance

The beam-diffuse solar transmittance of the slat averaged

over the entire solar spectrum of solar radiation.

Units: dimensionless

value < 1.0

Parameters:value (float) – value for IDD Field Slat Diffuse-Diffuse Solar Transmittance Raises:ValueError – if value is not a valid value Returns:the value of slat_diffusediffuse_solar_transmittance or None if not set Return type:float

slat_diffusediffuse_visible_transmittance

field Slat Diffuse-Diffuse Visible Transmittance

The beam-diffuse visible transmittance of the slat averaged

over the visible spectrum range of solar radiation.

value < 1.0

Parameters:value (float) – value for IDD Field Slat Diffuse-Diffuse Visible Transmittance Raises:ValueError – if value is not a valid value Returns:the value of slat_diffusediffuse_visible_transmittance or None if not set Return type:float

slat_infrared_transmittance

field Slat Infrared Transmittance

Long-wave hemispherical transmittance of the slat material.

Assumed to be the same for both sides of the slat.

value < 1.0

Parameters:value (float) – value for IDD Field Slat Infrared Transmittance Raises:ValueError – if value is not a valid value Returns:the value of slat_infrared_transmittance or None if not set Return type:float

slat_orientation

field Slat Orientation

Default value: Horizontal

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

slat_separation

field Slat Separation

Distance between adjacent slat faces

Units: m

IP-Units: in

value <= 0.025

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

slat_width

field Slat Width

Units: m

IP-Units: in

value <= 0.025

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

class pyidf.surface_construction_elements.WindowMaterialComplexShade

Bases: pyidf.helper.DataObject

Corresponds to IDD object WindowMaterial:ComplexShade Complex window shading layer thermal properties

back_emissivity

field Back Emissivity

Default value: 0.84

value <= 1.0

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

bottom_opening_multiplier

field Bottom Opening Multiplier

value <= 1.0

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

conductivity

field Conductivity

Units: W/m-K

Default value: 1.0

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

front_emissivity

field Front Emissivity

Default value: 0.84

value <= 1.0

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

front_opening_multiplier

field Front Opening Multiplier

Default value: 0.05

value <= 1.0

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

ir_transmittance

field IR Transmittance

value <= 1.0

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

layer_type

field Layer Type

Default value: OtherShadingType

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

left_side_opening_multiplier

field Left Side Opening Multiplier

value <= 1.0

Parameters:value (float) – value for IDD Field Left Side Opening Multiplier Raises:ValueError – if value is not a valid value Returns:the value of left_side_opening_multiplier 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

right_side_opening_multiplier

field Right Side Opening Multiplier

value <= 1.0

Parameters:value (float) – value for IDD Field Right Side Opening Multiplier Raises:ValueError – if value is not a valid value Returns:the value of right_side_opening_multiplier or None if not set Return type:float

slat_angle

field Slat Angle

Units: deg

Default value: 90.0

value >= -90.0

value <= 90.0

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

slat_conductivity

field Slat Conductivity

Units: W/m-K

Default value: 160.0

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

slat_curve

field Slat Curve

this value represents curvature radius of the slat.

if the slat is flat use zero.

if this value is not zero, then it must be > SlatWidth/2.

Units: m

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

slat_spacing

field Slat Spacing

Distance between adjacent slat faces

Units: m

Default value: 0.012

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

slat_thickness

field Slat Thickness

Distance between top and bottom surfaces of slat

Slat is assumed to be rectangular in cross section and flat

Units: m

Default value: 0.0006

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

slat_width

field Slat Width

Units: m

Default value: 0.016

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

thickness

field Thickness

Units: m

Default value: 0.002

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

top_opening_multiplier

field Top Opening Multiplier

value <= 1.0

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

class pyidf.surface_construction_elements.WindowMaterialDrapeEquivalentLayer

Bases: pyidf.helper.DataObject

Corresponds to IDD object WindowMaterial:Drape:EquivalentLayer Specifies the properties of equivalent layer drape fabric materials. Shades are considered to be perfect diffusers (all transmitted and reflected radiation is hemispherically-diffuse) independent of angle of incidence. unpleated drape fabric is treated as thin and flat layer.

back_side_drape_beamdiffuse_solar_reflectance

field Back Side Drape Beam-Diffuse Solar Reflectance

The back side beam-diffuse solar reflectance at normal incidence averaged

over the entire spectrum of solar radiation.

Units: dimensionless

value < 1.0

Parameters:value (float) – value for IDD Field Back Side Drape Beam-Diffuse Solar Reflectance Raises:ValueError – if value is not a valid value Returns:the value of back_side_drape_beamdiffuse_solar_reflectance or None if not set Return type:float

back_side_drape_beamdiffuse_solar_transmittance

field Back Side Drape Beam-Diffuse Solar Transmittance

The back side beam-diffuse solar transmittance at normal incidence averaged

over the entire spectrum of solar radiation. Assumed to be the same for front

and back sides.

Units: dimensionless

value < 1.0

Parameters:value (float) – value for IDD Field Back Side Drape Beam-Diffuse Solar Transmittance Raises:ValueError – if value is not a valid value Returns:the value of back_side_drape_beamdiffuse_solar_transmittance or None if not set Return type:float

back_side_drape_material_infrared_emissivity

field Back Side Drape Material Infrared Emissivity

Back side long-wave emissivity of the drape fabric at zero shade openness.

Openness fraction specified above is used to calculate the effective

emissivity value.

Units: dimensionless

Default value: 0.87

value < 1.0

Parameters:value (float) – value for IDD Field Back Side Drape Material Infrared Emissivity Raises:ValueError – if value is not a valid value Returns:the value of back_side_drape_material_infrared_emissivity or None if not set Return type:float

drape_beambeam_solar_transmittance_at_normal_incidence

field Drape Beam-Beam Solar Transmittance at Normal Incidence

The beam-beam solar transmittance at normal incidence. This value is the

same as the openness area fraction of the drape fabric. Assumed to be

same for front and back sides.

Units: dimensionless

value <= 0.2

Parameters:value (float) – value for IDD Field Drape Beam-Beam Solar Transmittance at Normal Incidence Raises:ValueError – if value is not a valid value Returns:the value of drape_beambeam_solar_transmittance_at_normal_incidence or None if not set Return type:float

drape_beambeam_visible_transmittance

field Drape Beam-Beam Visible Transmittance

The beam-beam visible transmittance at normal incidence averaged over the

visible spectrum of solar radiation. Assumed same for front and back sides.

Units: dimensionless

value < 1.0

Parameters:value (float) – value for IDD Field Drape Beam-Beam Visible Transmittance Raises:ValueError – if value is not a valid value Returns:the value of drape_beambeam_visible_transmittance or None if not set Return type:float

drape_beamdiffuse_visible_reflectance

field Drape Beam-Diffuse Visible Reflectance

The beam-diffuse visible reflectance at normal incidence average over the

visible spectrum range of solar radiation. Assumed to be the same for front

and back sides.

Units: dimensionless

value < 1.0

Parameters:value (float) – value for IDD Field Drape Beam-Diffuse Visible Reflectance Raises:ValueError – if value is not a valid value Returns:the value of drape_beamdiffuse_visible_reflectance or None if not set Return type:float

drape_beamdiffuse_visible_transmittance

field Drape Beam-Diffuse Visible Transmittance

The beam-diffuse visible transmittance at normal incidence averaged over the

visible spectrum range of solar radiation. Assumed to be the same for front

and back sides.

Units: dimensionless

value < 1.0

Parameters:value (float) – value for IDD Field Drape Beam-Diffuse Visible Transmittance Raises:ValueError – if value is not a valid value Returns:the value of drape_beamdiffuse_visible_transmittance or None if not set Return type:float

drape_material_infrared_transmittance

field Drape Material Infrared Transmittance

Long-wave transmittance of the drape fabric at zero openness fraction.

Assumed same for front and back sides.

Units: dimensionless

Default value: 0.05

value < 1.0

Parameters:value (float) – value for IDD Field Drape Material Infrared Transmittance Raises:ValueError – if value is not a valid value Returns:the value of drape_material_infrared_transmittance or None if not set Return type:float

front_side_drape_beamdiffuse_solar_reflectance

field Front Side Drape Beam-Diffuse Solar Reflectance

The front side beam-diffuse solar reflectance at normal incidence averaged

over the entire spectrum of solar radiation.

Units: dimensionless

value < 1.0

Parameters:value (float) – value for IDD Field Front Side Drape Beam-Diffuse Solar Reflectance Raises:ValueError – if value is not a valid value Returns:the value of front_side_drape_beamdiffuse_solar_reflectance or None if not set Return type:float

front_side_drape_beamdiffuse_solar_transmittance

field Front Side Drape Beam-Diffuse Solar Transmittance

The front side beam-diffuse solar transmittance at normal incidence averaged

over the entire spectrum of solar radiation. Assumed to be the same for front

and back sides.

Units: dimensionless

value < 1.0

Parameters:value (float) – value for IDD Field Front Side Drape Beam-Diffuse Solar Transmittance Raises:ValueError – if value is not a valid value Returns:the value of front_side_drape_beamdiffuse_solar_transmittance or None if not set Return type:float

front_side_drape_material_infrared_emissivity

field Front Side Drape Material Infrared Emissivity

Front side long-wave emissivity of the drape fabric at zero shade openness.

Openness fraction specified above is used to calculate the effective

emissivity value.

Units: dimensionless

Default value: 0.87

value < 1.0

Parameters:value (float) – value for IDD Field Front Side Drape Material Infrared Emissivity Raises:ValueError – if value is not a valid value Returns:the value of front_side_drape_material_infrared_emissivity or None if not set Return type:float

length_of_pleated_fabric

field Length of Pleated Fabric

Length of the pleated section of the draped fabric. If the drape fabric is

unpleated or is flat, then the pleated section length is set to zero.

Units: m

IP-Units: in

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

width_of_pleated_fabric

field Width of Pleated Fabric

Width of the pleated section of the draped fabric. If the drape fabric is

unpleated or is flat, then the pleated section width is set to zero.

Units: m

IP-Units: in

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

class pyidf.surface_construction_elements.WindowMaterialGap

Bases: pyidf.helper.DataObject

Corresponds to IDD object WindowMaterial:Gap Used to define the gap between two layers in a complex fenestration system, where the Construction:ComplexFenestrationState object is used. It is referenced as a layer in the Construction:ComplexFenestrationState object. It cannot be referenced as a layer from the Construction object.

deflection_state

field Deflection State

If left blank, it will be considered that gap is not deflected

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

gas_or_gas_mixture

field Gas (or Gas Mixture)

This field should reference only WindowMaterial:Gas

or WindowMaterial:GasMixture objects

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

name

field Name

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

pressure

field Pressure

Units: Pa

Default value: 101325.0

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

support_pillar

field Support Pillar

If left blank, it will be considered that gap does not have

support pillars

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

thickness

field Thickness

Units: m

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

class pyidf.surface_construction_elements.WindowMaterialGapEquivalentLayer

Bases: pyidf.helper.DataObject

Corresponds to IDD object WindowMaterial:Gap:EquivalentLayer Gas material properties that are used in Windows Equivalent Layer References only WindowMaterial:Gas properties

conductivity_coefficient_a

field Conductivity Coefficient A

Used only if Gas Type = Custom

Units: W/m-K

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

conductivity_coefficient_b

field Conductivity Coefficient B

Used only if Gas Type = Custom

Units: W/m-K2

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

conductivity_coefficient_c

field Conductivity Coefficient C

Used only if Gas Type = Custom

Units: W/m-K3

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

gap_vent_type

field Gap Vent Type

Sealed means the gap is enclosed and gas tight, i.e., no venting to indoor or

outdoor environment. VentedIndoor means the gap is vented to indoor environment, and

VentedOutdoor means the gap is vented to the outdoor environment. The gap types

VentedIndoor and VentedOutdoor are used with gas type “Air” only.

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

gas_type

field Gas Type

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

molecular_weight

field Molecular Weight

Used only if Gas Type = Custom

Units: g/mol

value >= 20.0

value <= 200.0

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

specific_heat_coefficient_a

field Specific Heat Coefficient A

Used only if Gas Type = Custom

Units: J/kg-K

Parameters:value (float) – value for IDD Field Specific Heat Coefficient A Raises:ValueError – if value is not a valid value Returns:the value of specific_heat_coefficient_a or None if not set Return type:float

specific_heat_coefficient_b

field Specific Heat Coefficient B

Used only if Gas Type = Custom

Units: J/kg-K2

Parameters:value (float) – value for IDD Field Specific Heat Coefficient B Raises:ValueError – if value is not a valid value Returns:the value of specific_heat_coefficient_b or None if not set Return type:float

specific_heat_coefficient_c

field Specific Heat Coefficient C

Used only if Gas Type = Custom

Units: J/kg-K3

Parameters:value (float) – value for IDD Field Specific Heat Coefficient C Raises:ValueError – if value is not a valid value Returns:the value of specific_heat_coefficient_c or None if not set Return type:float

specific_heat_ratio

field Specific Heat Ratio

Used only if Gas Type = Custom

value > 1.0

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

thickness

field Thickness

Units: m

IP-Units: in

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

viscosity_coefficient_a

field Viscosity Coefficient A

Used only if Gas Type = Custom

Units: kg/m-s

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

viscosity_coefficient_b

field Viscosity Coefficient B

Used only if Gas Type = Custom

Units: kg/m-s-K

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

viscosity_coefficient_c

field Viscosity Coefficient C

Used only if Gas Type = Custom

Units: kg/m-s-K2

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

class pyidf.surface_construction_elements.WindowMaterialGas

Bases: pyidf.helper.DataObject

Corresponds to IDD object WindowMaterial:Gas Gas material properties that are used in Windows or Glass Doors

conductivity_coefficient_a

field Conductivity Coefficient A

Used only if Gas Type = Custom

Units: W/m-K

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

conductivity_coefficient_b

field Conductivity Coefficient B

Used only if Gas Type = Custom

Units: W/m-K2

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

conductivity_coefficient_c

field Conductivity Coefficient C

Used only if Gas Type = Custom

Units: W/m-K3

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

gas_type

field Gas Type

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

molecular_weight

field Molecular Weight

Used only if Gas Type = Custom

Units: g/mol

value >= 20.0

value <= 200.0

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

specific_heat_coefficient_a

field Specific Heat Coefficient A

Used only if Gas Type = Custom

Units: J/kg-K

Parameters:value (float) – value for IDD Field Specific Heat Coefficient A Raises:ValueError – if value is not a valid value Returns:the value of specific_heat_coefficient_a or None if not set Return type:float

specific_heat_coefficient_b

field Specific Heat Coefficient B

Used only if Gas Type = Custom

Units: J/kg-K2

Parameters:value (float) – value for IDD Field Specific Heat Coefficient B Raises:ValueError – if value is not a valid value Returns:the value of specific_heat_coefficient_b or None if not set Return type:float

specific_heat_coefficient_c

field Specific Heat Coefficient C

Used only if Gas Type = Custom

Units: J/kg-K3

Parameters:value (float) – value for IDD Field Specific Heat Coefficient C Raises:ValueError – if value is not a valid value Returns:the value of specific_heat_coefficient_c or None if not set Return type:float

specific_heat_ratio

field Specific Heat Ratio

Used only if Gas Type = Custom

value > 1.0

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

thickness

field Thickness

Units: m

IP-Units: in

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

viscosity_coefficient_a

field Viscosity Coefficient A

Used only if Gas Type = Custom

Units: kg/m-s

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

viscosity_coefficient_b

field Viscosity Coefficient B

Used only if Gas Type = Custom

Units: kg/m-s-K

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

viscosity_coefficient_c

field Viscosity Coefficient C

Used only if Gas Type = Custom

Units: kg/m-s-K2

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

class pyidf.surface_construction_elements.WindowMaterialGasMixture

Bases: pyidf.helper.DataObject

Corresponds to IDD object WindowMaterial:GasMixture Gas mixtures that are used in Windows or Glass Doors

gas_1_fraction

field Gas 1 Fraction

value <= 1.0

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

gas_1_type

field Gas 1 Type

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

gas_2_fraction

field Gas 2 Fraction

value <= 1.0

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

gas_2_type

field Gas 2 Type

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

gas_3_fraction

field Gas 3 Fraction

value <= 1.0

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

gas_3_type

field Gas 3 Type

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

gas_4_fraction

field Gas 4 Fraction

value <= 1.0

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

gas_4_type

field Gas 4 Type

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

name

field Name

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

number_of_gases_in_mixture

field Number of Gases in Mixture

value >= 1

value <= 4

Parameters:value (int) – value for IDD Field Number of Gases in Mixture Raises:ValueError – if value is not a valid value Returns:the value of number_of_gases_in_mixture or None if not set Return type:int

thickness

field Thickness

Units: m

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

class pyidf.surface_construction_elements.WindowMaterialGlazing

Bases: pyidf.helper.DataObject

Corresponds to IDD object WindowMaterial:Glazing Glass material properties for Windows or Glass Doors Transmittance/Reflectance input method.

back_side_infrared_hemispherical_emissivity

field Back Side Infrared Hemispherical Emissivity

Default value: 0.84

value < 1.0

Parameters:value (float) – value for IDD Field Back Side Infrared Hemispherical Emissivity Raises:ValueError – if value is not a valid value Returns:the value of back_side_infrared_hemispherical_emissivity or None if not set Return type:float

back_side_solar_reflectance_at_normal_incidence

field Back Side Solar Reflectance at Normal Incidence

Used only when Optical Data Type = SpectralAverage

Back Side is side closest to zone air

value <= 1.0

Parameters:value (float) – value for IDD Field Back Side Solar Reflectance at Normal Incidence Raises:ValueError – if value is not a valid value Returns:the value of back_side_solar_reflectance_at_normal_incidence or None if not set Return type:float

back_side_visible_reflectance_at_normal_incidence

field Back Side Visible Reflectance at Normal Incidence

Used only when Optical Data Type = SpectralAverage

value <= 1.0

Parameters:value (float) – value for IDD Field Back Side Visible Reflectance at Normal Incidence Raises:ValueError – if value is not a valid value Returns:the value of back_side_visible_reflectance_at_normal_incidence or None if not set Return type:float

conductivity

field Conductivity

Units: W/m-K

Default value: 0.9

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

dirt_correction_factor_for_solar_and_visible_transmittance

field Dirt Correction Factor for Solar and Visible Transmittance

Default value: 1.0

value <= 1.0

Parameters:value (float) – value for IDD Field Dirt Correction Factor for Solar and Visible Transmittance Raises:ValueError – if value is not a valid value Returns:the value of dirt_correction_factor_for_solar_and_visible_transmittance or None if not set Return type:float

front_side_infrared_hemispherical_emissivity

field Front Side Infrared Hemispherical Emissivity

Default value: 0.84

value < 1.0

Parameters:value (float) – value for IDD Field Front Side Infrared Hemispherical Emissivity Raises:ValueError – if value is not a valid value Returns:the value of front_side_infrared_hemispherical_emissivity or None if not set Return type:float

front_side_solar_reflectance_at_normal_incidence

field Front Side Solar Reflectance at Normal Incidence

Used only when Optical Data Type = SpectralAverage

Front Side is side closest to outdoor air

value <= 1.0

Parameters:value (float) – value for IDD Field Front Side Solar Reflectance at Normal Incidence Raises:ValueError – if value is not a valid value Returns:the value of front_side_solar_reflectance_at_normal_incidence or None if not set Return type:float

front_side_visible_reflectance_at_normal_incidence

field Front Side Visible Reflectance at Normal Incidence

Used only when Optical Data Type = SpectralAverage

value <= 1.0

Parameters:value (float) – value for IDD Field Front Side Visible Reflectance at Normal Incidence Raises:ValueError – if value is not a valid value Returns:the value of front_side_visible_reflectance_at_normal_incidence or None if not set Return type:float

infrared_transmittance_at_normal_incidence

field Infrared Transmittance at Normal Incidence

value <= 1.0

Parameters:value (float) – value for IDD Field Infrared Transmittance at Normal Incidence Raises:ValueError – if value is not a valid value Returns:the value of infrared_transmittance_at_normal_incidence 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

optical_data_type

field Optical Data Type

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

poissons_ratio

field Poisson’s ratio

coefficient used for deflection calculations. Used only with complex

fenestration when deflection model is set to TemperatureAndPressureInput

Default value: 0.22

value < 1.0

Parameters:value (float) – value for IDD Field Poisson’s ratio Raises:ValueError – if value is not a valid value Returns:the value of poissons_ratio or None if not set Return type:float

solar_diffusing

field Solar Diffusing

Default value: No

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

solar_transmittance_at_normal_incidence

field Solar Transmittance at Normal Incidence

Used only when Optical Data Type = SpectralAverage

value <= 1.0

Parameters:value (float) – value for IDD Field Solar Transmittance at Normal Incidence Raises:ValueError – if value is not a valid value Returns:the value of solar_transmittance_at_normal_incidence or None if not set Return type:float

thickness

field Thickness

Units: m

IP-Units: in

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

visible_transmittance_at_normal_incidence

field Visible Transmittance at Normal Incidence

Used only when Optical Data Type = SpectralAverage

value <= 1.0

Parameters:value (float) – value for IDD Field Visible Transmittance at Normal Incidence Raises:ValueError – if value is not a valid value Returns:the value of visible_transmittance_at_normal_incidence or None if not set Return type:float

window_glass_spectral_data_set_name

field Window Glass Spectral Data Set Name

Used only when Optical Data Type = Spectral

Parameters:value (str) – value for IDD Field Window Glass Spectral Data Set Name Raises:ValueError – if value is not a valid value Returns:the value of window_glass_spectral_data_set_name or None if not set Return type:str

youngs_modulus

field Young’s modulus

coefficient used for deflection calculations. Used only with complex

fenestration when deflection model is set to TemperatureAndPressureInput

Units: Pa

Default value: 72000000000.0

Parameters:value (float) – value for IDD Field Young’s modulus Raises:ValueError – if value is not a valid value Returns:the value of youngs_modulus or None if not set Return type:float

class pyidf.surface_construction_elements.WindowMaterialGlazingEquivalentLayer

Bases: pyidf.helper.DataObject

Corresponds to IDD object WindowMaterial:Glazing:EquivalentLayer Glass material properties for Windows or Glass Doors Transmittance/Reflectance input method.

back_side_beambeam_solar_reflectance

field Back Side Beam-Beam Solar Reflectance

Used only when Optical Data Type = SpectralAverage

Back Side is side closest to zone air

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Back Side Beam-Beam Solar Reflectance Raises:ValueError – if value is not a valid value Returns:the value of back_side_beambeam_solar_reflectance or None if not set Return type:float

back_side_beambeam_solar_transmittance

field Back Side Beam-Beam Solar Transmittance

Used only when Optical Data Type = SpectralAverage

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Back Side Beam-Beam Solar Transmittance Raises:ValueError – if value is not a valid value Returns:the value of back_side_beambeam_solar_transmittance or None if not set Return type:float

back_side_beambeam_visible_solar_reflectance

field Back Side Beam-Beam Visible Solar Reflectance

Used only when Optical Data Type = SpectralAverage

Back Side is side closest to zone air

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Back Side Beam-Beam Visible Solar Reflectance Raises:ValueError – if value is not a valid value Returns:the value of back_side_beambeam_visible_solar_reflectance or None if not set Return type:float

back_side_beambeam_visible_solar_transmittance

field Back Side Beam-Beam Visible Solar Transmittance

Used only when Optical Data Type = SpectralAverage

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Back Side Beam-Beam Visible Solar Transmittance Raises:ValueError – if value is not a valid value Returns:the value of back_side_beambeam_visible_solar_transmittance or None if not set Return type:float

back_side_beamdiffuse_solar_reflectance

field Back Side Beam-Diffuse Solar Reflectance

Used only when Optical Data Type = SpectralAverage

Back Side is side closest to zone air

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Back Side Beam-Diffuse Solar Reflectance Raises:ValueError – if value is not a valid value Returns:the value of back_side_beamdiffuse_solar_reflectance or None if not set Return type:float

back_side_beamdiffuse_solar_transmittance

field Back Side Beam-Diffuse Solar Transmittance

Used only when Optical Data Type = SpectralAverage

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Back Side Beam-Diffuse Solar Transmittance Raises:ValueError – if value is not a valid value Returns:the value of back_side_beamdiffuse_solar_transmittance or None if not set Return type:float

back_side_beamdiffuse_visible_solar_reflectance

field Back Side Beam-Diffuse Visible Solar Reflectance

Used only when Optical Data Type = SpectralAverage

Back Side is side closest to zone air

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Back Side Beam-Diffuse Visible Solar Reflectance Raises:ValueError – if value is not a valid value Returns:the value of back_side_beamdiffuse_visible_solar_reflectance or None if not set Return type:float

back_side_beamdiffuse_visible_solar_transmittance

field Back Side Beam-Diffuse Visible Solar Transmittance

Used only when Optical Data Type = SpectralAverage

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Back Side Beam-Diffuse Visible Solar Transmittance Raises:ValueError – if value is not a valid value Returns:the value of back_side_beamdiffuse_visible_solar_transmittance or None if not set Return type:float

back_side_diffusediffuse_solar_reflectance

field Back Side Diffuse-Diffuse Solar Reflectance

Used only when Optical Data Type = SpectralAverage

If this field is autocalculate, then the back diffuse-diffuse solar

reflectance is automatically estimated from other inputs and used in

subsequent calculations. If this field is zero or positive, then the value

entered here will be used. Back side is side closest to indoor air.

Units: dimensionless

Default value: “autocalculate”

value <= 1.0

Parameters:value (float or “Autocalculate”) – value for IDD Field Back Side Diffuse-Diffuse Solar Reflectance Raises:ValueError – if value is not a valid value Returns:the value of back_side_diffusediffuse_solar_reflectance or None if not set Return type:float or “Autocalculate”

back_side_diffusediffuse_visible_solar_reflectance

field Back Side Diffuse-Diffuse Visible Solar Reflectance

Used only when Optical Data Type = SpectralAverage

This input field is not used currently.

Units: dimensionless

Default value: “autocalculate”

value <= 1.0

Parameters:value (float or “Autocalculate”) – value for IDD Field Back Side Diffuse-Diffuse Visible Solar Reflectance Raises:ValueError – if value is not a valid value Returns:the value of back_side_diffusediffuse_visible_solar_reflectance or None if not set Return type:float or “Autocalculate”

back_side_infrared_emissivity

field Back Side Infrared Emissivity

The back side long-wave hemispherical emissivity of the glazing.

Units: dimensionless

Default value: 0.84

value < 1.0

Parameters:value (float) – value for IDD Field Back Side Infrared Emissivity Raises:ValueError – if value is not a valid value Returns:the value of back_side_infrared_emissivity or None if not set Return type:float

diffusediffuse_solar_transmittance

field Diffuse-Diffuse Solar Transmittance

Used only when Optical Data Type = SpectralAverage

If this field is autocalculate, then the diffuse-diffuse solar

transmittance is automatically estimated from other inputs and used

in subsequent calculations. If this field is zero or positive, then

the value entered here will be used.

Units: dimensionless

Default value: “autocalculate”

value <= 1.0

Parameters:value (float or “Autocalculate”) – value for IDD Field Diffuse-Diffuse Solar Transmittance Raises:ValueError – if value is not a valid value Returns:the value of diffusediffuse_solar_transmittance or None if not set Return type:float or “Autocalculate”

diffusediffuse_visible_solar_transmittance

field Diffuse-Diffuse Visible Solar Transmittance

Used only when Optical Data Type = SpectralAverage

This input field is not used currently.

Units: dimensionless

Default value: “autocalculate”

value <= 1.0

Parameters:value (float or “Autocalculate”) – value for IDD Field Diffuse-Diffuse Visible Solar Transmittance Raises:ValueError – if value is not a valid value Returns:the value of diffusediffuse_visible_solar_transmittance or None if not set Return type:float or “Autocalculate”

front_side_beambeam_solar_reflectance

field Front Side Beam-Beam Solar Reflectance

Used only when Optical Data Type = SpectralAverage

Front Side is side closest to outdoor air

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Front Side Beam-Beam Solar Reflectance Raises:ValueError – if value is not a valid value Returns:the value of front_side_beambeam_solar_reflectance or None if not set Return type:float

front_side_beambeam_solar_transmittance

field Front Side Beam-Beam Solar Transmittance

Used only when Optical Data Type = SpectralAverage

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Front Side Beam-Beam Solar Transmittance Raises:ValueError – if value is not a valid value Returns:the value of front_side_beambeam_solar_transmittance or None if not set Return type:float

front_side_beambeam_visible_solar_reflectance

field Front Side Beam-Beam Visible Solar Reflectance

Used only when Optical Data Type = SpectralAverage

Front Side is side closest to outdoor air

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Front Side Beam-Beam Visible Solar Reflectance Raises:ValueError – if value is not a valid value Returns:the value of front_side_beambeam_visible_solar_reflectance or None if not set Return type:float

front_side_beambeam_visible_solar_transmittance

field Front Side Beam-Beam Visible Solar Transmittance

Used only when Optical Data Type = SpectralAverage

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Front Side Beam-Beam Visible Solar Transmittance Raises:ValueError – if value is not a valid value Returns:the value of front_side_beambeam_visible_solar_transmittance or None if not set Return type:float

front_side_beamdiffuse_solar_reflectance

field Front Side Beam-Diffuse Solar Reflectance

Used only when Optical Data Type = SpectralAverage

Front Side is side closest to outdoor air

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Front Side Beam-Diffuse Solar Reflectance Raises:ValueError – if value is not a valid value Returns:the value of front_side_beamdiffuse_solar_reflectance or None if not set Return type:float

front_side_beamdiffuse_solar_transmittance

field Front Side Beam-Diffuse Solar Transmittance

Used only when Optical Data Type = SpectralAverage

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Front Side Beam-Diffuse Solar Transmittance Raises:ValueError – if value is not a valid value Returns:the value of front_side_beamdiffuse_solar_transmittance or None if not set Return type:float

front_side_beamdiffuse_visible_solar_reflectance

field Front Side Beam-Diffuse Visible Solar Reflectance

Used only when Optical Data Type = SpectralAverage

Front Side is side closest to outdoor air

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Front Side Beam-Diffuse Visible Solar Reflectance Raises:ValueError – if value is not a valid value Returns:the value of front_side_beamdiffuse_visible_solar_reflectance or None if not set Return type:float

front_side_beamdiffuse_visible_solar_transmittance

field Front Side Beam-Diffuse Visible Solar Transmittance

Used only when Optical Data Type = SpectralAverage

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Front Side Beam-Diffuse Visible Solar Transmittance Raises:ValueError – if value is not a valid value Returns:the value of front_side_beamdiffuse_visible_solar_transmittance or None if not set Return type:float

front_side_diffusediffuse_solar_reflectance

field Front Side Diffuse-Diffuse Solar Reflectance

Used only when Optical Data Type = SpectralAverage

If this field is autocalculate, then the front diffuse-diffuse solar

reflectance is automatically estimated from other inputs and used in

subsequent calculations. If this field is zero or positive, then the value

entered here will be used. Front Side is side closest to outdoor air.

Units: dimensionless

Default value: “autocalculate”

value <= 1.0

Parameters:value (float or “Autocalculate”) – value for IDD Field Front Side Diffuse-Diffuse Solar Reflectance Raises:ValueError – if value is not a valid value Returns:the value of front_side_diffusediffuse_solar_reflectance or None if not set Return type:float or “Autocalculate”

front_side_diffusediffuse_visible_solar_reflectance

field Front Side Diffuse-Diffuse Visible Solar Reflectance

Used only when Optical Data Type = SpectralAverage

This input field is not used currently.

Units: dimensionless

Default value: “autocalculate”

value <= 1.0

Parameters:value (float or “Autocalculate”) – value for IDD Field Front Side Diffuse-Diffuse Visible Solar Reflectance Raises:ValueError – if value is not a valid value Returns:the value of front_side_diffusediffuse_visible_solar_reflectance or None if not set Return type:float or “Autocalculate”

front_side_infrared_emissivity

field Front Side Infrared Emissivity

The front side long-wave hemispherical emissivity of the glazing.

Units: dimensionless

Default value: 0.84

value < 1.0

Parameters:value (float) – value for IDD Field Front Side Infrared Emissivity Raises:ValueError – if value is not a valid value Returns:the value of front_side_infrared_emissivity or None if not set Return type:float

infrared_transmittance_applies_to_front_and_back

field Infrared Transmittance (applies to front and back)

The long-wave hemispherical transmittance of the glazing.

Assumed to be the same for both sides of the glazing.

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Infrared Transmittance (applies to front and back) Raises:ValueError – if value is not a valid value Returns:the value of infrared_transmittance_applies_to_front_and_back 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

optical_data_type

field Optical Data Type

Spectral is no longer supported and SpectralAverage is now the default.

Default value: SpectralAverage

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

window_glass_spectral_data_set_name

field Window Glass Spectral Data Set Name

Used only when Optical Data Type = Spectral

Parameters:value (str) – value for IDD Field Window Glass Spectral Data Set Name Raises:ValueError – if value is not a valid value Returns:the value of window_glass_spectral_data_set_name or None if not set Return type:str

class pyidf.surface_construction_elements.WindowMaterialGlazingGroupThermochromic

Bases: pyidf.helper.DataObject

Corresponds to IDD object WindowMaterial:GlazingGroup:Thermochromic thermochromic glass at different temperatures

add_extensible(optical_data_temperature_1=None, window_material_glazing_name_1=None)

Add values for extensible fields

Parameters:

• optical_data_temperature_1 (float) – value for IDD Field Optical Data Temperature 1 Units: C IP-Units: F if value is None it will not be checked against the specification and is assumed to be a missing value
• window_material_glazing_name_1 (str) – value for IDD Field Window Material Glazing Name 1 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

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.surface_construction_elements.WindowMaterialGlazingRefractionExtinctionMethod

Bases: pyidf.helper.DataObject

Corresponds to IDD object WindowMaterial:Glazing:RefractionExtinctionMethod Glass material properties for Windows or Glass Doors Index of Refraction/Extinction Coefficient input method Not to be used for coated glass

conductivity

field Conductivity

Units: W/m-K

Default value: 0.9

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

dirt_correction_factor_for_solar_and_visible_transmittance

field Dirt Correction Factor for Solar and Visible Transmittance

Default value: 1.0

value <= 1.0

Parameters:value (float) – value for IDD Field Dirt Correction Factor for Solar and Visible Transmittance Raises:ValueError – if value is not a valid value Returns:the value of dirt_correction_factor_for_solar_and_visible_transmittance or None if not set Return type:float

infrared_hemispherical_emissivity

field Infrared Hemispherical Emissivity

Emissivity of front and back side assumed equal

Default value: 0.84

value < 1.0

Parameters:value (float) – value for IDD Field Infrared Hemispherical Emissivity Raises:ValueError – if value is not a valid value Returns:the value of infrared_hemispherical_emissivity or None if not set Return type:float

infrared_transmittance_at_normal_incidence

field Infrared Transmittance at Normal Incidence

value < 1.0

Parameters:value (float) – value for IDD Field Infrared Transmittance at Normal Incidence Raises:ValueError – if value is not a valid value Returns:the value of infrared_transmittance_at_normal_incidence 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

solar_diffusing

field Solar Diffusing

Default value: No

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

solar_extinction_coefficient

field Solar Extinction Coefficient

Units: 1/m

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

solar_index_of_refraction

field Solar Index of Refraction

value > 1.0

Parameters:value (float) – value for IDD Field Solar Index of Refraction Raises:ValueError – if value is not a valid value Returns:the value of solar_index_of_refraction or None if not set Return type:float

thickness

field Thickness

Units: m

IP-Units: in

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

visible_extinction_coefficient

field Visible Extinction Coefficient

Units: 1/m

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

visible_index_of_refraction

field Visible Index of Refraction

value > 1.0

Parameters:value (float) – value for IDD Field Visible Index of Refraction Raises:ValueError – if value is not a valid value Returns:the value of visible_index_of_refraction or None if not set Return type:float

class pyidf.surface_construction_elements.WindowMaterialScreen

Bases: pyidf.helper.DataObject

Corresponds to IDD object WindowMaterial:Screen Window screen physical properties. Can only be located on the exterior side of a window construction.

angle_of_resolution_for_screen_transmittance_output_map

field Angle of Resolution for Screen Transmittance Output Map

Select the resolution of azimuth and altitude angles for the screen transmittance map.

A value of 0 means no transmittance map will be generated.

Valid values for this field are 0, 1, 2, 3 and 5.

Units: deg

Parameters:value (int) – value for IDD Field Angle of Resolution for Screen Transmittance Output Map Raises:ValueError – if value is not a valid value Returns:the value of angle_of_resolution_for_screen_transmittance_output_map or None if not set Return type:int

bottom_opening_multiplier

field Bottom Opening Multiplier

Effective area for air flow at the bottom of the screen divided by the perpendicular

area between the glass and the bottom of the screen.

Units: dimensionless

value <= 1.0

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

conductivity

field Conductivity

Thermal conductivity of the screen material.

Default is for aluminum.

Units: W/m-K

Default value: 221.0

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

diffuse_solar_reflectance

field Diffuse Solar Reflectance

Diffuse reflectance of the screen material over the entire solar radiation spectrum.

Assumed to be the same for both sides of the screen.

Units: dimensionless

value < 1.0

Parameters:value (float) – value for IDD Field Diffuse Solar Reflectance Raises:ValueError – if value is not a valid value Returns:the value of diffuse_solar_reflectance or None if not set Return type:float

diffuse_visible_reflectance

field Diffuse Visible Reflectance

Diffuse visible reflectance of the screen material averaged over the solar spectrum

and weighted by the response of the human eye.

Assumed to be the same for both sides of the screen.

Units: dimensionless

value < 1.0

Parameters:value (float) – value for IDD Field Diffuse Visible Reflectance Raises:ValueError – if value is not a valid value Returns:the value of diffuse_visible_reflectance or None if not set Return type:float

left_side_opening_multiplier

field Left Side Opening Multiplier

Effective area for air flow at the left side of the screen divided by the perpendicular

area between the glass and the left side of the screen.

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Left Side Opening Multiplier Raises:ValueError – if value is not a valid value Returns:the value of left_side_opening_multiplier or None if not set Return type:float

name

field Name

Enter a unique name for this window screen material.

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

reflected_beam_transmittance_accounting_method

field Reflected Beam Transmittance Accounting Method

Select the method used to account for the beam solar reflected off the material surface.

Default value: ModelAsDiffuse

Parameters:value (str) – value for IDD Field Reflected Beam Transmittance Accounting Method Raises:ValueError – if value is not a valid value Returns:the value of reflected_beam_transmittance_accounting_method or None if not set Return type:str

right_side_opening_multiplier

field Right Side Opening Multiplier

Effective area for air flow at the right side of the screen divided by the perpendicular

area between the glass and the right side of the screen.

Units: dimensionless

value <= 1.0

Parameters:value (float) – value for IDD Field Right Side Opening Multiplier Raises:ValueError – if value is not a valid value Returns:the value of right_side_opening_multiplier or None if not set Return type:float

screen_material_diameter

field Screen Material Diameter

Diameter assumed to be the same in both directions.

Units: m

IP-Units: in

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

screen_material_spacing

field Screen Material Spacing

Spacing assumed to be the same in both directions.

Units: m

IP-Units: in

Parameters:value (float) – value for IDD Field Screen Material Spacing Raises:ValueError – if value is not a valid value Returns:the value of screen_material_spacing or None if not set Return type:float

screen_to_glass_distance

field Screen to Glass Distance

Distance from the window screen to the adjacent glass surface.

Units: m

IP-Units: in

Default value: 0.025

value >= 0.001

value <= 1.0

Parameters:value (float) – value for IDD Field Screen to Glass Distance Raises:ValueError – if value is not a valid value Returns:the value of screen_to_glass_distance or None if not set Return type:float

thermal_hemispherical_emissivity

field Thermal Hemispherical Emissivity

Long-wave emissivity of the screen material.

Assumed to be the same for both sides of the screen.

Units: dimensionless

Default value: 0.9

value < 1.0

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

top_opening_multiplier

field Top Opening Multiplier

Effective area for air flow at the top of the screen divided by the perpendicular

area between the glass and the top of the screen.

Units: dimensionless

value <= 1.0

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

class pyidf.surface_construction_elements.WindowMaterialScreenEquivalentLayer

Bases: pyidf.helper.DataObject

Corresponds to IDD object WindowMaterial:Screen:EquivalentLayer Equivalent layer window screen physical properties. Can only be located on the exterior side of a window construction.

name

field Name

Enter a unique name for this window screen material.

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

screen_beambeam_solar_transmittance

field Screen Beam-Beam Solar Transmittance

The beam-beam transmittance of the screen material at normal incidence.

This input field is the same as the material openness area fraction

and can be autocalculated from the wire spacing and wire and diameter.

Assumed to be the same for both sides of the screen.

Units: dimensionless

Default value: “autocalculate”

value < 1.0

Parameters:value (float or “Autocalculate”) – value for IDD Field Screen Beam-Beam Solar Transmittance Raises:ValueError – if value is not a valid value Returns:the value of screen_beambeam_solar_transmittance or None if not set Return type:float or “Autocalculate”

screen_beambeam_visible_transmittance

field Screen Beam-Beam Visible Transmittance

The beam-beam visible transmittance of the screen material at normal

incidence averaged over the visible spectrum range of solar radiation.

Assumed to be the same for both sides of the screen.

Units: dimensionless

value < 1.0

Parameters:value (float) – value for IDD Field Screen Beam-Beam Visible Transmittance Raises:ValueError – if value is not a valid value Returns:the value of screen_beambeam_visible_transmittance or None if not set Return type:float

screen_beamdiffuse_solar_reflectance

field Screen Beam-Diffuse Solar Reflectance

The beam-diffuse solar reflectance of the screen material at normal

incidence averaged over the entire spectrum of solar radiation.

Assumed to be the same for both sides of the screen.

Units: dimensionless

value < 1.0

Parameters:value (float) – value for IDD Field Screen Beam-Diffuse Solar Reflectance Raises:ValueError – if value is not a valid value Returns:the value of screen_beamdiffuse_solar_reflectance or None if not set Return type:float

screen_beamdiffuse_solar_transmittance

field Screen Beam-Diffuse Solar Transmittance

The beam-diffuse solar transmittance of the screen material at normal

incidence averaged over the entire spectrum of solar radiation.

Assumed to be the same for both sides of the screen.

Units: dimensionless

value < 1.0

Parameters:value (float) – value for IDD Field Screen Beam-Diffuse Solar Transmittance Raises:ValueError – if value is not a valid value Returns:the value of screen_beamdiffuse_solar_transmittance or None if not set Return type:float

screen_beamdiffuse_visible_reflectance

field Screen Beam-Diffuse Visible Reflectance

Beam-diffuse visible reflectance of the screen material at normal

incidence averaged over the visible spectrum range of solar radiation.

Assumed to be the same for both sides of the screen.

Units: dimensionless

value < 1.0

Parameters:value (float) – value for IDD Field Screen Beam-Diffuse Visible Reflectance Raises:ValueError – if value is not a valid value Returns:the value of screen_beamdiffuse_visible_reflectance or None if not set Return type:float

screen_beamdiffuse_visible_transmittance

field Screen Beam-Diffuse Visible Transmittance

The beam-diffuse visible transmittance of the screen material at normal

incidence averaged over the visible spectrum range of solar radiation.

Assumed to be the same for both sides of the screen.

Units: dimensionless

value < 1.0

Parameters:value (float) – value for IDD Field Screen Beam-Diffuse Visible Transmittance Raises:ValueError – if value is not a valid value Returns:the value of screen_beamdiffuse_visible_transmittance or None if not set Return type:float

screen_infrared_emissivity

field Screen Infrared Emissivity

The long-wave hemispherical emissivity of the screen material.

Assumed to be the same for both sides of the screen.

Units: dimensionless

Default value: 0.93

value < 1.0

Parameters:value (float) – value for IDD Field Screen Infrared Emissivity Raises:ValueError – if value is not a valid value Returns:the value of screen_infrared_emissivity or None if not set Return type:float

screen_infrared_transmittance

field Screen Infrared Transmittance

The long-wave hemispherical transmittance of the screen material.

Assumed to be the same for both sides of the screen.

Units: dimensionless

Default value: 0.02

value < 1.0

Parameters:value (float) – value for IDD Field Screen Infrared Transmittance Raises:ValueError – if value is not a valid value Returns:the value of screen_infrared_transmittance or None if not set Return type:float

screen_wire_diameter

field Screen Wire Diameter

Diameter assumed to be the same in both directions.

Units: m

IP-Units: in

Default value: 0.005

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

screen_wire_spacing

field Screen Wire Spacing

Spacing assumed to be the same in both directions.

Units: m

IP-Units: in

Default value: 0.025

Parameters:value (float) – value for IDD Field Screen Wire Spacing Raises:ValueError – if value is not a valid value Returns:the value of screen_wire_spacing or None if not set Return type:float

class pyidf.surface_construction_elements.WindowMaterialShade

Bases: pyidf.helper.DataObject

Corresponds to IDD object WindowMaterial:Shade Specifies the properties of window shade materials. Reflectance and emissivity properties are assumed to be the same on both sides of the shade. Shades are considered to be perfect diffusers (all transmitted and reflected radiation is hemispherically-diffuse) independent of angle of incidence.

airflow_permeability

field Airflow Permeability

Units: dimensionless

value <= 0.8

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

bottom_opening_multiplier

field Bottom Opening Multiplier

Default value: 0.5

value <= 1.0

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

conductivity

field Conductivity

Units: W/m-K

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

infrared_hemispherical_emissivity

field Infrared Hemispherical Emissivity

Units: dimensionless

value < 1.0

Parameters:value (float) – value for IDD Field Infrared Hemispherical Emissivity Raises:ValueError – if value is not a valid value Returns:the value of infrared_hemispherical_emissivity or None if not set Return type:float

infrared_transmittance

field Infrared Transmittance

Units: dimensionless

value < 1.0

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

leftside_opening_multiplier

field Left-Side Opening Multiplier

Default value: 0.5

value <= 1.0

Parameters:value (float) – value for IDD Field Left-Side Opening Multiplier Raises:ValueError – if value is not a valid value Returns:the value of leftside_opening_multiplier 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

rightside_opening_multiplier

field Right-Side Opening Multiplier

Default value: 0.5

value <= 1.0

Parameters:value (float) – value for IDD Field Right-Side Opening Multiplier Raises:ValueError – if value is not a valid value Returns:the value of rightside_opening_multiplier or None if not set Return type:float

shade_to_glass_distance

field Shade to Glass Distance

Units: m

IP-Units: in

Default value: 0.05

value >= 0.001

value <= 1.0

Parameters:value (float) – value for IDD Field Shade to Glass Distance Raises:ValueError – if value is not a valid value Returns:the value of shade_to_glass_distance or None if not set Return type:float

solar_reflectance

field Solar Reflectance

Assumed same for both sides

Assumed independent of incidence angle

Units: dimensionless

value < 1.0

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

solar_transmittance

field Solar Transmittance

Assumed independent of incidence angle

Units: dimensionless

value < 1.0

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

thickness

field Thickness

Units: m

IP-Units: in

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

top_opening_multiplier

field Top Opening Multiplier

Default value: 0.5

value <= 1.0

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

visible_reflectance

field Visible Reflectance

Assumed same for both sides

Assumed independent of incidence angle

Units: dimensionless

value < 1.0

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

visible_transmittance

field Visible Transmittance

Assumed independent of incidence angle

Units: dimensionless

value < 1.0

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

class pyidf.surface_construction_elements.WindowMaterialShadeEquivalentLayer

Bases: pyidf.helper.DataObject

Corresponds to IDD object WindowMaterial:Shade:EquivalentLayer Specifies the properties of equivalent layer window shade material Shades are considered to be perfect diffusers (all transmitted and reflected radiation is hemispherically-diffuse) independent of angle of incidence. Shade represents roller blinds.

back_side_shade_beamdiffuse_solar_reflectance

field Back Side Shade Beam-Diffuse Solar Reflectance

The back side beam-diffuse solar reflectance at normal incidence averaged

over the entire spectrum of solar radiation.

Units: dimensionless

value < 1.0

Parameters:value (float) – value for IDD Field Back Side Shade Beam-Diffuse Solar Reflectance Raises:ValueError – if value is not a valid value Returns:the value of back_side_shade_beamdiffuse_solar_reflectance or None if not set Return type:float

back_side_shade_beamdiffuse_solar_transmittance

field Back Side Shade Beam-Diffuse Solar Transmittance

The back side beam-diffuse solar transmittance at normal incidence averaged

over the entire spectrum of solar radiation.

Units: dimensionless

value < 1.0

Parameters:value (float) – value for IDD Field Back Side Shade Beam-Diffuse Solar Transmittance Raises:ValueError – if value is not a valid value Returns:the value of back_side_shade_beamdiffuse_solar_transmittance or None if not set Return type:float

back_side_shade_material_infrared_emissivity

field Back Side Shade Material Infrared Emissivity

The back side long-wave emissivity of the shade material at zero shade

openness. Openness fraction is used to calculate the effective emissivity

value.

Units: dimensionless

Default value: 0.91

value < 1.0

Parameters:value (float) – value for IDD Field Back Side Shade Material Infrared Emissivity Raises:ValueError – if value is not a valid value Returns:the value of back_side_shade_material_infrared_emissivity or None if not set Return type:float

front_side_shade_beamdiffuse_solar_reflectance

field Front Side Shade Beam-Diffuse Solar Reflectance

The front side beam-diffuse solar reflectance at normal incidence averaged

over the entire spectrum of solar radiation.

Units: dimensionless

value < 1.0

Parameters:value (float) – value for IDD Field Front Side Shade Beam-Diffuse Solar Reflectance Raises:ValueError – if value is not a valid value Returns:the value of front_side_shade_beamdiffuse_solar_reflectance or None if not set Return type:float

front_side_shade_beamdiffuse_solar_transmittance

field Front Side Shade Beam-Diffuse Solar Transmittance

The front side beam-diffuse solar transmittance at normal incidence averaged

over the entire spectrum of solar radiation.

Units: dimensionless

value < 1.0

Parameters:value (float) – value for IDD Field Front Side Shade Beam-Diffuse Solar Transmittance Raises:ValueError – if value is not a valid value Returns:the value of front_side_shade_beamdiffuse_solar_transmittance or None if not set Return type:float

front_side_shade_material_infrared_emissivity

field Front Side Shade Material Infrared Emissivity

The front side long-wave emissivity of the shade material at zero shade

openness. Openness fraction is used to calculate the effective emissivity

value.

Units: dimensionless

Default value: 0.91

value < 1.0

Parameters:value (float) – value for IDD Field Front Side Shade Material Infrared Emissivity Raises:ValueError – if value is not a valid value Returns:the value of front_side_shade_material_infrared_emissivity 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

shade_beambeam_solar_transmittance

field Shade Beam-Beam Solar Transmittance

The beam-beam solar transmittance at normal incidence. This value is

the same as the openness area fraction of the shade material. Assumed

to be the same for front and back sides.

Units: dimensionless

value <= 0.8

Parameters:value (float) – value for IDD Field Shade Beam-Beam Solar Transmittance Raises:ValueError – if value is not a valid value Returns:the value of shade_beambeam_solar_transmittance or None if not set Return type:float

shade_beambeam_visible_transmittance_at_normal_incidence

field Shade Beam-Beam Visible Transmittance at Normal Incidence

The beam-beam visible transmittance at normal incidence averaged over the

visible spectrum range of solar radiation. Assumed to be the same for

front and back sides of the shade.

Units: dimensionless

value < 1.0

Parameters:value (float) – value for IDD Field Shade Beam-Beam Visible Transmittance at Normal Incidence Raises:ValueError – if value is not a valid value Returns:the value of shade_beambeam_visible_transmittance_at_normal_incidence or None if not set Return type:float

shade_beamdiffuse_visible_reflectance_at_normal_incidence

field Shade Beam-Diffuse Visible Reflectance at Normal Incidence

The beam-diffuse visible reflectance at normal incidence averaged over the

visible spectrum range of solar radiation. Assumed to be the same for

front and back sides of the shade.

Units: dimensionless

value < 1.0

Parameters:value (float) – value for IDD Field Shade Beam-Diffuse Visible Reflectance at Normal Incidence Raises:ValueError – if value is not a valid value Returns:the value of shade_beamdiffuse_visible_reflectance_at_normal_incidence or None if not set Return type:float

shade_beamdiffuse_visible_transmittance_at_normal_incidence

field Shade Beam-Diffuse Visible Transmittance at Normal Incidence

The beam-diffuse visible transmittance at normal incidence averaged over the

visible spectrum range of solar radiation. Assumed to be the same for

front and back sides of the shade.

Units: dimensionless

value < 1.0

Parameters:value (float) – value for IDD Field Shade Beam-Diffuse Visible Transmittance at Normal Incidence Raises:ValueError – if value is not a valid value Returns:the value of shade_beamdiffuse_visible_transmittance_at_normal_incidence or None if not set Return type:float

shade_material_infrared_transmittance

field Shade Material Infrared Transmittance

The long-wave transmittance of the shade material at zero shade openness.

Assumed to be the same for front and back sides of the shade.

Units: dimensionless

Default value: 0.05

value < 1.0

Parameters:value (float) – value for IDD Field Shade Material Infrared Transmittance Raises:ValueError – if value is not a valid value Returns:the value of shade_material_infrared_transmittance or None if not set Return type:float

class pyidf.surface_construction_elements.WindowMaterialSimpleGlazingSystem

Bases: pyidf.helper.DataObject

Corresponds to IDD object WindowMaterial:SimpleGlazingSystem Alternate method of describing windows This window material object is used to define an entire glazing system using simple performance parameters.

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

solar_heat_gain_coefficient

field Solar Heat Gain Coefficient

SHGC at Normal Incidence

value < 1.0

Parameters:value (float) – value for IDD Field Solar Heat Gain Coefficient Raises:ValueError – if value is not a valid value Returns:the value of solar_heat_gain_coefficient or None if not set Return type:float

ufactor

field U-Factor

Enter U-Factor including film coefficients

Note that the effective upper limit for U-factor is 5.8 W/m2-K

Units: W/m2-K

value <= 7.0

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

visible_transmittance

field Visible Transmittance

VT at Normal Incidence

optional

value < 1.0

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

class pyidf.surface_construction_elements.WindowThermalModelParams

Bases: pyidf.helper.DataObject

Corresponds to IDD object WindowThermalModel:Params object is used to select which thermal model should be used in tarcog simulations

deflection_model

field Deflection Model

Default value: NoDeflection

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

initial_pressure

field Initial pressure

This is pressure in time of window fabrication

Units: Pa

Default value: 101325.0

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

initial_temperature

field Initial temperature

This is temperature in time of window fabrication

Units: C

Default value: 25.0

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

name

field Name

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

sdscalar

field SDScalar

Default value: 1.0

value <= 1.0

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

standard

field standard

Default value: ISO15099

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

thermal_model

field Thermal Model

Default value: ISO15099

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

vacuum_pressure_limit

field Vacuum Pressure Limit

Units: Pa

Default value: 13.238

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