pyidf.detailed_ground_heat_transfer module

Data objects in group “Detailed Ground Heat Transfer”

class pyidf.detailed_ground_heat_transfer.GroundHeatTransferBasementAutoGrid

Bases: pyidf.helper.DataObject

Corresponds to IDD object GroundHeatTransfer:Basement:AutoGrid AutoGrid only necessary when EquivSizing is false If the modeled building is not a rectangle or square, Equivalent sizing MUST be used to get accurate results

basedepth_depth_of_the_basement_wall_below_grade

field BaseDepth: Depth of the basement wall below grade

Units: m

Default value: 2.0

Parameters:value (float) – value for IDD Field BaseDepth: Depth of the basement wall below grade Raises:ValueError – if value is not a valid value Returns:the value of basedepth_depth_of_the_basement_wall_below_grade or None if not set Return type:float

clearance_distance_from_outside_of_wall_to_edge_

field CLEARANCE: Distance from outside of wall to edge,

Units: m

Default value: 15.0

Parameters:value (float) – value for IDD Field CLEARANCE: Distance from outside of wall to edge, Raises:ValueError – if value is not a valid value Returns:the value of clearance_distance_from_outside_of_wall_to_edge_ or None if not set Return type:float

concagheight_height_of_the_foundation_wall_above_grade

field ConcAGHeight: Height of the foundation wall above grade

Units: m

Parameters:value (float) – value for IDD Field ConcAGHeight: Height of the foundation wall above grade Raises:ValueError – if value is not a valid value Returns:the value of concagheight_height_of_the_foundation_wall_above_grade or None if not set Return type:float

slabdepth_thickness_of_the_floor_slab

field SlabDepth: Thickness of the floor slab

Units: m

Default value: 0.1

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

slabx_x_dimension_of_the_building_slab

field SLABX: X dimension of the building slab

Units: m

value <= 60.0

Parameters:value (float) – value for IDD Field SLABX: X dimension of the building slab Raises:ValueError – if value is not a valid value Returns:the value of slabx_x_dimension_of_the_building_slab or None if not set Return type:float

slaby_y_dimension_of_the_building_slab

field SLABY: Y dimension of the building slab

Units: m

value <= 60.0

Parameters:value (float) – value for IDD Field SLABY: Y dimension of the building slab Raises:ValueError – if value is not a valid value Returns:the value of slaby_y_dimension_of_the_building_slab or None if not set Return type:float

class pyidf.detailed_ground_heat_transfer.GroundHeatTransferBasementBldgData

Bases: pyidf.helper.DataObject

Corresponds to IDD object GroundHeatTransfer:Basement:BldgData Specifies the surface and gravel thicknesses used for the Basement preprocessor ground heat transfer simulation.

dgravxy_width_of_gravel_pit_beside_basement_wall

field DGRAVXY: Width of gravel pit beside basement wall

Units: m

Default value: 0.3

Parameters:value (float) – value for IDD Field DGRAVXY: Width of gravel pit beside basement wall Raises:ValueError – if value is not a valid value Returns:the value of dgravxy_width_of_gravel_pit_beside_basement_wall or None if not set Return type:float

dgravzn_gravel_depth_extending_above_the_floor_slab

field DGRAVZN: Gravel depth extending above the floor slab

Units: m

Default value: 0.2

Parameters:value (float) – value for IDD Field DGRAVZN: Gravel depth extending above the floor slab Raises:ValueError – if value is not a valid value Returns:the value of dgravzn_gravel_depth_extending_above_the_floor_slab or None if not set Return type:float

dgravzp_gravel_depth_below_the_floor_slab

field DGRAVZP: Gravel depth below the floor slab

Units: m

Default value: 0.1

Parameters:value (float) – value for IDD Field DGRAVZP: Gravel depth below the floor slab Raises:ValueError – if value is not a valid value Returns:the value of dgravzp_gravel_depth_below_the_floor_slab or None if not set Return type:float

dslab_floor_slab_thickness

field DSLAB: Floor slab thickness

Units: m

Default value: 0.1

value <= 0.25

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

dwall_wall_thickness

field DWALL: Wall thickness

Units: m

Default value: 0.2

value >= 0.2

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

class pyidf.detailed_ground_heat_transfer.GroundHeatTransferBasementComBldg

Bases: pyidf.helper.DataObject

Corresponds to IDD object GroundHeatTransfer:Basement:ComBldg ComBldg contains the monthly average temperatures (C) and possibility of daily variation amplitude

april_average_temperature

field April average temperature

Units: C

Default value: 22.0

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

august_average_temperature

field August average temperature

Units: C

Default value: 22.0

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

daily_variation_sine_wave_amplitude

field Daily variation sine wave amplitude

(Normally zero, just for checking)

Units: deltaC

Parameters:value (float) – value for IDD Field Daily variation sine wave amplitude Raises:ValueError – if value is not a valid value Returns:the value of daily_variation_sine_wave_amplitude or None if not set Return type:float

december_average_temperature

field December average temperature

Units: C

Default value: 22.0

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

february_average_temperature

field February average temperature

Units: C

Default value: 22.0

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

january_average_temperature

field January average temperature

Units: C

Default value: 22.0

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

july_average_temperature

field July average temperature

Units: C

Default value: 22.0

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

june_average_temperature

field June average temperature

Units: C

Default value: 22.0

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

march_average_temperature

field March average temperature

Units: C

Default value: 22.0

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

may_average_temperature

field May average temperature

Units: C

Default value: 22.0

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

november_average_temperature

field November average temperature

Units: C

Default value: 22.0

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

october_average_temperature

field October average temperature

Units: C

Default value: 22.0

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

september_average_temperature

field September average temperature

Units: C

Default value: 22.0

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

class pyidf.detailed_ground_heat_transfer.GroundHeatTransferBasementEquivAutoGrid

Bases: pyidf.helper.DataObject

Corresponds to IDD object GroundHeatTransfer:Basement:EquivAutoGrid EquivAutoGrid necessary when EquivSizing=TRUE, TRUE is is the normal case.

