Advanced Construction, Surface, Zone Concepts¶
29 object types from idfpy.models.advanced_construction · EnergyPlus 26.2
| Object | Summary |
|---|---|
| ComplexFenestrationProperty:SolarAbsorbedLayers | Used to provide solar radiation absorbed in fenestration layers. |
| Foundation:Kiva | Refined definition of the foundation surface construction used to inform two-dimensional heat transfer … |
| Foundation:Kiva:Settings | Settings applied across all Kiva foundation calculations. |
| SurfaceControl:MovableInsulation | Exterior or Interior Insulation on opaque surfaces |
| SurfaceConvectionAlgorithm:Inside:AdaptiveModelSelections | Options to change the individual convection model equations for dynamic selection when using … |
| SurfaceConvectionAlgorithm:Inside:UserCurve | Used to describe a custom model equation for surface convection heat transfer coefficient If more than one … |
| SurfaceConvectionAlgorithm:Outside:AdaptiveModelSelections | Options to change the individual convection model equations for dynamic selection when using … |
| SurfaceConvectionAlgorithm:Outside:UserCurve | Used to describe a custom model equation for surface convection heat transfer coefficient If more than one … |
| SurfaceProperties:VaporCoefficients | The interior and external vapor transfer coefficients. |
| SurfaceProperty:ConvectionCoefficients | Allow user settable interior and/or exterior convection coefficients. |
| SurfaceProperty:ConvectionCoefficients:MultipleSurface | Allow user settable interior and/or exterior convection coefficients. |
| SurfaceProperty:ExposedFoundationPerimeter | Defines the perimeter of a foundation floor that is exposed to the exterior environment through the floor. |
| SurfaceProperty:ExteriorNaturalVentedCavity | Used to describe the decoupled layer, or baffle, and the characteristics of the cavity and openings for … |
| SurfaceProperty:GroundSurfaces | This object defines a list of ground surfaces for use with an exterior surface. |
| SurfaceProperty:HeatBalanceSourceTerm | Allows an additional heat source term to be added to the inside or outside surface boundary. |
| SurfaceProperty:HeatTransferAlgorithm | Determines which Heat Balance Algorithm will be used for a specific surface Allows selectively overriding the … |
| SurfaceProperty:HeatTransferAlgorithm:Construction | Determines which Heat Balance Algorithm will be used for surfaces that have a specific type of construction … |
| SurfaceProperty:HeatTransferAlgorithm:MultipleSurface | Determines which Heat Balance Algorithm will be used for a group of surface types Allows selectively … |
| SurfaceProperty:HeatTransferAlgorithm:SurfaceList | Determines which Heat Balance Algorithm will be used for a list of surfaces Allows selectively overriding the … |
| SurfaceProperty:IncidentSolarMultiplier | |
| SurfaceProperty:LocalEnvironment | This object defines the local environment properties of an exterior surface. |
| SurfaceProperty:OtherSideCoefficients | This object sets the other side conditions for a surface in a variety of ways. |
| SurfaceProperty:OtherSideConditionsModel | This object sets up modifying the other side conditions for a surface from other model results. |
| SurfaceProperty:SolarIncidentInside | Used to provide incident solar radiation on the inside of the surface. |
| SurfaceProperty:SurroundingSurfaces | This object defines a list of surrounding surfaces for an exterior surface. |
| SurfaceProperty:Underwater | This object sets up a convective water boundary condition for a surface The free stream temperature and … |
| ZoneMRTCalculation | Blends MRT values calculated for People instances into one Zone MRT. |
| ZoneProperty:LocalEnvironment | This object defines the local environment properties of a zone object. |
| ZoneProperty:UserViewFactors:BySurfaceName | View factors for Surface to Surface in a zone. |
ComplexFenestrationProperty:SolarAbsorbedLayers¶
from idfpy.models import ComplexFenestrationPropertySolarAbsorbedLayers
Used to provide solar radiation absorbed in fenestration layers. References surface-construction pair and if that pair is used in a simulation, then program will use value provided in schedules instead of calculating it.
Foundation:Kiva¶
from idfpy.models import FoundationKiva extensible
Refined definition of the foundation surface construction used to inform two-dimensional heat transfer calculated using the Kiva ground heat transfer methodology.
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | ||
initial_Initial Indoor Air Temperature |
number C |
Indoor air temperature used for Kiva initialization (prior to warmup period) If left blank, indoor air temperature will be determined based on zone setpoints | |
interior_Interior Horizontal Insulation Material Name |
reference | Names a Material, Material:AirGap, Material:InfraredTransparent, Material:NoMass, Material:RoofVegetation, WindowMaterial:Blind, WindowMaterial:Gas, WindowMaterial:GasMixture, WindowMaterial:Glazing, WindowMaterial:Glazing:RefractionExtinctionMethod, WindowMaterial:GlazingGroup:Thermochromic, WindowMaterial:Screen and 2 more | |
interior_Interior Horizontal Insulation Depth |
number m |
0.0 |
Distance from the slab bottom to the top of interior horizontal insulation Range: ≥ 0 |
interior_Interior Horizontal Insulation Width |
number m |
Extent of insulation as measured from the wall interior Range: > 0 |
|
interior_Interior Vertical Insulation Material Name |
reference | Names a Material, Material:AirGap, Material:InfraredTransparent, Material:NoMass, Material:RoofVegetation, WindowMaterial:Blind, WindowMaterial:Gas, WindowMaterial:GasMixture, WindowMaterial:Glazing, WindowMaterial:Glazing:RefractionExtinctionMethod, WindowMaterial:GlazingGroup:Thermochromic, WindowMaterial:Screen and 2 more | |
interior_Interior Vertical Insulation Depth |
number m |
Extent of insulation as measured from the wall top to the bottom edge of the interior vertical insulation Range: > 0 |
|
exterior_Exterior Horizontal Insulation Material Name |
reference | Names a Material, Material:AirGap, Material:InfraredTransparent, Material:NoMass, Material:RoofVegetation, WindowMaterial:Blind, WindowMaterial:Gas, WindowMaterial:GasMixture, WindowMaterial:Glazing, WindowMaterial:Glazing:RefractionExtinctionMethod, WindowMaterial:GlazingGroup:Thermochromic, WindowMaterial:Screen and 2 more | |
exterior_Exterior Horizontal Insulation Depth |
number m |
Distance from the exterior grade to the top of exterior horizontal insulation Range: ≥ 0 |
|
exterior_Exterior Horizontal Insulation Width |
number m |
0.0 |
Extent of insulation as measured from the wall exterior Range: ≥ 0 |
exterior_Exterior Vertical Insulation Material Name |
reference | Names a Material, Material:AirGap, Material:InfraredTransparent, Material:NoMass, Material:RoofVegetation, WindowMaterial:Blind, WindowMaterial:Gas, WindowMaterial:GasMixture, WindowMaterial:Glazing, WindowMaterial:Glazing:RefractionExtinctionMethod, WindowMaterial:GlazingGroup:Thermochromic, WindowMaterial:Screen and 2 more | |
exterior_Exterior Vertical Insulation Depth |
number m |
Extent of insulation as measured from the wall top to the bottom edge of the exterior vertical insulation Range: > 0 |
|
wall_Wall Height Above Grade |
number m |
0.2 |
Distance from the exterior grade to the wall top Range: ≥ 0 |
wall_Wall Depth Below Slab |
number m |
0.0 |
Distance from the slab bottom to the bottom of the foundation wall Range: ≥ 0 |
footing_Footing Wall Construction Name |
reference | Defines the below-grade surface construction for slabs. Required if foundation wall is not exposed to the zone. Names a Construction, Construction:AirBoundary, Construction:CfactorUndergroundWall, Construction:FfactorGroundFloor, Construction:WindowDataFile, Construction:WindowEquivalentLayer |
|
footing_Footing Material Name |
reference | Names a Material, Material:AirGap, Material:InfraredTransparent, Material:NoMass, Material:RoofVegetation, WindowMaterial:Blind, WindowMaterial:Gas, WindowMaterial:GasMixture, WindowMaterial:Glazing, WindowMaterial:Glazing:RefractionExtinctionMethod, WindowMaterial:GlazingGroup:Thermochromic, WindowMaterial:Screen and 2 more | |
footing_Footing Depth |
number m |
0.3 |
Top-to-bottom dimension of the footing (not to be confused with its depth in the ground). The width of the footing is defined by the material's thickness. Range: > 0 |
blocks |
list | Each item: custom_block_material_name, custom_block_depth (m), custom_block_x_position (m), custom_block_z_position (m) |
Referenced by 11 object types
BuildingSurface:Detailed, Ceiling:Interzone, Door:Interzone, FenestrationSurface:Detailed, Floor:Detailed, Floor:Interzone, GlazedDoor:Interzone, RoofCeiling:Detailed, Wall:Detailed, Wall:Interzone, Window:Interzone
Foundation:Kiva:Settings¶
from idfpy.models import FoundationKivaSettings
Settings applied across all Kiva foundation calculations. Object is not required. If not defined, defaults will be applied.
| Field | Type | Default | Details |
|---|---|---|---|
soil_Soil Conductivity |
number W/m-K |
1.73 |
Range: > 0 |
soil_Soil Density |
number kg/m3 |
1842.0 |
Range: > 0 |
soil_Soil Specific Heat |
number J/kg-K |
419.0 |
Range: > 0 |
ground_Ground Solar Absorptivity |
number dimensionless |
0.9 |
Range: ≥ 0, ≤ 1 |
ground_Ground Thermal Absorptivity |
number dimensionless |
0.9 |
Range: ≥ 0, ≤ 1 |
ground_Ground Surface Roughness |
number m |
0.03 |
Range: > 0 |
far_Far-Field Width |
number m |
40.0 |
Range: > 0 |
deep_Deep-Ground Boundary Condition |
choice | Autoselect |
One of Autoselect, GroundWater, ZeroFlux |
deep_Deep-Ground Depth |
number or Autocalculatem |
Autocalculate |
|
minimum_Minimum Cell Dimension |
number m |
0.02 |
Range: > 0 |
maximum_Maximum Cell Growth Coefficient |
number dimensionless |
1.5 |
Range: ≥ 1 |
simulation_Simulation Timestep |
choice | Hourly |
One of Hourly, Timestep |
SurfaceControl:MovableInsulation¶
from idfpy.models import SurfaceControlMovableInsulation
Exterior or Interior Insulation on opaque surfaces
SurfaceConvectionAlgorithm:Inside:AdaptiveModelSelections¶
from idfpy.models import SurfaceConvectionAlgorithmInsideAdaptiveModelSelections unique
Options to change the individual convection model equations for dynamic selection when using AdaptiveConvectiongAlgorithm This object is only needed to make changes to the default model selections for any or all of the surface categories. This object is for the inside face, the side of the surface facing a thermal zone.
| Field | Type | Default | Details |
|---|---|---|---|
nameName |
string | ||
simple_Simple Buoyancy Vertical Wall Equation Source |
choice | FohannoPolidoriVerticalWall |
Applies to zone with no HVAC or when HVAC is off This is for vertical walls One of ASHRAEVerticalWall, AlamdariHammondVerticalWall, FohannoPolidoriVerticalWall, ISO15099Windows, KhalifaEq3WallAwayFromHeat, KhalifaEq6NonHeatedWalls, UserCurve |
simple_Simple Buoyancy Vertical Wall User Curve Name |
reference | The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve Names a SurfaceConvectionAlgorithm:Inside:UserCurve |
|
simple_Simple Buoyancy Stable Horizontal Equation Source |
choice | AlamdariHammondStableHorizontal |
Applies to zone with no HVAC or when HVAC is off This is for horizontal surfaces with heat flow directed for stable thermal stratification One of AlamdariHammondStableHorizontal, UserCurve, WaltonStableHorizontalOrTilt |
simple_Simple Buoyancy Stable Horizontal Equation User Curve Name |
reference | The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve Names a SurfaceConvectionAlgorithm:Inside:UserCurve |
|
simple_Simple Buoyancy Unstable Horizontal Equation Source |
choice | AlamdariHammondUnstableHorizontal |
Applies to zone with no HVAC or when HVAC is off This is for passive horizontal surfaces with heat flow for unstable thermal stratification One of AlamdariHammondUnstableHorizontal, UserCurve, WaltonUnstableHorizontalOrTilt |
simple_Simple Buoyancy Unstable Horizontal Equation User Curve Name |
reference | The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve Names a SurfaceConvectionAlgorithm:Inside:UserCurve |
|
simple_Simple Buoyancy Stable Tilted Equation Source |
choice | WaltonStableHorizontalOrTilt |
Applies to zone with no HVAC or when HVAC is off This is for tilted surfaces with heat flow for stable thermal stratification One of AlamdariHammondStableHorizontal, UserCurve, WaltonStableHorizontalOrTilt |
simple_Simple Buoyancy Stable Tilted Equation User Curve Name |
reference | The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve Names a SurfaceConvectionAlgorithm:Inside:UserCurve |
|
simple_Simple Buoyancy Unstable Tilted Equation Source |
choice | WaltonUnstableHorizontalOrTilt |
Applies to zone with no HVAC or when HVAC is off This is for tilted surfaces with heat flow for unstable thermal stratification One of AlamdariHammondUnstableHorizontal, UserCurve, WaltonUnstableHorizontalOrTilt |
simple_Simple Buoyancy Unstable Tilted Equation User Curve Name |
reference | The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve Names a SurfaceConvectionAlgorithm:Inside:UserCurve |
|
simple_Simple Buoyancy Windows Equation Source |
choice | ISO15099Windows |
Applies to zone with no HVAC or when HVAC is off This is for all window surfaces One of ASHRAEVerticalWall, AlamdariHammondVerticalWall, FohannoPolidoriVerticalWall, ISO15099Windows, KaradagChilledCeiling, UserCurve |
simple_Simple Buoyancy Windows Equation User Curve Name |
reference | The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve Names a SurfaceConvectionAlgorithm:Inside:UserCurve |
|
floor_Floor Heat Ceiling Cool Vertical Wall Equation Source |
choice | KhalifaEq3WallAwayFromHeat |
Applies to zone with in-floor heating and/or in-ceiling cooling This is for vertical walls One of ASHRAEVerticalWall, AlamdariHammondVerticalWall, FohannoPolidoriVerticalWall, ISO15099Windows, KhalifaEq3WallAwayFromHeat, UserCurve |
floor_Floor Heat Ceiling Cool Vertical Wall Equation User Curve Name |
reference | The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve Names a SurfaceConvectionAlgorithm:Inside:UserCurve |
|
floor_Floor Heat Ceiling Cool Stable Horizontal Equation Source |
choice | AlamdariHammondStableHorizontal |
Applies to zone with in-floor heating and/or in-ceiling cooling This is for passive horizontal surfaces with heat flow for stable thermal stratification One of AlamdariHammondStableHorizontal, UserCurve, WaltonStableHorizontalOrTilt |
floor_Floor Heat Ceiling Cool Stable Horizontal Equation User Curve Name |
reference | The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve Names a SurfaceConvectionAlgorithm:Inside:UserCurve |
|
floor_Floor Heat Ceiling Cool Unstable Horizontal Equation Source |
choice | KhalifaEq4CeilingAwayFromHeat |
Applies to zone with in-floor heating and/or in-ceiling cooling This is for passive horizontal surfaces with heat flow for unstable thermal stratification One of AlamdariHammondUnstableHorizontal, KhalifaEq4CeilingAwayFromHeat, UserCurve, WaltonUnstableHorizontalOrTilt |
floor_Floor Heat Ceiling Cool Unstable Horizontal Equation User Curve Name |
reference | The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve Names a SurfaceConvectionAlgorithm:Inside:UserCurve |
|
floor_Floor Heat Ceiling Cool Heated Floor Equation Source |
choice | AwbiHattonHeatedFloor |
Applies to zone with in-floor heating and/or in-ceiling cooling This is for a floor with active heating elements One of AlamdariHammondUnstableHorizontal, AwbiHattonHeatedFloor, UserCurve, WaltonUnstableHorizontalOrTilt |
floor_Floor Heat Ceiling Cool Heated Floor Equation User Curve Name |
reference | The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve Names a SurfaceConvectionAlgorithm:Inside:UserCurve |
|
floor_Floor Heat Ceiling Cool Chilled Ceiling Equation Source |
choice | KaradagChilledCeiling |
Applies to zone with in-floor heating and/or in-ceiling cooling This is for a ceiling with active cooling elements One of AlamdariHammondUnstableHorizontal, KaradagChilledCeiling, UserCurve, WaltonUnstableHorizontalOrTilt |
floor_Floor Heat Ceiling Cool Chilled Ceiling Equation User Curve Name |
reference | The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve Names a SurfaceConvectionAlgorithm:Inside:UserCurve |
|
floor_Floor Heat Ceiling Cool Stable Tilted Equation Source |
choice | WaltonStableHorizontalOrTilt |
Applies to zone with in-floor heating and/or in-ceiling cooling This is for tilted surfaces with heat flow for stable thermal stratification One of AlamdariHammondStableHorizontal, ISO15099Windows, UserCurve, WaltonStableHorizontalOrTilt |
floor_Floor Heat Ceiling Cool Stable Tilted Equation User Curve Name |
reference | The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve Names a SurfaceConvectionAlgorithm:Inside:UserCurve |
|
floor_Floor Heat Ceiling Cool Unstable Tilted Equation Source |
choice | WaltonUnstableHorizontalOrTilt |
Applies to zone with in-floor heating and/or in-ceiling cooling This is for tilted surfaces with heat flow for unstable thermal stratification One of AlamdariHammondUnstableHorizontal, ISO15099Windows, UserCurve, WaltonUnstableHorizontalOrTilt |
floor_Floor Heat Ceiling Cool Unstable Tilted Equation User Curve Name |
reference | The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve Names a SurfaceConvectionAlgorithm:Inside:UserCurve |
|
floor_Floor Heat Ceiling Cool Window Equation Source |
choice | ISO15099Windows |
Applies to zone with in-floor heating and/or in-ceiling cooling This is for all window surfaces One of ASHRAEVerticalWall, AlamdariHammondVerticalWall, ISO15099Windows, UserCurve |
floor_Floor Heat Ceiling Cool Window Equation User Curve Name |
reference | The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve Names a SurfaceConvectionAlgorithm:Inside:UserCurve |
|
wall_Wall Panel Heating Vertical Wall Equation Source |
choice | KhalifaEq6NonHeatedWalls |
Applies to zone with in-wall panel heating This is for vertical walls that are not actively heated One of ASHRAEVerticalWall, AlamdariHammondVerticalWall, FohannoPolidoriVerticalWall, ISO15099Windows, KhalifaEq6NonHeatedWalls, UserCurve |
wall_Wall Panel Heating Vertical Wall Equation User Curve Name |
reference | The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve Names a SurfaceConvectionAlgorithm:Inside:UserCurve |
|
wall_Wall Panel Heating Heated Wall Equation Source |
choice | AwbiHattonHeatedWall |
Applies to zone with in-wall panel heating This is for vertical walls that are being actively heated One of ASHRAEVerticalWall, AlamdariHammondVerticalWall, AwbiHattonHeatedWall, FohannoPolidoriVerticalWall, ISO15099Windows, KhalifaEq5WallNearHeat, UserCurve |
wall_Wall Panel Heating Heated Wall Equation User Curve Name |
reference | The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve Names a SurfaceConvectionAlgorithm:Inside:UserCurve |
|
wall_Wall Panel Heating Stable Horizontal Equation Source |
choice | AlamdariHammondStableHorizontal |
Applies to zone with in-wall panel heating This is for horizontal surfaces with heat flow directed for stable thermal stratification One of AlamdariHammondStableHorizontal, UserCurve, WaltonStableHorizontalOrTilt |
wall_Wall Panel Heating Stable Horizontal Equation User Curve Name |
reference | The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve Names a SurfaceConvectionAlgorithm:Inside:UserCurve |
|
wall_Wall Panel Heating Unstable Horizontal Equation Source |
choice | KhalifaEq7Ceiling |
Applies to zone with in-wall panel heating This is for horizontal surfaces with heat flow directed for unstable thermal stratification One of ASHRAEVerticalWall, AlamdariHammondUnstableHorizontal, KaradagChilledCeiling, KhalifaEq7Ceiling, UserCurve, WaltonUnstableHorizontalOrTilt |
wall_Wall Panel Heating Unstable Horizontal Equation User Curve Name |
reference | The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve Names a SurfaceConvectionAlgorithm:Inside:UserCurve |
|
wall_Wall Panel Heating Stable Tilted Equation Source |
choice | WaltonStableHorizontalOrTilt |
Applies to zone with in-wall panel heating This is for tilted surfaces with heat flow for stable thermal stratification One of AlamdariHammondStableHorizontal, ISO15099Windows, UserCurve, WaltonStableHorizontalOrTilt |
wall_Wall Panel Heating Stable Tilted Equation User Curve Name |
reference | The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve Names a SurfaceConvectionAlgorithm:Inside:UserCurve |
|
wall_Wall Panel Heating Unstable Tilted Equation Source |
choice | WaltonUnstableHorizontalOrTilt |
Applies to zone with in-wall panel heating This is for tilted surfaces with heat flow for unstable thermal stratification One of AlamdariHammondUnstableHorizontal, ISO15099Windows, UserCurve, WaltonUnstableHorizontalOrTilt |
wall_Wall Panel Heating Unstable Tilted Equation User Curve Name |
reference | The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve Names a SurfaceConvectionAlgorithm:Inside:UserCurve |
|
wall_Wall Panel Heating Window Equation Source |
choice | ISO15099Windows |
Applies to zone with in-wall panel heating This is for all window surfaces One of ASHRAEVerticalWall, AlamdariHammondVerticalWall, FohannoPolidoriVerticalWall, ISO15099Windows, UserCurve |
wall_Wall Panel Heating Window Equation User Curve Name |
reference | The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve Names a SurfaceConvectionAlgorithm:Inside:UserCurve |
|
convective_Convective Zone Heater Vertical Wall Equation Source |
choice | FohannoPolidoriVerticalWall |
Applies to zone with convective heater This is for vertical walls not directly affected by heater One of ASHRAEVerticalWall, AlamdariHammondVerticalWall, FohannoPolidoriVerticalWall, ISO15099Windows, KhalifaEq3WallAwayFromHeat, KhalifaEq6NonHeatedWalls, UserCurve |
convective_Convective Zone Heater Vertical Wall Equation User Curve Name |
reference | The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve Names a SurfaceConvectionAlgorithm:Inside:UserCurve |
|
convective_Convective Zone Heater Vertical Walls Near Heater Equation Source |
choice | KhalifaEq5WallNearHeat |
Applies to zone with convective heater This is for vertical walls that are directly affected by heater Walls are considered "near" when listed in field set for Fraction of Radiant Energy to Surface One of ASHRAEVerticalWall, AlamdariHammondVerticalWall, AwbiHattonHeatedWall, FohannoPolidoriVerticalWall, ISO15099Windows, KhalifaEq5WallNearHeat, UserCurve |
convective_Convective Zone Heater Vertical Walls Near Heater Equation User Curve Name |
reference | The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve Names a SurfaceConvectionAlgorithm:Inside:UserCurve |
|
convective_Convective Zone Heater Stable Horizontal Equation Source |
choice | AlamdariHammondStableHorizontal |
Applies to zone with convective heater This is for horizontal surfaces with heat flow directed for stable thermal stratification One of AlamdariHammondStableHorizontal, UserCurve, WaltonStableHorizontalOrTilt |
convective_Convective Zone Heater Stable Horizontal Equation User Curve Name |
reference | The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve Names a SurfaceConvectionAlgorithm:Inside:UserCurve |
|
convective_Convective Zone Heater Unstable Horizontal Equation Source |
choice | KhalifaEq7Ceiling |
Applies to zone with convective heater This is for horizontal surfaces with heat flow directed for unstable thermal stratification One of AlamdariHammondUnstableHorizontal, KhalifaEq4CeilingAwayFromHeat, KhalifaEq7Ceiling, UserCurve, WaltonUnstableHorizontalOrTilt |
convective_Convective Zone Heater Unstable Horizontal Equation User Curve Name |
reference | The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve Names a SurfaceConvectionAlgorithm:Inside:UserCurve |
|
convective_Convective Zone Heater Stable Tilted Equation Source |
choice | WaltonStableHorizontalOrTilt |
Applies to zone with convective heater This is for tilted surfaces with heat flow for stable thermal stratification One of AlamdariHammondStableHorizontal, UserCurve, WaltonStableHorizontalOrTilt |
convective_Convective Zone Heater Stable Tilted Equation User Curve Name |
reference | The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve Names a SurfaceConvectionAlgorithm:Inside:UserCurve |
|
convective_Convective Zone Heater Unstable Tilted Equation Source |
choice | WaltonUnstableHorizontalOrTilt |
Applies to zone with convective heater This is for tilted surfaces with heat flow for unstable thermal stratification One of AlamdariHammondUnstableHorizontal, UserCurve, WaltonUnstableHorizontalOrTilt |
convective_Convective Zone Heater Unstable Tilted Equation User Curve Name |
reference | The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve Names a SurfaceConvectionAlgorithm:Inside:UserCurve |
|
convective_Convective Zone Heater Windows Equation Source |
choice | ISO15099Windows |
Applies to zone with convective heater This is for all window surfaces One of ASHRAEVerticalWall, AlamdariHammondVerticalWall, FohannoPolidoriVerticalWall, ISO15099Windows, KhalifaEq3WallAwayFromHeat, UserCurve |
convective_Convective Zone Heater Windows Equation User Curve Name |
reference | The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve Names a SurfaceConvectionAlgorithm:Inside:UserCurve |
|
central_Central Air Diffuser Wall Equation Source |
choice | GoldsteinNovoselacCeilingDiffuserWalls |
Applies to zone with mechanical forced central air with diffusers This is for all wall surfaces One of ASHRAEVerticalWall, AlamdariHammondVerticalWall, BeausoleilMorrisonMixedAssistedWall, BeausoleilMorrisonMixedOpposingWall, FisherPedersenCeilingDiffuserWalls, FohannoPolidoriVerticalWall, GoldsteinNovoselacCeilingDiffuserWalls, ISO15099Windows, UserCurve |
central_Central Air Diffuser Wall Equation User Curve Name |
reference | The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve Names a SurfaceConvectionAlgorithm:Inside:UserCurve |
|
central_Central Air Diffuser Ceiling Equation Source |
choice | FisherPedersenCeilingDiffuserCeiling |
Applies to zone with mechanical forced central air with diffusers This is for all ceiling surfaces One of BeausoleilMorrisonMixedStableCeiling, BeausoleilMorrisonMixedUnstableCeiling, FisherPedersenCeilingDiffuserCeiling, UserCurve |
central_Central Air Diffuser Ceiling Equation User Curve Name |
reference | The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve Names a SurfaceConvectionAlgorithm:Inside:UserCurve |
|
central_Central Air Diffuser Floor Equation Source |
choice | GoldsteinNovoselacCeilingDiffuserFloor |
Applies to zone with mechanical forced central air with diffusers This is for all floor surfaces One of BeausoleilMorrisonMixedStableFloor, BeausoleilMorrisonMixedUnstableFloor, FisherPedersenCeilingDiffuserFloor, GoldsteinNovoselacCeilingDiffuserFloor, UserCurve |
central_Central Air Diffuser Floor Equation User Curve Name |
reference | The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve Names a SurfaceConvectionAlgorithm:Inside:UserCurve |
|
central_Central Air Diffuser Window Equation Source |
choice | GoldsteinNovoselacCeilingDiffuserWindow |
Applies to zone with mechanical forced central air with diffusers This is for all window surfaces One of ASHRAEVerticalWall, AlamdariHammondVerticalWall, BeausoleilMorrisonMixedAssistedWall, BeausoleilMorrisonMixedOpposingWall, FisherPedersenCeilingDiffuserWalls, FohannoPolidoriVerticalWall, GoldsteinNovoselacCeilingDiffuserWindow, ISO15099Windows, UserCurve |
central_Central Air Diffuser Window Equation User Curve Name |
reference | The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve Names a SurfaceConvectionAlgorithm:Inside:UserCurve |
|
mechanical_Mechanical Zone Fan Circulation Vertical Wall Equation Source |
choice | KhalifaEq3WallAwayFromHeat |
reference choice fields One of ASHRAEVerticalWall, AlamdariHammondVerticalWall, BeausoleilMorrisonMixedAssistedWall, BeausoleilMorrisonMixedOpposingWall, FisherPedersenCeilingDiffuserWalls, FohannoPolidoriVerticalWall, GoldsteinNovoselacCeilingDiffuserWalls, ISO15099Windows, KhalifaEq3WallAwayFromHeat, UserCurve |
mechanical_Mechanical Zone Fan Circulation Vertical Wall Equation User Curve Name |
reference | The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve Names a SurfaceConvectionAlgorithm:Inside:UserCurve |
|
mechanical_Mechanical Zone Fan Circulation Stable Horizontal Equation Source |
choice | AlamdariHammondStableHorizontal |
reference choice fields One of AlamdariHammondStableHorizontal, UserCurve, WaltonStableHorizontalOrTilt |
mechanical_Mechanical Zone Fan Circulation Stable Horizontal Equation User Curve Name |
reference | The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve Names a SurfaceConvectionAlgorithm:Inside:UserCurve |
|
mechanical_Mechanical Zone Fan Circulation Unstable Horizontal Equation Source |
choice | KhalifaEq4CeilingAwayFromHeat |
reference choice fields One of AlamdariHammondUnstableHorizontal, KhalifaEq4CeilingAwayFromHeat, UserCurve, WaltonUnstableHorizontalOrTilt |
mechanical_Mechanical Zone Fan Circulation Unstable Horizontal Equation User Curve Name |
reference | The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve Names a SurfaceConvectionAlgorithm:Inside:UserCurve |
|
mechanical_Mechanical Zone Fan Circulation Stable Tilted Equation Source |
choice | WaltonStableHorizontalOrTilt |
reference choice fields One of UserCurve, WaltonStableHorizontalOrTilt |
mechanical_Mechanical Zone Fan Circulation Stable Tilted Equation User Curve Name |
reference | The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve Names a SurfaceConvectionAlgorithm:Inside:UserCurve |
|
mechanical_Mechanical Zone Fan Circulation Unstable Tilted Equation Source |
choice | WaltonUnstableHorizontalOrTilt |
reference choice fields One of AlamdariHammondUnstableHorizontal, UserCurve, WaltonUnstableHorizontalOrTilt |
mechanical_Mechanical Zone Fan Circulation Unstable Tilted Equation User Curve Name |
reference | The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve Names a SurfaceConvectionAlgorithm:Inside:UserCurve |
|
mechanical_Mechanical Zone Fan Circulation Window Equation Source |
choice | ISO15099Windows |
reference choice fields One of ASHRAEVerticalWall, AlamdariHammondVerticalWall, FohannoPolidoriVerticalWall, GoldsteinNovoselacCeilingDiffuserWindow, ISO15099Windows, UserCurve |
mechanical_Mechanical Zone Fan Circulation Window Equation User Curve Name |
reference | The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve Names a SurfaceConvectionAlgorithm:Inside:UserCurve |
|
mixed_Mixed Regime Buoyancy Assisting Flow on Walls Equation Source |
choice | BeausoleilMorrisonMixedAssistedWall |
reference choice fields One of ASHRAEVerticalWall, AlamdariHammondVerticalWall, BeausoleilMorrisonMixedAssistedWall, FisherPedersenCeilingDiffuserWalls, FohannoPolidoriVerticalWall, GoldsteinNovoselacCeilingDiffuserWalls, UserCurve |
mixed_Mixed Regime Buoyancy Assisting Flow on Walls Equation User Curve Name |
reference | The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve Names a SurfaceConvectionAlgorithm:Inside:UserCurve |
|
mixed_Mixed Regime Buoyancy Opposing Flow on Walls Equation Source |
choice | BeausoleilMorrisonMixedOpposingWall |
reference choice fields One of ASHRAEVerticalWall, AlamdariHammondVerticalWall, BeausoleilMorrisonMixedOpposingWall, FisherPedersenCeilingDiffuserWalls, FohannoPolidoriVerticalWall, GoldsteinNovoselacCeilingDiffuserWalls, UserCurve |
mixed_Mixed Regime Buoyancy Opposing Flow on Walls Equation User Curve Name |
reference | The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve Names a SurfaceConvectionAlgorithm:Inside:UserCurve |
|
mixed_Mixed Regime Stable Floor Equation Source |
choice | BeausoleilMorrisonMixedStableFloor |
reference choice fields One of AlamdariHammondStableHorizontal, BeausoleilMorrisonMixedStableFloor, UserCurve, WaltonStableHorizontalOrTilt |
mixed_Mixed Regime Stable Floor Equation User Curve Name |
reference | The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve Names a SurfaceConvectionAlgorithm:Inside:UserCurve |
|
mixed_Mixed Regime Unstable Floor Equation Source |
choice | BeausoleilMorrisonMixedUnstableFloor |
reference choice fields One of AlamdariHammondUnstableHorizontal, BeausoleilMorrisonMixedUnstableFloor, UserCurve, WaltonUnstableHorizontalOrTilt |
mixed_Mixed Regime Unstable Floor Equation User Curve Name |
reference | The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve Names a SurfaceConvectionAlgorithm:Inside:UserCurve |
|
mixed_Mixed Regime Stable Ceiling Equation Source |
choice | BeausoleilMorrisonMixedStableCeiling |
reference choice fields One of AlamdariHammondStableHorizontal, BeausoleilMorrisonMixedStableCeiling, UserCurve, WaltonStableHorizontalOrTilt |
mixed_Mixed Regime Stable Ceiling Equation User Curve Name |
reference | The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve Names a SurfaceConvectionAlgorithm:Inside:UserCurve |
|
mixed_Mixed Regime Unstable Ceiling Equation Source |
choice | BeausoleilMorrisonMixedUnstableCeiling |
reference choice fields One of AlamdariHammondUnstableHorizontal, BeausoleilMorrisonMixedUnstableCeiling, UserCurve, WaltonUnstableHorizontalOrTilt |
mixed_Mixed Regime Unstable Ceiling Equation User Curve Name |
reference | The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve Names a SurfaceConvectionAlgorithm:Inside:UserCurve |
|
mixed_Mixed Regime Window Equation Source |
choice | GoldsteinNovoselacCeilingDiffuserWindow |
reference choice fields One of GoldsteinNovoselacCeilingDiffuserWindow, ISO15099Windows, UserCurve |
mixed_Mixed Regime Window Equation User Curve Name |
reference | The SurfaceConvectionAlgorithm:Inside:UserCurve named in this field is used when the previous field is set to UserCurve Names a SurfaceConvectionAlgorithm:Inside:UserCurve |
SurfaceConvectionAlgorithm:Inside:UserCurve¶
from idfpy.models import SurfaceConvectionAlgorithmInsideUserCurve
Used to describe a custom model equation for surface convection heat transfer coefficient If more than one curve is referenced they are all used and added together.
| Field | Type | Default | Details |
|---|---|---|---|
nameName |
string | ||
reference_Reference Temperature for Convection Heat Transfer |
choice | Controls which temperature is differenced from surface temperature when using the Hc value One of AdjacentAirTemperature, MeanAirTemperature, SupplyAirTemperature |
|
hc_Hc Function of Temperature Difference Curve Name |
reference | Curve's "x" is absolute value of delta-T (Surface temperature minus reference temperature, (C)) Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more |
|
hc_Hc Function of Temperature Difference Divided by Height Curve Name |
reference | Curve's "x" is absolute value of delta-T/Height (Surface temp minus Air temp)/(vertical length scale), (C/m) when used for an inside face the vertical length scale is the zone's interior height Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more |
|
hc_Hc Function of Air Change Rate Curve Name |
reference | Curve's "x" is mechanical ACH (Air Changes per hour from mechanical air system), (1/hr) Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more |
|
hc_Hc Function of Air System Volume Flow Rate Divided by Zone Perimeter Length Curve Name |
reference | Curve's "x" is mechanical system air flow rate (m3/s) divided by zone's length along exterior walls (m). Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more |
Referenced by 3 object types
SurfaceConvectionAlgorithm:Inside:AdaptiveModelSelections, SurfaceProperty:ConvectionCoefficients, SurfaceProperty:ConvectionCoefficients:MultipleSurface
SurfaceConvectionAlgorithm:Outside:AdaptiveModelSelections¶
from idfpy.models import SurfaceConvectionAlgorithmOutsideAdaptiveModelSelections unique
Options to change the individual convection model equations for dynamic selection when using AdaptiveConvectiongAlgorithm This object is only needed to make changes to the default model selections for any or all of the surface categories. This object is for the outside face, the side of the surface facing away from the thermal zone.
| Field | Type | Default | Details |
|---|---|---|---|
nameName |
string | ||
wind_Wind Convection Windward Vertical Wall Equation Source |
choice | TARPWindward |
One of BlockenWindward, DOE2Windward, EmmelVertical, McAdams, Mitchell, MoWiTTWindward, NusseltJurges, SimpleCombined, TARPWindward, UserCurve |
wind_Wind Convection Windward Equation Vertical Wall User Curve Name |
reference | The SurfaceConvectionAlgorithm:Outside:UserCurve named in this field is used when the previous field is set to UserCurve Names a SurfaceConvectionAlgorithm:Outside:UserCurve |
|
wind_Wind Convection Leeward Vertical Wall Equation Source |
choice | TARPLeeward |
One of DOE2Leeward, EmmelVertical, McAdams, Mitchell, MoWiTTLeeward, NusseltJurges, SimpleCombined, TARPLeeward, UserCurve |
wind_Wind Convection Leeward Vertical Wall Equation User Curve Name |
reference | The SurfaceConvectionAlgorithm:Outside:UserCurve named in this field is used when the previous field is set to UserCurve Names a SurfaceConvectionAlgorithm:Outside:UserCurve |
|
wind_Wind Convection Horizontal Roof Equation Source |
choice | ClearRoof |
One of BlockenWindward, ClearRoof, DOE2Windward, EmmelRoof, McAdams, Mitchell, MoWiTTWindward, NusseltJurges, SimpleCombined, TARPWindward, UserCurve |
wind_Wind Convection Horizontal Roof User Curve Name |
reference | The SurfaceConvectionAlgorithm:Outside:UserCurve named in this field is used when the previous field is set to UserCurve Names a SurfaceConvectionAlgorithm:Outside:UserCurve |
|
natural_Natural Convection Vertical Wall Equation Source |
choice | ASHRAEVerticalWall |
This is for vertical walls One of ASHRAEVerticalWall, AlamdariHammondVerticalWall, FohannoPolidoriVerticalWall, ISO15099Windows, None, UserCurve |
natural_Natural Convection Vertical Wall Equation User Curve Name |
reference | The SurfaceConvectionAlgorithm:Outside:UserCurve named in this field is used when the previous field is set to UserCurve Names a SurfaceConvectionAlgorithm:Outside:UserCurve |
|
natural_Natural Convection Stable Horizontal Equation Source |
choice | WaltonStableHorizontalOrTilt |
This is for horizontal surfaces with heat flow directed for stable thermal stratification One of AlamdariHammondStableHorizontal, None, UserCurve, WaltonStableHorizontalOrTilt |
natural_Natural Convection Stable Horizontal Equation User Curve Name |
reference | The SurfaceConvectionAlgorithm:Outside:UserCurve named in this field is used when the previous field is set to UserCurve Names a SurfaceConvectionAlgorithm:Outside:UserCurve |
|
natural_Natural Convection Unstable Horizontal Equation Source |
choice | WaltonUnstableHorizontalOrTilt |
One of AlamdariHammondUnstableHorizontal, None, UserCurve, WaltonUnstableHorizontalOrTilt |
natural_Natural Convection Unstable Horizontal Equation User Curve Name |
reference | The SurfaceConvectionAlgorithm:Outside:UserCurve named in this field is used when the previous field is set to UserCurve Names a SurfaceConvectionAlgorithm:Outside:UserCurve |
SurfaceConvectionAlgorithm:Outside:UserCurve¶
from idfpy.models import SurfaceConvectionAlgorithmOutsideUserCurve
Used to describe a custom model equation for surface convection heat transfer coefficient If more than one curve is referenced they are all used and added together.
| Field | Type | Default | Details |
|---|---|---|---|
nameName |
string | ||
wind_Wind Speed Type for Curve |
choice | HeightAdjust |
One of HeightAdjust, ParallelComponent, ParallelComponentHeightAdjust, WeatherFile |
hf_Hf Function of Wind Speed Curve Name |
reference | Curve's "x" is wind speed of the type determined in the previous field (m/s) Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more |
|
hn_Hn Function of Temperature Difference Curve Name |
reference | Curve's "x" is absolute value of delta-T (Surface temperature minus air temperature, (C)) Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more |
|
hn_Hn Function of Temperature Difference Divided by Height Curve Name |
reference | Curve's "x" is absolute value of delta-T/Height (Surface temp minus Air temp)/(vertical length scale), (C/m) when used for an outside face the vertical length scale is the exterior facade's overall height Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more |
Referenced by 3 object types
SurfaceConvectionAlgorithm:Outside:AdaptiveModelSelections, SurfaceProperty:ConvectionCoefficients, SurfaceProperty:ConvectionCoefficients:MultipleSurface
SurfaceProperties:VaporCoefficients¶
from idfpy.models import SurfacePropertiesVaporCoefficients
The interior and external vapor transfer coefficients. Normally these value are calculated using the heat convection coefficient values. Use this object to used fixed constant values. Units are kg/Pa.s.m2 This will only work with the CombinedHeatAndMoistureFiniteElement algorithm for surfaces. Other algorithms will ignore these coefficients
| Field | Type | Default | Details |
|---|---|---|---|
surface_Surface Name required |
reference | Names a BuildingSurface:Detailed, Ceiling:Adiabatic, Ceiling:Interzone, Floor:Adiabatic, Floor:Detailed, Floor:GroundContact, Floor:Interzone, Roof, RoofCeiling:Detailed, Wall:Adiabatic, Wall:Detailed, Wall:Exterior and 2 more | |
constant_Constant External Vapor Transfer Coefficient |
choice | No |
One of No, Yes |
external_External Vapor Coefficient Value |
number kg/Pa-s-m2 |
0.0 |
Range: ≥ 0 |
constant_Constant Internal vapor Transfer Coefficient |
choice | No |
One of No, Yes |
internal_Internal Vapor Coefficient Value |
number kg/Pa-s-m2 |
0.0 |
Range: ≥ 0 |
SurfaceProperty:ConvectionCoefficients¶
from idfpy.models import SurfacePropertyConvectionCoefficients
Allow user settable interior and/or exterior convection coefficients. Note that some other factors may limit the lower bounds for these values, such as for windows, the interior convection coefficient must be >.28, for trombe wall algorithm selection (zone), the interior convection coefficient must be >.1 for TARP interior convection, the lower limit is also .1 Minimum and maximum limits are set in HeatBalanceAlgorithm object. Defaults in HeatBalanceAlgorithm object are [.1,1000].
| Field | Type | Default | Details |
|---|---|---|---|
surface_Surface Name required |
reference | Names a BuildingSurface:Detailed, Ceiling:Adiabatic, Ceiling:Interzone, Door, Door:Interzone, FenestrationSurface:Detailed, Floor:Adiabatic, Floor:Detailed, Floor:GroundContact, Floor:Interzone, GlazedDoor, GlazedDoor:Interzone and 10 more | |
convection_Convection Coefficient 1 Location required |
choice | One of Inside, Outside |
|
convection_Convection Coefficient 1 Type required |
choice | One of ASHRAEVerticalWall, ASTMC1340, AdaptiveConvectionAlgorithm, AlamdariHammondStableHorizontal, AlamdariHammondUnstableHorizontal, AlamdariHammondVerticalWall, AwbiHattonHeatedFloor, AwbiHattonHeatedWall, BeausoleilMorrisonMixedAssistedWall, BeausoleilMorrisonMixedOpposingWall, BeausoleilMorrisonMixedStableCeiling, BeausoleilMorrisonMixedStableFloor, BeausoleilMorrisonMixedUnstableCeiling, BeausoleilMorrisonMixedUnstableFloor, BlockenWindard, ClearRoof, DOE-2, EmmelRoof, EmmelVertical, FisherPedersenCeilingDiffuserCeiling, FisherPedersenCeilingDiffuserFloor, FisherPedersenCeilingDiffuserWalls, FohannoPolidoriVerticalWall, GoldsteinNovoselacCeilingDiffuserFloor, GoldsteinNovoselacCeilingDiffuserWalls, GoldsteinNovoselacCeilingDiffuserWindow, ISO15099Windows, KaradagChilledCeiling, KhalifaEq3WallAwayFromHeat, KhalifaEq4CeilingAwayFromHeat, KhalifaEq5WallNearHeat, KhalifaEq6NonHeatedWalls, KhalifaEq7Ceiling, McAdams, Mitchell, MoWitt, NusseltJurges, Schedule, Simple, SimpleCombined, TARP, UserCurve, Value, WaltonStableHorizontalOrTilt, WaltonUnstableHorizontalOrTilt |
|
convection_Convection Coefficient 1 |
number W/m2-K |
used if Convection Type=Value, min and max limits are set in HeatBalanceAlgorithm object. Default limits are Minimum >= 0.1 and Maximum <= 1000 | |
convection_Convection Coefficient 1 Schedule Name |
reference | used if Convection Type=Schedule, min and max limits are set in HeatBalanceAlgorithm object. Default limits are Minimum >= 0.1 and Maximum <= 1000 Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules |
|
convection_Convection Coefficient 1 User Curve Name |
reference | used if Convection Type = UserCurve Names a SurfaceConvectionAlgorithm:Inside:UserCurve, SurfaceConvectionAlgorithm:Outside:UserCurve |
|
convection_Convection Coefficient 2 Location |
choice | One of Inside, Outside |
|
convection_Convection Coefficient 2 Type |
choice | One of ASHRAEVerticalWall, ASTMC1340, AdaptiveConvectionAlgorithm, AlamdariHammondStableHorizontal, AlamdariHammondUnstableHorizontal, AlamdariHammondVerticalWall, AwbiHattonHeatedFloor, AwbiHattonHeatedWall, BeausoleilMorrisonMixedAssistedWall, BeausoleilMorrisonMixedOpposingWall, BeausoleilMorrisonMixedStableCeiling, BeausoleilMorrisonMixedStableFloor, BeausoleilMorrisonMixedUnstableCeiling, BeausoleilMorrisonMixedUnstableFloor, BlockenWindard, ClearRoof, DOE-2, EmmelRoof, EmmelVertical, FisherPedersenCeilingDiffuserCeiling, FisherPedersenCeilingDiffuserFloor, FisherPedersenCeilingDiffuserWalls, FohannoPolidoriVerticalWall, GoldsteinNovoselacCeilingDiffuserFloor, GoldsteinNovoselacCeilingDiffuserWalls, GoldsteinNovoselacCeilingDiffuserWindow, ISO15099Windows, KaradagChilledCeiling, KhalifaEq3WallAwayFromHeat, KhalifaEq4CeilingAwayFromHeat, KhalifaEq5WallNearHeat, KhalifaEq6NonHeatedWalls, KhalifaEq7Ceiling, McAdams, Mitchell, MoWitt, NusseltJurges, Schedule, Simple, SimpleCombined, TARP, UserCurve, Value, WaltonStableHorizontalOrTilt, WaltonUnstableHorizontalOrTilt |
|
convection_Convection Coefficient 2 |
number W/m2-K |
0.1 |
used if Convection Type=Value, min and max limits are set in HeatBalanceAlgorithm object. Default limits are Minimum >= 0.1 and Maximum <= 1000 |
convection_Convection Coefficient 2 Schedule Name |
reference | used if Convection Type=Schedule, min and max limits are set in HeatBalanceAlgorithm object. Default limits are Minimum >= 0.1 and Maximum <= 1000 Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules |
|
convection_Convection Coefficient 2 User Curve Name |
reference | used if Convection Type = UserCurve Names a SurfaceConvectionAlgorithm:Inside:UserCurve, SurfaceConvectionAlgorithm:Outside:UserCurve |
SurfaceProperty:ConvectionCoefficients:MultipleSurface¶
from idfpy.models import SurfacePropertyConvectionCoefficientsMultipleSurface
Allow user settable interior and/or exterior convection coefficients. Note that some other factors may limit the lower bounds for these values, such as for windows, the interior convection coefficient must be >.28, for trombe wall algorithm selection (zone), the interior convection coefficient must be >.1 for TARP interior convection, the lower limit is also .1 Minimum and maximum limits are set in HeatBalanceAlgorithm object. Defaults in HeatBalanceAlgorithm object are [.1,1000].
| Field | Type | Default | Details |
|---|---|---|---|
surface_Surface Type required |
choice | One of AllExteriorFloors, AllExteriorRoofs, AllExteriorSurfaces, AllExteriorWalls, AllExteriorWindows, AllInteriorCeilings, AllInteriorFloors, AllInteriorSurfaces, AllInteriorWalls, AllInteriorWindows |
|
convection_Convection Coefficient 1 Location required |
choice | One of Inside, Outside |
|
convection_Convection Coefficient 1 Type required |
choice | One of ASHRAEVerticalWall, ASTMC1340, AdaptiveConvectionAlgorithm, AlamdariHammondStableHorizontal, AlamdariHammondUnstableHorizontal, AlamdariHammondVerticalWall, AwbiHattonHeatedFloor, AwbiHattonHeatedWall, BeausoleilMorrisonMixedAssistedWall, BeausoleilMorrisonMixedOpposingWall, BeausoleilMorrisonMixedStableCeiling, BeausoleilMorrisonMixedStableFloor, BeausoleilMorrisonMixedUnstableCeiling, BeausoleilMorrisonMixedUnstableFloor, BlockenWindard, ClearRoof, DOE-2, EmmelRoof, EmmelVertical, FisherPedersenCeilingDiffuserCeiling, FisherPedersenCeilingDiffuserFloor, FisherPedersenCeilingDiffuserWalls, FohannoPolidoriVerticalWall, GoldsteinNovoselacCeilingDiffuserFloor, GoldsteinNovoselacCeilingDiffuserWalls, GoldsteinNovoselacCeilingDiffuserWindow, ISO15099Windows, KaradagChilledCeiling, KhalifaEq3WallAwayFromHeat, KhalifaEq4CeilingAwayFromHeat, KhalifaEq5WallNearHeat, KhalifaEq6NonHeatedWalls, KhalifaEq7Ceiling, McAdams, Mitchell, MoWitt, NusseltJurges, Schedule, Simple, SimpleCombined, TARP, UserCurve, Value, WaltonStableHorizontalOrTilt, WaltonUnstableHorizontalOrTilt |
|
convection_Convection Coefficient 1 |
number W/m2-K |
used if Convection Type=Value, min and max limits are set in HeatBalanceAlgorithm object. Default limits are Minimum >= 0.1 and Maximum <= 1000 | |
convection_Convection Coefficient 1 Schedule Name |
reference | used if Convection Type=Schedule, min and max limits are set in HeatBalanceAlgorithm object. Default limits are Minimum >= 0.1 and Maximum <= 1000 Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules |
|
convection_Convection Coefficient 1 User Curve Name |
reference | used if Convection Type = UserCurve Names a SurfaceConvectionAlgorithm:Inside:UserCurve, SurfaceConvectionAlgorithm:Outside:UserCurve |
|
convection_Convection Coefficient 2 Location |
choice | One of Inside, Outside |
|
convection_Convection Coefficient 2 Type |
choice | One of ASHRAEVerticalWall, ASTMC1340, AdaptiveConvectionAlgorithm, AlamdariHammondStableHorizontal, AlamdariHammondUnstableHorizontal, AlamdariHammondVerticalWall, AwbiHattonHeatedFloor, AwbiHattonHeatedWall, BeausoleilMorrisonMixedAssistedWall, BeausoleilMorrisonMixedOpposingWall, BeausoleilMorrisonMixedStableCeiling, BeausoleilMorrisonMixedStableFloor, BeausoleilMorrisonMixedUnstableCeiling, BeausoleilMorrisonMixedUnstableFloor, BlockenWindard, ClearRoof, DOE-2, EmmelRoof, EmmelVertical, FisherPedersenCeilingDiffuserCeiling, FisherPedersenCeilingDiffuserFloor, FisherPedersenCeilingDiffuserWalls, FohannoPolidoriVerticalWall, GoldsteinNovoselacCeilingDiffuserFloor, GoldsteinNovoselacCeilingDiffuserWalls, GoldsteinNovoselacCeilingDiffuserWindow, ISO15099Windows, KaradagChilledCeiling, KhalifaEq3WallAwayFromHeat, KhalifaEq4CeilingAwayFromHeat, KhalifaEq5WallNearHeat, KhalifaEq6NonHeatedWalls, KhalifaEq7Ceiling, McAdams, Mitchell, MoWitt, NusseltJurges, Schedule, Simple, SimpleCombined, TARP, UserCurve, Value, WaltonStableHorizontalOrTilt, WaltonUnstableHorizontalOrTilt |
|
convection_Convection Coefficient 2 |
number W/m2-K |
0.1 |
used if Convection Type=Value, min and max limits are set in HeatBalanceAlgorithm object. Default limits are Minimum >= 0.1 and Maximum <= 1000 |
convection_Convection Coefficient 2 Schedule Name |
reference | used if Convection Type=Schedule, min and max limits are set in HeatBalanceAlgorithm object. Default limits are Minimum >= 0.1 and Maximum <= 1000 Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules |
|
convection_Convection Coefficient 2 User Curve Name |
reference | used if Convection Type = UserCurve Names a SurfaceConvectionAlgorithm:Inside:UserCurve, SurfaceConvectionAlgorithm:Outside:UserCurve |
SurfaceProperty:ExposedFoundationPerimeter¶
from idfpy.models import SurfacePropertyExposedFoundationPerimeter extensible
Defines the perimeter of a foundation floor that is exposed to the exterior environment through the floor. User may either define the total exposed perimeter, fraction of perimeter exposed or individually define which segments of the floor surface perimeter are exposed.
| Field | Type | Default | Details |
|---|---|---|---|
surface_Surface Name required |
reference | Names a BuildingSurface:Detailed, Floor:Adiabatic, Floor:Detailed, Floor:GroundContact, Floor:Interzone | |
exposed_Exposed Perimeter Calculation Method required |
choice | Choices: TotalExposedPerimeter => total exposed perimeter in meters ExposedPerimeterFraction => fraction of total perimeter that is exposed. Value * Fraction = Total exposed perimeter BySegment => define whether the segment between each set of consecutive vertices of the floor surface is exposed. SUM(exposed segment lengths) = Total exposed perimeter One of BySegment, ExposedPerimeterFraction, TotalExposedPerimeter |
|
total_Total Exposed Perimeter |
number m |
Range: ≥ 0 | |
exposed_Exposed Perimeter Fraction |
number dimensionless |
1.0 |
Range: ≥ 0, ≤ 1 |
surfaces |
list | Each item: surface_segment_exposed |
SurfaceProperty:ExteriorNaturalVentedCavity¶
from idfpy.models import SurfacePropertyExteriorNaturalVentedCAVity extensible
Used to describe the decoupled layer, or baffle, and the characteristics of the cavity and openings for naturally ventilated exterior surfaces. This object is also used in conjunction with the OtherSideConditionsModel.
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | ||
boundary_Boundary Conditions Model Name required |
reference | Enter the name of a SurfaceProperty:OtherSideConditionsModel object Names a SurfaceProperty:OtherSideConditionsModel |
|
area_Area Fraction of Openings |
number dimensionless |
Range: > 0, ≤ 1 | |
thermal_Thermal Emissivity of Exterior Baffle Material |
number dimensionless |
Range: ≥ 0, ≤ 1 | |
solar_Solar Absorbtivity of Exterior Baffle |
number dimensionless |
Range: ≥ 0, ≤ 1 | |
height_Height Scale for Buoyancy-Driven Ventilation |
number m |
Range: > 0 | |
effective_Effective Thickness of Cavity Behind Exterior Baffle |
number m |
if corrugated, use average depth Range: > 0 |
|
ratio_Ratio of Actual Surface Area to Projected Surface Area |
number dimensionless |
1.0 |
this parameter is used to help account for corrugations in the collector Range: ≥ 0.8, ≤ 2 |
roughness_Roughness of Exterior Surface required |
choice | One of MediumRough, MediumSmooth, Rough, Smooth, VeryRough, VerySmooth |
|
effectiveness_Effectiveness for Perforations with Respect to Wind |
number dimensionless |
0.25 |
Range: > 0, ≤ 1.5 |
discharge_Discharge Coefficient for Openings with Respect to Buoyancy Driven Flow |
number dimensionless |
0.65 |
Range: > 0, ≤ 1.5 |
surface |
list | Each item: surface_name |
SurfaceProperty:GroundSurfaces¶
from idfpy.models import SurfacePropertyGroundSurfaces extensible
This object defines a list of ground surfaces for use with an exterior surface.
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | ||
ground_ |
list | Each item: ground_surface_name, ground_surface_view_factor (dimensionless), ground_surface_temperature_schedule_name, ground_surface_reflectance_schedule_name |
Referenced by 1 object types
SurfaceProperty:HeatBalanceSourceTerm¶
from idfpy.models import SurfacePropertyHeatBalanceSourceTerm
Allows an additional heat source term to be added to the inside or outside surface boundary. A heat source can be added to either or both the inside and outside of the same surface.
| Field | Type | Default | Details |
|---|---|---|---|
surface_Surface Name required |
reference | Names a BuildingSurface:Detailed, Ceiling:Adiabatic, Ceiling:Interzone, Floor:Adiabatic, Floor:Detailed, Floor:GroundContact, Floor:Interzone, Roof, RoofCeiling:Detailed, Wall:Adiabatic, Wall:Detailed, Wall:Exterior and 2 more | |
inside_Inside Face Heat Source Term Schedule Name |
reference | The value of this schedule is the source term value for the inside face of this surface If this field is left blank, no inside surface source term will be applied. The schedule values are heat rate per surface area (W/m2), when positive schedule values indicate heat gain and negative values indicates loss. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules |
|
outside_Outside Face Heat Source Term Schedule Name |
reference | The value of this schedule is the source term value for the outside face of this surface If this field is left blank, no outside surface source term will be applied. The schedule values are heat rate per surface area (W/m2), when positive schedule values indicate heat gain and negative values indicates loss. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules |
SurfaceProperty:HeatTransferAlgorithm¶
from idfpy.models import SurfacePropertyHeatTransferAlgorithm
Determines which Heat Balance Algorithm will be used for a specific surface Allows selectively overriding the global setting in HeatBalanceAlgorithm CTF (Conduction Transfer Functions), EMPD (Effective Moisture Penetration Depth with Conduction Transfer Functions). Advanced/Research Usage: CondFD (Conduction Finite Difference) Advanced/Research Usage: HAMT (Combined Heat And Moisture Finite Element)
| Field | Type | Default | Details |
|---|---|---|---|
surface_Surface Name required |
reference | Names a BuildingSurface:Detailed, Ceiling:Adiabatic, Ceiling:Interzone, Floor:Adiabatic, Floor:Detailed, Floor:GroundContact, Floor:Interzone, Roof, RoofCeiling:Detailed, Wall:Adiabatic, Wall:Detailed, Wall:Exterior and 2 more | |
algorithmAlgorithm |
choice | ConductionTransferFunction |
One of CombinedHeatAndMoistureFiniteElement, ConductionFiniteDifference, ConductionTransferFunction, MoisturePenetrationDepthConductionTransferFunction |
SurfaceProperty:HeatTransferAlgorithm:Construction¶
from idfpy.models import SurfacePropertyHeatTransferAlgorithmConstruction
Determines which Heat Balance Algorithm will be used for surfaces that have a specific type of construction Allows selectively overriding the global setting in HeatBalanceAlgorithm CTF (Conduction Transfer Functions), EMPD (Effective Moisture Penetration Depth with Conduction Transfer Functions). Advanced/Research Usage: CondFD (Conduction Finite Difference) Advanced/Research Usage: HAMT (Combined Heat And Moisture Finite Element)
| Field | Type | Default | Details |
|---|---|---|---|
nameName |
string | ||
algorithmAlgorithm |
choice | ConductionTransferFunction |
One of CombinedHeatAndMoistureFiniteElement, ConductionFiniteDifference, ConductionTransferFunction, MoisturePenetrationDepthConductionTransferFunction |
construction_Construction Name required |
reference | Names a Construction, Construction:AirBoundary, Construction:CfactorUndergroundWall, Construction:FfactorGroundFloor, Construction:WindowDataFile, Construction:WindowEquivalentLayer |
SurfaceProperty:HeatTransferAlgorithm:MultipleSurface¶
from idfpy.models import SurfacePropertyHeatTransferAlgorithmMultipleSurface
Determines which Heat Balance Algorithm will be used for a group of surface types Allows selectively overriding the global setting in HeatBalanceAlgorithm CTF (Conduction Transfer Functions), EMPD (Effective Moisture Penetration Depth with Conduction Transfer Functions). Advanced/Research Usage: CondFD (Conduction Finite Difference) Advanced/Research Usage: HAMT (Combined Heat And Moisture Finite Element)
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | ||
surface_Surface Type required |
choice | One of AllExteriorFloors, AllExteriorRoofs, AllExteriorSurfaces, AllExteriorWalls, AllGroundContactSurfaces, AllInteriorCeilings, AllInteriorFloors, AllInteriorSurfaces, AllInteriorWalls |
|
algorithmAlgorithm |
choice | ConductionTransferFunction |
One of CombinedHeatAndMoistureFiniteElement, ConductionFiniteDifference, ConductionTransferFunction, MoisturePenetrationDepthConductionTransferFunction |
SurfaceProperty:HeatTransferAlgorithm:SurfaceList¶
from idfpy.models import SurfacePropertyHeatTransferAlgorithmSurfaceList extensible
Determines which Heat Balance Algorithm will be used for a list of surfaces Allows selectively overriding the global setting in HeatBalanceAlgorithm CTF (Conduction Transfer Functions), EMPD (Effective Moisture Penetration Depth with Conduction Transfer Functions). Advanced/Research Usage: CondFD (Conduction Finite Difference) Advanced/Research Usage: HAMT (Combined Heat And Moisture Finite Element)
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | ||
algorithmAlgorithm |
choice | ConductionTransferFunction |
One of CombinedHeatAndMoistureFiniteElement, ConductionFiniteDifference, ConductionTransferFunction, MoisturePenetrationDepthConductionTransferFunction |
surface |
list | Each item: surface_name |
SurfaceProperty:IncidentSolarMultiplier¶
from idfpy.models import SurfacePropertyIncidentSolarMultiplier
| Field | Type | Default | Details |
|---|---|---|---|
surface_Surface Name required |
reference | Enter the name of an exterior window outside surface object Names a BuildingSurface:Detailed, Ceiling:Adiabatic, Ceiling:Interzone, Floor:Adiabatic, Floor:Detailed, Floor:GroundContact, Floor:Interzone, Roof, RoofCeiling:Detailed, Wall:Adiabatic, Wall:Detailed, Wall:Exterior and 2 more |
|
incident_Incident Solar Multiplier |
number dimensionless |
1.0 |
a constant multiplier for window solar transmittance and visible transmittance. If the Shading Multiplier Schedule Name is defined, the product of these two will be the final shading multiplier. Range: ≥ 0, ≤ 1 |
incident_Incident Solar Multiplier Schedule Name |
reference | The schedule values should be greater than or equal to 0 and less than or equal to 1. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules |
SurfaceProperty:LocalEnvironment¶
from idfpy.models import SurfacePropertyLocalEnvironment
This object defines the local environment properties of an exterior surface. One or more environment properties have to be defined and linked to the exterior surface.
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | ||
exterior_Exterior Surface Name |
reference | Enter the name of an exterior surface object Names a BuildingSurface:Detailed, Ceiling:Adiabatic, Ceiling:Interzone, Door, Door:Interzone, FenestrationSurface:Detailed, Floor:Adiabatic, Floor:Detailed, Floor:GroundContact, Floor:Interzone, GlazedDoor, GlazedDoor:Interzone and 10 more |
|
sunlit_Sunlit Fraction Schedule Name |
reference | Enter the name of a Schedule object Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules |
|
surrounding_Surrounding Surfaces Object Name |
reference | Enter the name of a SurfaceProperty:SurroundingSurfaces object Names a SurfaceProperty:SurroundingSurfaces |
|
outdoor_Outdoor Air Node Name |
reference | Enter the name of an OutdoorAir:Node object Names a OutdoorAir:Node |
|
ground_Ground Surfaces Object Name |
reference | Enter the name of a SurfaceProperty:GroundSurfaces object Names a SurfaceProperty:GroundSurfaces |
SurfaceProperty:OtherSideCoefficients¶
from idfpy.models import SurfacePropertyOtherSideCoefficients
This object sets the other side conditions for a surface in a variety of ways.
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | ||
combined_Combined Convective/Radiative Film Coefficient required |
number W/m2-K |
if>0, this field becomes the exterior convective/radiative film coefficient and the other fields are used to calculate the outdoor air temperature then exterior surface temperature based on outdoor air and specified coefficient if<=0, then remaining fields calculate the outside surface temperature The following fields are used in the equation: OtherSideTemp=N2*N3 + N4*OutdoorDry-bulb + N5*GroundTemp + N6*WindSpeed*OutdoorDry-bulb + N7*TempZone + N9*TempPrev | |
constant_Constant Temperature |
number C |
0.0 |
This parameter will be overwritten by the values from the Constant Temperature Schedule Name (below) if one is present |
constant_Constant Temperature Coefficient |
number | 1.0 |
This coefficient is used even with a Schedule. It should normally be 1.0 in that case. This field is ignored if Sinusoidal Variation of Constant Temperature Coefficient = Yes. |
external_External Dry-Bulb Temperature Coefficient |
number | 0.0 |
|
ground_Ground Temperature Coefficient |
number | 0.0 |
|
wind_Wind Speed Coefficient |
number | 0.0 |
|
zone_Zone Air Temperature Coefficient |
number | 0.0 |
|
constant_Constant Temperature Schedule Name |
reference | Name of schedule for values of constant temperature. Schedule values replace any value specified in the field Constant Temperature. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules |
|
sinusoidal_Sinusoidal Variation of Constant Temperature Coefficient |
choice | No |
Optionally used to vary Constant Temperature Coefficient with unitary sine wave One of No, Yes |
period_Period of Sinusoidal Variation |
number hr |
24.0 |
Use with sinusoidal variation to define the time period Range: > 0 |
previous_Previous Other Side Temperature Coefficient |
number | 0.0 |
This coefficient multiplies the other side temperature result from the previous zone timestep |
minimum_Minimum Other Side Temperature Limit |
number C |
This field specifies a lower limit for the other side temperature result. Blank indicates no limit | |
maximum_Maximum Other Side Temperature Limit |
number C |
This field specifies an upper limit for the other side temperature result. Blank indicates no limit |
Referenced by 11 object types
BuildingSurface:Detailed, Ceiling:Interzone, Door:Interzone, FenestrationSurface:Detailed, Floor:Detailed, Floor:Interzone, GlazedDoor:Interzone, RoofCeiling:Detailed, Wall:Detailed, Wall:Interzone, Window:Interzone
SurfaceProperty:OtherSideConditionsModel¶
from idfpy.models import SurfacePropertyOtherSideConditionsModel
This object sets up modifying the other side conditions for a surface from other model results.
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | ||
type_Type of Modeling |
choice | GapConvectionRadiation |
GapConvectionRadiation provides boundary conditions for convection and linearized thermal radiation across a gap or cavity on the other side of the surface that are modeled separately. UndergroundPipingSystemSurface provides boundary conditions for surfaces in contact with PipingSystem:Underground domains GroundCoupledSurface provides boundary conditions for surfaces in contact with GroundDomain objects ConvectiveUnderwater provides a connection between a surface and an underwater boundary condition defined using a SurfaceProperty:Underwater object One of ConvectiveUnderwater, GapConvectionRadiation, GroundCoupledSurface, UndergroundPipingSystemSurface |
Referenced by 17 object types
BuildingSurface:Detailed, Ceiling:Interzone, Door:Interzone, FenestrationSurface:Detailed, Floor:Detailed, Floor:Interzone, GlazedDoor:Interzone, PipingSystem:Underground:Domain, RoofCeiling:Detailed, Site:GroundDomain:Basement, Site:GroundDomain:Slab, SolarCollector:UnglazedTranspired, SolarCollectorPerformance:PhotovoltaicThermal:BIPVT, SurfaceProperty:ExteriorNaturalVentedCavity, Wall:Detailed, Wall:Interzone, Window:Interzone
SurfaceProperty:SolarIncidentInside¶
from idfpy.models import SurfacePropertySolarIncidentInside
Used to provide incident solar radiation on the inside of the surface. Reference surface-construction pair and if that pair is used in a simulation, then program will use value provided in schedule instead of calculating it.
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | ||
surface_Surface Name required |
reference | Names a BuildingSurface:Detailed, Ceiling:Adiabatic, Ceiling:Interzone, Floor:Adiabatic, Floor:Detailed, Floor:GroundContact, Floor:Interzone, Roof, RoofCeiling:Detailed, Wall:Adiabatic, Wall:Detailed, Wall:Exterior and 2 more | |
construction_Construction Name required |
reference | Names a Construction, Construction:AirBoundary, Construction:CfactorUndergroundWall, Construction:FfactorGroundFloor, Construction:WindowDataFile, Construction:WindowEquivalentLayer | |
inside_Inside Surface Incident Sun Solar Radiation Schedule Name required |
reference | Values in schedule are expected to be in W/m2 Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules |
SurfaceProperty:SurroundingSurfaces¶
from idfpy.models import SurfacePropertySurroundingSurfaces extensible
This object defines a list of surrounding surfaces for an exterior surface.
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | ||
sky_Sky View Factor |
number or Autocalculate |
Autocalculate |
optional |
sky_Sky Temperature Schedule Name |
reference | Schedule values are real numbers, -100.0 to 100.0, units C optional Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules |
|
ground_Ground View Factor |
number or Autocalculate |
Autocalculate |
optional |
ground_Ground Temperature Schedule Name |
reference | Schedule values are real numbers, -100.0 to 100.0, units C optional Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules |
|
surfaces |
list | Each item: surrounding_surface_name, surrounding_surface_view_factor, surrounding_surface_temperature_schedule_name |
Referenced by 1 object types
SurfaceProperty:Underwater¶
from idfpy.models import SurfacePropertyUnderwater
This object sets up a convective water boundary condition for a surface The free stream temperature and velocity are scheduled. If the free stream velocity is zero, the surface will naturally convect with the surrounding water.
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | ||
distance_Distance from Surface Centroid to Leading Edge of Boundary Layer required |
number m |
This is the distance from the leading edge of the boundary layer development to the centroid of the surface of interest. The value of this field is used as the distance in the Reynolds number for evaluating the local convection coefficient. | |
free_Free Stream Water Temperature Schedule required |
reference C |
Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules | |
free_Free Stream Water Velocity Schedule |
reference m/s |
Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules |
ZoneMRTCalculation¶
from idfpy.models import ZoneMRTCalculation extensible
Blends MRT values calculated for People instances into one Zone MRT. The weighting factors must sum to a value from 0.0 through 1.0. Only one ZoneMRTCalculation object is allowed for each Zone. All referenced People instances must be in the named Zone and must select at least one Thermal Comfort Model Type.
| Field | Type | Default | Details |
|---|---|---|---|
zone_Zone Name required |
reference | This field accepts a Zone name only, not a Space or SpaceList name. Names a Zone |
|
people_ |
list | Each item: people_name, mrt_weighting_factor |
ZoneProperty:LocalEnvironment¶
from idfpy.models import ZonePropertyLocalEnvironment
This object defines the local environment properties of a zone object. A corresponding outdoor air node should be defined and linked to the zone object.
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | ||
zone_Zone Name |
reference | Enter the name of a zone object Names a Zone |
|
outdoor_Outdoor Air Node Name |
reference | Enter the name of an OutdoorAir:Node object Names a OutdoorAir:Node |
ZoneProperty:UserViewFactors:BySurfaceName¶
from idfpy.models import ZonePropertyUserViewFactorsBySurfaceName extensible
View factors for Surface to Surface in a zone. (Number of Surfaces)**2 are expected. Any omitted surface pairs will be assumed to have a view factor of zero.
| Field | Type | Default | Details |
|---|---|---|---|
zone_Zone or ZoneList or Space or SpaceList Name |
reference | View factors may be entered for a space, zone, group of spaces, or group of zones in the same enclosure by way of Construction:AirBoundary or open spaces within a zone. This name must align with an enclosure encompassing the same zones or spaces. Names a Space, SpaceList, Zone, ZoneList |
|
view_ |
list | Each item: from_surface, to_surface, view_factor |