basedepth_depth_of_the_basement_wall_below_grade

field BaseDepth: Depth of the basement wall below grade

Units: m

Default value: 2.0

Parameters:value (float) – value for IDD Field BaseDepth: Depth of the basement wall below grade Raises:ValueError – if value is not a valid value Returns:the value of basedepth_depth_of_the_basement_wall_below_grade or None if not set Return type:float

clearance_distance_from_outside_of_wall_to_edge_of_3d_ground_domain

field CLEARANCE: Distance from outside of wall to edge of 3-D ground domain

Units: m

Default value: 15.0

Parameters:value (float) – value for IDD Field CLEARANCE: Distance from outside of wall to edge of 3-D ground domain Raises:ValueError – if value is not a valid value Returns:the value of clearance_distance_from_outside_of_wall_to_edge_of_3d_ground_domain or None if not set Return type:float

slabdepth_thickness_of_the_floor_slab

field SlabDepth: Thickness of the floor slab

Units: m

Default value: 0.1

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

class pyidf.detailed_ground_heat_transfer.GroundHeatTransferBasementEquivSlab

Bases: pyidf.helper.DataObject

Corresponds to IDD object GroundHeatTransfer:Basement:EquivSlab Using an equivalent slab allows non-rectangular shapes to be modeled accurately. The simulation default should be EquivSizing=True

apratio_the_area_to_perimeter_ratio_for_this_slab

field APRatio: The area to perimeter ratio for this slab

Units: m

Parameters:value (float) – value for IDD Field APRatio: The area to perimeter ratio for this slab Raises:ValueError – if value is not a valid value Returns:the value of apratio_the_area_to_perimeter_ratio_for_this_slab or None if not set Return type:float

equivsizing_flag

field EquivSizing: Flag

Will the dimensions of an equivalent slab be calculated (TRUE)

or will the dimensions be input directly? (FALSE)]

Only advanced special simulations should use FALSE.

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

class pyidf.detailed_ground_heat_transfer.GroundHeatTransferBasementInsulation

Bases: pyidf.helper.DataObject

Corresponds to IDD object GroundHeatTransfer:Basement:Insulation Describes the insulation used on an exterior basement wall for the Basement preprocessor ground heat transfer simulation.

insfull_flag_is_the_wall_fully_insulated

field INSFULL: Flag: Is the wall fully insulated?

True for full insulation

False for insulation half way down side wall from grade line

Parameters:value (str) – value for IDD Field INSFULL: Flag: Is the wall fully insulated? Raises:ValueError – if value is not a valid value Returns:the value of insfull_flag_is_the_wall_fully_insulated or None if not set Return type:str

rext_r_value_of_any_exterior_insulation

field REXT: R Value of any exterior insulation

Units: m2-K/W

Parameters:value (float) – value for IDD Field REXT: R Value of any exterior insulation Raises:ValueError – if value is not a valid value Returns:the value of rext_r_value_of_any_exterior_insulation or None if not set Return type:float

class pyidf.detailed_ground_heat_transfer.GroundHeatTransferBasementInterior

Bases: pyidf.helper.DataObject

Corresponds to IDD object GroundHeatTransfer:Basement:Interior Provides the information needed to simulate the inside boundary conditions for the Basement preprocessor ground heat transfer simulation.

cond_flag_is_the_basement_conditioned

field COND: Flag: Is the basement conditioned?

for EnergyPlus this should be TRUE

Default value: TRUE

Parameters:value (str) – value for IDD Field COND: Flag: Is the basement conditioned? Raises:ValueError – if value is not a valid value Returns:the value of cond_flag_is_the_basement_conditioned or None if not set Return type:str

hin_downward_combined_convection_and_radiation_heat_transfer_coefficient

field HIN: Downward combined (convection and radiation) heat transfer coefficient

Units: W/m2-K

Default value: 6.13

Parameters:value (float) – value for IDD Field HIN: Downward combined (convection and radiation) heat transfer coefficient Raises:ValueError – if value is not a valid value Returns:the value of hin_downward_combined_convection_and_radiation_heat_transfer_coefficient or None if not set Return type:float

hin_downward_convection_only_heat_transfer_coefficient

field HIN: Downward convection only heat transfer coefficient

Units: W/m2-K

Default value: 0.92

Parameters:value (float) – value for IDD Field HIN: Downward convection only heat transfer coefficient Raises:ValueError – if value is not a valid value Returns:the value of hin_downward_convection_only_heat_transfer_coefficient or None if not set Return type:float

hin_horizontal_combined_convection_and_radiation_heat_transfer_coefficient

field HIN: Horizontal combined (convection and radiation) heat transfer coefficient

Units: W/m2-K

Default value: 8.29

Parameters:value (float) – value for IDD Field HIN: Horizontal combined (convection and radiation) heat transfer coefficient Raises:ValueError – if value is not a valid value Returns:the value of hin_horizontal_combined_convection_and_radiation_heat_transfer_coefficient or None if not set Return type:float

hin_horizontal_convection_only_heat_transfer_coefficient

field HIN: Horizontal convection only heat transfer coefficient

Units: W/m2-K

Default value: 3.08

Parameters:value (float) – value for IDD Field HIN: Horizontal convection only heat transfer coefficient Raises:ValueError – if value is not a valid value Returns:the value of hin_horizontal_convection_only_heat_transfer_coefficient or None if not set Return type:float

hin_upward_combined_convection_and_radiation_heat_transfer_coefficient

field HIN: Upward combined (convection and radiation) heat transfer coefficient

Units: W/m2-K

Default value: 9.26

Parameters:value (float) – value for IDD Field HIN: Upward combined (convection and radiation) heat transfer coefficient Raises:ValueError – if value is not a valid value Returns:the value of hin_upward_combined_convection_and_radiation_heat_transfer_coefficient or None if not set Return type:float

hin_upward_convection_only_heat_transfer_coefficient

field HIN: Upward convection only heat transfer coefficient

Units: W/m2-K

Default value: 4.04

Parameters:value (float) – value for IDD Field HIN: Upward convection only heat transfer coefficient Raises:ValueError – if value is not a valid value Returns:the value of hin_upward_convection_only_heat_transfer_coefficient or None if not set Return type:float

class pyidf.detailed_ground_heat_transfer.GroundHeatTransferBasementManualGrid

Bases: pyidf.helper.DataObject

Corresponds to IDD object GroundHeatTransfer:Basement:ManualGrid Manual Grid only necessary using manual gridding (not recommended)

ibase_x_direction_cell_indicator_of_slab_edge_520

field IBASE: X direction cell indicator of slab edge: 5-20]

Parameters:value (float) – value for IDD Field IBASE: X direction cell indicator of slab edge: 5-20] Raises:ValueError – if value is not a valid value Returns:the value of ibase_x_direction_cell_indicator_of_slab_edge_520 or None if not set Return type:float

jbase_y_direction_cell_indicator_of_slab_edge_520

field JBASE: Y direction cell indicator of slab edge: 5-20]

Parameters:value (float) – value for IDD Field JBASE: Y direction cell indicator of slab edge: 5-20] Raises:ValueError – if value is not a valid value Returns:the value of jbase_y_direction_cell_indicator_of_slab_edge_520 or None if not set Return type:float

kbase_z_direction_cell_indicator_of_the_top_of_the_floor_slab_520

field KBASE: Z direction cell indicator of the top of the floor slab: 5-20]

Parameters:value (float) – value for IDD Field KBASE: Z direction cell indicator of the top of the floor slab: 5-20] Raises:ValueError – if value is not a valid value Returns:the value of kbase_z_direction_cell_indicator_of_the_top_of_the_floor_slab_520 or None if not set Return type:float

nx_number_of_cells_in_the_x_direction_20

field NX: Number of cells in the X direction: 20]

value >= 1.0

Parameters:value (float) – value for IDD Field NX: Number of cells in the X direction: 20] Raises:ValueError – if value is not a valid value Returns:the value of nx_number_of_cells_in_the_x_direction_20 or None if not set Return type:float

ny_number_of_cells_in_the_y_direction_20

field NY: Number of cells in the Y direction: 20]

value >= 1.0

Parameters:value (float) – value for IDD Field NY: Number of cells in the Y direction: 20] Raises:ValueError – if value is not a valid value Returns:the value of ny_number_of_cells_in_the_y_direction_20 or None if not set Return type:float

nzag_number_of_cells_in_the_z_direction_above_grade_4_always

field NZAG: Number of cells in the Z direction. above grade: 4 Always]

value >= 1.0

Parameters:value (float) – value for IDD Field NZAG: Number of cells in the Z direction. above grade: 4 Always] Raises:ValueError – if value is not a valid value Returns:the value of nzag_number_of_cells_in_the_z_direction_above_grade_4_always or None if not set Return type:float

nzbg_number_of_cells_in_z_direction_below_grade_1035

field NZBG: Number of cells in Z direction. below grade: 10-35]

value >= 1.0

Parameters:value (float) – value for IDD Field NZBG: Number of cells in Z direction. below grade: 10-35] Raises:ValueError – if value is not a valid value Returns:the value of nzbg_number_of_cells_in_z_direction_below_grade_1035 or None if not set Return type:float

class pyidf.detailed_ground_heat_transfer.GroundHeatTransferBasementMatlProps

Bases: pyidf.helper.DataObject

Corresponds to IDD object GroundHeatTransfer:Basement:MatlProps Specifies the material properties for the Basement preprocessor ground heat transfer simulation. Only the Foundation Wall, Floor Slab, Soil, and Gravel properties are currently used.

density_for_ceiling

field density for Ceiling

Units: kg/m3

Default value: 311.0

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

density_for_floor_slab

field density for Floor Slab

Units: kg/m3

Default value: 2243.0

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

density_for_foundation_wall

field Density for Foundation Wall

Units: kg/m3

Default value: 2243.0

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

density_for_gravel

field density for Gravel

Units: kg/m3

Default value: 2000.0

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

density_for_soil

field density for Soil

Units: kg/m3

Default value: 1500.0

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

density_for_wood

field density for Wood

Units: kg/m3

Default value: 449.0

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

nmat_number_of_materials_in_this_domain

field NMAT: Number of materials in this domain

value <= 6.0

Parameters:value (float) – value for IDD Field NMAT: Number of materials in this domain Raises:ValueError – if value is not a valid value Returns:the value of nmat_number_of_materials_in_this_domain or None if not set Return type:float

specific_heat_for_ceiling

field Specific heat for ceiling

Units: J/kg-K

Default value: 1530.0

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

specific_heat_for_floor_slab

field Specific heat for floor slab

Units: J/kg-K

Default value: 880.0

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

specific_heat_for_foundation_wall

field Specific heat for foundation wall

Units: J/kg-K

Default value: 880.0

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

specific_heat_for_gravel

field Specific heat for gravel

Units: J/kg-K

Default value: 720.0

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

specific_heat_for_soil

field Specific heat for soil

Units: J/kg-K

Default value: 840.0

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

specific_heat_for_wood

field Specific heat for wood

Units: J/kg-K

Default value: 1530.0

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

thermal_conductivity_for_ceiling

field Thermal conductivity for ceiling

Units: W/m-K

Default value: 0.09

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

thermal_conductivity_for_floor_slab

field Thermal conductivity for floor slab

Units: W/m-K

Default value: 1.4

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

thermal_conductivity_for_foundation_wall

field Thermal conductivity for foundation wall

Units: W/m-K

Default value: 1.4

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

thermal_conductivity_for_gravel

field thermal conductivity for gravel

Units: W/m-K

Default value: 1.9

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

thermal_conductivity_for_soil

field thermal conductivity for soil

Units: W/m-K

Default value: 1.1

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

thermal_conductivity_for_wood

field thermal conductivity for wood

Units: W/m-K

Default value: 0.12

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

class pyidf.detailed_ground_heat_transfer.GroundHeatTransferBasementSimParameters

Bases: pyidf.helper.DataObject

Corresponds to IDD object GroundHeatTransfer:Basement:SimParameters Specifies certain parameters that control the Basement preprocessor ground heat transfer simulation.

f_multiplier_for_the_adi_solution

field F: Multiplier for the ADI solution

0<F<1.0,

typically 0.1 (0.3 for high k soil - saturated sand is about 2.6 w/m-K)

value <= 1.0

Parameters:value (float) – value for IDD Field F: Multiplier for the ADI solution Raises:ValueError – if value is not a valid value Returns:the value of f_multiplier_for_the_adi_solution or None if not set Return type:float

iyrs_maximum_number_of_yearly_iterations

field IYRS: Maximum number of yearly iterations:

typically 15-30]

Default value: 15.0

Parameters:value (float) – value for IDD Field IYRS: Maximum number of yearly iterations: Raises:ValueError – if value is not a valid value Returns:the value of iyrs_maximum_number_of_yearly_iterations or None if not set Return type:float

class pyidf.detailed_ground_heat_transfer.GroundHeatTransferBasementSurfaceProps

Bases: pyidf.helper.DataObject

Corresponds to IDD object GroundHeatTransfer:Basement:SurfaceProps Specifies the soil surface properties for the Basement preprocessor ground heat transfer simulation.

albedo_surface_albedo_for_no_snow_conditions

field ALBEDO: Surface albedo for No snow conditions

Default value: 0.16

value <= 1.0

Parameters:value (float) – value for IDD Field ALBEDO: Surface albedo for No snow conditions Raises:ValueError – if value is not a valid value Returns:the value of albedo_surface_albedo_for_no_snow_conditions or None if not set Return type:float

albedo_surface_albedo_for_snow_conditions

field ALBEDO: Surface albedo for snow conditions

Default value: 0.4

value <= 1.0

Parameters:value (float) – value for IDD Field ALBEDO: Surface albedo for snow conditions Raises:ValueError – if value is not a valid value Returns:the value of albedo_surface_albedo_for_snow_conditions or None if not set Return type:float

epsln_surface_emissivity_no_snow

field EPSLN: Surface emissivity No Snow

Default value: 0.94

value <= 1.0

Parameters:value (float) – value for IDD Field EPSLN: Surface emissivity No Snow Raises:ValueError – if value is not a valid value Returns:the value of epsln_surface_emissivity_no_snow or None if not set Return type:float

epsln_surface_emissivity_with_snow

field EPSLN: Surface emissivity with Snow

Default value: 0.86

value <= 1.0

Parameters:value (float) – value for IDD Field EPSLN: Surface emissivity with Snow Raises:ValueError – if value is not a valid value Returns:the value of epsln_surface_emissivity_with_snow or None if not set Return type:float

pet_flag_potential_evapotranspiration_on

field PET: Flag, Potential evapotranspiration on?

Typically, PET is False

Default value: FALSE

Parameters:value (str) – value for IDD Field PET: Flag, Potential evapotranspiration on? Raises:ValueError – if value is not a valid value Returns:the value of pet_flag_potential_evapotranspiration_on or None if not set Return type:str

veght_surface_roughness_no_snow_conditions

field VEGHT: Surface roughness No snow conditions

Units: cm

Default value: 6.0

Parameters:value (float) – value for IDD Field VEGHT: Surface roughness No snow conditions Raises:ValueError – if value is not a valid value Returns:the value of veght_surface_roughness_no_snow_conditions or None if not set Return type:float

veght_surface_roughness_snow_conditions

field VEGHT: Surface roughness Snow conditions

Units: cm

Default value: 0.25

Parameters:value (float) – value for IDD Field VEGHT: Surface roughness Snow conditions Raises:ValueError – if value is not a valid value Returns:the value of veght_surface_roughness_snow_conditions or None if not set Return type:float

class pyidf.detailed_ground_heat_transfer.GroundHeatTransferBasementXface

Bases: pyidf.helper.DataObject

Corresponds to IDD object GroundHeatTransfer:Basement:XFACE This is only needed when using manual gridding (not recommended) XFACE: X Direction cell face coordinates: m

class pyidf.detailed_ground_heat_transfer.GroundHeatTransferBasementYface

Bases: pyidf.helper.DataObject

Corresponds to IDD object GroundHeatTransfer:Basement:YFACE This is only needed when using manual gridding (not recommended) YFACE: Y Direction cell face coordinates: m

class pyidf.detailed_ground_heat_transfer.GroundHeatTransferBasementZface

Bases: pyidf.helper.DataObject

Corresponds to IDD object GroundHeatTransfer:Basement:ZFACE This is only needed when using manual gridding (not recommended) ZFACE: Z Direction cell face coordinates: m

class pyidf.detailed_ground_heat_transfer.GroundHeatTransferControl

Bases: pyidf.helper.DataObject

Corresponds to IDD object GroundHeatTransfer:Control Object determines if the Slab and Basement preprocessors are going to be executed.

name

field Name

This field is included for consistency.11

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

run_basement_preprocessor

field Run Basement Preprocessor

Default value: No

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

run_slab_preprocessor

field Run Slab Preprocessor

Default value: No

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

class pyidf.detailed_ground_heat_transfer.GroundHeatTransferSlabAutoGrid

Bases: pyidf.helper.DataObject

Corresponds to IDD object GroundHeatTransfer:Slab:AutoGrid AutoGrid only necessary when EquivalentSlab option not chosen. Not normally needed by EnergyPlus users. This object permits user selection of rectangular slab dimensions. NO SLAB DIMENSIONS LESS THAN 6 m.

clearance_distance_from_edge_of_slab_to_domain_edge

field CLEARANCE: Distance from edge of slab to domain edge

Units: m

Default value: 15.0

Parameters:value (float) – value for IDD Field CLEARANCE: Distance from edge of slab to domain edge Raises:ValueError – if value is not a valid value Returns:the value of clearance_distance_from_edge_of_slab_to_domain_edge or None if not set Return type:float

slabdepth_thickness_of_slab_on_grade

field SLABDEPTH: Thickness of slab on grade

Units: m

Default value: 0.1

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

slabx_x_dimension_of_the_building_slab

field SLABX: X dimension of the building slab

typical values= 6 to 60.0

Units: m

value >= 6.0

Parameters:value (float) – value for IDD Field SLABX: X dimension of the building slab Raises:ValueError – if value is not a valid value Returns:the value of slabx_x_dimension_of_the_building_slab or None if not set Return type:float

slaby_y_dimension_of_the_building_slab

field SLABY: Y dimension of the building slab

typical values= 6 to 60.0

Units: m

value >= 6.0

Parameters:value (float) – value for IDD Field SLABY: Y dimension of the building slab Raises:ValueError – if value is not a valid value Returns:the value of slaby_y_dimension_of_the_building_slab or None if not set Return type:float

zclearance_distance_from_bottom_of_slab_to_domain_bottom

field ZCLEARANCE: Distance from bottom of slab to domain bottom

Units: m

Default value: 15.0

Parameters:value (float) – value for IDD Field ZCLEARANCE: Distance from bottom of slab to domain bottom Raises:ValueError – if value is not a valid value Returns:the value of zclearance_distance_from_bottom_of_slab_to_domain_bottom or None if not set Return type:float

class pyidf.detailed_ground_heat_transfer.GroundHeatTransferSlabBldgProps

Bases: pyidf.helper.DataObject

Corresponds to IDD object GroundHeatTransfer:Slab:BldgProps Object provides information about the building and its operating conditions Monthly Average Temperature SetPoint fields specify the average indoor building set point temperatures for each month of the year. These fields are useful for simulating a building that is not temperature controlled for some of the year. In such a case, the average indoor set point temperatures can be obtained by first running the model in EnergyPlus with an insulated floor boundary condition, and then using the resulting monthly average zone temperatures in these fields.

convtol_convergence_tolerance

field ConvTol: Convergence Tolerance

This field specifies the convergence tolerance used to

control the iteration. When the temperature change of all nodes

is less than the convergence value, iteration ceases.

Default value: 0.1

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

hbldg_building_height

field HBLDG: Building height

This field supplies the building height. This is used to calculate

the building shadowing on the ground.

typical value= 0-20

Units: m

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

iyrs_number_of_years_to_iterate

field IYRS: Number of years to iterate

This field specifies the number of years to iterate.

Either the ground heat transfer calculations come to an

an annual steady periodic condition by converging to a tolerance

(see ConvTol field) or it runs for this number of years.

A ten year maximum is usually sufficient.

Default value: 10.0

value >= 1.0

Parameters:value (float) – value for IDD Field IYRS: Number of years to iterate Raises:ValueError – if value is not a valid value Returns:the value of iyrs_number_of_years_to_iterate or None if not set Return type:float

shape_slab_shape

field Shape: Slab shape

Use only the value 0 here. Only a rectangular shape is implemented.

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

tin10_october_indoor_average_temperature_setpoint

field TIN10: October Indoor Average Temperature Setpoint

see memo on object for more information

Units: C

Default value: 22.0

Parameters:value (float) – value for IDD Field TIN10: October Indoor Average Temperature Setpoint Raises:ValueError – if value is not a valid value Returns:the value of tin10_october_indoor_average_temperature_setpoint or None if not set Return type:float

tin11_november_indoor_average_temperature_setpoint

field TIN11: November Indoor Average Temperature Setpoint

see memo on object for more information

Units: C

Default value: 22.0

Parameters:value (float) – value for IDD Field TIN11: November Indoor Average Temperature Setpoint Raises:ValueError – if value is not a valid value Returns:the value of tin11_november_indoor_average_temperature_setpoint or None if not set Return type:float

tin12_december_indoor_average_temperature_setpoint

field TIN12: December Indoor Average Temperature Setpoint

see memo on object for more information

Units: C

Default value: 22.0

Parameters:value (float) – value for IDD Field TIN12: December Indoor Average Temperature Setpoint Raises:ValueError – if value is not a valid value Returns:the value of tin12_december_indoor_average_temperature_setpoint or None if not set Return type:float

tin1_january_indoor_average_temperature_setpoint

field TIN1: January Indoor Average Temperature Setpoint

see memo on object for more information

Units: C

Default value: 22.0

Parameters:value (float) – value for IDD Field TIN1: January Indoor Average Temperature Setpoint Raises:ValueError – if value is not a valid value Returns:the value of tin1_january_indoor_average_temperature_setpoint or None if not set Return type:float

tin2_february_indoor_average_temperature_setpoint

field TIN2: February Indoor Average Temperature Setpoint

see memo on object for more information

Units: C

Default value: 22.0

Parameters:value (float) – value for IDD Field TIN2: February Indoor Average Temperature Setpoint Raises:ValueError – if value is not a valid value Returns:the value of tin2_february_indoor_average_temperature_setpoint or None if not set Return type:float

tin3_march_indoor_average_temperature_setpoint

field TIN3: March Indoor Average Temperature Setpoint

see memo on object for more information

Units: C

Default value: 22.0

Parameters:value (float) – value for IDD Field TIN3: March Indoor Average Temperature Setpoint Raises:ValueError – if value is not a valid value Returns:the value of tin3_march_indoor_average_temperature_setpoint or None if not set Return type:float

tin4_april_indoor_average_temperature_setpoint

field TIN4: April Indoor Average Temperature Setpoint

see memo on object for more information

Units: C

Default value: 22.0

Parameters:value (float) – value for IDD Field TIN4: April Indoor Average Temperature Setpoint Raises:ValueError – if value is not a valid value Returns:the value of tin4_april_indoor_average_temperature_setpoint or None if not set Return type:float

tin5_may_indoor_average_temperature_setpoint

field TIN5: May Indoor Average Temperature Setpoint

see memo on object for more information

Units: C

Default value: 22.0

Parameters:value (float) – value for IDD Field TIN5: May Indoor Average Temperature Setpoint Raises:ValueError – if value is not a valid value Returns:the value of tin5_may_indoor_average_temperature_setpoint or None if not set Return type:float

tin6_june_indoor_average_temperature_setpoint

field TIN6: June Indoor Average Temperature Setpoint

see memo on object for more information

Units: C

Default value: 22.0

Parameters:value (float) – value for IDD Field TIN6: June Indoor Average Temperature Setpoint Raises:ValueError – if value is not a valid value Returns:the value of tin6_june_indoor_average_temperature_setpoint or None if not set Return type:float

tin7_july_indoor_average_temperature_setpoint

field TIN7: July Indoor Average Temperature Setpoint

see memo on object for more information

Units: C

Default value: 22.0

Parameters:value (float) – value for IDD Field TIN7: July Indoor Average Temperature Setpoint Raises:ValueError – if value is not a valid value Returns:the value of tin7_july_indoor_average_temperature_setpoint or None if not set Return type:float

tin8_august_indoor_average_temperature_setpoint

field TIN8: August Indoor Average Temperature Setpoint

see memo on object for more information

Units: C

Default value: 22.0

Parameters:value (float) – value for IDD Field TIN8: August Indoor Average Temperature Setpoint Raises:ValueError – if value is not a valid value Returns:the value of tin8_august_indoor_average_temperature_setpoint or None if not set Return type:float

tin9_september_indoor_average_temperature_setpoint

field TIN9: September Indoor Average Temperature Setpoint

see memo on object for more information

Units: C

Default value: 22.0

Parameters:value (float) – value for IDD Field TIN9: September Indoor Average Temperature Setpoint Raises:ValueError – if value is not a valid value Returns:the value of tin9_september_indoor_average_temperature_setpoint or None if not set Return type:float

tinamp_daily_indoor_sine_wave_variation_amplitude

field TINAmp: Daily Indoor sine wave variation amplitude

This field permits imposing a daily sinusoidal variation

in the indoor setpoint temperature to simulate the effect

of a setback profile.

The value specified is the amplitude of the sine wave.

Units: deltaC

Parameters:value (float) – value for IDD Field TINAmp: Daily Indoor sine wave variation amplitude Raises:ValueError – if value is not a valid value Returns:the value of tinamp_daily_indoor_sine_wave_variation_amplitude or None if not set Return type:float

class pyidf.detailed_ground_heat_transfer.GroundHeatTransferSlabBoundConds

Bases: pyidf.helper.DataObject

Corresponds to IDD object GroundHeatTransfer:Slab:BoundConds Supplies some of the boundary conditions used in the ground heat transfer calculations.

evtr_is_surface_evapotranspiration_modeled

field EVTR: Is surface evapotranspiration modeled

This field specifies whether or not to use the evapotransporation model.

The inclusion of evapotransporation in the calculation has the greatest

effect in warm dry climates, primarily on the ground surface temperature.

This field can be used to turn the evapotransporation off and on to check

sensitivity to it.

Parameters:value (str) – value for IDD Field EVTR: Is surface evapotranspiration modeled Raises:ValueError – if value is not a valid value Returns:the value of evtr_is_surface_evapotranspiration_modeled or None if not set Return type:str

fixbc_is_the_lower_boundary_at_a_fixed_temperature

field FIXBC: is the lower boundary at a fixed temperature

This field permits using a fixed temperature at the lower surface of the model

instead of a zero heat flux condition. This change normally has a very small

effect on the results.

FALSE selects the zero flux lower boundary condition

Parameters:value (str) – value for IDD Field FIXBC: is the lower boundary at a fixed temperature Raises:ValueError – if value is not a valid value Returns:the value of fixbc_is_the_lower_boundary_at_a_fixed_temperature or None if not set Return type:str

tdeepin

field TDEEPin

User input lower boundary temperature if FIXBC is TRUE

Blank for FIXBC FALSE or to use the calculated 1-D deep ground temperature.

Units: C

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

userh_user_specified_ground_surface_heat_transfer_coefficient

field USERH: User specified ground surface heat transfer coefficient

Used only if USRHflag is TRUE and the heat transfer coefficient value is

specified in this field.

Units: W/m2-K

Parameters:value (float) – value for IDD Field USERH: User specified ground surface heat transfer coefficient Raises:ValueError – if value is not a valid value Returns:the value of userh_user_specified_ground_surface_heat_transfer_coefficient or None if not set Return type:float

usrhflag_is_the_ground_surface_h_specified_by_the_user

field USRHflag: Is the ground surface h specified by the user?

This field flags the use of a user specified heat transfer coefficient

on the ground surface. This condition is used primarily for testing.

For normal runs (USPHflag is FALSE) and the program calculates the heat

transfer coefficient using the weather conditions.

Parameters:value (str) – value for IDD Field USRHflag: Is the ground surface h specified by the user? Raises:ValueError – if value is not a valid value Returns:the value of usrhflag_is_the_ground_surface_h_specified_by_the_user or None if not set Return type:str

class pyidf.detailed_ground_heat_transfer.GroundHeatTransferSlabEquivalentSlab

Bases: pyidf.helper.DataObject

Corresponds to IDD object GroundHeatTransfer:Slab:EquivalentSlab Using an equivalent slab allows non-rectangular shapes to be modeled accurately. Object uses the area - perimeter (area/perimeter) ratio to determine the size of an equivalent rectangular slab. EnergyPlus users normally use this option.

apratio_the_area_to_perimeter_ratio_for_this_slab

field APRatio: The area to perimeter ratio for this slab

Equivalent square slab is simulated, side is 4*APRatio.

Units: m

value >= 1.5

value <= 22.0

Parameters:value (float) – value for IDD Field APRatio: The area to perimeter ratio for this slab Raises:ValueError – if value is not a valid value Returns:the value of apratio_the_area_to_perimeter_ratio_for_this_slab or None if not set Return type:float

clearance_distance_from_edge_of_slab_to_domain_edge

field CLEARANCE: Distance from edge of slab to domain edge

This field specifies the distance from the slab to the edge of

the area that will be modeled with the grid system. It is the basic size

dimension that is used to set the horizontal extent of the domain.

15 meters is a reasonable value.

Units: m

Default value: 15.0

Parameters:value (float) – value for IDD Field CLEARANCE: Distance from edge of slab to domain edge Raises:ValueError – if value is not a valid value Returns:the value of clearance_distance_from_edge_of_slab_to_domain_edge or None if not set Return type:float

slabdepth_thickness_of_slab_on_grade

field SLABDEPTH: Thickness of slab on grade

This field specifies the thickness of the slab. The slab top surface is level

with the ground surface, so this is the depth into the ground.

The slab depth has a significant effect on the temperature calculation,

and it is also important for the auto-grid process.

The finite difference grids are set in such a way that they use the slab thickness

to determine the vertical grid spacing. Autogridding will fail if the slab thickness

is specified larger than 0.25 meters.

Units: m

Default value: 0.1

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

zclearance_distance_from_bottom_of_slab_to_domain_bottom

field ZCLEARANCE: Distance from bottom of slab to domain bottom

This field specifies the vertical distance from the slab to the

bottom edge of the area that will be modeled with the grid system.

15 meters is a reasonable value.

Units: m

Default value: 15.0

Parameters:value (float) – value for IDD Field ZCLEARANCE: Distance from bottom of slab to domain bottom Raises:ValueError – if value is not a valid value Returns:the value of zclearance_distance_from_bottom_of_slab_to_domain_bottom or None if not set Return type:float

class pyidf.detailed_ground_heat_transfer.GroundHeatTransferSlabInsulation

Bases: pyidf.helper.DataObject

Corresponds to IDD object GroundHeatTransfer:Slab:Insulation This object supplies the information about insulation used around the slab. There are two possible configurations: under the slab or vertical insulation around the slab.

dins_width_of_strip_of_under_slab_insulation

field DINS: Width of strip of under slab insulation

This specifies the width of the perimeter strip of insulation

under the slab. It should be zero if for the vertical insulation

configuration is selected.

typical value= 0-2.0

Units: m

Parameters:value (float) – value for IDD Field DINS: Width of strip of under slab insulation Raises:ValueError – if value is not a valid value Returns:the value of dins_width_of_strip_of_under_slab_insulation or None if not set Return type:float

ivins_flag_is_there_vertical_insulation

field IVINS: Flag: Is there vertical insulation

Specifies if the vertical insulation configuration is being used.

values: 1=yes vertical insulation 0=no under-slab insulation

Parameters:value (int) – value for IDD Field IVINS: Flag: Is there vertical insulation Raises:ValueError – if value is not a valid value Returns:the value of ivins_flag_is_there_vertical_insulation or None if not set Return type:int

rins_r_value_of_under_slab_insulation

field RINS: R value of under slab insulation

This field provides the thermal resistance value

of the under slab insulation. It should be zero

if the vertical insulation configuration is selected.

typical value= 0-2.0

Units: m2-K/W

Parameters:value (float) – value for IDD Field RINS: R value of under slab insulation Raises:ValueError – if value is not a valid value Returns:the value of rins_r_value_of_under_slab_insulation or None if not set Return type:float

rvins_r_value_of_vertical_insulation

field RVINS: R value of vertical insulation

This field specifies the thermal resistance of the vertical

insulation. It should be zero if the under slab insulation

configuration is selected.

typical value= 0-3.0

Units: m2-K/W

Parameters:value (float) – value for IDD Field RVINS: R value of vertical insulation Raises:ValueError – if value is not a valid value Returns:the value of rvins_r_value_of_vertical_insulation or None if not set Return type:float

zvins_depth_of_vertical_insulation

field ZVINS: Depth of vertical insulation

This field specifies the depth of the vertical insulation

into the ground in meters. It starts at the slab upper surface

and extends into the ground.

It should be zero if the under slab insulation

configuration is selected.

only use values= .2 .4 .6 .8 1.0 1.5 2.0 2.5 3.0

Units: m

Parameters:value (float) – value for IDD Field ZVINS: Depth of vertical insulation Raises:ValueError – if value is not a valid value Returns:the value of zvins_depth_of_vertical_insulation or None if not set Return type:float

class pyidf.detailed_ground_heat_transfer.GroundHeatTransferSlabManualGrid

Bases: pyidf.helper.DataObject

Corresponds to IDD object GroundHeatTransfer:Slab:ManualGrid Manual Grid only necessary when using manual gridding (not recommended) Used only in special cases when previous two objects are not used. User must input complete gridding information.

ibox_x_direction_cell_indicator_of_slab_edge

field IBOX: X direction cell indicator of slab edge

typical values= 1-10

Parameters:value (float) – value for IDD Field IBOX: X direction cell indicator of slab edge Raises:ValueError – if value is not a valid value Returns:the value of ibox_x_direction_cell_indicator_of_slab_edge or None if not set Return type:float

jbox_y_direction_cell_indicator_of_slab_edge

field JBOX: Y direction cell indicator of slab edge

typical values= 1-10

Parameters:value (float) – value for IDD Field JBOX: Y direction cell indicator of slab edge Raises:ValueError – if value is not a valid value Returns:the value of jbox_y_direction_cell_indicator_of_slab_edge or None if not set Return type:float

nx_number_of_cells_in_the_x_direction

field NX: Number of cells in the X direction

value >= 1.0

Parameters:value (float) – value for IDD Field NX: Number of cells in the X direction Raises:ValueError – if value is not a valid value Returns:the value of nx_number_of_cells_in_the_x_direction or None if not set Return type:float

ny_number_of_cells_in_the_y_direction

field NY: Number of cells in the Y direction

value >= 1.0

Parameters:value (float) – value for IDD Field NY: Number of cells in the Y direction Raises:ValueError – if value is not a valid value Returns:the value of ny_number_of_cells_in_the_y_direction or None if not set Return type:float

nz_number_of_cells_in_the_z_direction

field NZ: Number of cells in the Z direction

value >= 1.0

Parameters:value (float) – value for IDD Field NZ: Number of cells in the Z direction Raises:ValueError – if value is not a valid value Returns:the value of nz_number_of_cells_in_the_z_direction or None if not set Return type:float

class pyidf.detailed_ground_heat_transfer.GroundHeatTransferSlabMaterials

Bases: pyidf.helper.DataObject

Corresponds to IDD object GroundHeatTransfer:Slab:Materials Object gives an overall description of the slab ground heat transfer model.

albedo_surface_albedo_no_snow

field ALBEDO: Surface Albedo: No Snow

Two fields specify the albedo value of the surface: first for no snow coverage days;

second for days with snow coverage. The albedo is the solar reflectivity of the surface,

and can vary from 0.05 for blacktop to 0.95 for fresh snow.

Typical values for North America reported by Bahnfleth range from 0.16 to 0.4.

Default value: 0.16

value <= 1.0

Parameters:value (float) – value for IDD Field ALBEDO: Surface Albedo: No Snow Raises:ValueError – if value is not a valid value Returns:the value of albedo_surface_albedo_no_snow or None if not set Return type:float

albedo_surface_albedo_snow

field ALBEDO: Surface Albedo: Snow

Default value: 0.4

value <= 1.0

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

epslw_surface_emissivity_no_snow

field EPSLW: Surface Emissivity: No Snow

EPSLW (No Snow and Snow) specifies the long wavelength (thermal) emissivity of the ground surface.

primarily important for nighttime radiation to sky.

typical value .95

Default value: 0.94

Parameters:value (float) – value for IDD Field EPSLW: Surface Emissivity: No Snow Raises:ValueError – if value is not a valid value Returns:the value of epslw_surface_emissivity_no_snow or None if not set Return type:float

epslw_surface_emissivity_snow

field EPSLW: Surface Emissivity: Snow

Default value: 0.86

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

hin_indoor_hconv_downward_flow

field HIN: Indoor HConv: Downward Flow

These fields specify the combined convective and radiative heat transfer coefficient between

the slab top inside surface and the room air for the cases where heat is flowing downward,

and upward. The program toggles between the two if the direction of the heat flux changes.

Typical values can be found in the ASHRAE Handbook of Fundamentals, but should be

about 6 W/(m2-K) for downward heat flow and 9 W/(m2-K) for upward heat flow.

typical value= 4-10

Units: W/m2-K

Default value: 6.13

Parameters:value (float) – value for IDD Field HIN: Indoor HConv: Downward Flow Raises:ValueError – if value is not a valid value Returns:the value of hin_indoor_hconv_downward_flow or None if not set Return type:float

hin_indoor_hconv_upward

field HIN: Indoor HConv: Upward

typical value= 4-10

Units: W/m2-K

Default value: 9.26

Parameters:value (float) – value for IDD Field HIN: Indoor HConv: Upward Raises:ValueError – if value is not a valid value Returns:the value of hin_indoor_hconv_upward or None if not set Return type:float

nmat_number_of_materials

field NMAT: Number of materials

This field specifies the number of different materials that will be used in the model.

Typically only a ground material and a slab material are used. (2 materials)

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

z0_surface_roughness_no_snow

field Z0: Surface Roughness: No Snow

fields Z0 (No Snow and Snow) describe the height at which an experimentally velocity profile goes to zero.

typical value= .75 cm

Units: cm

Default value: 0.75

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

z0_surface_roughness_snow

field Z0: Surface Roughness: Snow

typical value= .05 cm

Units: cm

Default value: 0.25

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

class pyidf.detailed_ground_heat_transfer.GroundHeatTransferSlabMatlProps

Bases: pyidf.helper.DataObject

Corresponds to IDD object GroundHeatTransfer:Slab:MatlProps This object contains the material properties for the materials used in the model. The fields are mostly self explanatory.

cp_slab_cp

field CP: Slab CP

Specific Heat of Slab Material

typical value=650.0

Units: J/kg-K

Default value: 650.0

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

cp_soil_cp

field CP: Soil CP

Specific Heat of Soil Material

typical value= 1200.0

Units: J/kg-K

Default value: 1200.0

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

rho_slab_material_density

field RHO: Slab Material density

Density of Slab Material

typical value= 2300.0

Units: kg/m3

Default value: 2300.0

Parameters:value (float) – value for IDD Field RHO: Slab Material density Raises:ValueError – if value is not a valid value Returns:the value of rho_slab_material_density or None if not set Return type:float

rho_soil_density

field RHO: Soil Density

Density of Soil Material

typical value= 1200.0

Units: kg/m3

Default value: 1200.0

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

tcon_slab_k

field TCON: Slab k

Conductivity of Slab Material

typical value= .9

Units: W/m-K

Default value: 0.9

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

tcon_soil_k

field TCON: Soil k

Conductivity of Soil Material

typical value= 1.0

Units: W/m-K

Default value: 1.0

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

class pyidf.detailed_ground_heat_transfer.GroundHeatTransferSlabXface

Bases: pyidf.helper.DataObject

Corresponds to IDD object GroundHeatTransfer:Slab:XFACE This is only needed when using manual gridding (not recommended) XFACE: X Direction cell face coordinates: m

class pyidf.detailed_ground_heat_transfer.GroundHeatTransferSlabYface

Bases: pyidf.helper.DataObject

Corresponds to IDD object GroundHeatTransfer:Slab:YFACE This is only needed when using manual gridding (not recommended) YFACE: Y Direction cell face coordinates: m,

class pyidf.detailed_ground_heat_transfer.GroundHeatTransferSlabZface

Bases: pyidf.helper.DataObject

Corresponds to IDD object GroundHeatTransfer:Slab:ZFACE This is only needed when using manual gridding (not recommended) ZFACE: Z Direction cell face coordinates: m